Skip to content

Commit

Permalink
README.md: Small fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
pierreprinetti committed Sep 6, 2024
1 parent ef387f6 commit cb9539a
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# openstack-mitm

Proxies calls to the OpenStack API with a self-signed certificate.
Proxies calls to the OpenStack API, exposing http or https with a provided certificate.

All URLs in the OpenStack catalog are rewritten to point to the proxy itself, which will properly reverse proxy them to the original URL.
All URLs in the OpenStack catalog are rewritten to point to the proxy itself, which will properly reverse-proxy them to the original URL.

## Use locally

Expand All @@ -13,14 +13,15 @@ Build with `go build ./cmd/osp-mitm`.
By default the server will listen on localhost on port 13000.

**Configuration:**
* **--url**: URL osp-mitm will be reachable at. Default: `http://locahost:13000`
* **--cert**: path of the local PEM-encoded HTTPS certificate file. Mandatory if the scheme of --url is HTTPS.
* **--key**: path of the local PEM-encoded HTTPS certificate key file. Mandatory if the scheme of --url is HTTPS.
* **-o**: If provided, a new clouds.yaml that points to osp-mitm is created at that location.
* `--url <url>`: URL osp-mitm will be reachable at. Default: `http://locahost:13000`
* `--cert <path>`: path of the local PEM-encoded HTTPS certificate file. Mandatory if the scheme of --url is HTTPS.
* `--key <path>`: path of the local PEM-encoded HTTPS certificate key file. Mandatory if the scheme of --url is HTTPS.
* `-o <path>`: Location where to write a new `clouds.yaml` that points to the osp-mitm instance.

## Examples

Local server:
### Local server

```shell
export OS_CLOUD=openstack
./osp-mitm -o mitm-clouds.yaml
Expand All @@ -30,7 +31,7 @@ export OS_CLIENT_CONFIG_FILE=./mitm-clouds.yaml
openstack server list
```

Exposing osp-mitm on the network, with HTTPS:
### On the network, with HTTPS

```shell
./osp-mitm \
Expand Down

0 comments on commit cb9539a

Please sign in to comment.