jsha / minica

minica is a small, simple CA intended for use in situations where the CA operator also operates each host where a certificate will be used.
MIT License
3.02k stars 246 forks source link

Installation instructions lack consistency. #63

Closed Ricky-Tigg closed 1 year ago

Ricky-Tigg commented 1 year ago

v.: 1.0.2. Hello. An interpretation of the instructions of installation appeared to be required. Here presented in the reading order

"First, install the Go tools and set up your $GOPATH. Then, run: go install github.com/jsha/minica@latest" | Done.

Despite the above command does not print any information about what it is doing, it appears that it installed in current directory all needed resources to run the application.

$ tree --metafirst --noreport -pshL 3 go/bin/
[drwxr-xr-x    60]  go/bin/
[-rwxr-xr-x  4.1M]  ├── minica
[-rw-------  1.6K]  ├── minica-key.pem
[-rw-------  1.2K]  └── minica.pem

Ii keep on going.

"When using Go 1.11 (...) can instead do the following" | It starts becoming confusing. As demonstrated above the installation is already achieved. Therefore learning now the Go version comes too late. Note: command valid on my system.

$ dnf rq --installed --qf %{version} golang
1.20.3

As indicated a command such as ./go/bin/minica --domains localhost could already be run.

$ file localhost/*
localhost/cert.pem: PEM certificate
localhost/key.pem:  PEM RSA private key

At last, as noticeable no mention of the certificate file to be imported into a web-browser is present in that documentation. that should be easy to improve. Otherwise it seems to me that it is a useful utility that you have created.

Ricky-Tigg commented 1 year ago

Inactive state for long enough to indicate that this tool won't receive proper instructions nor improvement.