Skip to content

Commit 988ca23

Browse files
authored
[docs] Added units for timeout settings in README #278
Closes #278
1 parent 63af4a4 commit 988ca23

File tree

1 file changed

+28
-20
lines changed

1 file changed

+28
-20
lines changed

README.rst

Lines changed: 28 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -178,44 +178,52 @@ You can change the values for the following variables in
178178
``OPENWISP_SSH_AUTH_TIMEOUT``
179179
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
180180

181-
+--------------+---------+
182-
| **type**: | ``int`` |
183-
+--------------+---------+
184-
| **default**: | ``2`` |
185-
+--------------+---------+
181+
+--------------+-------------+
182+
| **type**: | ``int`` |
183+
+--------------+-------------+
184+
| **default**: | ``2`` |
185+
+--------------+-------------+
186+
| **unit**: | ``seconds`` |
187+
+--------------+-------------+
186188

187189
Configure timeout to wait for an authentication response when establishing a SSH connection.
188190

189191
``OPENWISP_SSH_BANNER_TIMEOUT``
190192
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
191193

192-
+--------------+---------+
193-
| **type**: | ``int`` |
194-
+--------------+---------+
195-
| **default**: | ``60`` |
196-
+--------------+---------+
194+
+--------------+-------------+
195+
| **type**: | ``int`` |
196+
+--------------+-------------+
197+
| **default**: | ``60`` |
198+
+--------------+-------------+
199+
| **unit**: | ``seconds`` |
200+
+--------------+-------------+
197201

198202
Configure timeout to wait for the banner to be presented when establishing a SSH connection.
199203

200204
``OPENWISP_SSH_COMMAND_TIMEOUT``
201205
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
202206

203-
+--------------+---------+
204-
| **type**: | ``int`` |
205-
+--------------+---------+
206-
| **default**: | ``30`` |
207-
+--------------+---------+
207+
+--------------+-------------+
208+
| **type**: | ``int`` |
209+
+--------------+-------------+
210+
| **default**: | ``30`` |
211+
+--------------+-------------+
212+
| **unit**: | ``seconds`` |
213+
+--------------+-------------+
208214

209215
Configure timeout on blocking read/write operations when executing a command in a SSH connection.
210216

211217
``OPENWISP_SSH_CONNECTION_TIMEOUT``
212218
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
213219

214-
+--------------+---------+
215-
| **type**: | ``int`` |
216-
+--------------+---------+
217-
| **default**: | ``5`` |
218-
+--------------+---------+
220+
+--------------+-------------+
221+
| **type**: | ``int`` |
222+
+--------------+-------------+
223+
| **default**: | ``5`` |
224+
+--------------+-------------+
225+
| **unit**: | ``seconds`` |
226+
+--------------+-------------+
219227

220228
Configure timeout for the TCP connect when establishing a SSH connection.
221229

0 commit comments

Comments
 (0)