If you experience issues or unintended behaviour when using Surrealist, please open an issue on our GitHub repository. Additionally check the FAQ and known issues first as they too might solve your issue. If you are still running into issues you can attempt one of the following:
The developer console may include hints to the cause of your problem. Include any errors you find inside with reported GitHub issues as it may significantly help the maintainers understand your problem.
You can open the developer tools using the following key combination
Ctrl + Shift + iCommand + Option + iRemoving your configuration file may solve issues, however you will lose configured connections and other settings. It is recommended to backup the config file before deleting it.
The config file can be found at the following location
$HOME/.config/SurrealDB/Surrealist/config.json$HOME/Library/Application Support/SurrealDB/Surrealist/config.json%AppData%\SurrealDB\Surrealist\config.jsonNoteAvoid sharing your config or uploading it to public locations as it contains the authentication details to your configured connections.
Surrealist outputs logfiles that may contain hints to the cause of the issue. You can find the logs at the following locations:
$HOME/.config/SurrealDB/Surrealist/logs$HOME/Library/Application Support/SurrealDB/Surrealist/logs%AppData%\SurrealDB\Surrealist\logsNoteLogfiles should not contain any sensitive information, however please review them carefully before sharing them with others.
Since Surrealist operates over a network connection it is possible to run into unexpected issues while attempting to connect to, or query, a database. While there are many reasons why a connection might fail, here are some common issues and their solutions:
Some protocols might not always be supported by the network configuration. For example, some networks might block the WebSocket protocol. In this case, you can switch to the HTTP or HTTPS protocol to bypass the restriction.
You might be connecting to an endpoint using the HTTPS or WSS protocol without a valid SSL certificate present on the server. In this case, you can switch to the HTTP or WS protocol to bypass the SSL verification. It is recommended to perform HTTP or WS connections through the desktop app, as web browsers might block these connections due to security reasons.
Firewalls might block Surrealist from connecting to the internet. Make sure that Surrealist is allowed to connect to the internet by checking your firewall settings.
Using the Web App you might find yourself restricted by browsers or browser extensions. Make sure to disable any browser extensions that might interfere with Surrealist, or switch to the desktop app.
Connection issues can be notirously difficult to troubleshoot. Here are some steps you can take to diagnose the issue:
You are always welcome to share feedback and ask questions about Surrealist in the #surrealist channel in our Discord server.
If you have found a bug or would like to request a feature, please open an issue on our GitHub repository.
If you have any other questions or feedback, feel free to leave some feedback using the feedback button on the righhand side of the screen.