From cb57322190fad8ac3f98e9d8346b5504669f4d1e Mon Sep 17 00:00:00 2001 From: Cameron Gutman Date: Mon, 26 Feb 2024 22:13:32 -0600 Subject: [PATCH] Move and rename Files tab to be less prominent --- docs/source/about/advanced_usage.rst | 185 +++++++++++------------ src_assets/common/assets/web/config.html | 142 ++++++++--------- 2 files changed, 163 insertions(+), 164 deletions(-) diff --git a/docs/source/about/advanced_usage.rst b/docs/source/about/advanced_usage.rst index f376f658..f29e6d05 100644 --- a/docs/source/about/advanced_usage.rst +++ b/docs/source/about/advanced_usage.rst @@ -124,99 +124,6 @@ editing the `conf` file in a text editor. Use the examples as reference. global_prep_cmd = [{"do":"nircmd.exe setdisplay 1280 720 32 144","undo":"nircmd.exe setdisplay 2560 1440 32 144"}] -`Files `__ -------------------------------------------------- - -`file_apps `__ -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -**Description** - The application configuration file path. The file contains a json formatted list of applications that can be started - by Moonlight. - -**Default** - OS and package dependent - -**Example** - .. code-block:: text - - file_apps = apps.json - -`credentials_file `__ -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -**Description** - The file where user credentials for the UI are stored. - -**Default** - ``sunshine_state.json`` - -**Example** - .. code-block:: text - - credentials_file = sunshine_state.json - -`log_path `__ -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -**Description** - The path where the sunshine log is stored. - -**Default** - ``sunshine.log`` - -**Example** - .. code-block:: text - - log_path = sunshine.log - -`pkey `__ -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -**Description** - The private key used for the web UI and Moonlight client pairing. For best compatibility, this should be an RSA-2048 private key. - - .. warning:: Not all Moonlight clients support ECDSA keys or RSA key lengths other than 2048 bits. - -**Default** - ``credentials/cakey.pem`` - -**Example** - .. code-block:: text - - pkey = /dir/pkey.pem - -`cert `__ -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -**Description** - The certificate used for the web UI and Moonlight client pairing. For best compatibility, this should have an RSA-2048 public key. - - .. warning:: Not all Moonlight clients support ECDSA keys or RSA key lengths other than 2048 bits. - -**Default** - ``credentials/cacert.pem`` - -**Example** - .. code-block:: text - - cert = /dir/cert.pem - -`file_state `__ -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -**Description** - The file where current state of Sunshine is stored. - -**Default** - ``sunshine_state.json`` - -**Example** - .. code-block:: text - - file_state = sunshine_state.json - - `Input `__ ------------------------------------------------- @@ -928,6 +835,98 @@ keybindings ping_timeout = 10000 +`Config Files `__ +-------------------------------------------------------- + +`file_apps `__ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Description** + The application configuration file path. The file contains a json formatted list of applications that can be started + by Moonlight. + +**Default** + OS and package dependent + +**Example** + .. code-block:: text + + file_apps = apps.json + +`credentials_file `__ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Description** + The file where user credentials for the UI are stored. + +**Default** + ``sunshine_state.json`` + +**Example** + .. code-block:: text + + credentials_file = sunshine_state.json + +`log_path `__ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Description** + The path where the sunshine log is stored. + +**Default** + ``sunshine.log`` + +**Example** + .. code-block:: text + + log_path = sunshine.log + +`pkey `__ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Description** + The private key used for the web UI and Moonlight client pairing. For best compatibility, this should be an RSA-2048 private key. + + .. warning:: Not all Moonlight clients support ECDSA keys or RSA key lengths other than 2048 bits. + +**Default** + ``credentials/cakey.pem`` + +**Example** + .. code-block:: text + + pkey = /dir/pkey.pem + +`cert `__ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Description** + The certificate used for the web UI and Moonlight client pairing. For best compatibility, this should have an RSA-2048 public key. + + .. warning:: Not all Moonlight clients support ECDSA keys or RSA key lengths other than 2048 bits. + +**Default** + ``credentials/cacert.pem`` + +**Example** + .. code-block:: text + + cert = /dir/cert.pem + +`file_state `__ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Description** + The file where current state of Sunshine is stored. + +**Default** + ``sunshine_state.json`` + +**Example** + .. code-block:: text + + file_state = sunshine_state.json + `Advanced `__ ------------------------------------------------------- diff --git a/src_assets/common/assets/web/config.html b/src_assets/common/assets/web/config.html index 3921f966..a072e101 100644 --- a/src_assets/common/assets/web/config.html +++ b/src_assets/common/assets/web/config.html @@ -124,65 +124,6 @@ - -
- -
- - -
- The file where current apps of Sunshine are stored -
-
- - -
- - -
- Store Username/Password separately from Sunshine's state file. -
-
- - -
- - -
- The file where the current logs of Sunshine are stored. -
-
- - -
- - -
The private key used for the web UI and Moonlight client pairing. For best - compatibility, this should be an RSA-2048 private key.
-
- - -
- - -
- The certificate used for the web UI and Moonlight client pairing. For best compatibility, this should have - an RSA-2048 public key. -
-
- - -
- - -
- The file where current state of Sunshine is stored -
-
- -
-
@@ -729,6 +670,65 @@
+ +
+ +
+ + +
+ The file where current apps of Sunshine are stored +
+
+ + +
+ + +
+ Store Username/Password separately from Sunshine's state file. +
+
+ + +
+ + +
+ The file where the current logs of Sunshine are stored. +
+
+ + +
+ + +
The private key used for the web UI and Moonlight client pairing. For best + compatibility, this should be an RSA-2048 private key.
+
+ + +
+ + +
+ The certificate used for the web UI and Moonlight client pairing. For best compatibility, this should have + an RSA-2048 public key. +
+
+ + +
+ + +
+ The file where current state of Sunshine is stored +
+
+ +
+
@@ -1204,18 +1204,6 @@ "global_prep_cmd": "[]", }, }, - { - id: "files", - name: "Files", - options: { - "file_apps": "", - "credentials_file": "", - "log_path": "", - "pkey": "", - "cert": "", - "file_state": "", - }, - }, { id: "input", name: "Input", @@ -1264,6 +1252,18 @@ "ping_timeout": 10000, }, }, + { + id: "files", + name: "Config Files", + options: { + "file_apps": "", + "credentials_file": "", + "log_path": "", + "pkey": "", + "cert": "", + "file_state": "", + }, + }, { id: "advanced", name: "Advanced",