diff --git a/Jenkinsfile b/Jenkinsfile index 3356340..598e2ba 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -5,7 +5,7 @@ pipeline { label 'linux-x64' } environment { - APP_VERSION = 'v0.3.0' + APP_VERSION = 'v0.4.0' BUILD_DATE = '' } options { diff --git a/README.md b/README.md index 374d271..b55eda7 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # headscale-webui -## This is a simple front-end for a Headscale server. +## This is a simple front-end for a Headscale server #### PR's, questions, bug-fixes, feature requests are welcome! --- Allows you to do the following: @@ -18,6 +18,7 @@ Allows you to do the following: * PreAuth key associated with the machine * Enable / disable routes and exit nodes * Add and delete machine tags +7. Basic authentication (See Docker Compose changes below) --- @@ -28,6 +29,9 @@ Allows you to do the following: 2. HS_SERVER - Change to your headscale's URL 3. BASE_PATH - This will be the path your server is served on. Because the Windows Tailscale GUI expects , I usually put this as "/admin" 4. KEY - Your encryption key to store your headscale API key on disk. Generate a new one with "openssl rand -base64 32". Do not forget the quotations around the key when entering. + 5. AUTH_TYPE - Set to either "Basic" or "OIDC" for password authentication + 6. AUTH_USER - Username for Basic auth Can be removed if AUTH_TYPE is not "Basic" + 7. AUTH_PASS - Password for Basic auth. Can be removed if AUTH_TYPE is not "Basic" 2. You will also need to change the volumes: 1. /data - Where your encryption key will reside. Can be anywhere writable by UID 1000 2. /etc/headscale/ - This is your Headscale configuration file. diff --git a/docker-compose.yml b/docker-compose.yml index 53d7f7d..1178d66 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -8,9 +8,9 @@ services: - HS_SERVER=localhost # Set this to your Headscale server's URL. It will need to access /api/ on Headscale. - BASE_PATH="/admin" # Default, can be anything you want. Tailscale's Windows app expects "HS_SERVER/admin" - KEY="YourKeyBetweenQuotes" # Generate with "openssl rand -base64 32" - - AUTH_TYPE="Basic" # AUTH_TYPE is either "Basic" or "OIDC" - - BASIC_AUTH_USER="user" # Used for basic auth - - BASIC_AUTH_PASS="pass" # Used for basic auth + - AUTH_TYPE=Basic # AUTH_TYPE is either "Basic" or "OIDC" - Removing this will disable authentication + - BASIC_AUTH_USER=user # Used for basic auth - Can be omitted if not using Basic Auth + - BASIC_AUTH_PASS=pass # Used for basic auth - Can be omitted if not using Basic Auth volumes: - ./volume:/data # Headscale-WebUI's storage. Make sure ./volume is readable by UID 1000 (chown 1000:1000 ./volume) - ./headscale/config/:/etc/headscale/:ro # Headscale's config storage location. Used to read your Headscale config. \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml index b9a2447..8ab321a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,8 +1,8 @@ [tool.poetry] name = "headscale-webui" -version = "0.1.0" -description = "" -authors = ["Your Name "] +version = "v0.4.0" +description = "A simple web UI for small-scale Headscale deployments." +authors = ["Albert Copeland "] license = "AGPL" [tool.poetry.dependencies]