Config and Installation docs improvements

.wiki/Configuration.md

@@ -5,23 +5,22 @@ Location: `backend/config/default.json`
 
 | Property | Description |
 | --- | --- |
-| `mode` | Should be either `development` or `production`. No more explanation needed. |
+| `mode` | Should be either `development` or `production`. |
 | `migration` | Should be set to true if you need to update DB documents to a newer version after an update. Should be false at all other times. |
-| `secret` | Whatever you want - used by express's session module. |
+| `secret` | Set to something unique and secure - used by express's session module. |
 | `domain` | Should be the url where the site will be accessible from, usually `http://localhost` for non-Docker. |
 | `serverDomain` | Should be the url where the backend will be accessible from, usually `http://localhost/backend` for docker or `http://localhost:8080` for non-Docker. |
 | `serverPort` | Should be the port where the backend will listen on, should always be `8080` for Docker, and is recommended for non-Docker. |
 | `registrationDisabled` | If set to true, users can't register accounts. |
 | `apis.youtube.key` | Can be obtained by setting up a [YouTube API Key](https://developers.google.com/youtube/v3/getting-started). You need to use the YouTube Data API v3, and create an API key. |
-| `apis.recaptcha.secret` | Can be obtained by setting up a [ReCaptcha Site (v3)](https://www.google.com/recaptcha/admin). |
-| `apis.recaptcha.enabled` | Keep at false to keep disabled. |
+| `apis.recaptcha` | Can be obtained by setting up a [ReCaptcha Site (v3)](https://www.google.com/recaptcha/admin), or you can disable it. |
 | `apis.github` | Can be obtained by setting up a [GitHub OAuth Application](https://github.com/settings/developers). You need to fill in some values to create the OAuth application. The homepage is the homepage of frontend. The authorization callback url is the backend url with `/auth/github/authorize/callback` added at the end. For example `http://localhost/backend/auth/github/authorize/callback`. |
 | `apis.discogs` | Can be obtained by setting up a [Discogs application](https://www.discogs.com/settings/developers), or you can disable it. |
-| `smtp` | Can be obtained by setting up an SMTP server, using a provider such as [Mailgun](http://www.mailgun.com/), or you can disable it. |
+| `smtp` | Can be obtained by setting up an SMTP server, or you can disable it. |
 | `redis.url` | Should be left alone for Docker, and changed to `redis://localhost:6379/0` for non-Docker. |
 | `redis.password` | Should be the Redis password you either put in your `startRedis.cmd` file for Windows, or `.env` for docker. |
 | `mongo.url` | Needs to have the proper password for the MongoDB musare user, and for non-Docker you need to replace `@musare:27017` with `@localhost:27017`. |
-| `cookie.domain` | Should be the ip or address you use to access the site, without protocols (http/https), so for example `localhost`. |
+| `cookie.domain` | The ip or address you use to access the site, without protocols (http/https), so for example `localhost`. |
 | `cookie.secure` | Should be `true` for SSL connections, and `false` for normal http connections. |
 | `skipConfigVersionCheck` | Skips checking if the config version is outdated or not. Should almost always be set to false. |
 | `skipDbDocumentsVersionCheck` | Skips checking if there are any DB documents outdated or not. Should almost always be set to false. |

.wiki/Installation.md

@@ -1,4 +1,5 @@
 # Installation
+Musare can be installed with Docker (recommended) or without, guides for both installations can be found below.
 
 ## Docker
 
@@ -39,7 +40,7 @@
 6. `cp frontend/dist/config/template.json frontend/dist/config/default.json` and configure as per [Configuration](./Configuration.md#Frontend)
 7. Start services
     - **Linux**
-        1. Execute `systemctl enable --now redis mongod`
+        1. Execute `systemctl start redis mongod`
         2. Execute `cd frontend && npm run dev` and `cd backend && npm run dev` separately.
     - **Windows**
         - **Automatic** Run `windows-start.cmd` or just double click the `windows-start.cmd` file and all servers will automatically start up.
@@ -52,13 +53,13 @@
     1. In the root directory, create a folder called `.database`
     2. Create a file called `startMongo.cmd` in the root directory with the contents:
 
-        `"C:\Program Files\MongoDB\Server\3.2\bin\mongod.exe" --dbpath "D:\Programming\HTML\MusareNode\.database"`
+        `"C:\Program Files\MongoDB\Server\4.0\bin\mongod.exe" --dbpath "C:\Path\To\MusareNode\.database"`
 
         Make sure to adjust your paths accordingly.
     3. Start the database by executing the script `startMongo.cmd` you just made
 - Set up the MongoDB database itself
     1. Start MongoDB
-        - **Linux** Execute `systemctl enable --now mongod`
+        - **Linux** Execute `systemctl start mongod`
         - **Windows** Execute the `startMongo.cmd` script you just made
     2. Connect to Mongo from a command prompt
 
@@ -92,7 +93,7 @@
             It should look like `notify-keyspace-events Ex` when done.
     2. Create a file called `startRedis.cmd` in the main folder with the contents:
 
-        `"D:\Redis\redis-server.exe" "D:\Redis\redis.windows.conf" "--requirepass" "PASSWORD"`
+        `"C:\Path\To\Redis\redis-server.exe" "C:\Path\To\Redis\redis.windows.conf" "--requirepass" "PASSWORD"`
 
         And again, make sure that the paths lead to the proper config and executable. Replace `PASSWORD` with your Redis password.
 - **Linux**

README.md

@@ -12,7 +12,7 @@ You can also find the staging branch at [musare.dev](https://musare.dev)
 ## Getting Started
 - [Installation](./.wiki/Installation.md)
 - [Configuration](./.wiki/Configuration.md)
-- [Utility Script](./.wiki/Utility%20Script.md)
+- [Utility Script](./.wiki/Utility_Script.md)
 
 <br />