Skip to content

Commit 8c5ef71

Browse files
authored
Merge pull request #18 from backplane/fixreadme
WIP: update readme
2 parents 2bd8a58 + dbb4e8a commit 8c5ef71

1 file changed

Lines changed: 6 additions & 10 deletions

File tree

README.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,10 @@ Below is an example configuration that demonstrates setting up RegistryProxy:
2121
# Generate "secretkey" with: openssl rand -hex 32
2222
# Generate "auth" with: echo "Basic $(printf '%s:%s' 'myusername' 'mypassword' | base64)"
2323
listen_addr: 0.0.0.0
24-
port: 5000
24+
listen_port: 5000
2525
secret_key: 796280902778385984e2acd2868447a0ee703a8fab0ed7e69103cd50b9e3cddd
26-
registry_fqdn: reg.example.com
26+
proxy_fqdn: reg.example.com
27+
log_level: DEBUG
2728
proxies:
2829
"bp/":
2930
registry: index.docker.io
@@ -38,15 +39,10 @@ With the above configuration, navigating to reg.example.com/bp/true will serve t
3839
3940
To use RegistryProxy, follow these steps:
4041
41-
1. Clone the repository:
42+
1. Create a config.yaml file with your specific configurations.
43+
2. Run the proxy:
4244
```bash
43-
git clone https://github.com/yourusername/registryproxy.git
44-
```
45-
2. Create a config.yaml file with your specific configurations.
46-
3. Build and run the proxy:
47-
```bash
48-
docker build -t registryproxy .
49-
docker run -p 5000:5000 registryproxy
45+
docker run --rm -d -p 5000:5000 --volume "$(pwd)/config.yaml:/config.yaml:ro" backplane/registryproxy --config /config.yaml
5046
```
5147

5248
## Security Considerations

0 commit comments

Comments
 (0)