docs: include menu in config.html and fix status
[web.git] / docs / uci_dropbear.txt
1 Dropbear Configuration
2 ======================
3
4 '/etc/config/dropbear'.
5
6 == Sections
7
8 The 'dropbear' configuration contains settings for the dropbear SSH server in a single section.
9
10 === Dropbear
11
12 The 'dropbear' section contains these settings:
13
14 [cols="4*1,4",options="header"]
15 |====
16 | Name | Type | Required | Default | Description
17 | 'enable' | boolean | no | 1 | Set to '0' to disable starting dropbear at system boot.
18 | 'verbose' | boolean | no | 0 | Set to '1' to enable verbose output by the start script.
19 | 'BannerFile' | string | no | _(none)_ | Name of a file to be printed before the user has authenticated successfully.
20 | 'PasswordAuth' | boolean | no | 1 | Set to '0' to disable authenticating with passwords.
21 | 'Port' | integer | no | 22 | Port number to listen on.
22 | 'RootPasswordAuth' | boolean | no | 1 | Set to '0' to disable authenticating as root with passwords.
23 | 'RootLogin' | boolean | no | 1 | Set to '0' to disable SSH logins as root.
24 | 'GatewayPorts' | boolean | no | 0 | Set to '1' to allow remote hosts to connect to forwarded ports.
25 | 'Interface' | string | no | _(none)_ | Tells dropbear to listen only on the specified interface.((e.g. 'lan', 'wan', 'henet'))
26 | 'rsakeyfile' | file| no | _(none)_ | Path to RSA file
27 | 'dsskeyfile' | file| no | _(none)_ | Path to DSS/DSA file
28 | 'SSHKeepAlive' | integer| no | 300 | Keep Alive
29 | 'IdleTimeout' | integer| no | 0| Idle Timeout
30 |====
31
32 This is the default configuration:
33
34 ----
35 config dropbear
36 option PasswordAuth 'on'
37 option RootPasswordAuth 'on'
38 option Port '22'
39 ----
40
41 === Multiple dropbear instances
42
43 Edit /etc/config/dropbear to add a second instance.
44 ----
45 vi /etc/config/dropbear
46 ----
47
48 The below example shows one on port 22 on the lan side, one on port 2022 on the wan side. Note: wan side is set for PasswordAuth off so make sure you have added an ssh-key.
49
50 Also make sure to check your firewall DNAT (port forward) to allow access to the wan side port, 2022 in this case.
51
52 ----
53 config dropbear
54 option PasswordAuth 'on'
55 option Port '22'
56 option Interface 'lan'
57
58 config dropbear
59 option PasswordAuth 'off'
60 option Interface 'wan'
61 option Port '2022'
62 ----