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

chore: add acl file instructions

Browse Source
This commit is contained in:
Aarnav Tale 2024-04-15 04:06:18 -04:00
parent b285753b24
commit c2fe69ec17
No known key found for this signature in database
3 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -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. 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 - [ ] 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] OIDC based login for the web UI
- [x] Automated API key regeneration - [x] Automated API key regeneration
- [x] Editable headscale configuration - [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 ## Deployment
- If you run Headscale in a Docker container, see the [Advanced Deployment](/docs/Advanced-Integration.md) guide. - 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. - 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 ## Contributing
If you would like to contribute, please install a relatively modern version of Node.js and PNPM. If you would like to contribute, please install a relatively modern version of Node.js and PNPM.

4
docs/Basic-Integration.md
View File

@ -44,3 +44,7 @@ services:
You may also choose to run it natively with the distributed binaries on the releases page. 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. 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`).

2
docs/Configuration.md
View File

@ -13,7 +13,7 @@ You can configure Headplane using environment variables.
- **`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`). - **`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). - **`HEADSCALE_CONTAINER`**: The name of the Headscale container (required for Docker integration).
### SSO/OpenID Connect ### SSO/OpenID Connect