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

Add Caddy instructions to the documentation #594

Merged
merged 5 commits into from
May 23, 2022

Conversation

martijndeb
Copy link
Contributor

This PR adds Caddy instructions to the documentation. It borrows some text from the NGINX document for the configuration of GoToSocial. It doesn't require much configuration, so the installation instruction is actually a little bit easier.

Add instructions for working with Caddy 2. Some texts are duplicated from the NGINX part (mainly the configuration part, about systemctl).
Adds the new Caddy document to the document tree
Removed the header statements for the proxy, as proxying those are transparant. Kept the flush_interval directive, disabling the response buffer completely so we can write without delays.
Corrects the opening link
Copy link
Contributor

@igalic igalic left a comment

Choose a reason for hiding this comment

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

some feedback

docs/installation_guide/caddy.md Outdated Show resolved Hide resolved

## Results

You should now be able to open the splash page for your instance in your web browser, and will see that it runs under HTTPS!
Copy link
Contributor

Choose a reason for hiding this comment

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

how long does caddy take to retrieve the certificate?
is it necessary to restart it, when it got new ones?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Caddy fully manages it using a challenge. It's near instant. Whenever the certificate is set to expire it will renew it before that happens, which gives you zero downtime

docs/installation_guide/caddy.md Outdated Show resolved Hide resolved
docs/installation_guide/caddy.md Show resolved Hide resolved
@igalic mentioned a few comments to improve these docs. I've processed those in this PR.
@martijndeb
Copy link
Contributor Author

I've added the FreeBSD installation command, and resolved your comments @igalic thanks for the feedback!

@tsmethurst
Copy link
Contributor

Thanks for this! :)

@tsmethurst tsmethurst merged commit d6abe10 into superseriousbusiness:main May 23, 2022
@martijndeb martijndeb deleted the add-caddy-docs branch May 23, 2022 15:59
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.

3 participants