mirror of
https://github.com/idanoo/autobrr
synced 2025-07-23 00:39:13 +00:00
docs(install): distroless docker builds (#1500)
* chore(readme): add section about distroless docker builds * Update README.md * Update README.md * Update README.md - one of the maintainers + one of the longterm maintainers * docs: update distroless note to caution * docs: distroless make warning bold --------- Co-authored-by: ze0s <43699394+zze0s@users.noreply.github.com>
This commit is contained in:
parent
fe7709640e
commit
6dc4965f22
1 changed files with 16 additions and 0 deletions
16
README.md
16
README.md
|
@ -26,6 +26,7 @@ Full documentation can be found at [https://autobrr.com](https://autobrr.com)
|
||||||
- [QuickBox](#quickbox)
|
- [QuickBox](#quickbox)
|
||||||
- [Shared Seedbox](#shared-seedbox)
|
- [Shared Seedbox](#shared-seedbox)
|
||||||
- [Docker Compose](#docker-compose)
|
- [Docker Compose](#docker-compose)
|
||||||
|
- [Distroless docker images](#distroless-docker-images)
|
||||||
- [Windows](#windows)
|
- [Windows](#windows)
|
||||||
- [MacOS](#macos)
|
- [MacOS](#macos)
|
||||||
- [Linux Generic](#linux-generic)
|
- [Linux Generic](#linux-generic)
|
||||||
|
@ -209,6 +210,21 @@ Then start with:
|
||||||
docker compose up -d
|
docker compose up -d
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Distroless Docker Images
|
||||||
|
|
||||||
|
> [!CAUTION]
|
||||||
|
> This image comes without a shell, and external filtering and actions relying on `exec` will therefore not work with anything but compiled static binaries.
|
||||||
|
>
|
||||||
|
> To clarify: **`BASH` and `SH` shell scripts WILL NOT WORK!**
|
||||||
|
>
|
||||||
|
> Use the standard image if you rely on this functionality.
|
||||||
|
|
||||||
|
For users who prioritize container security, one of the longterm maintainers offer alternative Docker images built on [Distroless](https://github.com/GoogleContainerTools/distroless). Specifically the `distroless/static-debian12:nonroot` base image.
|
||||||
|
|
||||||
|
Distroless images do not contain a package manager or shell, thereby reducing the potential attack surface and making them a more secure option. These stripped-back images contain only the application and its runtime dependencies.
|
||||||
|
|
||||||
|
The repository for these builds can be found here: [https://github.com/s0up4200/autobrr-distroless](https://github.com/s0up4200/autobrr-distroless)
|
||||||
|
|
||||||
### Windows
|
### Windows
|
||||||
|
|
||||||
Check the Windows Setup Guide [here](https://autobrr.com/installation/windows).
|
Check the Windows Setup Guide [here](https://autobrr.com/installation/windows).
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue