oura 2.2.0

The tail of Cardano
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

---
title: Docker
---

_Oura_ provides already built public Docker images through Github Packages. To execute _Oura_ via Docker, use the following command:

```sh
docker run ghcr.io/txpipe/oura:latest
```

The result of the above command should show _Oura's_ command-line help message.


## Entry Point

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 \
    daemon --help
```

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

## Available Tags

Images are published to `ghcr.io/txpipe/oura` under several tags, each following a different update trigger (see the _Updated on_ column). Pick the one that matches how closely you want to track new changes:

| Tag                | Example          | Updated on             | Description                                                              |
| :----------------- | :--------------- | :--------------------- | :---------------------------------------------------------------------- |
| `latest`           | `latest`         | every push to `main`   | Tracks the tip of the `main` branch (development builds, not a release).|
| `stable`           | `stable`         | every release          | Tracks the most recent released version.                                |
| `v{major}`         | `v2`             | every release          | Latest release within a major version.                                  |
| `v{major}.{minor}` | `v2.1`           | every release          | Latest release within a minor version.                                  |
| `v{version}`       | `v2.1.0`         | its matching release   | A specific, immutable release.                                          |
| `sha-{commit}`     | `sha-2dec504`    | every build            | A specific commit; fully immutable.                                     |

## Versioned Images

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.

To use a versioned image, replace the `latest` tag by the desired version with the `v` prefix. For example, to pin the `v2.1.0` release, use the following image:

```
ghcr.io/txpipe/oura:v2.1.0
```

You can also track a major or minor line (for example `v2` or `v2.1`) to automatically pick up compatible updates, or use `stable` to always run the most recent release. Note that `latest` follows the `main` branch rather than the latest release, so avoid it in production.