opnsense / opnsense/plugins

[os-tailscale] WebUI Support for Tailscale Peer Relay Server functionality

Open
#5,711 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
PHP
Stars
1.2k
Forks
863
Avg merge
2d 6h
Merged PRs (30d)
10

Description

Important notices
Before you add a new report, we ask you kindly to acknowledge the following:

Is your feature request related to a problem? Please describe.

Could it be possible to include Tailscale Relay Server setting up under OPNsense UI Tailscale configuration?

Relay server functionality is already included in the Tailscale plugin binary:

Currently in order to have Relay server in OPNsense, the following command should executed manually in a shell:
tailscale set --relay-server-port=40000

Describe the solution you'd like
What I am suggesting?:

Adding the following additional visual elements under OPNSense Tailscale WebUI configuration screen (/ui/tailscale/settings)

  • Use as Relay server: Y/N.
  • Relay server port. (i.e. 40000 the default one)

Additionally, it could make sense to create automatically a firewall rule to allow Relay server port traffic.

Describe alternatives you've considered
I have created a custom boot script:

cat << 'EOF' > /usr/local/etc/rc.syshook.d/start/99-tailscale-relay-port.sh
#!/bin/sh
/usr/local/bin/tailscale set --relay-server-port=40000
EOF

Additional context

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the Tailscale settings page entry point, /ui/tailscale/settings, and review how existing configuration values are stored and applied. Trace the current plugin command handling, then determine how the relay-server-port setting and enable control should be represented; done means the WebUI configures the relay server and the requested port, with firewall handling clarified.

Written by the indexing model from the issue text.

Assessment

Tech stack
php, shell
Domain
devops, networking
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.