From 69e14cc38a3ac07d8fb95e2edfbc9689084a59cf Mon Sep 17 00:00:00 2001
From: Jacek Kowalski <Jacek@jacekk.info>
Date: Fri, 13 Mar 2026 08:43:05 +0000
Subject: [PATCH] Add gw4/gw6 container creation time driver options

---
 README.md |   48 +++++++++++++++++++++++++++++++++++++++++++++---
 1 files changed, 45 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 29ebfc9..dce319d 100644
--- a/README.md
+++ b/README.md
@@ -31,14 +31,56 @@
 One will be pushed inside the container and another will remain on host
 (without any IP assigned).
 
-Plugin accepts optional `parent` parameter, which is a name of bridge
-interface that the second interface should be added to:
+## Options
+
+To use options, add `--opt option=value` as an argument of `docker network create`:
 
 ```bash
 docker network create --driver jacekkow/pyveth:latest --opt parent=br0 new-network
 ```
 
-This way host interface will be automatically attached to the specified bridge.
+Available options:
+
+`parent=brname`
+
+Automatically attach host interface to the bridge interface `brname`.
+
+`nogw=1`
+
+Disable assignment of gateway IP.
+
+`nogw4=1`
+
+Disable assignment of IPv4 gateway IP.
+
+`nogw6=1`
+
+Disable assignment of IPv6 gateway IP.
+
+## Container creation options
+
+To use these options add `--network name=network_name,driver-opt=option=value,driver-opt=option=value`
+to the `docker run` invocation:
+
+```bash
+docker run -i -t --rm --network name=test,ip=192.168.1.1,driver-opt=gw4=192.168.0.1,driver-opt=gw6=fe80:: alpine
+```
+
+Available options:
+
+`gw4=IP`
+
+`gw6=IP`
+
+Forces assignment of a specified gateway (if one is not provided by the IPAM)
+when creating the interface. Useful for [pyipam](https://github.com/jacekkow/docker-plugin-pyipam)
+with "ptp=1,nogw=1" options.
+
+Using these would add routes:
+```
+default via IP dev eth0
+IP dev eth0 scope link
+```
 
 ## Manual packaging
 

--
Gitblit v1.10.0