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.

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

Conversation

npcraft
Copy link

@npcraft npcraft commented Dec 30, 2024

linuxserver.io


  • I have read the contributing guideline and understand that I have made the correct modifications

Description

Headscale Nginx configs added.

Benefits of this PR and context

Headscale Nginx configs were missing, so it is added. It will help everyone who wants to configure headscale.

How Has This Been Tested?

I have setup Headscale with tailscale client on phone and laptop to make sure that config works.

Source / References

https://headscale.net/stable/ref/integration/reverse-proxy/?h=nginx

@npcraft npcraft mentioned this pull request Dec 30, 2024
1 task
@LinuxServer-CI
Copy link

This pull request has been automatically marked as stale because it has not had recent activity. This might be due to missing feedback from OP. It will be closed if no further activity occurs. Thank you for your contributions.

# 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

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

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.
    # }  

@LinuxServer-CI
Copy link

This pull request has been automatically marked as stale because it has not had recent activity. This might be due to missing feedback from OP. It will be closed if no further activity occurs. Thank you for your contributions.

@LinuxServer-CI
Copy link

This pull request has been automatically marked as stale because it has not had recent activity. This might be due to missing feedback from OP. It will be closed if no further activity occurs. Thank you for your contributions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

Successfully merging this pull request may close these issues.

3 participants