Skip to content

Commit 54d0fd5

Browse files
committed
how to logs
1 parent 75b7b90 commit 54d0fd5

File tree

1 file changed

+30
-4
lines changed

1 file changed

+30
-4
lines changed

docs/troubleshooting.md

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,6 @@ sidebar_position: 99
66

77
Below, we will gradually list some common issues and corresponding solutions to help you maximize the potential of your app. If you can't find a solution to your problem here, feel free to open a ticket on our Github board or seek assistance via [Discord](https://discord.gg/NEdNen2dSu). Alternatively, you may also directly [email our company address](mailto:contact@phalco.de) if the issue is confidential.
88

9-
:::tip How to report an issue
10-
Always provide as much information as possible so that we can reproduce the problem, and **always** attach a full (from the start of the server to when the problem occurs) log file with the `SERVER_LOG_LEVEL` env-var set to `debug`. You **must not** shorten log files. It just makes it harder for us to understand what went wrong. We know they get big, but we know how to read them.
11-
:::
12-
139
## All-Rounder Solutions that Fix Most Problems
1410

1511
I can't mention these in every single Section below, so before you try to solve anything, try these:
@@ -78,3 +74,33 @@ Either make sure this user has permissions to read/write to the folders you map
7874
- Restart your Client and Server
7975
- If your server is in your LAN, make sure you don't mistakenly access it from WAN
8076
- Check your middle-mans: Proxies, VPNs and older Network Hardware could all affect the download speeds.
77+
78+
## How to Report an Issue
79+
80+
To help us resolve your issue quickly and accurately, please include as much detail as possible, especially:
81+
82+
- A **complete log file** (from server start to when the issue occurs).
83+
- Set the environment variable `SERVER_LOG_LEVEL` to `debug` before collecting the logs.
84+
85+
:::warn Full logs needed
86+
Please do not trim or shorten log files. It just makes it harder for us to understand what went wrong. We know they get big, but we know how to read them.
87+
You can redact sensitive details by replacing them with the word `**REDACTED**` before you send them if you want to, but the server tries to automatically redact sensitive data, so they should be gernerally safe to share.
88+
:::
89+
90+
## How to Collect Logs
91+
92+
If you're not sure how to gather logs, or your system makes it unclear you can use GameVault's Built-in Logging feature:
93+
94+
1. **Enable logging:**
95+
96+
Set the environment variable `SERVER_LOG_FILES_ENABLED` to `true`
97+
98+
2. **Set the log folder:**
99+
100+
- If you're using Docker:
101+
Bind a local folder to `/logs` using the docker volumes feature.
102+
103+
- If you're running natively:
104+
Make sure the `VOLUMES_LOGS` path is set to a local folder in your configuration.
105+
106+
After this setup, logs will be saved automatically to the specified location.

0 commit comments

Comments
 (0)