diff --git a/README.md b/README.md index db2ad79..3263f50 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ This is a relatively tiny Remix app that aims to provide a usable GUI for the He It's still very early in it's development, however these are some of the features that are planned. - [ ] Editable tags, machine names, users, etc -- [ ] ACL control through Docker integration +- [x] ACL control through Docker integration - [x] OIDC based login for the web UI - [x] Automated API key regeneration - [x] Editable headscale configuration @@ -16,6 +16,7 @@ It's still very early in it's development, however these are some of the feature ## Deployment - If you run Headscale in a Docker container, see the [Advanced Deployment](/docs/Advanced-Integration.md) guide. - If you run Headscale natively, see the [Basic Deployment](/docs/Basic-Integration.md) guide. +- For more configuration options, refer to the [Configuration](/docs/Configuration.md) guide. ## Contributing If you would like to contribute, please install a relatively modern version of Node.js and PNPM. diff --git a/docs/Basic-Integration.md b/docs/Basic-Integration.md index 078b16c..7514554 100644 --- a/docs/Basic-Integration.md +++ b/docs/Basic-Integration.md @@ -44,3 +44,7 @@ services: You may also choose to run it natively with the distributed binaries on the releases page. You'll need to manage running this yourself, and I would recommend making a `systemd` unit. + +## ACL Configuration +If you would like to get the web ACL configuration working, you'll need to pass the `ACL_FILE` environment variable. +This should point to the path of the ACL file on the Headscale server (ie. `ACL_FILE=/etc/headscale/acl_policy.json`). diff --git a/docs/Configuration.md b/docs/Configuration.md index a9c0eee..7ba0876 100644 --- a/docs/Configuration.md +++ b/docs/Configuration.md @@ -13,7 +13,7 @@ You can configure Headplane using environment variables. - **`HOST`**: The host to bind the server to (default: `0.0.0.0`). - **`PORT`**: The port to bind the server to (default: `3000`). - **`CONFIG_FILE`**: The path to the Headscale `config.yaml` (default: `/etc/headscale/config.yaml`). -- **`ACL_FILE`**: The path to the ACL file (default: `/etc/headscale/acl_policy.json`). +- **`ACL_FILE`**: The path to the ACL file (default: `/etc/headscale/acl_policy.json`, not needed if you have `acl_policy_path` in your config). - **`HEADSCALE_CONTAINER`**: The name of the Headscale container (required for Docker integration). ### SSO/OpenID Connect