Skip to content

Commit df6b4cc

Browse files
committed
Improved documentation
Added some links, tips to documentation
1 parent 4a49c15 commit df6b4cc

File tree

5 files changed

+9
-3
lines changed

5 files changed

+9
-3
lines changed

CHANGELOG.md

+2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
- Added instructions for IPv6 configuration
66
- Added outside interface option to setup wizards
7+
- Added some links to documentation
8+
79
### 1.0.3 - New examples, fixes, more docs
810

911
- Updated instructions

CONTRIBUTING.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -90,4 +90,5 @@ Sections:
9090

9191
- [OpenVPN docs](https://community.openvpn.net/openvpn/wiki/GettingStartedwithOVPN)
9292
- [Setup OpenVPN on alpine linux](https://wiki.alpinelinux.org/wiki/Setting_up_a_OpenVPN_server#Alternative_Certificate_Method)
93-
- [EasyRSA](https://community.openvpn.net/openvpn/wiki/GettingStartedwithOVPN)
93+
- [EasyRSA](https://community.openvpn.net/openvpn/wiki/GettingStartedwithOVPN)
94+
- [EasyRSA doc](https://github.com/OpenVPN/easy-rsa/tree/master/doc)

README.md

+2
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,8 @@ services:
7272
|`-e PGID=1000`|for GroupID - see below for explanation|
7373
|`-v /config`|All the config files including OpenVPNs reside here|
7474

75+
See also: [EasyRSA](https://github.com/OpenVPN/easy-rsa/blob/master/doc/EasyRSA-Advanced.md)
76+
7577
## User / Group Identifiers
7678

7779
When using volumes (`-v` flags) permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.

docs/README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,8 @@ Configs:
7272
<example config name>
7373
```
7474

75-
**Note:** Please read example documentation to understand how to use it.
75+
**Note:** Please read example documentation to understand how to use it.
76+
**Warning:** Some examples automaticaly add firewall rules, so if you are using host networking make sure to check **iptables** for correct configuration.
7677
**Tip:** If you modifed config in a way that others might need same configuration, consider making new example.
7778

7879
#### ovpn_init

docs/SetupGuide.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -141,4 +141,4 @@ This is simple setup guide to help you get started. It uses the simplest configu
141141
```
142142

143143
**Note:** PUID, GUID parameters are optional.
144-
**Note:** Container in this example will connect to host network, so there is less network overhead (recommended), this also works if container is in default docker network.
144+
**Note:** Container in this example will connect to host network, so there is less network overhead (recommended), this also works if container is in default docker network. (But be careful if you already have firewall configured, because some rules are added when using most of examples).

0 commit comments

Comments
 (0)