Skip to content

Commit 24cfb95

Browse files
committed
doc/network_forwards: Split configuration into own table
Signed-off-by: Stéphane Graber <[email protected]> Sponsored-by: ActivePort (https://www.activeport.com.au)
1 parent 2203d80 commit 24cfb95

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

doc/howto/network_forwards.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,18 @@ Property | Type | Required | Description
3838
:-- | :-- | :-- | :--
3939
`listen_address` | string | yes | IP address to listen on
4040
`description` | string | no | Description of the network forward
41-
`config` | string set | no | Configuration options as key/value pairs (only `target_address` and `user.*` custom keys supported)
41+
`config` | string set | no | See table below
4242
`ports` | port list | no | List of {ref}`port specifications <network-forwards-port-specifications>`
4343

44+
### Forward configuration
45+
46+
Network forwards have the following configuration options:
47+
48+
Key | Type | Default | Description
49+
:-- | :--- | :------ | :----------
50+
`user.*` | string | - | User defined key/value configuration
51+
`target_address` | string | - | Default target address for anything not covered through a port definition
52+
4453
(network-forwards-listen-addresses)=
4554
### Requirements for listen addresses
4655

0 commit comments

Comments
 (0)