diff --git a/README.md b/README.md index 25a366e..5bad111 100644 --- a/README.md +++ b/README.md @@ -22,3 +22,23 @@ * `abra app deploy ` For more, see [`docs.coopcloud.tech`](https://docs.coopcloud.tech). + + +## Getting started using headscale +The recipe deploys two containers. + +1. One is headscale itself. Note that it's a "distroless" container, so you can't enter with `bash` or `sh`, but you have to run the commands directly. + +> The headscale/headscale Docker container is based on a "distroless" image that does not contain a shell or any other debug tools. If you need to debug your application running in the Docker container, you can use the -debug variant, for example headscale/headscale:x.x.x-debug. +> +> https://headscale.net/0.24.1/setup/install/container/#debugging-headscale-running-in-docker + +To run the command line do this: + +```bash +abra app run yourapp.xyz app -- headscale help +``` + +2. The UI runs on `https://yourapp.xyz/web`, the UI is a mere frontend (a static site), so no data is saved on a server, so you will need to set URL and API-Key yourself on every client. Find more about the UI [here](https://github.com/gurucomputing/headscale-ui). + +For the usage of headscale itself, check the [offical docs](https://headscale.net/stable/usage/getting-started/). \ No newline at end of file