Skip to content

Commit e45ef07

Browse files
committed
Fixed typos & additional explanation
1 parent ccffc57 commit e45ef07

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ Sections:
4646
ssl
4747
safessl-easyrsa.cnf
4848
vars
49-
example # Example configs
50-
config # Example client & server configs (see root/defaults/example/README.md)
49+
example # Example configs (see root/defaults/example/README.md)
50+
config # Example client & server configs
5151
hook # Example hook configs
5252
module # Modules for openvpn
5353
hooks # Put your custom scripts in one of subfolders

root/defaults/example/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ config
4040
- **DO NOT** use `dev` attribute, because it is set to static interface `tun0`.
4141
- **DO NOT** use any script running directives, because they are probably already set in `system.conf` (except `auth-user-pass-verify` is commented out), but use hooks directory.
4242
- **DO NOT** use log directives, because they are already set for `log` directory.
43-
- Please name your hooks as `\<number\>-\<name\>` to ensure order of execution.
43+
- Please name your hooks as `<number>-<name>` to ensure order of execution.
4444

4545
### Wizard
4646

@@ -50,9 +50,11 @@ User will call `ovpn_enconf CONFIG_NAME [wizard args]` to load your example in s
5050
Then there are two options:
5151

5252
1. User manualy configure settigns in `/config/openvpn` folder
53-
2. Your **wizard** script, configures files in `/config/openvpn`
53+
2. Your **wizard** script, configures files which will be copied to `/config/openvpn`
5454
- Configuration files are copied to temporary location (so they can be modified)
5555
- `wizard` script will be called with temporary location as first argument `$1` (folder has same structure as in examples)
56+
- Your `wizard` script **MUST** only modify files in temporary location.
57+
- When your wizard exits with code 0, files are copied from temporary location to config folder.
5658

5759
## General hooks
5860

0 commit comments

Comments
 (0)