pcvolkmer/docker-wireguard-boringtun
1
0
Fork 0
mirror of https://github.com/pcvolkmer/docker-wireguard-boringtun.git synced 2025-10-30 12:16:12 +00:00
Code Issues Packages Releases Activity

Add help command, use short commands but keep longer commands

Browse Source
This commit is contained in:
Paul-Christian Volkmer
2022-12-02 16:30:22 +01:00
parent cac4c23574
commit f45cc7985d
2 changed files with 37 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@@ -56,33 +56,39 @@ Start the service in detached mode.
$ docker-compose up -d $ docker-compose up -d
``` ```
### List server and client configs
```
$ docker-compose run wg ls
```
### Add new client ### Add new client
Stop the service and run Stop the service and run
``` ```
$ docker-compose run wg add-client $ docker-compose run wg add
``` ```
This will create new client configuration and adds peer configuration to server config file. This will create new client configuration and adds peer configuration to server config file. Restart service.
### Show client config
Run command to show client configuration and QR code.
```
$ docker-compose run wg show-client 1
```
### Remove client ### Remove client
Stop the service and run Stop the service and run
``` ```
$ docker-compose run wg rm-client 1 $ docker-compose run wg rm 1
``` ```
This will remove client with id '1' (or any other client for different id) configuration. This will remove client with id '1' (or any other client for different id) configuration. Restart service.
### Show client config
Run command to show client configuration and QR code.
```
$ docker-compose run wg show 1
```
### Remove configuration and create new one from scratch ### Remove configuration and create new one from scratch

26
scripts/entrypoint.sh
View File

@@ -13,12 +13,17 @@ if [ ! -f "/etc/wireguard/$DEVICE.conf" ]; then
fi fi
case "$1" in case "$1" in
'add-client') 'ls-configs' | 'ls')
cd /etc/wireguard
/scripts/ls-configs.sh
exit 0
;;
'add-client' | 'add')
cd /etc/wireguard cd /etc/wireguard
/scripts/add-client.sh /scripts/add-client.sh
exit 0 exit 0
;; ;;
'rm-client') 'rm-client' | 'show')
if [ -z $2 ]; then if [ -z $2 ]; then
echo "Usage: rm-client <client id>" echo "Usage: rm-client <client id>"
exit 1 exit 1
@@ -27,7 +32,7 @@ case "$1" in
/scripts/rm-client.sh $2 /scripts/rm-client.sh $2
exit 0 exit 0
;; ;;
'show-client') 'show-client' | 'show')
if [ -z $2 ]; then if [ -z $2 ]; then
echo "Usage: show-client <client id>" echo "Usage: show-client <client id>"
exit 1 exit 1
@@ -36,10 +41,17 @@ case "$1" in
/scripts/show-client.sh $2 /scripts/show-client.sh $2
exit 0 exit 0
;; ;;
'ls-configs') 'help')
cd /etc/wireguard echo "Usage: <Command> [<Arguments>]"
/scripts/ls-configs.sh echo
exit 0 echo "Where Command is one of:"
echo
echo "ls List server and clients sorted by creation date"
echo "add Add new client"
echo "rm Remove client by ID"
echo "show Show client config with qrcode"
echo "help Show this help message"
echo
;; ;;
*) *)
echo "Starting wg-quick on $DEVICE" echo "Starting wg-quick on $DEVICE"