Skip to main content

Troubleshooting

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. Alternatively, you may also directly email our company address if the issue is confidential.

Please also attach a log file. We recommend you to read: How to Collect Logs.

All-Rounder Solutions that Fix Most Problems​

I can't mention these in every single Section below, so before you try to solve anything, try these:

  • Check if the server is running healthy and is reachable from your client.
  • Restart GameVault Client and Server.
  • Examine Client and Server Logs for error details. (Set SERVER_LOG_LEVEL to debug)
  • Check Server for any issues with Configuration.

Common Problems and Solutions​

Incorrect Game Mapping​

  • Refer to this for instructions on how to remap your games.

Server fails to save media / create SQLITE Database / index games / throws a Permissions Denied / No Permission / EACCES error​

This is most probably a permissions issue due to the fact that gamevault runs as a non-root user (1000:1000) by default for security purposes.

Either make sure this user has permissions to read/write to the folders you map in as volumes, or run GameVault with a user that has the permissions to do so. You can do this by using the PUID & PGID environment variables.

Unable to Connect to Server / 500 Internal Server Error​

  • Ensure that you use the correct protocol (http or https) in the connection string, particularly if your server doesn't support SSL.
  • If you have disabled authentication in your server configuration, make sure to include the authentication header for user-specific requests. See here for more information.

Initial Admin User is not working​

  • You need to register the first user. It is automatically activated and granted admin permissions.

Games Not Appearing in the Installations / Servers List​

Missing Box Arts​

Lack of Metadata in Games​

Lost my Admin Role​

  • Refer to this for instructions on how to regain admin privileges for your user.

Forgot my Admin Password​

  • Refer to this for instructions on how to reset the password of your admin user.

Game Downloads are slow​

  • Make sure the Clients Bandwidth Speed Limit is unset under Settings -> Application
  • Make sure the Servers Bandwidth Speed Limit is unset (SERVER_MAX_DOWNLOAD_BANDWIDTH_IN_KBPS environment variable unset or 0)
  • Restart your Client and Server
  • If your server is in your LAN, make sure you don't mistakenly access it from WAN
  • Check your middle-mans: Proxies, VPNs and older Network Hardware could all affect the download speeds.

How to Collect Logs​

To help us resolve your issue quickly and accurately, please set the server environment variable SERVER_LOG_LEVEL to debug before collecting the logs, and include a complete log file (from server start to when the issue occurs).

full logs needed

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. 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.

Unsure how to gather logs?​

If you're not sure how to gather logs, or your system makes it unclear you can use GameVault's Built-in Logging feature:

  1. Enable logging:

    Set the environment variable SERVER_LOG_FILES_ENABLED to true

  2. Set the log folder:

    • If you're using Docker:
      Bind a local folder to /logs using the docker volumes feature.

    • If you're running natively:
      Make sure the VOLUMES_LOGS path is set to a local folder in your configuration.

After this setup, logs will be saved automatically to the specified location.