Skip to content

Commit 870908f

Browse files
update README.md
1 parent 12a7559 commit 870908f

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Run netbird rootless and distroless from a single image.
77

88
# INTRODUCTION 📢
99

10-
NetBird combines a WireGuard-based overlay network with Zero Trust Network Access, providing a unified open source platform for reliable and secure connectivity. Create your own selfhosted ZTNA mesh network.
10+
[NetBird](https://github.com/netbirdio/netbird) (created by [netbird](https://github.com/netbirdio)) combines a WireGuard-based overlay network with Zero Trust Network Access, providing a unified open source platform for reliable and secure connectivity. Create your own selfhosted ZTNA mesh network.
1111

1212
# SYNOPSIS 📖
1313
**What can I do with this?** This image will run netbird from a single image (not multiple) [rootless](https://github.com/11notes/RTFM/blob/main/linux/container/image/rootless.md) and [distroless](https://github.com/11notes/RTFM/blob/main/linux/container/image/distroless.md) for more security. Due to the nature of a single image and not multiple, you see in the [compose.yaml](https://github.com/11notes/docker-netbird/blob/master/compose.yaml) example that an ```entrypoint:``` has been defined for each service. This image also needs some environment variables present in your **.env** file. This image's defaults (management.json) as well as the example **.env** are to be used with Keycloak as your IdP and Traefik as your reverse proxy. You can however provide your own **management.json** file and use any IdP you like and use a different reverse proxy.
@@ -75,6 +75,8 @@ x-image-netbird: &image
7575

7676
services:
7777
postgres:
78+
# for more information about this image checkout:
79+
# https://github.com/11notes/docker-postgres
7880
image: "11notes/postgres:17"
7981
read_only: true
8082
environment:
@@ -137,6 +139,8 @@ services:
137139
volumes:
138140
- "management.etc:/netbird/etc"
139141
- "management.var:/netbird/var"
142+
tmpfs:
143+
- "/tmp:uid=1000,gid=1000"
140144
networks:
141145
frontend:
142146
backend:
@@ -238,7 +242,7 @@ docker pull quay.io/11notes/netbird:0.59.2
238242
> [!IMPORTANT]
239243
>This image is not based on another image but uses [scratch](https://hub.docker.com/_/scratch) as the starting layer.
240244
>The image consists of the following distroless layers that were added:
241-
>* [11notes/distroless:curl](https://github.com/11notes/docker-distroless/blob/master/curl.dockerfile) - app to execute HTTP requests
245+
>* [11notes/distroless:localhealth](https://github.com/11notes/docker-distroless/blob/master/localhealth.dockerfile) - app to execute HTTP requests only on 127.0.0.1
242246
>* 11notes/distroless:nginx
243247
244248
# BUILT WITH 🧰
@@ -256,4 +260,4 @@ docker pull quay.io/11notes/netbird:0.59.2
256260
# ElevenNotes™️
257261
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).
258262
259-
*created 03.10.2025, 07:19:06 (CET)*
263+
*created 03.10.2025, 08:56:48 (CET)*

0 commit comments

Comments
 (0)