Skip to content

README.md: assorted doc updates #72

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

Merged
merged 1 commit into from
Jul 15, 2024
Merged

README.md: assorted doc updates #72

merged 1 commit into from
Jul 15, 2024

Conversation

willnorris
Copy link
Member

  • remove mention of debug logging that's no longer needed
  • add note about putting state_dir on persistent volume in containers
  • add note about auth provider and tagged nodes
  • fix a few missing words

Updates #docs

Unless the node is registered as `ephemeral`, the auth key is only needed on first run.
Node state is stored in `state_dir` and reused when Caddy restarts.
When running in a container, it is generally recommended to use `ephemeral` and always provide an auth key,
or to mount the state directory on a persistent volume, depending on the use case.
Copy link
Contributor

Choose a reason for hiding this comment

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

(Note to self): We should probably document these practices (and the why) somewhere in the main docs page so that places like this can just link it. I've created an issue for this https://github.com/tailscale/tailscale-www/issues/6107 (closed source)

- remove mention of debug logging that's no longer needed
- add note about putting state_dir on persistent volume in containers
- add note about auth provider and tagged nodes
- fix a few missing words

Updates #docs

Signed-off-by: Will Norris <will@tailscale.com>
@willnorris willnorris merged commit c357e48 into main Jul 15, 2024
2 of 3 checks passed
@willnorris willnorris deleted the will/docs branch July 15, 2024 16:17
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