Add docs about no Gerbil

This commit is contained in:
Owen Schwartz 2025-01-12 16:06:54 -05:00
parent a79769bd96
commit df2bfe9283
No known key found for this signature in database
GPG key ID: 8271FDFFD9E0CCBD
2 changed files with 52 additions and 2 deletions

View file

@ -37,8 +37,10 @@ sudo ./installer
The installer will prompt you for the following basic information:
1. **Domain Name**: Enter your fully qualified domain name that you have pointing to this instance
2. **Let's Encrypt Email**: Provide an email address for SSL certificate registration with Lets Encrypt. This should be an email you have access to.
1. **Base Domain Name**: Enter your base fully qualified domain name (without any subdomains) Example: `example.com`
2. **Dashboard Domain Name**: The domain where the application will be hosted. This is used for many things, including generating links. You can run Pangolin on a subdomain or root domain. Example: `proxy.example.com`
3. **Let's Encrypt Email**: Provide an email address for SSL certificate registration with Lets Encrypt. This should be an email you have access to.
4. **Tunneling** You can choose not to install Gerbil for tunneling support - in this config it will just be a normal reverse proxy. See [how to use without tunneling](../03-Pangolin/03-without-tunneling.md).
### 3. Admin User Setup

View file

@ -0,0 +1,48 @@
# Without Tunneling
You can use Pangolin without Gerbil and tunneling. In this configuration Pangolin is essentially acting as a reverse proxy and authentication manager and can be deployed on the *local* network in order to provide access to resources.
All setup remains the same, except Pangolin and Traefik must now be on the same network you want to proxy targets to and you do not need to install Gerbil.
When Gerbil starts up, it will register itself with Pangolin. By not doing this you will only have the option to choose the "Local" connection method. This will mean that Traefik will use the local network.
## How to
### Installer
When asked if you want to install Gerbil for tunneling, select no. Gerbil will be removed from the Docker compose.
### Manual
Follow existing manual install steps, but Gerbil is not required. Your Docker compose should look like the below.
```yaml
services:
pangolin:
image: fosrl/pangolin:1.0.0-beta.4
container_name: pangolin
restart: unless-stopped
volumes:
- ./config:/app/config
healthcheck:
test: ["CMD", "curl", "-f", "http://localhost:3001/api/v1/"]
interval: "3s"
timeout: "3s"
retries: 5
traefik:
image: traefik:v3.1
container_name: traefik
restart: unless-stopped
ports: # added ports to expose from traefik
- 443:443
- 80:80
depends_on:
pangolin:
condition: service_healthy
command:
- --configFile=/etc/traefik/traefik_config.yml
volumes:
- ./config/traefik:/etc/traefik:ro # Volume to store the Traefik configuration
- ./config/letsencrypt:/letsencrypt # Volume to store the Let's Encrypt certificates
```