Skip to content
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

replace sample Caddyfile with a number of examples #51

Merged
merged 1 commit into from May 17, 2024
Merged

Conversation

willnorris
Copy link
Member

These examples don't demonstrate all of the various config options since most are pretty straightforward and not terribly interesting. Instead, it focuses on the different plugins and types of use-cases they enable.

Also fix some inconsistent indentation in README config samples.

@willnorris willnorris requested a review from irbekrm May 11, 2024 04:15
@willnorris willnorris force-pushed the will/examples branch 2 times, most recently from b8259f3 to 84b4a62 Compare May 16, 2024 18:19

Multiple example configurations are provided in the [examples directory].
These examples expect an [auth key] to be set in the `TS_AUTHKEY` environment variable.
All nodes registered while running these examples will be ephemeral and removed after disconnect.
Copy link
Contributor

@irbekrm irbekrm May 17, 2024

Choose a reason for hiding this comment

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

will be ephemeral

I guess that depends on whether the auth key is ephemeral, right? Maybe reword like 'create [ephemeral auth key][link] for nodes to be removed after disconnect'? nvm, I hadn't read the whole of this - saw the 'ephemeral' config option now

README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@irbekrm irbekrm left a comment

Choose a reason for hiding this comment

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

The examples are awesome and really well documented too- I found them super helpful!

These examples don't demonstrate all of the various config options since
most are pretty straightforward and not terribly interesting.  Instead,
it focuses on the different plugins and types of use-cases they enable.

Also fix some inconsistent indentation in README config samples.

Signed-off-by: Will Norris <will@tailscale.com>
@willnorris willnorris merged commit 1ed47be into main May 17, 2024
1 check passed
@willnorris willnorris deleted the will/examples branch May 17, 2024 18:12
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.

None yet

2 participants