Skip to content

Commit 02adabf

Browse files
committed
Explain docker image tags
1 parent c029a2f commit 02adabf

2 files changed

Lines changed: 10 additions & 1 deletion

File tree

.github/workflows/docker.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ jobs:
2626
with:
2727
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
2828
tags: |
29+
type=raw,value=latest,enable={{is_default_branch}}
2930
type=ref,event=branch
3031
type=semver,pattern={{version}}
3132
type=semver,pattern={{major}}.{{minor}}

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,18 @@ BBBLB is currently in a **pre-alpha state**. It is a working prototype and **not
5050

5151
The documentation is still a work in progress. Pull requests are very welcomed!
5252

53-
# Deployment and Getting Started
53+
## Deployment and Getting Started
5454

5555
To get started, check out the docker compose based deployment example in [examples/bbblb-compose](https://github.com/defnull/bbblb/blob/main/examples/bbblb-compose) and refer to [examples/bbblb-compose/README.md](https://github.com/defnull/bbblb/blob/main/examples/bbblb-compose/README.md) for a step by step instructions.
5656

57+
Docker images are available via `ghcr.io`:
58+
59+
* `ghcr.io/defnull/bbblb:main` Main branch
60+
* `ghcr.io/defnull/bbblb:latest` Whatever tag pushed last. DO NOT USE as this can jump to older maintenance releases at the moment.
61+
* `ghcr.io/defnull/bbblb:X` Latest minor or patch release for the major version `X` (e.g. `1`)
62+
* `ghcr.io/defnull/bbblb:X.Y` Latest patch release for the minor version `X.Y` (e.g. `1.2`)
63+
* `ghcr.io/defnull/bbblb:X.Y.Z` A specific patch release `X.Y.Z` (e.g. `1.2.3`)
64+
5765
Manual deployments without docker are of cause also possible. The most complex part is not BBBLB, but the front-ent http server to get presentation playback to work. We will provide documentation in the future, pull requests are very welcomed.
5866

5967
## Configuration Options

0 commit comments

Comments
 (0)