Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 7 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ If you are using docker, you can install `headscale` alongside `headscale-ui`, l
version: '3.5'
services:
headscale:
image: headscale/headscale:latest
image: headscale/headscale:stable
container_name: headscale
volumes:
- ./container-config:/etc/headscale
Expand All @@ -27,7 +27,8 @@ services:
restart: unless-stopped
container_name: headscale-ui
# ports:
# - 9443:443
# - 8443:8443
# - 8080:8080
```

Headscale UI serves on port 443 and uses a self signed cert by default. You will need to add a `config.yaml` file under your `container-config` folder so that `headscale` has all of the required settings declared. An example from the official `headscale` repo is [here](https://github.com/juanfont/headscale/blob/main/config-example.yaml).
Expand All @@ -36,19 +37,14 @@ Headscale UI serves on port 443 and uses a self signed cert by default. You will
The docker container lets you set the following settings:
| Variable | Description | Example |
|----|----|----|
| HTTP_PORT | Sets the HTTP port to an alternate value | `80` |
| HTTPS_PORT | Sets the HTTPS port to an alternate value | `443` |
| HTTP_PORT | Sets the HTTP port to an alternate value | `8080` |
| HTTPS_PORT | Sets the HTTPS port to an alternate value | `8443` |

### Proxy Settings
You will need a reverse proxy to install `headscale-ui` on your domain. Here is an example [Caddy Config](https://caddyserver.com/) to achieve this:
```
https://hs.yourdomain.com.au {
reverse_proxy /web* https://headscale-ui {
transport http {
tls_insecure_skip_verify
}
}

reverse_proxy /web* http://headscale-ui:8080
reverse_proxy * http://headscale:8080
}

Expand Down Expand Up @@ -92,6 +88,7 @@ See [Other Configurations](/documentation/configuration.md) for further proxy ex
The following versions correspond to the appropriate headscale version
| Headscale Version | HS-UI Version |
|-------------------|---------------|
| 23+ | 2024-10-01+ |
| 19+ | 2023-01-30+ |
| <19 | <2023-01-30 |

Expand Down
4 changes: 2 additions & 2 deletions docker/production/dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ ENV PROJECT_NAME="headscale-ui"
# URL for the github/git location
ENV PROJECT_URL="https://github.com/gurucomputing/headscale-ui"
# Ports that caddy will run on
ENV HTTP_PORT="80"
ENV HTTPS_PORT="443"
ENV HTTP_PORT="8080"
ENV HTTPS_PORT="8443"

# Production Web Server port. Runs a self signed SSL certificate
EXPOSE 443
Expand Down
25 changes: 0 additions & 25 deletions docker/test/test-server/Caddyfile

This file was deleted.

42 changes: 0 additions & 42 deletions docker/test/test-server/docker-compose.yaml

This file was deleted.

27 changes: 0 additions & 27 deletions docker/test/test-server/dockerfile

This file was deleted.

25 changes: 0 additions & 25 deletions docker/test/test-server/scripts/1-image-build.sh

This file was deleted.

23 changes: 0 additions & 23 deletions docker/test/test-server/scripts/2-initialise.sh

This file was deleted.

38 changes: 0 additions & 38 deletions docker/test/test-workers/docker-compose.yaml

This file was deleted.