Ngrok Documentation (#586)

* Ngrok doc

* Add files via upload

* Update README.md

* Update mkdocs.yml
This commit is contained in:
Marco Beretta 2023-07-05 15:20:23 +02:00 committed by GitHub
parent 75250f3a5f
commit 3c1aeab340
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 31 additions and 0 deletions

View file

@ -97,6 +97,7 @@ Keep up with the latest updates by visiting the releases page - [Releases](https
* [Heroku](docs/deployment/heroku.md)
* [Linode](docs/deployment/linode.md)
* [Cloudflare](docs/deployment/cloudflare.md)
* [Ngrok](docs/deployment/ngrok.md)
</details>
<details>

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

29
docs/deployment/ngrok.md Normal file
View file

@ -0,0 +1,29 @@
# Ngrok Installation
To use Ngrok for tunneling your local server to the internet, follow these steps:
## Sign up
1. Go to https://ngrok.com/ and sign up for an account.
## Docker Installation
1. Copy your auth token from https://dashboard.ngrok.com/get-started/your-authtoken.
2. Open a terminal and run the following command: `docker run -d -it -e NGROK_AUTHTOKEN=<your token> ngrok/ngrok http 80`
## Windows Installation
1. Download the ZIP file from https://ngrok.com/download.
2. Extract the contents of the ZIP file using 7zip or WinRar.
3. Run `ngrok.exe`.
4. Copy your auth token from https://dashboard.ngrok.com/get-started/your-authtoken.
5. In the `ngrok.exe` terminal, run the following command: `ngrok config add-authtoken <your token>`
6. If you haven't done so already, start LibreChat normally.
7. In the `ngrok.exe` terminal, run the following command: ngrok http 3080
You will see a link that can be used to access LibreChat.
![ngrok-windows](../assets/docs/deployment/ngrok-1.png)
---
Please note that this readme assumes some prior knowledge and familiarity with the command line, Docker, and running applications on your local machine. If you have any issues or questions, refer to the Ngrok documentation or open an issuee on our [Discord server](https://discord.gg/NGaa9RPCft)

View file

@ -101,6 +101,7 @@ nav:
- Hetzner: 'deployment/hetzner_ubuntu.md'
- Heroku: 'deployment/heroku.md'
- Linode: 'deployment/linode.md'
- Ngrok: 'deployment/ngrok.md'
- Contributions:
- Documentation Guidelines: 'contributions/documentation_guidelines.md'
- Code Standards and Conventions: 'contributions/coding_conventions.md'