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

Document how to setup TLS #352

Closed
chbatey opened this issue Aug 15, 2018 · 8 comments
Closed

Document how to setup TLS #352

chbatey opened this issue Aug 15, 2018 · 8 comments
Milestone

Comments

@chbatey
Copy link
Member

chbatey commented Aug 15, 2018

No description provided.

@raboof
Copy link
Member

raboof commented Nov 2, 2018

@ignasi35
Copy link
Member

ignasi35 commented Apr 8, 2020

@raboof other than cross-linking to sections of the docs you mentioned, do you think any extra documentation is necessary?

I was thinking that a new section in https://doc.akka.io/docs/akka-grpc/current/deploy.html or https://doc.akka.io/docs/akka-grpc/current/troubleshooting.html could be enough to detail each problem and a brief description of the solution and link to the corresponding existing docs.

@ignasi35
Copy link
Member

ignasi35 commented Apr 8, 2020

@raboof One of the reasons I'd rather keep this minimal is that both ConnectionContext.https() and UseHttp2.Always are deprecated so I'd rather keep the contents of these new docs minimal so users find the appropriate ref docs for 10.1 or 10.2.

@raboof
Copy link
Member

raboof commented Apr 9, 2020

Good point! I agree pointing to the Akka HTTP docs (and perhaps improving those a bit? or are they OK?) should be sufficient. We can point to 10.1 now and update both the dependency and the documentation reference to 10.2.0 when that comes out

@ignasi35
Copy link
Member

ignasi35 commented Apr 9, 2020

Here's some sample code I used while investigating the work requried for this issue.

@ignasi35
Copy link
Member

After #912 I did a review of what's already documented to setup TLs on the client-side and found https://doc.akka.io/docs/akka-grpc/current/client/configuration.html contains all the necessary information.

I think we can mark this issue as completed.

@esamson
Copy link

esamson commented Apr 15, 2020

Sorry to jump in here. I was lead to this issue by this section of the docs: https://doc.akka.io/docs/akka-grpc/current/server/walkthrough.html#serving-the-service-with-akka-http

I'm hoping that's the part that needs updating for this issue to be closed.

@ignasi35
Copy link
Member

Good catch @esamson! I'll remove that TODO and cross-link the walkthrough to the deployment.md where TLS is now documented. Thanks!

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

No branches or pull requests

4 participants