omnidbteam/omnidb repository overview

⁠Quick reference

• Maintained by: the OmniDB team

• Documentation: Docs⁠

• Where to get help: GitHub⁠

• Where to report issues: Issues⁠

⁠Supported tags

• 3.0.3b, latest⁠
• 3.0.2b⁠

⁠What is OmniDB?

OmniDB is an open source browser-based app designed to access and manage many different Database Management systems, e.g. PostgreSQL, Oracle and MySQL. OmniDB can run either as an App or via Browser, combining the flexibility needed for various access paths with a design that puts security first.

Since early development, OmniDB was designed as an browser-based app. Consequently, it runs in most browsers, from any operational system. It can be accessed by several computers and multiple users, each one of them with his/her own group of connections. It also can be hosted in any operational system, without the need of install any dependencies. We will see further details on installation in the next chapters.

OmniDB’s main objective is to offer an unified workspace with all functionalities needed to manipulate different DMBS. DBMS specific tools aren’t required: in OmniDB, the context switch between different DBMS is done with a simple connection switch, without leaving the same page. The end-user’s sensation is that there is no difference when he/she manipulates different DBMS, it just feels like different connections.

Despite this, OmniDB is built with simplicity in mind, designed to be a fast and lightweight browser-based application.

⁠How to use this image

Please be aware that we use my_container as the container name and my_volume as the volume name in the examples below. Feel free to change that to other names that fit better to your environment.

⁠Creating container

Usual ways to spawn a container are using or not using port mapping between container and host.

⁠Using port mapping

To run a container with this image you should invoke a command like:

docker run --rm --name my_container --volume my_volume:/home/omnidb/.omnidb/omnidb-server --publish 8000:8000 omnidbteam/omnidb:latest

This will create a container and spawn OmniDB server in the port 8000 of the container, mapping such port to port 8000 of the host. You can then access OmniDB by using the following URL from host:

http://127.0.0.1:8000

⁠Not using port mapping

If you don't want to use port mapping between container and host, please create the container with a command similar to:

docker run --rm --name my_container --volume my_volume:/home/omnidb/.omnidb/omnidb-server omnidbteam/omnidb:latest

Then you can access OmniDB by using the following url in your host browser:

http://<container_ip>:8000

⁠Changing configuration

OmniDB configuration can be changed by accessing volume folder and changing config.py file accordingly. After changing configuration, you have to recreate your container, so OmnIDB will reload with the new configs. You can edit the config file with the following command for example:

docker exec -it my_container vim /home/omnidb/.omnidb/omnidb-server/config.py

After changing the file, just recreate your container and changes will be applied.

⁠Creating a super user

After creating a container, you must create OmniDB super/normal users. You can create a super user by running a command similar to:

docker exec -it my_container python omnidb-server.py --createsuperuser=admin pass

This command will create a user with login admin and password pass.

In a analogous way, you can create normal users with:

docker exec -it my_container python omnidb-server.py --createuser=myuser mypass

⁠Accessing OmniDB output

You can have access to the OmniDB server output by running the command below:

docker logs my_container

⁠Accessing OmniDB logs

If you want to check messages logged by OmniDB, you can run the command below:

docker exec -it my_container tail /home/omnidb/.omnidb/omnidb-server/omnidb.log