Skip to content

Commit

Permalink
add docs for proxying etc
Browse files Browse the repository at this point in the history
  • Loading branch information
Alfagun74 authored Apr 3, 2024
1 parent 501bf1d commit 08ff97a
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
4 changes: 2 additions & 2 deletions docs/server-docs/setup/docker-compose.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ services:
ports:
- 8080:8080
db:
image: postgres:15
image: postgres:16
restart: unless-stopped
environment:
POSTGRES_USER: gamevault
Expand Down Expand Up @@ -90,7 +90,7 @@ This will start the GameVault server and PostgreSQL server in the background. Th

## Conclusion

You have now successfully set up your GameVault Server using Docker and Docker Compose.
Congratulations! Your GameVault Server has been successfully set up using Docker and Docker Compose. You can now access it using your server's IP address followed by the designated port, such as http://192.168.0.15:8080.

[Click here to continue.](setup.md#what-next)

Expand Down
8 changes: 5 additions & 3 deletions docs/server-docs/setup/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,16 @@ We're looking for people who are excited to help out. Since we don't run a GameV

**Congratulations! 🥳**

You now should have a server up and running. To further set up and start using server, follow these steps:
You now should have a server up and running. To further set up and start using server, you can follow these steps:

1. **Configure your server:** Customize the server settings to meet your specific needs. Refer to the [configuration guide](../configuration.md) for detailed instructions.

2. **Add some games:** Prepare your game files in the required format for GameVault to identify and install them correctly. Read the [structure chapter](../structure.md) for important information. Once ready, proceed to [add your games](../adding-games.md).

3. **Enhance your games with metadata:** Connect your server to RAWG, the world's largest video game database that GameVault utilizes for fetching game metadata. This will enrich your gaming experience. Learn how to establish the connection in the [indexing and metadata guide](../indexing-and-metadata.md).
3. **Create an admin user:** Set up an admin user account to gain full administrative access to the application. Refer to the [user management guide](../user-management.md) for instructions on setting up the first user.

4. **Create an admin user:** Set up an admin user account to gain full administrative access to the application. Refer to the [user management guide](../user-management.md) for instructions on setting up the first user.
4. **Enhance your games with metadata:** Connect your server to RAWG, the world's largest video game database that GameVault utilizes for fetching game metadata. This will enrich your gaming experience. Learn how to establish the connection in the [indexing and metadata guide](../indexing-and-metadata.md).

5. **(OPTIONAL) Make your server accessible outside your Local Area Network**: If you want to make the application accessible beyond your local network, for instance, for your friends or yourself to connect to it remotely, you'll need to configure an HTTPS reverse proxy and potentially make adjustments to firewall rules. We recommend utilizing [NGINX Proxy Manager](https://nginxproxymanager.com) for this purpose. Numerous guides are available on how to set up a reverse proxy for a Docker container, so we won't cover it in detail in this guide.

Enjoy your new gaming experience with GameVault!

0 comments on commit 08ff97a

Please sign in to comment.