Browse Source

docs: added new frontend config options to the Configuration.md file, and the new backend command to the Backend_Commands.md file

Kristian Vos 2 năm trước cách đây
mục cha
commit
0ef01144dc
2 tập tin đã thay đổi với 9 bổ sung0 xóa
  1. 1 0
      .wiki/Backend_Commands.md
  2. 8 0
      .wiki/Configuration.md

+ 1 - 0
.wiki/Backend_Commands.md

@@ -13,6 +13,7 @@ Backend commands are inputted via STDIN or if using the Utility Script by using
 | `runjob` | `module job_name json_encoded_payload` | Run a specified job in a specified module including a JSON encoded payload, and return response. |
 | `eval` | `some_javascript` | Execute JavaScript within the index.js context and return response. |
 | `lockdown` | | Lockdown backend. |
+| `version` | | Prints the Musare version and Git repository info. |
 | `stats` | `module` | Returns job statistics for a specified module. |
 
 ## Modules

+ 8 - 0
.wiki/Configuration.md

@@ -76,9 +76,17 @@ Location: `frontend/dist/config/default.json`
 | `siteSettings.christmas` | Whether to enable christmas theming. |
 | `messages.accountRemoval` | Message to return to users on account removal. |
 | `shortcutOverrides` | Overwrite keyboard shortcuts, for example `"editSong.useAllDiscogs": { "keyCode": 68, "ctrl": true, "alt": true, "shift": false, "preventDefault": true }`. |
+| `debug.git.remote` | Allow the website/users to view the current Git repository's remote. [^1] |
+| `debug.git.remoteUrl` | Allow the website/users to view the current Git repository's remote URL. [^1] |
+| `debug.git.branch` | Allow the website/users to view the current Git repository's branch. [^1] |
+| `debug.git.latestCommit` | Allow the website/users to view the current Git repository's latest commit hash. [^1] |
+| `debug.git.latestCommitShort` | Allow the website/users to view the current Git repository's latest commit hash (short). [^1] |
+| `debug.version` | Allow the website/users to view the current package.json version. [^1] |
 | `skipConfigVersionCheck` | Skips checking if the config version is outdated or not. Should almost always be set to false. |
 | `configVersion` | Version of the config. Every time the template changes, you should change your config accordingly and update the configVersion. |
 
+[^1]: Requires a frontend restart to update. The data will be available from the frontend console and by the frontend code.
+
 ## Docker Environment
 Location: `.env`