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 TLS to atuin-server #1457

Merged
merged 3 commits into from
Dec 27, 2023
Merged

Add TLS to atuin-server #1457

merged 3 commits into from
Dec 27, 2023

Conversation

drbrain
Copy link
Contributor

@drbrain drbrain commented Dec 25, 2023

atuin as a project already includes most of the dependencies necessary for server-side TLS. This allows atuin server start to use a TLS certificate when self-hosting in order to avoid the complication of wrapping it in a TLS-aware proxy server.

Configuration is handled similar to the metrics server with its own struct and currently accepts only the private key and certificate file paths:

#

[tls]
enable = true
cert_path = "/path/to/letsencrypt/live/FQDN/fullchain.pem"
pkey_path = "/path/to/letsencrypt/live/FQDN/privkey.pem"

Starting a TLS server and a TCP server are divergent because the tests need to bind to an arbitrary port to avoid collisions across tests. The API to accomplish this for a TLS server is much more verbose.

atuin as a project already includes most of the dependencies necessary
for server-side TLS.  This allows `atuin server start` to use a TLS
certificate when self-hosting in order to avoid the complication of
wrapping it in a TLS-aware proxy server.

Configuration is handled similar to the metrics server with its own
struct and currently accepts only the private key and certificate file
paths.

Starting a TLS server and a TCP server are divergent because the tests
need to bind to an arbitrary port to avoid collisions across tests.  The
API to accomplish this for a TLS server is much more verbose.
Copy link

vercel bot commented Dec 25, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
atuin-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 25, 2023 1:43am

Copy link
Member

@ellie ellie left a comment

Choose a reason for hiding this comment

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

Thank you!

Seeing as this is your first time contributing, if you would like a holographic contributors-only Atuin sticker, then please fill out this form!

We do also have a Discord if you'd like to ask any questions, or just fancy hanging out!

@ellie ellie merged commit d52e576 into atuinsh:main Dec 27, 2023
9 checks passed
@drbrain drbrain deleted the tls-server branch December 27, 2023 17:27
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