dahjah/headplane
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

chore: update readme

Browse Source
This commit is contained in:
Aarnav Tale 2024-03-29 16:19:31 -04:00
parent 22b6af685a
commit c2060ed45a
No known key found for this signature in database
1 changed files with 21 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -23,14 +23,32 @@ Here's a very basic `docker-compose.yaml` file that utilizes each configuration
```yaml ```yaml
version: '3.8' version: '3.8'
services: services:
headscale:
image: 'headscale/headscale:0.23.0-alpha5'
container_name: 'headscale'
restart: 'unless-stopped'
command: 'serve'
volumes:
- './data:/var/lib/headscale'
- './configs:/etc/headscale'
ports:
- '8080:8080'
environment:
TZ: 'America/New_York'
headplane: headplane:
container_name: headplane container_name: headplane
image: ghcr.io/tale/headplane:latest image: ghcr.io/tale/headplane:latest
restart: unless-stopped restart: unless-stopped
volumes:
- './data:/var/lib/headscale'
- './configs:/etc/headscale'
ports:
- '3000:3000'
environment: environment:
HEADSCALE_URL: 'https://tailscale.example.com' HEADSCALE_URL: 'http://headscale:8080'
API_KEY: 'abcdefghijklmnopqrstuvwxyz' API_KEY: 'abcdefghijklmnopqrstuvwxyz'
COOKIE_SECRET: 'abcdefghijklmnopqrstuvwxyz' COOKIE_SECRET: 'abcdefghijklmnopqrstuvwxyz'
HEADSCALE_CONTAINER: 'headscale'
OIDC_CLIENT_ID: 'headscale' OIDC_CLIENT_ID: 'headscale'
OIDC_ISSUER: 'https://sso.example.com' OIDC_ISSUER: 'https://sso.example.com'
OIDC_CLIENT_SECRET: 'super_secret_client_secret' OIDC_CLIENT_SECRET: 'super_secret_client_secret'
@ -49,6 +67,8 @@ services:
- **`HOST`**: The host to bind the server to (default: `0.0.0.0`). - **`HOST`**: The host to bind the server to (default: `0.0.0.0`).
- **`PORT`**: The port to bind the server to (default: `3000`). - **`PORT`**: The port to bind the server to (default: `3000`).
- **`CONFIG_FILE`**: The path to the Headscale `config.yaml` (default: `/etc/headscale/config.yaml`).
- **`HEADSCALE_CONTAINER`**: The name of the Headscale container (for Docker integration).
### SSO/OpenID Connect ### SSO/OpenID Connect
If you want to use OpenID Connect for SSO, you'll need to provide these variables. If you want to use OpenID Connect for SSO, you'll need to provide these variables.