Skip to content

Commit

Permalink
docs: update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
cenk1cenk2 committed Nov 17, 2022
1 parent b5b0ba9 commit 58c9b3b
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 6 deletions.
2 changes: 1 addition & 1 deletion CLI.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Initiates the SoftEtherVPN server that will run in this container.

| Flag / Environment | Description | Type | Required | Default |
|---------------- | --------------- | --------------- | --------------- | --------------- |
| `$HEALTH_CHECK_INTERVAL` | Health check interval to the upstream server in duration. | `Duration` | `false` | 0s |
| `$HEALTH_CHECK_INTERVAL` | Health check interval to the upstream server in duration. | `Duration` | `false` | 10m |
| `$HEALTH_DHCP_SERVER_ADDRESS` | Upstream DHCP server address for doing health checks. | `String` | `false` | CIDR address range start |
| `$HEALTH_ENABLE_PING` | Whether to enable the ping check or not. | `Bool` | `false` | false |

Expand Down
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ This container runs a SoftEther VPN Server bundled together with a configuration
---

- [CLI Documentation](./CLI.md)

<!-- toc -->

- [Features](#features)
Expand All @@ -29,13 +30,14 @@ This container runs a SoftEther VPN Server bundled together with a configuration
- [Versioning](#versioning)
- [Health Check](#health-check)
- [Graceful Shutdown](#graceful-shutdown)
- [Architecture](#architecture)
- [Environment Variables](#environment-variables)
- [General](#general)
- [CLI](#cli)
- [DHCP Server](#dhcp-server)
- [Health](#health)
- [Linux Bridge](#linux-bridge)
- [Server](#server)
- [SoftEther](#softether)
- [Health](#health)
- [DHCP-Server](#dhcp-server)
- [Linux-Bridge](#linux-bridge)
- [Setup](#setup)
- [Volumes](#volumes)
- [SoftEther Configuration](#softether-configuration)
Expand Down Expand Up @@ -112,7 +114,7 @@ Options for DHCP server or Linux bridge interfaces get activated when that serve

| Flag / Environment | Description | Type | Required | Default |
| ----------------------------- | --------------------------------------------------------- | ---------- | -------- | ------------------------ |
| `$HEALTH_CHECK_INTERVAL` | Health check interval to the upstream server in duration. | `Duration` | `false` | 0s |
| `$HEALTH_CHECK_INTERVAL` | Health check interval to the upstream server in duration. | `Duration` | `false` | 10m |
| `$HEALTH_DHCP_SERVER_ADDRESS` | Upstream DHCP server address for doing health checks. | `String` | `false` | CIDR address range start |
| `$HEALTH_ENABLE_PING` | Whether to enable the ping check or not. | `Bool` | `false` | false |

Expand Down
1 change: 1 addition & 0 deletions pipe/flags.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ var Flags = []cli.Flag{
Category: category_health,
Required: false,
EnvVars: []string{"HEALTH_CHECK_INTERVAL"},
DefaultText: "10m",
Value: time.Minute * 10,
Destination: &TL.Pipe.Health.CheckInterval,
},
Expand Down

0 comments on commit 58c9b3b

Please sign in to comment.