Skip to content

Commit

Permalink
Merge pull request #328 from Razboy20/fix/broken-links
Browse files Browse the repository at this point in the history
Improve doc internal links
  • Loading branch information
articbloom authored Jul 28, 2024
2 parents 0c4a568 + b4b3b93 commit 680e419
Show file tree
Hide file tree
Showing 58 changed files with 207 additions and 200 deletions.
2 changes: 1 addition & 1 deletion docs/VPS/starting-with-vps.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,5 +67,5 @@ After that, click on the "Open" button and the SSH connection will start, you wi
![img](/VPS/starting-with-vps/3.png)

:::important
Need to connect to your VPS via VNC? Check out our guide here: [How to connect to your VPS via VNC](https://docs.bloom.host/vnc)
Need to connect to your VPS via VNC? Check out our guide here: [How to connect to your VPS via VNC](vnc.md)
:::
2 changes: 1 addition & 1 deletion docs/billing/cancellations.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,5 +47,5 @@ To cancel a PayPal Subscription (recurring payment) follow this steps:
:::caution
You may request a refund on the basis that you have submitted an "Immediate" cancellation request and fall within 72 hours of the initial payment, and activation of your service. Refund requests should be requested via a ticket through our [billing panel](https://billing.bloom.host/supporttickets.php). These refunds are only issued on a one-time per customer basis.

You can visit our [Refund documentation](https://docs.bloom.host/billing/refunds) to learn more about our refund policy. You can also read our [Terms and Service Policy](https://bloom.host/terms/).
You can visit our [Refund documentation](/billing/refunds) to learn more about our refund policy. You can also read our [Terms and Service Policy](https://bloom.host/terms/).
:::
2 changes: 1 addition & 1 deletion docs/billing/refunds.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,5 +41,5 @@ Download a backup of all your files before submitting a refund request. Once the
## PayPal Subscriptions (Recurring Payments) need to be cancelled manually

:::caution
IMPORTANT: You have to manually cancel your PayPal Subscription (Recurring Payment) after you request a refund or cancellation, otherwise PayPal will continue to send us the payment for your server. Please refer to our guide on [how to cancel a PayPal Subscription](https://docs.bloom.host/billing/paypal) to avoid overpayments.
IMPORTANT: You have to manually cancel your PayPal Subscription (Recurring Payment) after you request a refund or cancellation, otherwise PayPal will continue to send us the payment for your server. Please refer to our guide on [how to cancel a PayPal Subscription](/billing/paypal) to avoid overpayments.
:::
2 changes: 1 addition & 1 deletion docs/games/palworld/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Learn how you can change the settings of your Palworld server!

## Palworld Modifying Settings

First, stop your server. Then, using the [File Manager](/using_the_panel/file-manager-controls),
First, stop your server. Then, using the [File Manager](/using_the_panel/file-manager-controls.md),
copy the contents of the `DefaultPalWorldSettings.ini` file to the
`Pal/Saved/Config/LinuxServer/PalWorldSettings.ini` file.
Lastly, remove the first 3 lines of the file.
Expand Down
2 changes: 1 addition & 1 deletion docs/games/palworld/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Restarting the server.
Server should auto update on restarts, if it doesn't follow Method 2

# Method 2
First, stop your server. Then, go to the [Backups](/using_the_panel/backups) tab.
First, stop your server. Then, go to the [Backups](/using_the_panel/backups.md) tab.
Make a backup just incase something goes wrong, after that go to Settings tab, click Reinstall.


Expand Down
2 changes: 1 addition & 1 deletion docs/games/rust/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ first time after installing new plugins, but you will see the status show as 'Ru
![Server showing loaded](/games/rust/plugins/loaded.png)

Lastly, you can verify that the plugin is installed by using the `plugins` command in-game as
an [administrator](./admin.md) or in the console.
an [administrator](admin.md) or in the console.
![Command verifying successful installation](/games/rust/plugins/list.png)

---
Expand Down
2 changes: 1 addition & 1 deletion docs/games/terraria/banning.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Changes to the file are reflected instantly.

## TShock

When using [TShock](./tshock/overview.md), it's possible to ban based on the server-side user profiles instead of the
When using [TShock](tshock/overview.md), it's possible to ban based on the server-side user profiles instead of the
IP address.

### Banning
Expand Down
2 changes: 1 addition & 1 deletion docs/games/terraria/tmodloader/mods.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ note: This is referenced on the /terraria page on the main site

:::caution HEADS UP!
Mods are not part of the vanilla server software, so in order for this to work, you must
install [tModLoader](./overview.md).
install [tModLoader](overview.md).
:::

Mods are a way for developers to add new items, bosses, mechanics and more into the game.
Expand Down
2 changes: 1 addition & 1 deletion docs/games/terraria/tshock/admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Learn how you can earn admin privileges on your TShock server!

:::caution HEADS UP!
Special commands and permissions are not part of the vanilla server software, so in order for this to work, you must
install [TShock](./overview.md).
install [TShock](overview.md).
:::

Once the server loads, you should see a few lines about the `/setup` command:
Expand Down
2 changes: 1 addition & 1 deletion docs/games/terraria/tshock/crossplay.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Learn how you can enable mobile <-> PC crossplay on your TShock ser

:::caution HEADS UP!
This is not possible with the vanilla server software, so in order for this to work, you must
install [TShock](./overview.md).
install [TShock](overview.md).
:::

By default the game only allows either PC, or mobile players to connect to a server. To work around this limitation, you
Expand Down
2 changes: 1 addition & 1 deletion docs/games/terraria/tshock/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ note: This is referenced on the /terraria page on the main site

:::caution HEADS UP!
Plugins are not part of the vanilla server software, so in order for this to work, you must
install [TShock](./overview.md).
install [TShock](overview.md).
:::

First, find some plugins you would like to install. A safe source is
Expand Down
4 changes: 2 additions & 2 deletions docs/games/terraria/tshock/whitelisting.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ description: Learn how to set up and manage a whitelist on your Terraria server!
---

:::info HEADS UP
The game does not provide a whitelisting functionality by default, so we will have to use [TShock](./overview.md), a
The game does not provide a whitelisting functionality by default, so we will have to use [TShock](overview.md), a
third party server software.

As an alternative for the vanilla server, you can use [server passwords](/games/terraria/password).

If you haven't already, make sure to install is using [the steps here](./overview.md)!
If you haven't already, make sure to install is using [the steps here](overview.md)!
:::

## Toggling Whitelist
Expand Down
2 changes: 1 addition & 1 deletion docs/other-servers/caddy-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,4 @@ After you press **SPLIT SERVER** confirm you would like to split your server by
## Configuring the Caddy server.

To start, drop your html/php files into the "/public" directory of the caddy server. Then start the server.
If you would like to use a domain for this server follow these [instructions](https://docs.bloom.host/ports-and-proxies/) to setup a reverse proxy.
If you would like to use a domain for this server follow these [instructions](/ports-and-proxies/) to setup a reverse proxy.
6 changes: 3 additions & 3 deletions docs/other-servers/grafana.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ If you want to connect multiple servers to your Grafana dashboard you can do so
## UnifiedMetrics

Download the plugin off the [Github](https://github.com/Cubxity/UnifiedMetrics/releases) and install it in the `plugins` folder.
For assistance on how to install plugins, please refer to the [plugin installation page](https://docs.bloom.host/installing-plugins).
For assistance on how to install plugins, please refer to the [plugin installation page](/installing-plugins).

Now you're gonna want to open up the default port for UnifiedMetrics (9100) under the Ports & Proxies tab.

Expand All @@ -38,7 +38,7 @@ We're now done with UnifiedMetrics, onto Prometheus :)
## Prometheus

Now we're going to setup a Prometheus server, you're gonna want to split a Prometheus instance which is located under the "NO SUPPORT SERVERS" category with 150MB of RAM and 10GB of Storage (may need to be adjusted to your needs).
For assistance on how the server splitter works, please refer to the [server splitter page](https://docs.bloom.host/split-server).
For assistance on how the server splitter works, please refer to the [server splitter page](/split-server).

Once the server is created, head to it under the Server Split tab.

Expand All @@ -56,7 +56,7 @@ Once the server is created, change it to the default Grafana port (3000) under t

At this point you may want to setup a reverse proxy for Grafana so it gets HTTPS and so users don't need to specify a port.

Simply follow this guide [here](https://docs.bloom.host/ports-and-proxies).
Simply follow this guide [here](/ports-and-proxies).

Now, head to your Grafana's IP & Port (or subdomain if you setup the reverse proxy) and login.

Expand Down
4 changes: 2 additions & 2 deletions docs/plugins_and_modifications/gtnh.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ keywords:
:::important
Before following this guide, make sure that the appropriate version of Java is installed on your computer and that you have at least 6GB of RAM available for the first time setup on your computer.

You should also familiarize yourself with using SFTP to transfer files using our [SFTP guide](https://docs.bloom.host/sftp), it will be needed to transfer files.
You should also familiarize yourself with using SFTP to transfer files using our [SFTP guide](/sftp), it will be needed to transfer files.
:::

:::note
Expand Down Expand Up @@ -66,7 +66,7 @@ In "File Manager" select and delete all files.

# Uploading your server.

Ensure you have familiarized yourself with using SFTP. You can follow our guide on [how to connect through SFTP](https://docs.bloom.host/sftp).
Ensure you have familiarized yourself with using SFTP. You can follow our guide on [how to connect through SFTP](/sftp).

In the folder where you extracted the Gregtech New Horizons server pack, select all files and compress them into a zip. It is a good idea to name it something like "GTNH.zip" so that you can easily find it for the next step. This is recommended as it will significantly speed up transfer via SFTP. Wait for the zipping to complete.

Expand Down
4 changes: 2 additions & 2 deletions docs/plugins_and_modifications/modpacks.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ keywords:
:::important
Before following this guide, make sure that the modpack that you want to install isn't on the 'Modpacks' tab of our Minecraft panel. If the modpack is there, you can just click it and it will be automatically installed for you.

To see a list of available modpacks please visit our [Modpack list page](https://docs.bloom.host/extras/available-modpacks), in that page we also explain the process you have to follow if you want us to add a modpack to our One-Click Modpack installer.
To see a list of available modpacks please visit our [Modpack list page](/extras/available-modpacks), in that page we also explain the process you have to follow if you want us to add a modpack to our One-Click Modpack installer.
:::

:::note
Expand Down Expand Up @@ -75,7 +75,7 @@ After compressing the files, you will need to upload the compressed/archived fil

![](/plugins_and_modifications/serverpacks/11.png)

Server packs contain a lot of files, so you will need to connect through SFTP to upload the archived file. You can follow our guide on [How to connect through SFTP](https://docs.bloom.host/sftp). After you connect through SFTP, you can just drag and drop the .zip to the SFTP server.
Server packs contain a lot of files, so you will need to connect through SFTP to upload the archived file. You can follow our guide on [How to connect through SFTP](/sftp). After you connect through SFTP, you can just drag and drop the .zip to the SFTP server.

![](/plugins_and_modifications/serverpacks/13.png)

Expand Down
3 changes: 1 addition & 2 deletions docs/plugins_and_modifications/mods-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ You'll first need to find the mod that you wish to install. Downloads can be fou
Make sure you are downloading the correct version of your mods. Forge and Fabric mods are most likely not cross compatible with each other unless stated so otherwise by the developer of those mods.
:::

You have two choices: save the mod to your local machine and then upload it to the panel or copy the link to the mod download and use our Download from URL feature which can be found on the File Manager. Mods can either be uploaded via the [web panel](https://mc.bloom.host) or through [SFTP](https://docs.bloom.host/how-to-use-sftp). If you're uploading in bulk, go with the latter.
You have two choices: save the mod to your local machine and then upload it to the panel or copy the link to the mod download and use our Download from URL feature which can be found on the File Manager. Mods can either be uploaded via the [web panel](https://mc.bloom.host) or through [SFTP](/using_the_panel/sftp.md). If you're uploading in bulk, go with the latter.

In your server's root directory, locate the `/mods` folder, if it's not there then create a new directory named `/mods`. Navigate into this folder, and upload your mods' files there! The vast majority of mods require you to restart your server to take effect.

Expand All @@ -33,4 +33,3 @@ Be sure to use the correct version of the mod. Unlike Spigot/Paper plugins, mods


Some mods need players to install them locally as well. Consult the documentation of your mod to see if this is required. Some mods may provide a seperate file for players and servers.

Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ For assistance on how to install plugins, please refer to the [Bukkit plugin ins

You will then need to decide if you are going to be using internal storage (HSQLDB) or external storage (MySQL).

If you decide to use MySQL for AdvancedBan, you can [learn how to setup a MySQL database here](https://docs.bloom.host/databases).
If you decide to use MySQL for AdvancedBan, you can [learn how to setup a MySQL database here](/databases).

## Usage
AdvancedBan has many commands to be able to moderate and punish rule-breakers, the most important commands are here:
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins_and_modifications/multiplatform/bluemap.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,6 @@ Your server needs to be restarted after the port has been allocated.

:::

You can also create a Proxy for your BlueMap link, to remove the need to type `:8100` after your IP address: https://docs.bloom.host/ports-and-proxies/
You can also create a Proxy for your BlueMap link, to remove the need to type `:8100` after your IP address: /ports-and-proxies/

For more information, the download link, their support Discord, the wiki and a demo! you can go to the [BlueMap website](https://bluemap.bluecolored.de/)
4 changes: 2 additions & 2 deletions docs/plugins_and_modifications/multiplatform/dynmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Dynmap allows you to see your Minecraft world in 3D in real time, like Google Ma
![Dynmap preview](https://cdn.discordapp.com/attachments/716405933105872938/750877749954084875/unknown.png)

# Usage
Spigot/Paper: Download the Dynmap plugin and place into the `plugins` folder then restart your server to generate `configuration.txt`. Create a MySQL database. If you are unsure, [check out this guide](https://docs.bloom.host/databases).
Spigot/Paper: Download the Dynmap plugin and place into the `plugins` folder then restart your server to generate `configuration.txt`. Create a MySQL database. If you are unsure, [check out this guide](/databases).

For other platforms, refer to the [Dynmap installation guide](https://github.com/webbukkit/dynmap/wiki/Installation)

Expand All @@ -45,7 +45,7 @@ Now enter the database information into this section remembering to remove the `
```
Now go into the minecraft panel, click the "Ports & Proxies" tab, and create a new port. You will be able to choose a port that you want to use and enter the port number you just opened into the config file.
You can also add your Dynmap IP to Bloom's reverse proxy(on the sidebar of the panel,), changing the website link from `123.456.67.2:8123` to `subdomain.yourdomain.com`. Please read [this guide](https://docs.bloom.host/ports-and-proxies/).
You can also add your Dynmap IP to Bloom's reverse proxy(on the sidebar of the panel,), changing the website link from `123.456.67.2:8123` to `subdomain.yourdomain.com`. Please read [this guide](/ports-and-proxies/).

## Info

Expand Down
2 changes: 1 addition & 1 deletion docs/plugins_and_modifications/multiplatform/litebans.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ In-game punishments can still be issued as normal.
## Punishment storage
Next, you have to decide what type of storage you want for all your punishments, your options are H2, MySQL, MariaDB, and PostgreSQL. On Bloom you are going to want to use H2, or MySQL. H2 will store the information on your server, while MySQL will store it on a separate database. MySQL allows you to sync data accross a network if you are running one. Otherwise its your choice.

If you are using MySQL, you can see how to set up LiteBans with MySQL [HERE](https://docs.bloom.host/databases)
If you are using MySQL, you can see how to set up LiteBans with MySQL [HERE](/databases)

## Commands
LiteBans offers many commands to moderate your server, below will be a short list of the important ones.
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins_and_modifications/multiplatform/worldedit.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Pasting huge schematics or constructions with WorldEdit consumes a lot of server

### Setup

Download the latest version for your Minecraft version (e.g. if your server is 1.16.2, download the latest one compatible with 1.16.2). Drop it in your plugins folder. Turn on or restart the server, and it should be working! If you need help installing plugins, check [How to install plugins](https://docs.bloom.host/installing-plugins).
Download the latest version for your Minecraft version (e.g. if your server is 1.16.2, download the latest one compatible with 1.16.2). Drop it in your plugins folder. Turn on or restart the server, and it should be working! If you need help installing plugins, check [How to install plugins](/installing-plugins).

For other platforms (such as Forge or Fabric,) refer to [EngineHub’s guide on installing WorldEdit](https://worldedit.enginehub.org/en/latest/install/).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ A "check" in an anticheat is a part of the plugin that analyzes if the player is
- `decay:` determines how fast violations for a player will decay

The thresholds section is pretty simple, it just determines what commands should be run when a player/potential-hacker reaches a certain violation level (VL)
- See [Conditional Commands](https://docs.bloom.host/plugins/cc) for info on reducing lag related kicks/bans
- See [Conditional Commands](/plugins/cc) for info on reducing lag related kicks/bans

## There's a false positive, what do I do?
### AAC's configurability means that false positives are easily fixed. There are two types of false positives:
Expand Down
4 changes: 2 additions & 2 deletions docs/plugins_and_modifications/plugins/citizens2.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ Citizens2 is an advanced NPC plugin for Spigot that allows developers to extend
1. Upload the jar(s) to your `/plugins` folder.
1. Restart the server.

If you need help installing plugins, check [How to install plugins](https://docs.bloom.host/installing-plugins).
If you need help installing plugins, check [How to install plugins](/installing-plugins).

:::note
You may also want to look at installing the Denzien, Sentinel, and dtlTraders plugins for Citizens.
- [Denizen](./denizen) is an extension for Citizens that allows scripting of NPCs to handle tasks, quests, player interaction and more!
- [Denizen](denizen) is an extension for Citizens that allows scripting of NPCs to handle tasks, quests, player interaction and more!
- Sentinel is an extension for Citizens that allows Combat NPCs who can protect players, towns, etc.
- dtlTraders is an extension for Citizens that allows NPCs as merchants who can buy, sell, and/or trade with players.
:::
Expand Down
6 changes: 3 additions & 3 deletions docs/plugins_and_modifications/plugins/coreprotect.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ CoreProtect is a fast, efficient, data logging and anti-griefing tool. Rollback


:::important
Before you get started, you need to have created a MySQL database. More info on that can be found [here](https://docs.bloom.host/databases).
Before you get started, you need to have created a MySQL database. More info on that can be found [here](/databases).
:::
[Download the plugin](https://www.spigotmc.org/resources/coreprotect.8631/), and upload the jar into your `/plugins folder`, and then restart the server. If you need help installing plugins, check [How to install plugins](https://docs.bloom.host/installing-plugins).
[Download the plugin](https://www.spigotmc.org/resources/coreprotect.8631/), and upload the jar into your `/plugins folder`, and then restart the server. If you need help installing plugins, check [How to install plugins](/installing-plugins).

After that, go to the `CoreProtect` folder, which can be found inside the `plugins` folder. From there, edit the `config.yml` file.

Expand Down Expand Up @@ -65,4 +65,4 @@ There are, of course, more commands in the plugin, which you can check out [here

[Configuration](https://docs.coreprotect.net/config/)

[GitHub](https://github.com/PlayPro/CoreProtect/)
[GitHub](https://github.com/PlayPro/CoreProtect/)
Loading

0 comments on commit 680e419

Please sign in to comment.