Skip to content

Commit 01f9064

Browse files
authored
Docker tag usage (#639)
* Docker tag usage * Update README.md * Update README.md * Changed based on feedback * Feedback
1 parent 089ff32 commit 01f9064

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -165,15 +165,42 @@ For easy deployment, we've created an official Docker container. There are two v
165165
166166
The default one will run as `root`:
167167
168+
> [!WARNING]
169+
> It is discouraged to use `latest` tag for WatchTower or similar tools. The `latest` tag can reference unreleased developer, test builds, and patch releases for older versions. Use an actual version tag until transfer.sh supports major or minor version tags.
170+
168171
```bash
169172
docker run --publish 8080:8080 dutchcoders/transfer.sh:latest --provider local --basedir /tmp/
170173
```
171174
175+
### No root
176+
177+
The `-noroot` tags indicate image builds that run with least priviledge to reduce the attack surface might an application get compromised.
178+
> [!NOTE]
179+
> Using `-noroot` is **recommended**
180+
172181
The one tagged with the suffix `-noroot` will use `5000` as both UID and GID:
173182
```bash
174183
docker run --publish 8080:8080 dutchcoders/transfer.sh:latest-noroot --provider local --basedir /tmp/
175184
```
176185
186+
> [!NOTE]
187+
> Development history details at:
188+
> - https://github.com/dutchcoders/transfer.sh/pull/418
189+
190+
### Tags
191+
192+
Name | Usage
193+
--|--
194+
latest| Latest CI build, can be nightly, at commit, at tag, etc.
195+
latest-noroot| Latest CI build, can be nightly, at commit, at tag, etc. using [no root]
196+
nightly| Scheduled CI build every midnight UTC
197+
nightly-noroot| Scheduled CI build every midnight UTC using [no root]
198+
edge| Latest CI build after every commit on `main`
199+
edge-noroot| Latest CI build after every commit on `main` using [no root]
200+
x.y.z| CI build after tagging a release
201+
x.y.z-noroot| CI build after tagging a release using [no root]
202+
203+
177204
### Building the Container
178205
You can also build the container yourself. This allows you to choose which UID/GID will be used, e.g. when using NFS mounts:
179206
```bash

0 commit comments

Comments
 (0)