From 7aa68131607ecbff0b5cb2380287d3ee99bc718a Mon Sep 17 00:00:00 2001 From: Peter Vacho Date: Sat, 11 Jan 2025 18:46:09 +0100 Subject: [PATCH] Add section about ngrok for easy testing outside lan --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index b22a46e..939fd01 100644 --- a/README.md +++ b/README.md @@ -186,6 +186,21 @@ sudo docker-compose up -d > mount](https://docs.docker.com/engine/storage/bind-mounts/#use-a-bind-mount-with-compose). By default, MongoDB will > store the data in `/data/db` directory. +## Ngrok forwarding + +If you need to quickly expose the server to the internet for testing purposes, you can use [Ngrok](https://ngrok.com/). +This tool allows you to create a secure tunnel to your localhost, which can be accessed from anywhere on the internet, +from a randomly generated ngrok subdomain. If you're using Arch Linux, you can install it from the AUR (e.g. with `paru +-S ngrok`) + +Assuming you're running the server on `localhost:8000`, you can expose it by running: + +```bash +ngrok http 8000 +``` + +That said, if you're on the same LAN network, you can also use the local IP address of the machine running the server. + ## Configuration To configure the project, you can either set the environment variables manually or create a `.env` file in the root directory of