Skip to content

Commit a1c0bb6

Browse files
committed
Fix docs
1 parent 3db7576 commit a1c0bb6

File tree

4 files changed

+32
-22
lines changed

4 files changed

+32
-22
lines changed

README.md

Lines changed: 28 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,33 @@
33
usage: openvpn-admin [<flags>]
44
55
Flags:
6-
--help Show context-sensitive help (also try --help-long and --help-man).
7-
--listen.host="0.0.0.0" host(s) for openvpn-admin
8-
--listen.port="8080" port for openvpn-admin
9-
--role="master" server role master or slave
10-
--master.host="http://127.0.0.1" url for master server
11-
--master.basic-auth.user="" user for basic auth on master server url
12-
--master.basic-auth.password="" password for basic auth on master server url
13-
--master.sync-frequency=600 master host data sync frequency in seconds.
14-
--master.sync-token=TOKEN master host data sync security token
15-
--ovpn.host=HOST:PORT ... host for openvpn server
16-
--ovpn.network="172.16.100.0/24" network for openvpn server
17-
--mgmt.host="127.0.0.1" host for openvpn server mgmt interface
18-
--mgmt.port="8989" port for openvpn server mgmt interface
19-
--easyrsa.path="/mnt/easyrsa" path to easyrsa dir
6+
--help Show context-sensitive help (also try --help-long and --help-man).
7+
--listen.host="0.0.0.0" host for openvpn-admin
8+
--listen.port="8080" port for openvpn-admin
9+
--role="master" server role master or slave
10+
--master.host="http://127.0.0.1"
11+
url for master server
12+
--master.basic-auth.user="" user for basic auth on master server url
13+
--master.basic-auth.password=""
14+
password for basic auth on master server url
15+
--master.sync-frequency=600 master host data sync frequency in seconds.
16+
--master.sync-token=TOKEN master host data sync security token
17+
--ovpn.server=HOST:PORT ... host(s) for openvpn server
18+
--ovpn.network="172.16.100.0/24"
19+
network for openvpn server
20+
--mgmt=main=127.0.0.1:8989 ...
21+
comma separated (alias=address) for openvpn servers mgmt interfaces
22+
--metrics.path="/metrics" URL path for surfacing collected metrics
23+
--easyrsa.path="/mnt/easyrsa" path to easyrsa dir
2024
--easyrsa.index-path="/mnt/easyrsa/pki/index.txt"
21-
path to easyrsa index file.
22-
--ccd.path="/mnt/ccd" path to client-config-dir
23-
--static.path="./static" path to static dir
24-
--debug Enable debug mode.
25+
path to easyrsa index file.
26+
--ccd.path="/mnt/ccd" path to client-config-dir
27+
--auth.password Enable additional password authorization.
28+
--auth.db="/mnt/easyrsa/pki/users.db"
29+
Database path fort password authorization.
30+
--static.path="./static" path to static dir
31+
--debug Enable debug mode.
32+
--verbose Enable verbose mode.
33+
--version Show application version.
34+
2535
```

docker-compose-slave.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ services:
2222
build:
2323
context: .
2424
image: openvpn-admin:local
25-
command: /app/openvpn-admin --debug --ovpn.network="172.16.100.0/22" --master.sync-token="TOKEN" --master.host="http://172.20.0.1:8080" --role="slave" --ovpn.server="127.0.0.1:7744" --ovpn.server="127.0.0.1:7778" --auth.password
25+
command: /app/openvpn-admin --debug --ovpn.network="172.16.100.0/22" --master.sync-token="TOKEN" --master.host="http://172.20.0.1:8080" --role="slave" --ovpn.server="127.0.0.1:7777:tcp" --ovpn.server="127.0.0.1:7778:tcp" --auth.password
2626
environment:
2727
- OPVN_SLAVE=1
2828
network_mode: service:openvpn

docker-compose.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ services:
2121
build:
2222
context: .
2323
image: openvpn-admin:local
24-
command: /app/openvpn-admin --debug --ovpn.network="172.16.100.0/22" --master.sync-token="TOKEN" --auth.password
24+
command: /app/openvpn-admin --debug --ovpn.network="172.16.100.0/22" --master.sync-token="TOKEN" --auth.password --ovpn.server="127.0.0.1:7777:tcp"
2525
network_mode: service:openvpn
2626
volumes:
2727
- ./easyrsa_master:/mnt/easyrsa

main.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ const (
3030
indexTxtDateLayout = "060102150405Z"
3131
stringDateFormat = "2006-01-02 15:04:05"
3232
ovpnStatusDateLayout = "Mon Jan 2 15:04:05 2006"
33-
version = "1.5.0"
33+
version = "1.5.0-fix.1"
3434
)
3535

3636
var (
@@ -42,7 +42,7 @@ var (
4242
masterBasicAuthPassword = kingpin.Flag("master.basic-auth.password","password for basic auth on master server url").Default("").String()
4343
masterSyncFrequency = kingpin.Flag("master.sync-frequency", "master host data sync frequency in seconds.").Default("600").Int()
4444
masterSyncToken = kingpin.Flag("master.sync-token", "master host data sync security token").Default("justasimpleword").PlaceHolder("TOKEN").String()
45-
openvpnServer = kingpin.Flag("ovpn.server","comma separated addresses for openvpn servers").Default("127.0.0.1:7777").PlaceHolder("HOST:PORT").Strings()
45+
openvpnServer = kingpin.Flag("ovpn.server","comma separated addresses for openvpn servers").Default("127.0.0.1:7777:tcp").PlaceHolder("HOST:PORT:PROTOCOL").Strings()
4646
openvpnNetwork = kingpin.Flag("ovpn.network","network for openvpn server").Default("172.16.100.0/24").String()
4747
mgmtAddress = kingpin.Flag("mgmt","comma separated (alias=address) for openvpn servers mgmt interfaces").Default("main=127.0.0.1:8989").Strings()
4848
metricsPath = kingpin.Flag("metrics.path", "URL path for surfacing collected metrics").Default("/metrics").String()

0 commit comments

Comments
 (0)