Skip to content

Commit 972d160

Browse files
m1k1om1k1o
committed
docs: add missing filetransfer config to v2.
1 parent 3a8a5c3 commit 972d160

File tree

3 files changed

+120
-101
lines changed

3 files changed

+120
-101
lines changed

‎webpage/docs/migration-from-v2/help.json

+99-84
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,102 @@
1515
"defaultValue": "false",
1616
"description": "save logs to file"
1717
},
18+
{
19+
"key": [
20+
"cert"
21+
],
22+
"type": "string",
23+
"description": "path to the SSL cert used to secure the neko server"
24+
},
25+
{
26+
"key": [
27+
"key"
28+
],
29+
"type": "string",
30+
"description": "path to the SSL key used to secure the neko server"
31+
},
32+
{
33+
"key": [
34+
"bind"
35+
],
36+
"type": "string",
37+
"description": "address/port/socket to serve neko"
38+
},
39+
{
40+
"key": [
41+
"proxy"
42+
],
43+
"type": "boolean",
44+
"defaultValue": "false",
45+
"description": "enable reverse proxy mode"
46+
},
47+
{
48+
"key": [
49+
"static"
50+
],
51+
"type": "string",
52+
"description": "path to neko client files to serve"
53+
},
54+
{
55+
"key": [
56+
"path_prefix"
57+
],
58+
"type": "string",
59+
"description": "path prefix for HTTP requests"
60+
},
61+
{
62+
"key": [
63+
"cors"
64+
],
65+
"type": "strings",
66+
"description": "list of allowed origins for CORS"
67+
},
68+
{
69+
"key": [
70+
"locks"
71+
],
72+
"type": "strings",
73+
"description": "resources, that will be locked when starting (control, login)"
74+
},
75+
{
76+
"key": [
77+
"implicit_control"
78+
],
79+
"type": "boolean",
80+
"defaultValue": "false",
81+
"description": "if enabled members can gain control implicitly"
82+
},
83+
{
84+
"key": [
85+
"control_protection"
86+
],
87+
"type": "boolean",
88+
"defaultValue": "false",
89+
"description": "control protection means, users can gain control only if at least one admin is in the room"
90+
},
91+
{
92+
"key": [
93+
"heartbeat_interval"
94+
],
95+
"type": "int",
96+
"defaultValue": "120",
97+
"description": "heartbeat interval in seconds"
98+
},
99+
{
100+
"key": [
101+
"file_transfer_enabled"
102+
],
103+
"type": "boolean",
104+
"defaultValue": "false",
105+
"description": "enable file transfer feature"
106+
},
107+
{
108+
"key": [
109+
"file_transfer_path"
110+
],
111+
"type": "string",
112+
"description": "path to use for file transfer"
113+
},
18114
{
19115
"key": [
20116
"display"
@@ -192,93 +288,12 @@
192288
"type": "string",
193289
"description": "admin password for connecting to stream"
194290
},
195-
{
196-
"key": [
197-
"cert"
198-
],
199-
"type": "string",
200-
"description": "path to the SSL cert used to secure the neko server"
201-
},
202-
{
203-
"key": [
204-
"key"
205-
],
206-
"type": "string",
207-
"description": "path to the SSL key used to secure the neko server"
208-
},
209-
{
210-
"key": [
211-
"bind"
212-
],
213-
"type": "string",
214-
"description": "address/port/socket to serve neko"
215-
},
216-
{
217-
"key": [
218-
"proxy"
219-
],
220-
"type": "boolean",
221-
"defaultValue": "false",
222-
"description": "enable reverse proxy mode"
223-
},
224-
{
225-
"key": [
226-
"static"
227-
],
228-
"type": "string",
229-
"description": "path to neko client files to serve"
230-
},
231-
{
232-
"key": [
233-
"path_prefix"
234-
],
235-
"type": "string",
236-
"description": "path prefix for HTTP requests"
237-
},
238-
{
239-
"key": [
240-
"cors"
241-
],
242-
"type": "strings",
243-
"description": "list of allowed origins for CORS"
244-
},
245-
{
246-
"key": [
247-
"locks"
248-
],
249-
"type": "strings",
250-
"description": "resources, that will be locked when starting (control, login)"
251-
},
252-
{
253-
"key": [
254-
"implicit_control"
255-
],
256-
"type": "boolean",
257-
"defaultValue": "false",
258-
"description": "if enabled members can gain control implicitly"
259-
},
260-
{
261-
"key": [
262-
"control_protection"
263-
],
264-
"type": "boolean",
265-
"defaultValue": "false",
266-
"description": "control protection means, users can gain control only if at least one admin is in the room"
267-
},
268-
{
269-
"key": [
270-
"heartbeat_interval"
271-
],
272-
"type": "int",
273-
"defaultValue": "120",
274-
"description": "heartbeat interval in seconds"
275-
},
276291
{
277292
"key": [
278293
"nat1to1"
279294
],
280295
"type": "strings",
281-
"description": "sets a list of external IP addresses of 1:1 (D)NAT and a candidate type for which the external IP "
296+
"description": "sets a list of external IP addresses of 1:1 (D)NAT and a candidate type for which the external IP address is used"
282297
},
283298
{
284299
"key": [
@@ -307,14 +322,14 @@
307322
"iceserver"
308323
],
309324
"type": "strings",
310-
"description": "describes a single STUN and TURN server that can be used by the ICEAgent to establish a connection "
325+
"description": "describes a single STUN and TURN server that can be used by the ICEAgent to establish a connection with a peer"
311326
},
312327
{
313328
"key": [
314329
"iceservers"
315330
],
316331
"type": "string",
317-
"description": "describes a single STUN and TURN server that can be used by the ICEAgent to establish a connection "
332+
"description": "describes a single STUN and TURN server that can be used by the ICEAgent to establish a connection with a peer"
318333
},
319334
{
320335
"key": [

‎webpage/docs/migration-from-v2/help.txt

+20-16
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,22 @@
11

22
--legacy enable legacy mode (default true)
3+
34
--logs save logs to file
45

6+
--cert string path to the SSL cert used to secure the neko server
7+
--key string path to the SSL key used to secure the neko server
8+
--bind string address/port/socket to serve neko
9+
--proxy enable reverse proxy mode
10+
--static string path to neko client files to serve
11+
--path_prefix string path prefix for HTTP requests
12+
--cors strings list of allowed origins for CORS
13+
--locks strings resources, that will be locked when starting (control, login)
14+
--implicit_control if enabled members can gain control implicitly
15+
--control_protection control protection means, users can gain control only if at least one admin is in the room
16+
--heartbeat_interval int heartbeat interval in seconds (default 120)
17+
--file_transfer_enabled enable file transfer feature
18+
--file_transfer_path string path to use for file transfer
19+
520
--display string XDisplay to capture
621
--video_codec string video codec to be used
722
--av1 DEPRECATED: use video_codec
@@ -12,6 +27,7 @@
1227
--video_bitrate int video bitrate in kbit/s
1328
--hwenc string use hardware accelerated encoding
1429
--max_fps int maximum fps delivered via WebRTC, 0 is for no maximum
30+
1531
--device string audio device to capture
1632
--audio_codec string audio codec to be used
1733
--g722 DEPRECATED: use audio_codec
@@ -20,6 +36,7 @@
2036
--pcmu DEPRECATED: use audio_codec
2137
--audio string audio codec parameters to use for streaming
2238
--audio_bitrate int audio bitrate in kbit/s
39+
2340
--broadcast_pipeline string custom gst pipeline used for broadcasting, strings {url} {device} {display} will be replaced
2441
--broadcast_url string a default default URL for broadcast streams, can be disabled/changed later by admins in the GUI
2542
--broadcast_autostart automatically start broadcasting when neko starts and broadcast_url is set
@@ -29,24 +46,11 @@
2946
--password string password for connecting to stream
3047
--password_admin string admin password for connecting to stream
3148

32-
--cert string path to the SSL cert used to secure the neko server
33-
--key string path to the SSL key used to secure the neko server
34-
--bind string address/port/socket to serve neko
35-
--proxy enable reverse proxy mode
36-
--static string path to neko client files to serve
37-
--path_prefix string path prefix for HTTP requests
38-
--cors strings list of allowed origins for CORS
39-
40-
--locks strings resources, that will be locked when starting (control, login)
41-
--implicit_control if enabled members can gain control implicitly
42-
--control_protection control protection means, users can gain control only if at least one admin is in the room
43-
--heartbeat_interval int heartbeat interval in seconds (default 120)
44-
45-
--nat1to1 strings sets a list of external IP addresses of 1:1 (D)NAT and a candidate type for which the external IP
49+
--nat1to1 strings sets a list of external IP addresses of 1:1 (D)NAT and a candidate type for which the external IP address is used
4650
--tcpmux int single TCP mux port for all peers
4751
--udpmux int single UDP mux port for all peers
4852
--icelite configures whether or not the ice agent should be a lite agent
49-
--iceserver strings describes a single STUN and TURN server that can be used by the ICEAgent to establish a connection
50-
--iceservers string describes a single STUN and TURN server that can be used by the ICEAgent to establish a connection
53+
--iceserver strings describes a single STUN and TURN server that can be used by the ICEAgent to establish a connection with a peer
54+
--iceservers string describes a single STUN and TURN server that can be used by the ICEAgent to establish a connection with a peer
5155
--ipfetch string automatically fetch IP address from given URL when nat1to1 is not present
5256
--epr string limits the pool of ephemeral ports that ICE UDP connections can allocate from

‎webpage/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
"clear": "docusaurus clear",
1212
"serve": "docusaurus serve",
1313
"gen-config": "node ./src/components/Configuration/generate.js ./docs/configuration/help.txt ./docs/configuration/help.json",
14-
"gen-config:v2": "node ./src/components/Configuration/generate.js ./docs/v2-migration/help.txt ./docs/v2-migration/help.json",
14+
"gen-config:v2": "node ./src/components/Configuration/generate.js ./docs/migration-from-v2/help.txt ./docs/migration-from-v2/help.json",
1515
"write-translations": "docusaurus write-translations",
1616
"write-heading-ids": "docusaurus write-heading-ids",
1717
"gen-api-docs": "./gen-api-docs.sh",

0 commit comments

Comments
 (0)