nebari-dev / nebari-dev/nebari-docs

[DOC] - Add more details about auto-enabling SSL certs

Open
#204 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

area: documentation 📖 area: security 🔐 good first issue
Dominant language
No language data
Stars
21
Forks
40
Avg merge
19h 50m
Merged PRs (30d)
6

Description

Preliminary Checks
Summary

We thought the SSL certs would be taken care of by cloudflare, but didn’t realize we needed the extra flag for that to happen.

This caused the browser (Chrome) to attempt to block access to the website. (which we got around by typing "thisisunsafe" - I know, its not safe, don't try this at home, kids).

Solution:
When running nebari init  there is a flag you can pass to auto-enable the certs --ssl-cert-email

Steps to Resolve this Issue

We need to add some details on this to docs both in the nebari init page and the nebari deploy pages.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the nebari init and nebari deploy documentation pages mentioned in the issue. Review how the --ssl-cert-email flag and SSL certificate behavior are currently described, then update both pages so users know when the flag is needed and what outcome to expect.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.