Skip to content

Commit

Permalink
chore: render README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bot-ross[bot] committed Apr 14, 2024
1 parent 3d02e59 commit 6833e69
Showing 1 changed file with 16 additions and 17 deletions.
33 changes: 16 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,24 @@ The goal of this project is to support [semantically versioned](https://semver.o

It also adheres to a [KISS principle](https://en.wikipedia.org/wiki/KISS_principle), logging to stdout, [one process per container](https://testdriven.io/tips/59de3279-4a2d-4556-9cd0-b444249ed31e/), no [s6-overlay](https://github.com/just-containers/s6-overlay) and all images are built on top of [Alpine](https://hub.docker.com/_/alpine) or [Ubuntu](https://hub.docker.com/_/ubuntu).

## Tag immutability

The containers built here do not use immutable tags, as least not in the more common way you have seen from [linuxserver.io](https://fleet.linuxserver.io/) or [Bitnami](https://bitnami.com/stacks/containers).

We do take a similar approach but instead of appending a `-ls69` or `-r420` prefix to the tag we instead insist on pinning to the sha256 digest of the image, while this is not as pretty it is just as functional in making the images immutable.

| Container | Immutable |
|----------------------------------------------------|-----------|
| `ghcr.io/onedr0p/sonarr:rolling` ||
| `ghcr.io/onedr0p/sonarr:3.0.8.1507` ||
| `ghcr.io/onedr0p/sonarr:rolling@sha256:8053...` ||
| `ghcr.io/onedr0p/sonarr:3.0.8.1507@sha256:8053...` ||

_If pinning an image to the sha256 digest, tools like [Renovate](https://github.com/renovatebot/renovate) support updating the container on a digest or application version change._

## Rootless

To run these containers as non-root make sure you update your configuration.
To run these containers as non-root make sure you update your configuration to the user and group you want.

### Docker compose

Expand Down Expand Up @@ -61,29 +76,13 @@ spec:
spec:
# ...
securityContext:
runAsNonRoot: true
runAsUser: 65534
runAsGroup: 65534
fsGroup: 65534
fsGroupChangePolicy: OnRootMismatch
# ...
```

## Tag immutability

The containers built here do not use immutable tags, as least not in the more common way you have seen from [linuxserver.io](https://fleet.linuxserver.io/) or [Bitnami](https://bitnami.com/stacks/containers).

We do take a similar approach but instead of appending a `-ls69` or `-r420` prefix to the tag we instead insist on pinning to the sha256 digest of the image, while this is not as pretty it is just as functional in making the images immutable.

| Container | Immutable |
|----------------------------------------------------|-----------|
| `ghcr.io/onedr0p/sonarr:rolling` ||
| `ghcr.io/onedr0p/sonarr:3.0.8.1507` ||
| `ghcr.io/onedr0p/sonarr:rolling@sha256:8053...` ||
| `ghcr.io/onedr0p/sonarr:3.0.8.1507@sha256:8053...` ||

_If pinning an image to the sha256 digest, tools like [Renovate](https://github.com/renovatebot/renovate) support updating the container on a digest or application version change._

## Passing arguments to a application

Some applications do not support defining configuration via environment variables and instead only allow certain config to be set in the command line arguments for the app. To circumvent this, for applications that have an `entrypoint.sh` read below.
Expand Down

0 comments on commit 6833e69

Please sign in to comment.