Oura provides already built public Docker images through Github Packages. To execute Oura via Docker, use the following command:
docker run ghcr.io/txpipe/oura:latest
The result of the above command should show Oura's command-line help message.
The entry-point of the image points to Oura executable. You can pass the same command-line arguments that you would pass to the binary release running bare-metal. For example:
docker run -it ghcr.io/txpipe/oura:latest \ watch relays-new.cardano-mainnet.iohk.io:3001 \ --bearer tcp
For more information on available command-line arguments, check the usage section.
Using a Configuration File
The default daemon configuration file for Oura is located in
/etc/oura/daemon.toml. To run Oura in daemon mode with a custom configuration file, you need to mount it in the correct location. The following example runs a docker container in background using a configuration file named
daemon.toml located in the current folder:
docker run -d -v $(pwd)/daemon.toml:/etc/oura/daemon.toml \ ghcr.io/txpipe/oura:latest daemon
Images are also tagged with the corresponding version number. It is highly recommended to use a fixed image version in production environments to avoid the effects of new features being included in each release (please remember Oura hasn't reached v1 stability guarantees).
To use a versioned image, replace the
latest tag by the desired version with the
v prefix. For example, to use version
1.0.0, use the following image: