From 04606a7c9a9d9fa782004d539f65ac348e2d8dd0 Mon Sep 17 00:00:00 2001 From: William Date: Sat, 15 Jun 2024 13:46:04 +0100 Subject: [PATCH] docs: improve setup instructions Improve Mongo instructions & add advice for Pterodactyl self-hosts --- docs/Setup.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/docs/Setup.md b/docs/Setup.md index 01caac52..a4c7d822 100644 --- a/docs/Setup.md +++ b/docs/Setup.md @@ -31,22 +31,29 @@ This will walk you through installing HuskSync on your network of Spigot or Fabr - Unless you want to have multiple clusters of servers within your network, each with separate user data, you should not change the value of `cluster_id`.
-Important — MongoDB Users +MongoDB users — additional instructions - Navigate to the HuskSync config file on each server (`~/plugins/HuskSync/config.yml`) - Set `type` in the `database` section to `MONGO` - Under `credentials` in the `database` section, enter the credentials of your MongoDB Database. You shouldn't touch the `connection_pool` properties. -
+- Under `parameters` in the `mongo_settings` section, ensure the specified `&authSource=` matches the database you are using (default is `HuskSync`). -Additional configuration for MongoDB Atlas users +#### Additional setup for MongoDB Atlas -- Navigate to the HuskSync config file on each server (`~/plugins/HuskSync/config.yml`) - Set `using_atlas` in the `mongo_settings` section to `true`. - Remove `&authSource=HuskSync` from `parameters` in the `mongo_settings`. (The `port` setting in `credentials` is disregarded when using Atlas.)
+
+Pterodactyl self-hosts — Redis setup instructions + +If you are hosting your Redis server on the same node as your servers, you need to use `172.18.0.1` as your host (or equivalent if you changed your network settings), and bind it in the Redis config `nano /etc/redis/redis.conf`. + +You will also need to uncomment the `requirepass` directive and set a password to allow outside connections, or disable `protected-mode`. Once a password is set and Redis is restarted `systemctl restart redis`, you will also need to update the password in your pterodactyl `.env` (`nano /var/www/pterodactyl/.env`) and refresh the cache `cd /var/www/pterodactyl && php artisan config:clear`. + +You may also need to allow connections from your firewall depending on your distribution.
### 4. Set server names in server.yml files