Skip to content

Commit

Permalink
improve documentation related to certificates
Browse files Browse the repository at this point in the history
  • Loading branch information
rarescosma committed Oct 16, 2024
1 parent fae9cc1 commit e20cce1
Showing 1 changed file with 27 additions and 4 deletions.
31 changes: 27 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,15 +84,36 @@ sudo ln -sf $(pwd)/octotail/main.py /usr/local/bin/octotail

### __Important:__ post-install

Run `mitmproxy` once and install its root certificate:
Run `generate-cert` once to generate the proxy root certificate:

```shell
mitmproxy
^C
generate-certs
```

#### Install the generated proxy root certificate

This step is highly platform-dependent.

sudo trust anchor ~/.mitmproxy/mitmproxy-ca-cert.cer
##### On Arch Linux

```shell
sudo trust anchor ~/.local/share/octotail/mitmproxy/mitmproxy-ca-cert.cer
```

#### On macOS

```shell
sudo security add-trusted-cert -d -p ssl -p basic \
-k /Library/Keychains/System.keychain \
~/local/.share/octotail/mitmproxy/mitmproxy-ca-cert.pem
```

#### Others

Please refer to the ["Installing the mitmproxy CA certificate manually"][]
section of the mitmproxy documentation, changing `~/.mitmproxy` with
`~/.local/share/octotail/mitmproxy` where appropriate.

## Usage

```
Expand Down Expand Up @@ -205,3 +226,5 @@ git push proxy

[Codecrafters]: https://codecrafters.io/
[mitmproxy]: https://mitmproxy.org/
[uv & uvx]: https://github.com/astral-sh/uv
["Installing the mitmproxy CA certificate manually"]: https://docs.mitmproxy.org/stable/concepts-certificates/#installing-the-mitmproxy-ca-certificate-manually

0 comments on commit e20cce1

Please sign in to comment.