diff --git a/README.md b/README.md index be19929..882726b 100644 --- a/README.md +++ b/README.md @@ -189,7 +189,16 @@ Provided your DNS is properly configured on the device you're using, and you're ## FAQ -### [How do you add client configurations?](https://github.com/IAmStoxe/wirehole/issues/2#issuecomment-691294254) +### [How do you add client configurations? +If the environment variable `PEERS` is set to a number, the container will run in server mode and the necessary server and peer/client confs will be generated. The peer/client config qr codes will be output in the docker log. They will also be saved in text and png format under /config/peerX. + +Variables `SERVERURL`, `SERVERPORT`, `INTERNAL_SUBNET` and `PEERDNS` are optional variables used for server mode. Any changes to these environment variables will trigger regeneration of server and peer confs. Peer/client confs will be recreated with existing private/public keys. Delete the peer folders for the keys to be recreated along with the confs. + +To add more peers/clients later on, you increment the `PEERS` environment variable and recreate the container. + +To display the QR codes of active peers again, you can use the following command and list the peer numbers as arguments: `docker-compose exec -it wireguard /app/show-peer 1 4 5` will show peers #1 #4 and #5 (Keep in mind that the QR codes are also stored as PNGs in the config folder). + +The templates used for server and peer confs are saved under /config/templates. Advanced users can modify these templates and force conf generation by deleting /config/wg0.conf and restarting the container. ---