Update multiple documentation files (#273)

* Improve Adminer doc formatting and tips Fix code block format. Enhanced readability and user guidance in the Adminer documentation by correcting the capitalization of database names, adding titles to code blocks for clarity, and introducing a tips section for Adminer plugins. This helps users quickly identify default login credentials for both MariaDB and PostgreSQL, and discover extensibility options with plugins. * Add protected role title to Adminer anotation * Update apprise.md with new URL and setup instructions * Update Doplarr documentation links Updated main project and Docker links to point to the new official Doplarr documentation site and Docker hub. Enhanced the instructions for setting up Sonarr and Radarr integration with Doplarr, including direct edits to the Saltbox inventory configuration with clearer annotations and default values. This should help users with easier navigation and a better understanding of the setup process. * Update Duplicati documentation and links Enhanced the Duplicati section in the docs by improving the project description and updating usage link formatting. The description now clearly outlines Duplicati. Transitioned to a standardized documentation link presentation for better visual coherence and user navigation experience. * Updated LGSM install guide with enhanced clarity Enhanced the LGSM installation documentation to improve user guidance. Steps for adding game server instances to the inventory have been clarified with a direct link to inventory instructions and reformatted YAML code blocks annotated for easier understanding. The explanation on setting image tags and exposing ports has been moved from the YAML comments into a numbered list for greater visibility. Additionally, the documentation link was relocated to improve the structure and flow of the instructions. These changes aim to assist users in setting up multiple game servers with more intuitive and accessible instructions. * Enhanced Minecraft docs and clarified MC Router use - Added 'Minecraft' tags (front matter) to related documentation pages for improved categorization. - Revised MC Router documentation to better define its role in a Minecraft server network and removed obsolete URL section. - Streamlined hyperlink descriptions and fixed formatting in Minecraft server docs for better readability and consistency. Note: These documentation updates aim to make it easier for users to navigate and understand the setup and use of Minecraft servers and related components. * Improve Minecraft and LinuxGSM docs clarity - Corrected grammar in the LinuxGSM documentation for consistency. - Enhanced the Minecraft server documentation: - Provided direct links to updated project home and command references. - Added clarification about the role of MC-Router with an internal link for additional context. - Included a warning note about Cloudflare proxy when configuring subdomains. - Refined the multi-server setup instructions for better user guidance. - Updated the `mkdocs.yml` to include MC-Router in the navigation structure. * Update Minecraft server instance configuration docs Enhanced the Minecraft documentation to illustrate the use of more descriptive instance names (`mcserver1`, `mcserver2`) for clarity. Domain references were updated to align with these changes and demonstrate the correct italics markdown format. Additionally, provided instructions for setting different Docker image tags per instance, allowing for varying Minecraft server versions on a per-server basis, which facilitates more flexible server management and version control. * Update Minecraft inventory vars * Updated Bedrock server docs for clarity and CDN usage Enhanced Minecraft Bedrock server documentation with a hyperlink for quick reference and rectified a typo. Added a critical warning about disabling Cloudflare proxy for subdomains to ensure server accessibility. Also included a direct link to the Minecraft Bedrock documentation for ease of access. * Add Apprise client documentation and API information
saltyorg · Feb 16, 2024 · 852fad6 · 852fad6
1 parent 2f382e3
commit 852fad6
Show file tree

Hide file tree

Showing 9 changed files with 125 additions and 69 deletions.
diff --git a/docs/sandbox/apps/adminer.md b/docs/sandbox/apps/adminer.md
@@ -4,7 +4,7 @@
 
 [Adminer](https://www.adminer.org/) Adminer (formerly phpMinAdmin) is a full-featured database management tool written in PHP. Adminer is available for MySQL, MariaDB, PostgreSQL, SQLite, MS SQL, Oracle, Elasticsearch, MongoDB and others via plugin.
 
-!!!info
+!!!info "Protected Role"
     By default, the role is protected behind your Authelia/SSO middleware. You will also have to log into the app itself.
 
 | Details     |             |             |             |
@@ -25,22 +25,25 @@ sb install sandbox-adminer
 
 ### 3. Setup
 
-- Default login for [mariadb](../../apps/mariadb.md)
+- Default login for [MariaDB](../../apps/mariadb.md)
 
-```yaml
+``` yaml title="Adminer Mariadb Login"
   System: Mysql
   Server: mariadb:3306
   Username: root
   Password: password321
-  ```
+```
+
+- Default login for [Postgres](../../apps/postgres.md)
 
-- Default login for [postgres](../../apps/postgres.md)
-  
-``` { .yaml}
+``` yaml title="Adminer Postgres Login"
   System: PostgreSQL
   Server: postgres:5432
   Username: your_saltbox_user
   Password: password4321
-  ```
+```
+
+??? tip "Adminer Plugins"
+    Adminer has a number of plugins available to extend its functionality. You can find them [here](https://www.adminer.org/en/plugins/).
 
 - [:octicons-link-16: Documentation: Adminer Docs](https://github.com/vrana/adminer/#readme){: .header-icons }
diff --git a/docs/sandbox/apps/apprise.md b/docs/sandbox/apps/apprise.md
@@ -4,6 +4,9 @@
 
 [Apprise](https://github.com/caronc/apprise) allows you to send a notification to almost all of the most popular notification services available to us today such as: Telegram, Discord, Slack, Amazon SNS, Gotify, etc.
 
+!!! note
+    Saltbox has a built-in Apprise client that can be used to send notifications. This container is not only used to provide a web UI for configuring and managing notifications, but it also exposes an API. This API allows for programmatic interaction, enabling other applications or scripts to send notifications through the Apprise service. For more information, see the [Apprise Client Docs](https://github.com/caronc/apprise/wiki).
+
 | Details     |             |             |             |
 |-------------|-------------|-------------|-------------|
 | [:material-home: Project home](https://github.com/caronc/apprise){: .header-icons } | [:octicons-link-16: Docs](https://github.com/caronc/apprise/wiki){: .header-icons } | [:octicons-mark-github-16: Github](https://github.com/caronc/apprise){: .header-icons } | [:material-docker: Docker](https://hub.docker.com/r/caronc/apprise){: .header-icons }|
@@ -16,13 +19,22 @@ sb install sandbox-apprise
 
 ```
 
-### 2. Setup
+### 2. URL
+
+- To access apprise, visit `https://apprise._yourdomain.com_`
+
+### 3. Setup
+
+The instance runs on the Docker network accessible to other saltbox network containers at `http://apprise:8000`
+
+The configured username/password are taken from your Saltbox [`accounts.yml`](../../saltbox/install/install.md#__tabbed_2_1) file located in `/srv/git/saltbox/accounts.yml`
 
-As configured, the instance runs on the Docker network accessible to other saltbox network containers at <br />
-`http://apprise:8000` <br />
-as well as via the reverse proxy at <br />
-`https://apprise.domain.tld`.
+A typical apprise URL would look like this:
 
-The configured username/password are taken from your Saltbox [`accounts.yml`](../../saltbox/install/install.md#configuration) file located in `/srv/git/saltbox/accounts.yml`
+``` shell
+
+https://apprise._yourdomain.com_/notify?service=discord&title=Hello&body=World
+
+```
 
 - [:octicons-link-16: Documentation: Apprise Client Docs](https://github.com/caronc/apprise/wiki){: .header-icons }
diff --git a/docs/sandbox/apps/doplarr.md b/docs/sandbox/apps/doplarr.md
@@ -2,11 +2,11 @@
 
 ## What is it?
 
-[Doplarr](https://github.com/kiranshila/doplarr) is a chatbot used to simplify using services like Sonarr/Radarr/Overseer via the use of chat. Current platform is Discord only.
+[Doplarr](https://kiranshila.github.io/Doplarr/#/) is a chatbot used to simplify using services like Sonarr/Radarr/Overseer via the use of chat. Current platform is Discord only.
 
 | Details     |             |             |             |
 |-------------|-------------|-------------|-------------|
-| [:material-home: Project home](https://github.com/kiranshila/doplarr){: .header-icons } | [:octicons-link-16: Docs](https://github.com/kiranshila/doplarr){: .header-icons } | [:octicons-mark-github-16: Github](https://github.com/kiranshila/doplarr){: .header-icons } | [:material-docker: Docker](https://ghcr.io/kiranshila/doplarr){: .header-icons }|
+| [:material-home: Project home](https://kiranshila.github.io/Doplarr/#/){: .header-icons } | [:octicons-link-16: Docs](https://kiranshila.github.io/Doplarr/#/configuration){: .header-icons } | [:octicons-mark-github-16: Github](https://github.com/kiranshila/doplarr){: .header-icons } | [:material-docker: Docker](https://hub.docker.com/r/linuxserver/doplarr){: .header-icons }|
 
 ## Setup Doplarr
 
@@ -33,16 +33,22 @@ sb install sandbox-doplarr
 ```
 
 !!! Note
-      📢 You may also override the default setting of Doplarr working with overseer, to work with Sonarr and Radarr. Additional informations here [:octicons-link-16: Documentation](https://github.com/kiranshila/Doplarr/blob/main/README.md#sonarrradarr) .
-      The recommended way to customize these parameters is to use the [inventory](../../saltbox/inventory/index.md :
-      You should edit `/srv/git/saltbox/inventories/host_vars/localhost.yml` and add the following section:
-
-  ```yaml
-      ### Custom settings for Doplarr ###
-      doplarr_docker_envs_defaults:
-        SONARR__URL: "http://sonarr:8989"
-        RADARR__URL: "http://radarr:7878"
-        SONARR__API: sonarr_api
-        RADARR__API: radarr_api
-        DISCORD__TOKEN: your_discord_bot_token
-      ```
+      📢 You may also override the default setting of Doplarr working with overseer, to work with Sonarr and Radarr.
+      The recommended way to customize these parameters is to use the [inventory](../../saltbox/inventory/index.md). You should edit `/srv/git/saltbox/inventories/host_vars/localhost.yml` and add the following section.
+
+``` yaml title="Inventory"
+doplarr_docker_envs_defaults:
+  SONARR_URL: # (1)!
+  RADARR_URL: # (2)!
+  SONARR_API: # (3)!
+  RADARR_API: # (4)!
+  DISCORD_TOKEN: # (5)!
+```
+
+1. This line will set the Sonarr URL. Saltbox defaults to `"http://sonarr:8989"`.
+2. This line will set the Radarr URL. Saltbox defaults to `"http://radarr:7878"`.
+3. This line will set the Sonarr API key. Place your API key here. Wrap it in quotes.
+4. This line will set the Radarr API key. Place your API key here. Wrap it in quotes.
+5. This line will set the Discord token. Place your token here. Wrap it in quotes.
+
+- [:octicons-link-16: Documentation: Doplarr Docs](https://kiranshila.github.io/Doplarr/#/configuration){: .header-icons }
diff --git a/docs/sandbox/apps/duplicati.md b/docs/sandbox/apps/duplicati.md
@@ -1,8 +1,8 @@
-# duplicati
+# Duplicati
 
 ## What is it?
 
-[duplicati](https://duplicati.com/) is a...
+[Duplicati](https://duplicati.com/) is a free, open-source backup client that securely stores encrypted, incremental, compressed backups on cloud storage services and remote file servers. It works with a variety of storage types, including FTP, SSH, WebDAV, and cloud services like Backblaze B2, Tardigrade, and Amazon S3.
 
 | Details     |             |             |             |
 |-------------|-------------|-------------|-------------|
@@ -20,6 +20,4 @@ sb install sandbox-duplicati
 
 - To access duplicati, visit `https://duplicati._yourdomain.com_`
 
-### 3. Usage
-
-- Consult [the doc](https://duplicati.readthedocs.io/en/latest/)
+- [:octicons-link-16: Documentation: Duplicati Docs](https://duplicati.readthedocs.io/en/latest/){: .header-icons }
diff --git a/docs/sandbox/apps/lgsm.md b/docs/sandbox/apps/lgsm.md
@@ -6,29 +6,32 @@ LinuxGSM is a command-line tool for quick and simple deployment and management o
 
 | Details     |             |             |             |
 |-------------|-------------|-------------|-------------|
-| [:material-home: Project home](https://linuxgsm.com){: .header-icons } | [:octicons-link-16: Docs](https://docs.linuxgsm.com){: .header-icons } | [:octicons-mark-github-16: Github](https://github.com/GameServerManagers/LinuxGSM){: .header-icons } | [:material-docker: Docker](https://hub.docker.com/r/gameservermanagers/gameserver){: .header-icons }
+| [:material-home: Project home](https://linuxgsm.com){: .header-icons } | [:octicons-link-16: Docs](https://docs.linuxgsm.com){: .header-icons } | [:octicons-mark-github-16: Github](https://github.com/GameServerManagers/LinuxGSM){: .header-icons } | [:material-docker: Docker](https://hub.docker.com/r/gameservermanagers/gameserver){: .header-icons }|
 
 ### 1. Installation
 
-To add instances, add:
+To add instances, add the following to the inventory. See these instructions on inventory [here](../../saltbox/inventory/index.md).
 
-```yaml
+``` yaml title="Inventory"
 
-lgsm_instances: ["lgsm_valheim", "lgsm_rust"]
-# Example setting image tag to correct shortcode from https://github.com/GameServerManagers/LinuxGSM/blob/master/lgsm/data/serverlist.csv using lgsm_shortcode will automatically pull the correct image tag
-lgsm_valheim_docker_image_tag: "vh" # this is the valheimserver shortcode
-lgsm_valheim_docker_ports_defaults: ["2456:2456/udp","2457:2457/udp"] # ports for valheim need to be exposed
-# notice that rust is the image tag for the rustserver. This means we dont have to specify it here
-lgsm_rust_docker_ports_defaults: ["28015:28015/udp","28017:28017/udp","28082:28082/udp"] # ports for rust example to be exposed
+lgsm_instances: ["lgsm_valheim", "lgsm_rust"] # (1)!
+lgsm_valheim_docker_image_tag: "vh" # (2)!
+lgsm_valheim_docker_ports_defaults: ["2456:2456/udp","2457:2457/udp"] # (3)!
+lgsm_rust_docker_ports_defaults: ["28015:28015/udp","28017:28017/udp","28082:28082/udp"] # (4)!
 
 ```
 
-To the inventory files. [See instructions on inventory here](../../saltbox/inventory/index.md)
+1. Example setting image tag to correct shortcode from <https://github.com/GameServerManagers/LinuxGSM/blob/master/lgsm/data/serverlist.csv> using lgsm_shortcode will automatically pull the correct image tag
+2. This is the valheim server shortcode
+3. ports for valheim need to be exposed. Notice that rust is the image tag for the rust server. This means we don't have to specify it here.
+4. The ports for the rust server need to be exposed as well.
 
 Then run:
 
 ``` shell
+
 sb install sandbox-lgsm
+
 ```
 
 This will start the installation of LinuxGSM using the specified image tag per instance, which allows for the installation and management of multiple game servers.
@@ -44,8 +47,8 @@ For our valheim example the config would be `/opt/lgsm_valheim/config-lgsm/vhser
 
 Any actual game server configs will be in the `/opt/CONTAINERNAME/serverfiles/` and are all dependant on the game server installed.
 
-- [:octicons-link-16: Documentation](https://docs.linuxgsm.com/configuration/game-server-config){: .header-icons }
-
 ### 3. Join Server
 
 In your game, connect to your ip and default ports for the server. Make sure you set the UDP and TCP for the ports correctly. If everything was setup correctly the game should connect to the server.
+
+- [:octicons-link-16: Documentation](https://docs.linuxgsm.com/configuration/game-server-config){: .header-icons }
diff --git a/docs/sandbox/apps/mcrouter.md b/docs/sandbox/apps/mcrouter.md
@@ -1,10 +1,18 @@
-# mcrouter
+---
+tags:
+  - Minecraft
+---
+
+# MC Router
 
 ## THIS DOCUMENTATION IS NOT YET COMPLETED
 
 ## What is it?
 
-[mcrouter](https://github.com/itzg/mc-router) is a...
+[MC Router](https://github.com/itzg/mc-router) Routes Minecraft client connections to backend servers based upon the requested server address.
+
+!!! Note
+    MC Router is not intended to be used as a standalone server, but rather as a component of a larger Minecraft server network. It is installed in tandem with the [Minecraft](../apps/minecraft.md) role.
 
 | Details     |             |             |             |
 |-------------|-------------|-------------|-------------|
@@ -18,10 +26,6 @@ sb install sandbox-mcrouter
 
 ```
 
-### 2. URL
-
-- To access mcrouter, visit `https://mcrouter._yourdomain.com_`
-
 ### 3. Usage
 
 - Instructions for mcrouter
diff --git a/docs/sandbox/apps/minecraft-bedrock.md b/docs/sandbox/apps/minecraft-bedrock.md
@@ -1,8 +1,13 @@
+---
+tags:
+  - Minecraft
+---
+
 # Minecraft Bedrock
 
 ## What is it?
 
-This is a Minecraft Bedrock server for the multi-platform Minecraft version.
+[Minecraft Bedrock](https://github.com/itzg/docker-minecraft-bedrock-server) is a server for the multi-platform version of Minecraft.
 
 !!! Note
     📢 This server will expose the port UDP 19132
@@ -21,8 +26,13 @@ sb install sandbox-minecraft-bedrock
 
 ### 2. Join Server
 
-- The server will be accesible at `minecraft-bedrock._yourdomain.com_` or `_yourserverip_:19132`
+- The server will be accessible at `minecraft-bedrock._yourdomain.com_` or `_yourserverip_:19132`
+
+!!! Warning "Cloudflare CDN"
+    If you are using Cloudflare, you will need to disable the proxy for the subdomain(s) to work correctly. This can be done by clicking the orange cloud next to the subdomain in the DNS settings. Or specify it in the inventory using `minecraft-bedrock_dns_proxy: false` if you have the global toggle on. Otherwise you won't be able to reach the minecraft server at all.
 
 ### Change server version
 
 By default, the server will be using the latest version available. To choose a specific version add `minecraft_bedrock_version: "1.19.31"` to the [inventory system](../../saltbox/inventory/index.md).
+
+- [:octicons-link-16: Documentation: MC Bedrock Docs](https://github.com/itzg/docker-minecraft-bedrock-server){: .header-icons }
diff --git a/docs/sandbox/apps/minecraft.md b/docs/sandbox/apps/minecraft.md
@@ -1,13 +1,17 @@
+---
+tags:
+  - Minecraft
+---
+
 # Minecraft
 
 ## What is it?
 
-Run one or multiple minecraft servers with custom subdomains. Utilizes minecraft server and mc-router to allow each server to have its own subdomain with the default port.
+Run one or multiple minecraft servers with custom subdomains. Utilizes Minecraft server and [MC-Router](../apps/mcrouter.md) to allow each server to have its own subdomain with the default port.
 
-| Details     |             |             |             |
-|-------------|-------------|-------------|-------------|
-| [:material-home: Project home](https://github.com/itzg/docker-minecraft-server){: .header-icons } | [:octicons-link-16: Docs](https://github.com/itzg/docker-minecraft-server){: .header-icons } | [:octicons-mark-github-16: Github](https://github.com/itzg/docker-minecraft-server){: .header-icons } | [:material-docker: Docker](https://hub.docker.com/r/itzg/minecraft-server){: .header-icons }
-| [:material-home: Project home](https://github.com/itzg/mc-router){: .header-icons } | [:octicons-link-16: Docs](https://github.com/itzg/mc-router){: .header-icons } | [:octicons-mark-github-16: Github](https://github.com/itzg/mc-router){: .header-icons } | [:material-docker: Docker](https://hub.docker.com/r/itzg/mc-router){: .header-icons }
+| Details     |             |             |
+|-------------|-------------|-------------|
+| [:material-home: Project home](https://docker-minecraft-server.readthedocs.io/en/latest/){: .header-icons } | [:octicons-link-16: Docs](https://docker-minecraft-server.readthedocs.io/en/latest/commands/){: .header-icons } | [:octicons-mark-github-16: Github](https://github.com/itzg/docker-minecraft-server){: .header-icons }|
 
 ### 1. Installation
 
@@ -17,35 +21,50 @@ sb install sandbox-minecraft
 
 ```
 
-This will install mc-router and the minecraft server. If you have listed multiple minecraft instances, it will install these too. (See below for multi server instructions)
+This will install [mc-router](../apps/mcrouter.md) and the minecraft server. If you have listed multiple minecraft instances, it will install these too. (See below for multi server instructions)
 
 ### 2. Join Server
 
+!!! Warning "Cloudflare CDN"
+    If you are using Cloudflare, you will need to disable the proxy for the subdomain(s) to work correctly. This can be done by clicking the orange cloud next to the subdomain in the DNS settings. Or specify it in the inventory using `minecraft_dns_proxy: false` if you have the global toggle on. Otherwise you won't be able to reach the minecraft server at all.
+
 - By default, a single server will be accesible at  `minecraft._yourdomain.com_`
 - If you have set up multiple instances, these will be accesible by default at `instanceName._yourdomain.com_` (See multi server instructions below)
 
 ### 3. Multi Server Set Up
 
-To add multiple instances, add:
+To add multiple instances, add the following to the inventory. See these instructions on inventory [here](../../saltbox/inventory/index.md).
 
-```yaml
+``` yaml
 
-minecraft_instances: ["server1", "server2"]
+minecraft_instances: ["mcserver1", "mcserver2"] # (1)!
 
 ```
 
-To the inventory files. [See instructions on inventory here](../../saltbox/inventory/index.md)
+1. This will install two servers, server1 and server2.
 
-These servers will be accesible at `instanceName.__yourdomain.com__`
+These servers will be accesible at `instanceName._yourdomain.com_`
 
-So for the example above, `server1.youdomain.com` and `server2.yourdomain.com`
+So for the example above, `mcserver1._yourdomain.com_` and `mcserver2._yourdomain.com_`
 
 ### 4. Setup
 
-For individual servers, you can change things such as memory using custom docker envs. [See instructions on inventory here](../../saltbox/inventory/index.md)
+For individual servers, you can change things such as memory using custom docker envs. See instructions on inventory [here](../../saltbox/inventory/index.md)
+
+For a single install, the inventory vars will look like this `minecraft_docker_image_tag`.
+
+When you have set up multiple servers, they will all use the `minecraft_docker_image_tag` settings as a default. To override this use the instance name instead. E.g `instanceName_docker_image_tag`.
 
-For a single install, the inventory paths will look like this `minecraft_docker_image_tag`
+``` yaml title="Inventory"
+
+minecraft_instances: ["server1", "server2"] # (1)!
+mcserver1_docker_image_tag: "itzg/minecraft-server:latest" # (2)!
+mcserver2_docker_image_tag: "itzg/minecraft-server:1.17.1" # (3)!
+
+```
 
-When you have set up multiple servers, they will all use the `minecraft_docker_image_tag` settings as a default. To override this use the instance name instead. E.g `instanceName_docker_image_tag`
+1. This will install two servers, mcserver1 and mcserver2.
+2. This will install the latest version of the minecraft server on mcserver1.
+3. This will install version 1.17.1 of the minecraft server on mcserver2.
 
 - [:octicons-link-16: Documentation](https://github.com/itzg/docker-minecraft-server){: .header-icons }
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -217,6 +217,7 @@ nav:
           - Homepage: sandbox/apps/homepage.md
         - Game Servers:
           - LinuxGSM: sandbox/apps/lgsm.md
+          - MC-Router: sandbox/apps/mcrouter.md
           - Minecraft: sandbox/apps/minecraft.md
           - Minecraft Bedrock: sandbox/apps/minecraft-bedrock.md
         - Media Management: