Skip to content

Commit a29d71b

Browse files
committed
big improvements to setup docs
1 parent 0764dc5 commit a29d71b

File tree

17 files changed

+860
-4435
lines changed

17 files changed

+860
-4435
lines changed

docs/advanced-usage/failt2ban.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This guide explains how to set up Fail2Ban to safeguard your GameVault applicati
1414
## Prerequisites
1515

1616
- Fail2Ban installed on your host system
17-
- Running GameVault instance as outlined in the [server setup documentation](../server-docs/setup.md)
17+
- Running GameVault instance as outlined in the [server setup documentation](../server-docs/setup/setup)
1818

1919
## Steps
2020

docs/server-docs/setup.md

Lines changed: 0 additions & 230 deletions
This file was deleted.

docs/server-docs/setup/_category_.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
position: 1
2+
label: Setup

docs/server-docs/setup/caprover.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
---
2+
title: "Using CapRover"
3+
sidebar_position: 3
4+
---
5+
6+
[CapRover](https://caprover.com) is an open-source platform that simplifies the deployment and management of web applications through containerization, providing a user-friendly interface for developers.
7+
8+
Setting up a GameVault Server on CapRover is just a click away because we have created a CapRover [One-Click-App](https://caprover.com/docs/one-click-apps.html) Integration for this purpose. However, our app hasn't gained enough prominence to be included in the official [One-Click-App](https://caprover.com/docs/one-click-apps.html) Repository of CapRover. So, we decided to create our own [third-party repository](https://github.com/Phalcode/caprover-one-click-apps).
9+
10+
In this guide, you will learn how to connect to our [third-party repository](https://github.com/Phalcode/caprover-one-click-apps) and install GameVault on your CapRover Instance.
11+
12+
## Prerequisites
13+
14+
- A running [CapRover](https://caprover.com) Server
15+
16+
## Step 1: Log in to your CapRover Dashboard
17+
18+
Log in to your CapRover dashboard.
19+
20+
![Step 1](/img/docs/setup/caprover/caprover1.png)
21+
22+
## Step 2: Navigate to the One-Click-Apps/Databases
23+
24+
Go to "Apps" and click on "One-Click Apps/Databases."
25+
26+
![Step 2](/img/docs/setup/caprover/caprover2.png)
27+
28+
## Step 3: Connect Phalcode's third-party repository
29+
30+
Scroll down to the bottom. Under "3rd party repositories," copy and paste the following link: `https://phalcode.github.io/caprover-one-click-apps`. Click the "Connect New Repository" button.
31+
32+
![Step 3](/img/docs/setup/caprover/caprover3.png)
33+
34+
## Step 4: Install our GameVault One-Click-App
35+
36+
Now, all you need to do is search for 'GameVault' using the search box and follow the installation wizard.
37+
38+
If you can't find GameVault in the list, try reloading the page and search again.
39+
40+
![Step 4](/img/docs/setup/caprover/caprover4.png)
41+
42+
## Step 5: Enable WebSocket Support
43+
44+
Go to "Apps" and click on the GameVault App you just created. Make sure WebSocket Support is enabled.
45+
46+
![Step 5](/img/docs/setup/caprover/caprover5.png)
47+
48+
## Step 6: Configuring Volumes
49+
50+
Configure your mounted volumes as you like.
51+
52+
![Step 6](/img/docs/setup/caprover/caprover6.png)
53+
54+
## Conclusion
55+
56+
You have now successfully set up your GameVault Server using CapRover.
57+
58+
[Click here to continue.](setup#what-next)
59+
60+
## Additional Info
61+
62+
### Stopping the Server
63+
64+
Navigate to "Apps" and select the GameVault App you have created.
65+
66+
Click on "App Configs".
67+
68+
Set "Instance Count" to 0.
69+
70+
### Reading the Logs
71+
72+
Navigate to "Apps" and choose the GameVault App you have created.
73+
74+
Click on "Deployment".
75+
76+
You should now see the logs. If needed, click on "View App Logs" first.

0 commit comments

Comments
 (0)