9192013bfe
Adds documentation website using https://vitepress.dev. Some decisions are questionable, for example creation of a symbolic link for the README in the `docs/`. I wanted to preserve the ability to read docs using Github. Maybe not needed. Another issue, is the page outline for the `NixOS` chapter is too narrow. But should serve as a scaffold/basis for doing it properly.
1.4 KiB
Simple Mode
Simple mode enables you to quickly deploy Headplane and is recommended for any testing or simple environments. It does not include the automatic management of DNS and Headplane settings, requiring manual editing and reloading when making changes. If you're looking for a more feature-complete deployment method, check out Integrated Mode.
Deployment
If you are not looking to deploy with Docker, follow the Bare-Metal deployment guide.
Requirements:
- Docker and Docker Compose
- Headscale 0.26 or newer (already deployed)
- A finished configuration file (config.yaml)
Here is what a sample Docker Compose deployment would look like:
services:
headplane:
# I recommend you pin the version to a specific release
image: ghcr.io/tale/headplane:0.6.0
container_name: headplane
restart: unless-stopped
ports:
- '3000:3000'
volumes:
- './config.yaml:/etc/headplane/config.yaml'
- './headplane-data:/var/lib/headplane'
This will result in the Headplane UI being available at the /admin path of the
server you deployed it on. The /admin path is currently not configurable unless
you build the container yourself or run Headplane in Bare-Metal mode.
Refer to the Configuration guide for help with setting up your
config.yamlfile to the appropriate values.