OmniDB Config Tool

Note: the standalone omnidb-config/omnidb-config-app/ omnidb-config-server CLI utility described on this page belonged to the previous Python/Django-based build and is not part of the current release. The single omnidb-server binary only accepts -A/--app (desktop app mode) and -d/--homedir (choose the home directory), documented in the Installation chapter. The maintenance tasks the old tool offered can still be done manually, described below.

Home directory

OmniDB stores everything — the omnidb.db database (users, connections, and other app data) and a temp folder for exported files — in a single home directory. By default this is ~/.omnidb/omnidb-app (desktop mode) or ~/.omnidb/omnidb-server (server mode); pass -d /some/path to use a different one.

Create a user

There is currently no CLI option to create a user without opening OmniDB. On first run against an empty home directory, OmniDB creates a default admin/admin superuser automatically — sign in with it and create further users from the Users screen, or change the default password.

Vacuum

OmniDB has a single SQLite database, omnidb.db, storing all users, connections, and other OmniDB-related data. Since it’s a plain SQLite file, you can vacuum it with any SQLite client while OmniDB isn’t running, e.g.:

user@machine:~$ sqlite3 ~/.omnidb/omnidb-app/omnidb.db 'VACUUM;'

Reset database

If you wish to wipe out all OmniDB information and get a clean database as it was just installed, quit OmniDB and delete (or move aside) the home directory’s omnidb.db file. A new, empty one — with a fresh default admin/admin user — is created automatically the next time OmniDB starts. Use this with caution: it cannot be undone.

Delete temporary files

Exported query results (CSV/XLSX/etc.) are written to the temp folder inside the home directory. It’s safe to delete its contents manually at any time while OmniDB isn’t running; OmniDB re-creates it as needed.