Skip to content

Commit e60fa0f

Browse files
authored
Include usage flags documentation
1 parent 9c683bf commit e60fa0f

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

README.md

+28-1
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,8 @@ About it you can read in a good [article](https://www.redhat.com/en/blog/secure-
7373

7474
You may omit the `-v /lib/modules:/lib/modules:ro` bind mount and `--cap-add SYS_MODULE` if your distro already loaded `ip6_tables` kernel module on boot. If you have a systemd-based distro, you can ensure that on next boot by `echo ip6_tables >/etc/modules-load.d/ipv6nat.conf`, see [modules-load.d(5)](https://www.freedesktop.org/software/systemd/man/modules-load.d.html).
7575

76+
By default, the docker-ipv6nat command runs with the `--retry` flag. See the "Usage Flags" section below for more options. Add them to the end of the `docker run` command.
77+
7678
### AUR Package
7779

7880
If you are running ArchLinux, you can install the latest version by getting the package from the [AUR](https://aur.archlinux.org/packages/docker-ipv6nat/).
@@ -91,7 +93,32 @@ systemctl start docker-ipv6nat.service
9193
### Standalone Binary
9294

9395
Alternatively, you can download the latest release from the [release page](https://github.com/robbertkl/docker-ipv6nat/releases) and run it directly on your host.
94-
See `docker-ipv6nat --help` for usage flags.
96+
See below for usage flags.
97+
98+
### Usage Flags
99+
100+
Output from `docker-ipv6nat --help`:
101+
102+
```
103+
Usage: docker-ipv6 [options]
104+
105+
Automatically configure IPv6 NAT for running docker containers
106+
107+
Options:
108+
-cleanup
109+
remove rules when shutting down
110+
-debug
111+
log ruleset changes to stdout
112+
-retry
113+
keep retrying to reconnect after a disconnect
114+
-version
115+
show version
116+
117+
Environment Variables:
118+
DOCKER_HOST - default value for -endpoint
119+
DOCKER_CERT_PATH - directory path containing key.pem, cert.pem and ca.pem
120+
DOCKER_TLS_VERIFY - enable client TLS verification
121+
```
95122

96123
## Docker IPv6 configuration
97124

0 commit comments

Comments
 (0)