sublime-security / sublime-platform

A free and open platform for detecting and preventing email attacks like BEC, malware, and credential phishing. Gain visibility and control, hunt for advanced threats, collaborate with the community, and write detections-as-code.
https://sublime.security
MIT License
159 stars 14 forks source link

Add interactive prompt for ssl #85

Closed madirey closed 1 year ago

madirey commented 1 year ago

Adds low(er)-risk interactive prompt for SSL support. Suggested doc edits have been submitted separately.

NOTE: We'll need one additional step in the docs (and I'm unable to add it because the 'suggest additional edits' button does not work): if sublime.env does not exist, then cp sublime.env.example sublime.env. This is to occur before "Update sublime.env with your domain..."

Flow for new users:

  1. Run curl -sL https://sublimesecurity.com/install.sh | sh
  2. Select y for SSL (exits script, redirects to docs).
  3. Go to docs.
  4. Configure domain.
  5. Edit sublime.env and certbot.env in sublime-platform directory
  6. Re-run script from sublime-platform directory: clone_platform=false ./install-and-launch.sh (doesn't prompt for SSL because certbot.env exists.

Flow for existing users:

  1. Read docs
  2. Configure domain.
  3. Edit sublime.env and certbot.env in sublime-platform directory
  4. Re-run script from sublime-platform directory: clone_platform=false ./install-and-launch.sh ... or run ./update-and-run.sh always_launch ... or run LETSENCRYPT_ENV=certbot.env docker compose --profile letsencrypt up -d ... 😬
image
madirey commented 1 year ago

Suggested Doc edits:

image image