Installation script does not anticipate Let's Encrypt failure

Open
#111 9 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
30/100
Issue type
Bug
Clarity
Needs clarification
Activity status
Stale
Tech stack
typescript
Domain
cli

Research direction

Start with the caprover serversetup and caprover login entry points and reproduce the Let's Encrypt failure followed by a retry. Determine how failed setup state and certificate errors are handled, and review the prompts for consistent terminology. Done means a failed certificate setup can be recovered or retried and the reported password and machine-name confusion is addressed.

Written by the indexing model from the issue text.

Description

What is the problem?

Having used the Digital Ocean Marketplace app, I am having two issues with the installation script. They are not directly related - happy to open separate issues if it makes it easier to work with.

1. I seem to be stuck in a loop, which the installation script does not anticipate.

Steps to reproduce the problem:

I ran the installation script caprover serversetup and it generated an error when the Let's Encrypt certificate generation fails (Error 1107 and Some challenges have failed). I cannot re-run caprover serversetup because the script considers that it has succeeded and prevents further running of it:

You may have already setup the server with root domain: mydomain.com! Use caprover login to log into an existing server.

Then when I use caprover login, I get an error message (Something bad happened and Error: self signed certificate).

Visiting http(s)://captain.mydomain.com just loads a page saying Nothing here yet :/ and a link to the documentation. Visiting http(s)://mydomain.com:3000 loads nothing at this point.

I'd be happy to try to regenerate the certificates, but I could not see anything in the documentation for the CLI app. Can ACME certbot be called directly?

2. Clearer terminology would be helpful.

Steps to reproduce the problem:

When running the caprover serversetup script, you are asked for new CapRover password (min 8 characters). But when you run caprover login you are asked for a CapRover machine password and then a CapRover machine name, with whom the login credentials are stored locally and suggests captain-01. Maybe this is obvious to people with more experience, but given that at this point I have not provided a machine name, username or anything else yet, it was not for me.

Output of uname -a && lsb_release -a && free -h on your server:

Linux machine-name 4.15.0-159-generic caprover/caprover#167-Ubuntu SMP Tue Sep 21 08:55:05 UTC 2021 x86_64 x86_64 x86_64 GNU/Linux
No LSB modules are available.
Distributor ID: Ubuntu
Description:    Ubuntu 18.04.6 LTS
Release:        18.04
Codename:       bionic
              total        used        free      shared  buff/cache   available
Mem:           985M        226M        311M        1.0M        446M        606M
Swap:            0B          0B          0B
Dominant language
TypeScript
Stars
78
Forks
43
PR merge metrics
No merged PRs in 30d

Getting set up

  • Ships a Dockerfile or Docker Compose file
  • Has a pull request template
  • No 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.

More from caprover/caprover-cli

All issues in caprover/caprover-cli

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.