Skip to content

Commit

Permalink
Improve surrealist troubleshooting (#873)
Browse files Browse the repository at this point in the history
  • Loading branch information
macjuul authored Sep 19, 2024
1 parent 3216732 commit 362507e
Showing 1 changed file with 44 additions and 4 deletions.
48 changes: 44 additions & 4 deletions src/content/doc-surrealist/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,24 +20,64 @@ You can open the developer tools using the following key combination
- **Windows / Linux:** `Ctrl + Shift + i`
- **MacOS:** `Command + Option + i`

### Resetting the config
### Backing up / resetting the configuration file

Removing 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

- **Linux:** `$HOME/.config/SurrealDB/Surrealist/config.json`
- **MacOS:** `$HOME/Library/Application Support/SurrealDB/Surrealist/config.json`
- **Windows:**  `{FOLDERID_RoamingAppData}\SurrealDB\Surrealist\config.json`

- **Windows:** `%AppData%\SurrealDB\Surrealist\config.json`

> [!NOTE]
> Avoid sharing your config or uploading it to public locations as it contains the authentication details to your configured connections.
### Viewing the logs

Surrealist outputs logfiles that may contain hints to the cause of the issue. You can find the logs at the following locations:

- **Linux:** `$HOME/.config/SurrealDB/Surrealist/logs`
- **MacOS:** `$HOME/Library/Application Support/SurrealDB/Surrealist/logs`
- **Windows:** `%AppData%\SurrealDB\Surrealist\logs`

> [!NOTE]
> Logfiles should not contain any sensitive information, however please review them carefully before sharing them with others.
## Connection issues

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:

### Unsupported protocols

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.

### SSL

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.

### Firewall issues

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.

### Browser restrictions

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.

### Troubleshooting connection issues

Connection issues can be notirously difficult to troubleshoot. Here are some steps you can take to diagnose the issue:

- **Connect using the CLI**: Since Surrealist always runs in a secure environment, localhost or LAN connections may be blocked by a viarety of reasons. Try connecting to the database using the [CLI](https://surrealdb.com/docs/surrealdb/cli) to see if the issue persists, as this is not subject to the same restrictions.
- **Check the logs**: The Surrealist logfiles may contain hints to the cause of the issue. Check the logs for any errors or warnings that might help you diagnose the issue.
- **Check the developer console**: You can open the developer console to reveal hidden errors or warnings that might help you diagnose the issue.
- **Check the network tab**: The network tab in the developer console may contain information on the network requests that Surrealist is making. Check for any failed requests or errors that might help you diagnose the issue.

## Submitting feedback

You are always welcome to share feedback and ask questions about Surrealist in the #surrealist channel in our [Discord](https://discord.gg/surrealdb) server.

If you have found a bug or would like to request a feature, please open an issue on our [GitHub repository](https://github.com/surrealdb/surrealist).

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

0 comments on commit 362507e

Please sign in to comment.