Skip to content

Commit

Permalink
add more guides, change sidebar
Browse files Browse the repository at this point in the history
  • Loading branch information
pedrotski committed Dec 22, 2023
1 parent 87a12b2 commit 6147ef9
Show file tree
Hide file tree
Showing 6 changed files with 93 additions and 4 deletions.
6 changes: 2 additions & 4 deletions astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,8 @@ export default defineConfig({
}
}, {
label: 'Game Guides',
collapsed: true,
autogenerate: {
directory: 'games'
}
collapsed: false,
autogenerate: { directory: 'games', collapsed: true }
}, {
label: 'Account',
collapsed: true,
Expand Down
16 changes: 16 additions & 0 deletions src/content/docs/getting-started/adding subusers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: Adding Subusers
description: Learn how to add subusers to your game server.
tableOfContents: false
sidebar:
label: Adding Subusers
---

With Game Host Bros you can add different Subusers to help with your server. Each user you add can have their own permissions from something basic such as restarting the server, all the way up to full admin access.

1. Load the [Game Host Bros Panel](https://panel.gamehostbros.com/).
2. Select your server.
3. In the left-hand menu, click `Management > Subusers`.
4. Click the button labeled `Create`.
5. Input the User’s email address and assign the permissions you want to give them.
6. Click `Add New Subuser` to save.
9 changes: 9 additions & 0 deletions src/content/docs/getting-started/beginners guide.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
---
title: Beginners Guide
description: Your guide to becoming a game server master.
sidebar:
# Set a custom label for the link
label: Beginners Guide
# Set a custom order for the link (lower numbers are displayed higher up)
order: 1
# Add a badge to the link
badge:
text: 🔥 Hot
variant: tip
---

Guides lead a user through a specific task they want to accomplish, often with a sequence of steps.
Expand Down
23 changes: 23 additions & 0 deletions src/content/docs/getting-started/creating databases.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: Creating Databases
description: Learn how to create a database for your game server.
tableOfContents: false
sidebar:
label: Creating Databases
---

This article will guide you through the process of creating a MySQL database for your game server, which is used by some plugins to store data.

1. Load the [Game Host Bros Panel](https://panel.gamehostbros.com/).
2. Select your server.
3. In the left-hand menu, click `Management > Databases`.
4. Click the `Create` button.
5. Locate the plugin you'd like to use the MySQL database for. Open the plugin's configuration file and input the database details correctly.
6. Restart your server.

:::note
- Resetting your database will remove all the information in that database.
- Backups do not include databases.
- The MySQL port is always, 3306.
- If you want to use 127.0.0.1, it is now 172.200.0.1
:::
24 changes: 24 additions & 0 deletions src/content/docs/getting-started/schedules.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: Schedules
description: Learn how to create Schedules for your game server.
tableOfContents: false
sidebar:
label: Schedules
---

You can set up schedules to restart your server, send commands, or do game-specific tasks such as wiping Rust servers.

:::note
When setting up the schedule, the time is in UTC +0. We suggest you restart your servers at least once every 24 hours for the best possible performance.
:::

<iframe src="//www.youtube.com/embed/MyIA9kse-Ec" allowfullscreen="allowfullscreen"></iframe>

1. Load the [Game Host Bros Panel](https://panel.gamehostbros.com/).
2. Select your server.
3. In the left-hand menu, click `Configuration > Schedules`.
4. Click the `Create` button.
5. Give your schedule a name, in this example we will use "Restart" as the name.
6. Put in the time you want the server to perform the action [in cron format](https://crontab.guru/). For example, to run the Restart at 10 UTC, I would put in 0 10 * * *.
7. It will now say AT 10:00, Next run at November 29, 2023 @ 6:00 PM. That means at 6:00PM your time the schedule will run.
8. Click Submit and then `Create Task` on the top right and select the type of Task you want to perform. Example: we use power action, and restart.
19 changes: 19 additions & 0 deletions src/content/docs/getting-started/uploading files.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: How to Upload Files to Your Game Server
description: Learn how to upload files to your game server.
tableOfContents: false
sidebar:
label: Uploading Files
---

This guide will walk you through the process of uploading files to your game server using [Filezilla](https://filezilla-project.org/download.php?show_all=1).

1. Load the [Game Host Bros Panel](https://panel.gamehostbros.com/).
2. Select your server.
3. In the left-hand menu, click `System > SFTP Details`.
4. Open FileZilla and locate the `Quickconnect` bar.
5. Enter the SFTP connection address you obtained from the game panel into the `Host` field.
6. Input the `username` and the `password`. The password is the same you use to log in to the Game Panel.
7. Click the `Quickconnect` button.

Once connected, you'll see your local files on the left side of the FileZilla window and your game server files on the right side. To upload files, simply locate the files on your local machine (left side), and drag and drop them to the desired location on your game server (right side).

0 comments on commit 6147ef9

Please sign in to comment.