Skip to content

Commit

Permalink
Add initial install instruction with mkcert to startup proxbox backend
Browse files Browse the repository at this point in the history
  • Loading branch information
emersonfelipesp committed Mar 4, 2025
1 parent a6c5e07 commit 33eb0e7
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions proxbox_api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,4 +63,26 @@ Or using `uvicorn`:

```
uvicorn main:app --host 0.0.0.0 --port 8800
```

## Using mkcert

Install the local CA in the system trust store.

```
mkcert -install
mkcert localhost 127.0.0.1 ::1
```

With the keyfile and certfile generated, pass it on uvicorn command to start up FastAPI

```
/opt/netbox/venv/bin/uvicorn netbox-proxbox.proxbox_api.proxbox_api.main:app --host 0.0.0.0 --port 8800 --app-dir /opt/netbox/netbox --ssl-keyfile=localhost+2-key.pem --ssl-certfile=localhost+2.pem
```

Or

```
cd /opt/netbox/netbox/netbox-proxbox/proxbox_api
uvicorn proxbox_api.main:app --host 0.0.0.0 --port 8800 --reload --ssl-keyfile=./proxbox_api/localhost+2-key.pem --ssl-certfile=./proxbox_api/localhost+2.pem
```

0 comments on commit 33eb0e7

Please sign in to comment.