πŸ‘©β€πŸ”§ Troubleshooting#

Common Errors#

No module named β€˜olvid’#

The module olvid-bot was not found. If you are using a virtual environment, remember to activate it.

source .venv/bin/activate

Otherwise, install the latest version of the module using the pip command.

pip3 install olvid-bot

Client key not found#

Your client key could not be found. Please ensure it is either in your environment by running the command env, or that the .env file exists, contains the correct values and is located in the current directory.

Admin client key not found#

Unable to find an administrator client key. If you are not using administration APIs (identity or client key management), use the OlvidClient class instead of the OlvidAdminClient class.

Otherwise, check that the key is properly defined using the OLVID_ADMIN_CLIENT_KEY variable and not the OLVID_CLIENT_KEY variable.

Finally, verify using the CLI that the key you are using is valid and has administrative rights. (see Client key management)

Failed to connect to all addresses#

Your program failed to connect to the daemon. Please ensure that the daemon is running and functional.

# start daemon in the background
docker compose up -d daemon
# check daemon logs
docker compose logs -f daemon

If you have just started the daemon, please wait a little before trying again, it is possible that it has not finished its startup sequence and is therefore not ready to receive client connections yet.

If the daemon seems to be working, make sure that port 50051 is exposed or accessible from your program’s runtime environment.

In case of a different configuration than that of our installation page, remember to specify the address of the daemon. To do this, you can use the OLVID_DAEMON_URL variable as an environment variable or in a .env file.

You need to specify the domain name or IP address of the daemon, followed by the port. For example:

OLVID_DAEMON_URL=http://localhost:50051
# ou
OLVID_DAEMON_URL=http://daemon:50051

Invalid client key#

The client key you are using is not recognized by the daemon.

  • Make sure there are no conflicts between two key values across a .env file, your environment variables, and your code.

  • If you have multiple daemon instances, make sure you are connecting to the correct one.