docs: Update docs for Postgres support (#619)

* Renamed PrivateHomeListCommand.java to HomeListCommand.java as it shows all homes not just private homes * Implemented #543 * Implemented #515 * added changes to all lang files, removed un used imports, fix error where it would not remove invulnerability from player on sponge * make economy hook disabled by default * make all hooks disabled by default to prevent race errors * Update docs to reflect [Commit 7ad9104](7ad9104) * revert bool change * docs: fix POSTGRESQ typo --------- Co-authored-by: William <[email protected]>
WiIIiam278 · Apr 24, 2024 · a43785c · a43785c
1 parent 7ad9104
commit a43785c
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 17 deletions.
diff --git a/docs/Config-Files.md b/docs/Config-Files.md
@@ -26,17 +26,17 @@ language: en-gb
 check_for_updates: true
 # Database settings
 database:
-  # Type of database to use (SQLITE, H2, MYSQL, or MARIADB)
+  # Type of database to use (SQLITE, H2, MYSQL, MARIADB, or POSTGRESQL)
   type: SQLITE
-  # Specify credentials here if you are using MYSQL or MARIADB
+  # Specify credentials here if you are using MYSQL, MARIADB, or POSTGRESQL
   credentials:
     host: localhost
     port: 3306
     database: huskhomes
     username: root
     password: pa55w0rd
     parameters: ?autoReconnect=true&useSSL=false&useUnicode=true&characterEncoding=UTF-8
-  # MYSQL / MARIADB database Hikari connection pool properties
+  # MYSQL / MARIADB / POSTGRESQL database Hikari connection pool properties
   # Don't modify this unless you know what you're doing!
   pool_options:
     size: 12

diff --git a/docs/Database.md b/docs/Database.md
@@ -3,12 +3,13 @@ HuskHomes stores player data, homes, warps, and teleports in a database of your
 ## Database types
 > **Warning:** There is currently no automatic way of migrating between _database_ types. Changing the database type will cause data to be lost.
 
-| Type      | File or Server | Description                                                                 | Supports cross-server |
-|:----------|----------------|:----------------------------------------------------------------------------|:---------------------:|
-| `SQLITE`  | File           | A file-based database. This is the default (recommended) option.            |           ❌           |
-| `H2`      | File           | A file-based database, similar to SQLITE, with slightly faster query times. |           ❌           |
-| `MYSQL`   | Server         | A database hosted on a MySQL server.                                        |           ✅           |
-| `MARIADB` | Server         | A database hosted on a MariaDB server.                                      |           ✅           |
+| Type         | File or Server | Description                                                                 | Supports cross-server |
+|:-------------|----------------|:----------------------------------------------------------------------------|:---------------------:|
+| `SQLITE`     | File           | A file-based database. This is the default (recommended) option.            |           ❌           |
+| `H2`         | File           | A file-based database, similar to SQLITE, with slightly faster query times. |           ❌           |
+| `MYSQL`      | Server         | A database hosted on a MySQL server.                                        |           ✅           |
+| `MARIADB`    | Server         | A database hosted on a MariaDB server.                                      |           ✅           |
+| `POSTGRESQL` | Server         | A database hosted on a PostgreSQL server.                                   |           ✅           |
 
 ### Cross-server
 If you are using HuskHomes on a cross-server network, you will need to use a database type that supports cross-server setups. This is because cross-server setups require a single database to be shared between all servers so that HuskHomes can access the same data on each server.
@@ -25,15 +26,15 @@ database:
   type: SQLITE
   mysql:
     credentials:
-      # Specify credentials here if you are using MYSQL or MARIADB as your database type
+      # Specify credentials here if you are using MYSQL, MARIADB, or POSTGRESQL as your database type
       host: localhost
       port: 3306
       database: HuskHomes
       username: root
       password: pa55w0rd
       parameters: ?autoReconnect=true&useSSL=false&useUnicode=true&characterEncoding=UTF-8
     connection_pool:
-      # MYSQL / MARIADB database Hikari connection pool properties. Don't modify this unless you know what you're doing!
+      # MYSQL / MARIADB / POSTGRESQL database Hikari connection pool properties. Don't modify this unless you know what you're doing!
       size: 12
       idle: 12
       lifetime: 1800000
@@ -42,7 +43,7 @@ database:
 ```
 </details>
 
-### Credentials (MariaDB & MySQL)
-You will need to specify the credentials (hostname, port, username, password and the database) if you are using MariaDB or MySQL. These credentials are used to connect to your database server.
+### Credentials (MariaDB, MySQL & PostgreSQL)
+You will need to specify the credentials (hostname, port, username, password and the database) if you are using MariaDB, MySQL or PostgreSQL. These credentials are used to connect to your database server.
 
-Additionally, you can modify the HikariCP connection pool properties if you know what you're doing. The default values should be fine for most users.
+Additionally, you can modify the HikariCP connection pool properties if you know what you're doing. The default values should be fine for most users.
diff --git a/docs/Setup.md b/docs/Setup.md
@@ -4,7 +4,7 @@ This will walk you through installing HuskHomes on your Spigot, Fabric or Sponge
 > **Note:** If the plugin fails to load, please check that you are not running an [incompatible version combination](Unsupported-Versions)
 
 * A Spigot (1.17.1+), Fabric (latest Minecraft version), or Sponge (Implementing API v10) _Minecraft: Java Edition_ server running on Java 17+
-* (For proxy network support) A proxy server (Velocity, BungeeCord) and MySQL (v8.0+)/MariaDB database
+* (For proxy network support) A proxy server (Velocity, BungeeCord) and MySQL (v8.0+)/MariaDB/PostgreSQL database
 * (For optional [[Redis support]]) A Redis database (v5.0+)
 
 ## Download HuskHomes for your server
@@ -37,8 +37,8 @@ These instructions are for installing HuskHomes on multiple Spigot, Fabric or Sp
 - Advanced users: If you'd prefer, you can just create one config.yml file and create symbolic links in each `/plugins/HuskHomes/` (`/config/huskhomes/` on Fabric/Sponge) folder to it to make updating it easier.
 ### 3. Configure servers to use cross-server mode
 - Navigate to the HuskHomes [config](Config-Files) file on each server (`~/plugins/HuskHomes/config.yml` on Spigot, `~/config/huskhomes/config.yml` on Fabric/Sponge)
-- Under `database`, set `type` to `MYSQL` or `MARIADB` (depending on which type of database you wish to use)
-- Under `mysql`/`credentials`, enter the credentials of your MySQL or MariaDB database server.
+- Under `database`, set `type` to `MYSQL`, `MARIADB` or `POSTGRESQL` (depending on which type of database you wish to use)
+- Under `mysql`/`credentials`, enter the credentials of your MySQL, MariaDB or PostgreSQL database server.
 - Scroll down and look for the `cross_server` section. Set `enabled` to `true`.
 - You can additionally configure a Redis server to use for network messaging, if you prefer (set the `messenger_type` to `REDIS` if you do this).
 - Save the config file. Make sure you have updated the file on every server.