diff --git a/README.md b/README.md index 549064ee82..c7b4cb834c 100644 --- a/README.md +++ b/README.md @@ -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)
diff --git a/docs/assets/docs/deployment/ngrok-1.png b/docs/assets/docs/deployment/ngrok-1.png new file mode 100644 index 0000000000..d254a2307c Binary files /dev/null and b/docs/assets/docs/deployment/ngrok-1.png differ diff --git a/docs/deployment/ngrok.md b/docs/deployment/ngrok.md new file mode 100644 index 0000000000..3d6a08f7e2 --- /dev/null +++ b/docs/deployment/ngrok.md @@ -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= 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 ` +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) diff --git a/mkdocs.yml b/mkdocs.yml index 98e470f7a9..cbcafeeabc 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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'