Compare commits
13 Commits
Author | SHA1 | Date | |
---|---|---|---|
|
a540a56772 | ||
|
51147b410f | ||
|
6009688b0f | ||
|
edb2566b92 | ||
|
00c07f3db6 | ||
|
c87afae7c4 | ||
|
791dba8ff4 | ||
|
88667db760 | ||
|
0ffc28b553 | ||
|
d3be14f9f9 | ||
|
5b9a82e25c | ||
|
9affbbf742 | ||
|
c452c17583 |
2
.github/workflows/docker.yml
vendored
2
.github/workflows/docker.yml
vendored
@@ -419,7 +419,7 @@ jobs:
|
||||
if [ -f LICENSE ]; then
|
||||
git add LICENSE
|
||||
fi
|
||||
git commit -m "github-actions[bot]: update README.md"
|
||||
git commit -m "docs: auto update README.md"
|
||||
git push origin HEAD:master
|
||||
|
||||
|
||||
|
2
.json
2
.json
@@ -3,7 +3,7 @@
|
||||
"name": "netbird",
|
||||
"root": "/netbird",
|
||||
"semver": {
|
||||
"version": "0.50.3"
|
||||
"version": "0.52.2"
|
||||
},
|
||||
"readme": {
|
||||
"description": "Run netbird rootless and distroless from a single image.",
|
||||
|
80
README.md
80
README.md
@@ -1,7 +1,7 @@
|
||||

|
||||
|
||||
# NETBIRD
|
||||
[<img src="https://img.shields.io/github/issues/11notes/docker-NETBIRD?color=7842f5">](https://github.com/11notes/docker-NETBIRD/issues)
|
||||
[<img src="https://img.shields.io/github/issues/11notes/docker-NETBIRD?color=7842f5">](https://github.com/11notes/docker-NETBIRD/issues)
|
||||
|
||||
Run netbird rootless and distroless from a single image.
|
||||
|
||||
@@ -14,15 +14,20 @@ NetBird combines a WireGuard-based overlay network with Zero Trust Network Acces
|
||||
|
||||
The init binary **management** will replace all variables in the format ```${VARIABLE}``` with all environment variables present in the service.
|
||||
|
||||
> [!IMPORTANT]
|
||||
>* This image runs as 1000:1000 by default, most other images run everything as root
|
||||
>* This image has no shell since it is distroless, most other images run on a distro like Debian or Alpine with full shell access (security)
|
||||
>* This image does not ship with any critical or high rated CVE and is automatically maintained via CI/CD, most other images mostly have no CVE scanning or code quality tools in place
|
||||
>* This image is created via a secure, pinned CI/CD process and immune to upstream attacks, most other images have upstream dependencies that can be exploited
|
||||
>* This image works as read-only, most other images need to write files to the image filesystem
|
||||
>* This image is a lot smaller than most other images
|
||||
# UNIQUE VALUE PROPOSITION 💶
|
||||
**Why should I run this image and not the other image(s) that already exist?** Good question! Because ...
|
||||
|
||||
If you value security, simplicity and the ability to interact with the maintainer and developer of an image. Using my images is a great start in that direction.
|
||||
> [!IMPORTANT]
|
||||
>* ... this image runs [rootless](https://github.com/11notes/RTFM/blob/main/linux/container/image/rootless.md) as 1000:1000
|
||||
>* ... this image has no shell since it is [distroless](https://github.com/11notes/RTFM/blob/main/linux/container/image/distroless.md)
|
||||
>* ... this image is auto updated to the latest version via CI/CD
|
||||
>* ... this image has a health check
|
||||
>* ... this image runs read-only
|
||||
>* ... this image is automatically scanned for CVEs before and after publishing
|
||||
>* ... this image is created via a secure and pinned CI/CD process
|
||||
>* ... this image is very small
|
||||
|
||||
If you value security, simplicity and optimizations to the extreme, then this image might be for you.
|
||||
|
||||
# COMPARISON 🏁
|
||||
Below you find a comparison between this image and the most used or original one.
|
||||
@@ -36,7 +41,7 @@ Below you find a comparison between this image and the most used or original one
|
||||
|
||||
# VOLUMES 📁
|
||||
* **/netbird/etc** - Directory of your management.json config
|
||||
* **/netbird/var** - Directory of dynamic data from differnet init systems (relay, signal, management)
|
||||
* **/netbird/var** - Directory of dynamic data from different init systems (relay, signal, management)
|
||||
|
||||
# EXAMPLE ENV FILE 📑
|
||||
```ini
|
||||
@@ -62,6 +67,11 @@ TURN_SECRET=
|
||||
# COMPOSE ✂️
|
||||
```yaml
|
||||
name: "netbird"
|
||||
|
||||
x-image-netbird: &image
|
||||
image: "11notes/netbird:0.52.2"
|
||||
read_only: true
|
||||
|
||||
services:
|
||||
db:
|
||||
image: "11notes/postgres:16"
|
||||
@@ -69,22 +79,22 @@ services:
|
||||
environment:
|
||||
TZ: "Europe/Zurich"
|
||||
POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
|
||||
# make a full and compressed database backup each day at 03:00
|
||||
POSTGRES_BACKUP_SCHEDULE: "0 3 * * *"
|
||||
volumes:
|
||||
- "db.etc:/postgres/etc"
|
||||
- "db.var:/postgres/var"
|
||||
- "db.backup:/postgres/backup"
|
||||
# used for optional cron container to create automatic backups
|
||||
- "db.cmd:/run/cmd"
|
||||
tmpfs:
|
||||
- "/run/postgresql:uid=1000,gid=1000"
|
||||
# needed for read-only
|
||||
- "/postgres/run:uid=1000,gid=1000"
|
||||
- "/postgres/log:uid=1000,gid=1000"
|
||||
networks:
|
||||
backend:
|
||||
restart: "always"
|
||||
|
||||
dashboard:
|
||||
image: "11notes/netbird:0.48.0"
|
||||
read_only: true
|
||||
<<: *image
|
||||
environment:
|
||||
NETBIRD_MGMT_API_ENDPOINT: "https://${NETBIRD_FQDN}"
|
||||
NETBIRD_MGMT_GRPC_API_ENDPOINT: "https://${NETBIRD_FQDN}"
|
||||
@@ -117,8 +127,7 @@ services:
|
||||
db:
|
||||
condition: "service_healthy"
|
||||
restart: true
|
||||
image: "11notes/netbird:0.48.0"
|
||||
read_only: true
|
||||
<<: *image
|
||||
env_file: '.env'
|
||||
environment:
|
||||
TZ: "Europe/Zurich"
|
||||
@@ -145,7 +154,7 @@ services:
|
||||
restart: "always"
|
||||
|
||||
signal:
|
||||
image: "11notes/netbird:0.48.0"
|
||||
<<: *image
|
||||
environment:
|
||||
TZ: "Europe/Zurich"
|
||||
entrypoint: ["/usr/local/bin/signal"]
|
||||
@@ -163,7 +172,7 @@ services:
|
||||
restart: "always"
|
||||
|
||||
relay:
|
||||
image: "11notes/netbird:0.48.0"
|
||||
<<: *image
|
||||
environment:
|
||||
TZ: "Europe/Zurich"
|
||||
NB_LISTEN_ADDRESS: ":33080"
|
||||
@@ -176,22 +185,6 @@ services:
|
||||
- "33080:33080/tcp"
|
||||
restart: "always"
|
||||
|
||||
# optional images
|
||||
cron:
|
||||
depends_on:
|
||||
db:
|
||||
condition: "service_healthy"
|
||||
restart: true
|
||||
image: "11notes/cron:4.6"
|
||||
environment:
|
||||
TZ: "Europe/Zurich"
|
||||
# create daily full backup at 3 o'clock
|
||||
CRONTAB: |-
|
||||
0 3 * * * cmd-socket '{"bin":"backup"}' > /proc/1/fd/1
|
||||
volumes:
|
||||
- "db.cmd:/run/cmd"
|
||||
restart: "always"
|
||||
|
||||
volumes:
|
||||
management.etc:
|
||||
management.var:
|
||||
@@ -200,7 +193,6 @@ volumes:
|
||||
db.etc:
|
||||
db.var:
|
||||
db.backup:
|
||||
db.cmd:
|
||||
|
||||
networks:
|
||||
frontend:
|
||||
@@ -225,18 +217,18 @@ networks:
|
||||
# MAIN TAGS 🏷️
|
||||
These are the main tags for the image. There is also a tag for each commit and its shorthand sha256 value.
|
||||
|
||||
* [0.48.0](https://hub.docker.com/r/11notes/netbird/tags?name=0.48.0)
|
||||
* [0.52.2](https://hub.docker.com/r/11notes/netbird/tags?name=0.52.2)
|
||||
|
||||
### There is no latest tag, what am I supposed to do about updates?
|
||||
It is of my opinion that the ```:latest``` tag is dangerous. Many times, I’ve introduced **breaking** changes to my images. This would have messed up everything for some people. If you don’t want to change the tag to the latest [semver](https://semver.org/), simply use the short versions of [semver](https://semver.org/). Instead of using ```:0.48.0``` you can use ```:0``` or ```:0.48```. Since on each new version these tags are updated to the latest version of the software, using them is identical to using ```:latest``` but at least fixed to a major or minor version.
|
||||
It is of my opinion that the ```:latest``` tag is dangerous. Many times, I’ve introduced **breaking** changes to my images. This would have messed up everything for some people. If you don’t want to change the tag to the latest [semver](https://semver.org/), simply use the short versions of [semver](https://semver.org/). Instead of using ```:0.52.2``` you can use ```:0``` or ```:0.52```. Since on each new version these tags are updated to the latest version of the software, using them is identical to using ```:latest``` but at least fixed to a major or minor version.
|
||||
|
||||
If you still insist on having the bleeding edge release of this app, simply use the ```:rolling``` tag, but be warned! You will get the latest version of the app instantly, regardless of breaking changes or security issues or what so ever. You do this at your own risk!
|
||||
|
||||
# REGISTRIES ☁️
|
||||
```
|
||||
docker pull 11notes/netbird:0.48.0
|
||||
docker pull ghcr.io/11notes/netbird:0.48.0
|
||||
docker pull quay.io/11notes/netbird:0.48.0
|
||||
docker pull 11notes/netbird:0.52.2
|
||||
docker pull ghcr.io/11notes/netbird:0.52.2
|
||||
docker pull quay.io/11notes/netbird:0.52.2
|
||||
```
|
||||
|
||||
# SOURCE 💾
|
||||
@@ -246,7 +238,7 @@ docker pull quay.io/11notes/netbird:0.48.0
|
||||
> [!IMPORTANT]
|
||||
>This image is not based on another image but uses [scratch](https://hub.docker.com/_/scratch) as the starting layer.
|
||||
>The image consists of the following distroless layers that were added:
|
||||
>* [11notes/distroless:curl](https://github.com/11notes/docker-distroless/blob/master/curl.dockerfile) - app to execute HTTP or UNIX requests
|
||||
>* [11notes/distroless:curl](https://github.com/11notes/docker-distroless/blob/master/curl.dockerfile) - app to execute HTTP requests
|
||||
>* 11notes/distroless:nginx
|
||||
|
||||
# BUILT WITH 🧰
|
||||
@@ -259,9 +251,9 @@ docker pull quay.io/11notes/netbird:0.48.0
|
||||
|
||||
# CAUTION ⚠️
|
||||
> [!CAUTION]
|
||||
>* Because this image is distroless, it only works with PostgreSQL, not SQLite. The GeoLocation middleware is also disabled because of this!
|
||||
>* Because this image is distroless, it only works with PostgreSQL, **not SQLite**. The GeoLocation middleware is also disabled because of this!
|
||||
|
||||
# ElevenNotes™️
|
||||
This image is provided to you at your own risk. Always make backups before updating an image to a different version. Check the [releases](https://github.com/11notes/docker-netbird/releases) for breaking changes. If you have any problems with using this image simply raise an [issue](https://github.com/11notes/docker-netbird/issues), thanks. If you have a question or inputs please create a new [discussion](https://github.com/11notes/docker-netbird/discussions) instead of an issue. You can find all my other repositories on [github](https://github.com/11notes?tab=repositories).
|
||||
|
||||
*created 23.06.2025, 15:37:06 (CET)*
|
||||
*created 31.07.2025, 09:02:52 (CET)*
|
@@ -1,7 +1,7 @@
|
||||
name: "netbird"
|
||||
|
||||
x-image-netbird: &image
|
||||
image: "11notes/netbird:0.50.2"
|
||||
image: "11notes/netbird:0.52.2"
|
||||
read_only: true
|
||||
|
||||
services:
|
||||
|
Reference in New Issue
Block a user