Skip to content

Create headscale.subdomain.conf.sample #727

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Create headscale.subdomain.conf.sample #727

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
647ee20
Create headscale.subdomain.conf.sample
npcraft Dec 30, 2024
3d03b6d
Merge branch 'linuxserver:master' into master
npcraft Jan 31, 2025
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
42 changes: 42 additions & 0 deletions headscale.subdomain.conf.sample
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
## Version 2024/12/29
# make sure that your headscale container is named headscale
# make sure that your dns has a cname set for headscale

server {
listen 443 ssl;
listen [::]:443 ssl;

server_name headscale.*;

include /config/nginx/ssl.conf;

client_max_body_size 0;

# enable for ldap auth (requires ldap-location.conf in the location block)
#include /config/nginx/ldap-server.conf;

# enable for Authelia (requires authelia-location.conf in the location block)
#include /config/nginx/authelia-server.conf;

# enable for Authentik (requires authentik-location.conf in the location block)
#include /config/nginx/authentik-server.conf;

location / {
Copy link
Member

@quietsy quietsy Jan 30, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a /api location endpoint without the auth comments, you can take a look at other samples as a reference.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@quietsy Actually /api location is not needed for this proxy to work. I have it in production already for long time, works perfectly fine.
Please let me know, what do you think.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not needed but it's our standard way of writing confs to avoid api issues when enabling authentik/authelia.

Copy link
Author

@npcraft npcraft Mar 8, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@quietsy /api location is not added because in example file _template.subdomain.conf.sample mentioned that, if /api is not required for headscale it should not be included.

As this comment in the file confusing for me, can you please explain, as you have said it should be included.

Otherpoint that headscale is really not compatible with authentik and authelia, so I would like to also remove that commented lines, because it will be confusing to keep something which will not be compatible with headscale.

Please let me know what do you think? Thanks for you time.

# REMOVE THIS LINE BEFORE SUBMITTING: Some proxies require one or more additional location blocks for things like API or RPC endpoints.
# REMOVE THIS LINE BEFORE SUBMITTING: If the proxy you are making a sample for does not require an additional location block please remove the commented out section below.

    # location ~ (/<container_name>)?/api {
    #     include /config/nginx/proxy.conf;
    #     include /config/nginx/resolver.conf;
    #     set $upstream_app <container_name>;
    #     set $upstream_port <port_number>;
    #     set $upstream_proto <http or https>;
    #     proxy_pass $upstream_proto://$upstream_app:$upstream_port;
    #
    #     # REMOVE THIS LINE BEFORE SUBMITTING: Additional proxy settings such as headers go below this line, leave the blank line above.
    # }

# enable for ldap auth (requires ldap-server.conf in the server block)
#include /config/nginx/ldap-location.conf;

# enable for Authelia (requires authelia-server.conf in the server block)
#include /config/nginx/authelia-location.conf;

# enable for Authentik (requires authentik-server.conf in the server block)
#include /config/nginx/authentik-location.conf;

include /config/nginx/proxy.conf;
include /config/nginx/resolver.conf;
set $upstream_app headscale;
set $upstream_port 8080;
set $upstream_proto http;
proxy_pass $upstream_proto://$upstream_app:$upstream_port;
}

}