Skip to content

Update index.md with Tailscale persistence instructions and subnet ro…#14

Open
spamsgood wants to merge 2 commits intoUGREEN-NASync:mainfrom
spamsgood:patch-1
Open

Update index.md with Tailscale persistence instructions and subnet ro…#14
spamsgood wants to merge 2 commits intoUGREEN-NASync:mainfrom
spamsgood:patch-1

Conversation

@spamsgood
Copy link
Copy Markdown

@spamsgood spamsgood commented Jun 4, 2025

…uting section

Added detailed instructions on how to configure Tailscale to persist across reboots and system updates using a systemd override. Also included an optional section on how to advertise a subnet or VLAN for external access via Tailscale. The guide has been reformatted for consistency with other sections and generalized for broader use.

Pull request type

Please check the type of change your PR introduces:

  • Bugfix
  • Feature
  • Documentation/Content changes

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Other information

Summary by Sourcery

Revamp the Tailscale setup guide with step-by-step sections, persistence configuration, and subnet routing options

Documentation:

  • Reformat guide into clear SSH, install, start, and DNS-fix steps
  • Add instructions to disable Tailscale DNS override for reliable name resolution
  • Introduce systemd override to persist Tailscale settings across reboots and updates
  • Include optional subnet/VLAN advertisement steps for external network access
  • Update credit attribution and license notice

…uting section

Added detailed instructions on how to configure Tailscale to persist across reboots and system updates using a systemd override. Also included an optional section on how to advertise a subnet or VLAN for external access via Tailscale. The guide has been reformatted for consistency with other sections and generalized for broader use.
@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai bot commented Jun 4, 2025

Reviewer's Guide

This PR reorganizes the Tailscale setup guide into clear, numbered steps and consistent formatting, adds optional DNS override fixes, implements systemd overrides for persistence across reboots and updates, introduces subnet/VLAN advertisement instructions, and refreshes the credit attribution.

File-Level Changes

Change Details Files
Restructured installation guide into discrete steps with consistent formatting
  • Split content into “Step 1…Step 4” sections with “###” headings
  • Inserted horizontal separators between major sections
  • Refined command block presentation for clarity
docs/ugos/install/tailscale/index.md
Added optional DNS override fix
  • Explained UGOS DNS override issue when tailscale starts
  • Provided commands to disable Tailscale’s DNS handling
  • Marked the workaround as optional but recommended
docs/ugos/install/tailscale/index.md
Implemented persistence instructions via systemd override
  • Showed how to create /etc/systemd/system/tailscaled.service.d/override.conf
  • Supplied override.conf contents to preserve custom flags
  • Outlined systemctl daemon-reexec, reload, enable, and restart steps
docs/ugos/install/tailscale/index.md
Introduced subnet/VLAN advertisement section
  • Described how to advertise LAN subnets or VLANs
  • Included sample tailscale up command with --advertise-routes
  • Directed reviewers to approve routes in Tailscale admin panel
docs/ugos/install/tailscale/index.md
Updated credit attribution
  • Expanded original credit to include new contributor
  • Standardized license statement under MIT
docs/ugos/install/tailscale/index.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @spamsgood - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 2 issues found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

@Drauku Drauku left a comment

Choose a reason for hiding this comment

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

Please add a blurb about testing this through an update, and the update version it was last tested on so we have verification it still works.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants