Skip to content

Commit

Permalink
move docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kayra1 committed May 10, 2024
1 parent 7f91d16 commit b653fbe
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 7 deletions.
8 changes: 1 addition & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,7 @@
4. Build the frontend: `cd ui && npm build build`
5. Install the project: `go install ./...`
6. Create a `config.yaml` file:
```yaml
keypath: "./key.pem"
certpath: "./cert.pem"
dbpath: "./certs.db"
port: 3000
```
7. Run the project: `gocert --config config.yaml`
7. Run the project: `gocert -config config.yaml`

Commands for go need to be run from the project directory, and commands for the frontend need to be run from the `ui/` directory
## Testing
Expand Down
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,18 @@ GoCert is a certificate management tool.
docker pull ghcr.io/canonical/gocert:latest
docker run -it ghcr.io/canonical/gocert:latest
```

## Requirements

GoCert requires 3 files to operate:
* A private key
* A TLS certificate with that private key
* A YAML config file with the required parameters
as an example:

```yaml
keypath: "./key.pem"
certpath: "./cert.pem"
dbpath: "./certs.db"
port: 3000
```

0 comments on commit b653fbe

Please sign in to comment.