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

More detail in Create Certificates section of manual. #591

Closed
indivisionjoe opened this issue Jun 25, 2021 · 6 comments
Closed

More detail in Create Certificates section of manual. #591

indivisionjoe opened this issue Jun 25, 2021 · 6 comments
Labels
enhancement New feature or request

Comments

@indivisionjoe
Copy link

This is in reference to this page: https://truecharts.org/manual/certificates/

It would be helpful to get more details in the HOW-TO section for this process.

For example, there are many settings pages in the Add CSR process. It is unclear what options need to be set. It does say that the defaults should be ok. But, SCALE is in early develop and it's unclear if/when the defaults will change. It would help to have a screenshot of how each settings page should look.

Also, it would be very helpful to have screenshots of how the main SCALE Certificates page should look after completing each step. In my case, the CSR says "Issuer: external - signature pending". If there was a screenshot of a successful CSR Add I could confirm whether or not my result indicates something wrong.

@indivisionjoe indivisionjoe added the enhancement New feature or request label Jun 25, 2021
@Ornias1993
Copy link
Member

For example, there are many settings pages in the Add CSR process. It is unclear what options need to be set. It does say that the defaults should be ok.

The defaults should be okey, because it's only about lets-encrypt certificates.
It's an oversight on iX's part, but most of the other settings (all of them?) are not even used for generating letsencrypt certificates.
So explaining them would be a waste.

It's not likely to change, because letsencrypt itself simply has no way of accepting any of those settings.

Also, it would be very helpful to have screenshots of how the main SCALE Certificates page should look after completing each step.

This is something we cán and should do, i'll add it to my todo list for this week right away! 👍

In my case, the CSR says "Issuer: external - signature pending".

You need to click the Create ACME Certificate button, this wizard should create a duplicate CSR (for letsencrypt renewal) ánd a certificate. You can ignore the "Issuer: external - signature pending" warning.

To be clear:
I absolutely HATE the process, I scolded on everyone and their dog at iX how absolutely terrible the letsencrypt user experience was... and they purposefully released it in this terrible state.

Besides documenting the Letsencrypt basics, there isn't much I can do for you really :(

Anyway:
When we say "the defaults should be okey" we actually mean: "don't touch them".
We provided this guide to fill a gap in the iX documentation regarding letsencrypt support, not to provide thorough guidance on the whole certificate system. If you want more general docs on that feature you should file a ticket at the iX Jira instead :(

@indivisionjoe
Copy link
Author

Thank you. Understood. I'm definitely not looking for a complete certificate guide. There is just enough complexity in this process that I needed a little more clarity about the specific steps to be sure that I didn't mess something up along the way. All things considered, I think that simply adding the extra screenshots would be everything needed.

I think I now have a cert set up properly for a subdomain I have. But, now I have no idea how I will utilize this. But, I guess it will become more clear once Traefik is ready. :)

@Ornias1993
Copy link
Member

All things considered, I think that simply adding the extra screenshots would be everything needed.

Afaik there is only one screenshot missing.
I'm not going to spend time creating screenshots for clicking 'next'.

@indivisionjoe
Copy link
Author

All things considered, I think that simply adding the extra screenshots would be everything needed.

Afaik there is only one screenshot missing.
I'm not going to spend time creating screenshots for clicking 'next'.

In order to show how all inputs are filled out and what the resulting main page looks like at different stages it's more than one screenshot and is not just showing 'next'.

@Ornias1993
Copy link
Member

All things considered, I think that simply adding the extra screenshots would be everything needed.

Afaik there is only one screenshot missing.
I'm not going to spend time creating screenshots for clicking 'next'.

In order to show how all inputs are filled out and what the resulting main page looks like at different stages it's more than one screenshot and is not just showing 'next'.

Thinking about this issue, i've decided to close this.
Not because I think it isn't a valid complaint, but simply because you should get iX to fix their own documentation (they could even literally copy-paste ours in this case and work from there). The certificates screen is not a TrueCharts feature and keeping this issue open, may give the impression it is a TrueCharts feature.

@truecharts-admin
Copy link
Collaborator

This issue is locked to prevent necro-posting on closed issues. Please create a new issue or contact staff on discord of the problem persists

@truecharts truecharts locked and limited conversation to collaborators Feb 7, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants