1+ name : netbird
2+ services :
3+ netbird :
4+ image : netbirdio/netbird:0.62.3
5+ container_name : netbird
6+ network_mode : host
7+ restart : unless-stopped
8+ cap_add :
9+ - NET_ADMIN
10+ - SYS_ADMIN
11+ - SYS_RESOURCE
12+ deploy :
13+ resources :
14+ reservations :
15+ memory : 128M
16+ environment :
17+ NB_SETUP_KEY : " "
18+ NB_MANAGEMENT_URL : " "
19+ NB_HOSTNAME : " Zima"
20+ NB_ENABLE_SSH_ROOT : " true"
21+ NB_ALLOW_SERVER_SSH : " true"
22+ volumes :
23+ - type : bind
24+ source : /DATA/AppData/$AppID
25+ target : /var/lib/netbird
26+ x-casaos :
27+ envs :
28+ - container : NB_SETUP_KEY
29+ description :
30+ en_US : NetBird Setup Key (get from your dashboard at app.netbird.io or your self-hosted instance)
31+ en_GB : NetBird Setup Key (get from your dashboard at app.netbird.io or your self-hosted instance)
32+ zh_CN : NetBird 设置密钥(从 app.netbird.io 或您的自托管实例获取)
33+ ja_JP : NetBirdセットアップキー(app.netbird.ioまたはセルフホストインスタンスから取得)
34+ - container : NB_MANAGEMENT_URL
35+ description :
36+ en_US : NetBird Management URL (optional, for self-hosted instances)
37+ en_GB : NetBird Management URL (optional, for self-hosted instances)
38+ zh_CN : NetBird 管理 URL(可选,用于自托管实例)
39+ ja_JP : NetBird管理URL(オプション、セルフホストインスタンス用)
40+ - container : NB_HOSTNAME
41+ description :
42+ en_US : Hostname for this NetBird client
43+ en_GB : Hostname for this NetBird client
44+ zh_CN : 此 NetBird 客户端的主机名
45+ ja_JP : このNetBirdクライアントのホスト名
46+ - container : NB_ENABLE_SSH_ROOT
47+ description :
48+ en_US : Enable SSH access as root user
49+ en_GB : Enable SSH access as root user
50+ zh_CN : 启用 root 用户 SSH 访问
51+ ja_JP : rootユーザーでのSSHアクセスを有効にする
52+ - container : NB_ALLOW_SERVER_SSH
53+ description :
54+ en_US : Allow SSH server access through NetBird
55+ en_GB : Allow SSH server access through NetBird
56+ zh_CN : 允许通过 NetBird 访问 SSH 服务器
57+ ja_JP : NetBird経由のSSHサーバーアクセスを許可
58+ volumes :
59+ - container : /var/lib/netbird
60+ description :
61+ en_US : NetBird State Directory
62+ en_GB : NetBird State Directory
63+ zh_CN : NetBird 状态目录
64+ ja_JP : NetBird状態ディレクトリ
65+ x-casaos :
66+ architectures :
67+ - amd64
68+ - arm64
69+ main : netbird
70+ category : Network
71+ developer : NetBird GmbH
72+ author : NetBird Team
73+ tagline :
74+ en_US : Connect your devices into a secure WireGuard®-based overlay network with SSO, MFA and granular access controls.
75+ en_GB : Connect your devices into a secure WireGuard®-based overlay network with SSO, MFA and granular access controls.
76+ zh_CN : 将设备连接到安全的 WireGuard® 覆盖网络,支持 SSO、MFA 和细粒度访问控制。
77+ ja_JP : SSO、MFA、きめ細かなアクセス制御を備えた安全なWireGuard®ベースのオーバーレイネットワークにデバイスを接続します。
78+ description :
79+ en_US : |
80+ NetBird combines a WireGuard®-based overlay network with Zero Trust Network Access, providing a unified open source platform for reliable and secure connectivity.
81+
82+ - Secure Remote Access – Enable least privilege network access in a few clicks
83+ - Zero-Config Deployment – Replace legacy VPNs with a peer-to-peer WireGuard®-based network
84+ - Seamless SSO with MFA – Secure your network access with session-based SSO & MFA
85+ - Dynamic Posture Checks – Grant access only to devices meeting your security rules
86+ - Centralized Network Management – Control your private network from a single place
87+ - Detailed Activity Logging – Identify who did what, and when in your network
88+
89+ **Learn More:**
90+ - [NetBird Website](https://netbird.io)
91+ - [Documentation](https://docs.netbird.io)
92+ - [Self-Hosting Guide](https://docs.netbird.io/selfhosted/selfhosted-quickstart)
93+ - [NetBird GitHub](https://github.com/netbirdio/netbird)
94+ - [Slack Community](https://docs.netbird.io/slack-url)
95+ en_GB : |
96+ NetBird combines a WireGuard®-based overlay network with Zero Trust Network Access, providing a unified open source platform for reliable and secure connectivity.
97+
98+ - Secure Remote Access – Enable least privilege network access in a few clicks
99+ - Zero-Config Deployment – Replace legacy VPNs with a peer-to-peer WireGuard®-based network
100+ - Seamless SSO with MFA – Secure your network access with session-based SSO & MFA
101+ - Dynamic Posture Checks – Grant access only to devices meeting your security rules
102+ - Centralised Network Management – Control your private network from a single place
103+ - Detailed Activity Logging – Identify who did what, and when in your network
104+
105+ **Learn More:**
106+ - [NetBird Website](https://netbird.io)
107+ - [Documentation](https://docs.netbird.io)
108+ - [Self-Hosting Guide](https://docs.netbird.io/selfhosted/selfhosted-quickstart)
109+ - [NetBird GitHub](https://github.com/netbirdio/netbird)
110+ - [Slack Community](https://docs.netbird.io/slack-url)
111+ zh_CN : |
112+ NetBird 将基于 WireGuard® 的覆盖网络与零信任网络访问相结合,提供一个统一的开源平台,实现可靠且安全的连接。
113+
114+ - 安全远程访问 – 轻松实现最小权限网络访问
115+ - 零配置部署 – 使用点对点 WireGuard® 网络取代传统 VPN
116+ - 无缝 SSO 与 MFA – 通过基于会话的 SSO 和 MFA 保护网络访问
117+ - 动态 Posture 检查 – 仅允许符合安全规则的设备访问
118+ - 集中网络管理 – 从单一位置控制您的私有网络
119+ - 详细活动日志 – 识别网络中的操作者和操作时间
120+
121+ **了解更多:**
122+ - [NetBird 官网](https://netbird.io)
123+ - [文档](https://docs.netbird.io)
124+ - [自托管指南](https://docs.netbird.io/selfhosted/selfhosted-quickstart)
125+ - [NetBird GitHub](https://github.com/netbirdio/netbird)
126+ - [Slack 社区](https://docs.netbird.io/slack-url)
127+ ja_JP : |
128+ NetBirdはWireGuard®ベースのオーバーレイネットワークとゼロトラストネットワークアクセスを組み合わせ、信頼性とセキュリティを備えた統合オープンソースプラットフォームを提供します。
129+
130+ - 安全なリモートアクセス – 数回のクリックで最小権限ネットワークアクセスを有効化
131+ - ゼロ設定デプロイメント – ピアツーピアWireGuard®ベースネットワークでレガシーVPNを置き換え
132+ - シームレスなSSOとMFA – セッションベースのSSOとMFAでネットワークアクセスを保護
133+ - 動的ポスチャチェック – セキュリティルールを満たすデバイスにのみアクセスを許可
134+ - 集中ネットワーク管理 – 単一の場所からプライベートネットワークを制御
135+ - 詳細なアクティビティログ – ネットワーク内で誰が、いつ、何を行ったかを特定
136+
137+ **詳細:**
138+ - [NetBird ウェブサイト](https://netbird.io)
139+ - [ドキュメント](https://docs.netbird.io)
140+ - [セルフホストガイド](https://docs.netbird.io/selfhosted/selfhosted-quickstart)
141+ - [NetBird GitHub](https://github.com/netbirdio/netbird)
142+ - [Slack コミュニティ](https://docs.netbird.io/slack-url)
143+ icon : https://cdn.jsdelivr.net/gh/IceWhaleTech/CasaOS-AppStore@main/Apps/NetBird/icon.png
144+ screenshot_link :
145+ - https://cdn.jsdelivr.net/gh/IceWhaleTech/CasaOS-AppStore@main/Apps/NetBird/screenshot-1.png
146+ - https://cdn.jsdelivr.net/gh/IceWhaleTech/CasaOS-AppStore@main/Apps/NetBird/screenshot-2.png
147+ - https://cdn.jsdelivr.net/gh/IceWhaleTech/CasaOS-AppStore@main/Apps/NetBird/screenshot-3.png
148+ thumbnail : https://cdn.jsdelivr.net/gh/IceWhaleTech/CasaOS-AppStore@main/Apps/NetBird/thumbnail.png
149+ scheme : " https"
150+ hostname : " app.netbird.io"
151+ port_map : " "
152+ index : /
153+ title :
154+ en_US : NetBird
155+ tips :
156+ before_install :
157+ en_US : |
158+ ### Getting Started
159+
160+ 1. Visit your NetBird dashboard ([app.netbird.io](https://app.netbird.io) or your self-hosted instance) and log in or create a new account
161+ 2. Navigate to the **Setup Keys** page
162+ 3. Click **Create Setup Key** to create a new key
163+ 4. Give your key a name (e.g., "Zima Server") and copy the generated setup key
164+ 5. In ZimaOS, click the settings icon in the top-right corner of the app tile
165+ 6. Paste the setup key in the **NB_SETUP_KEY** field
166+ 7. (Optional) If using a self-hosted NetBird dashboard, enter the URL in **NB_MANAGEMENT_URL**
167+ 8. (Optional) Customize the hostname in **NB_HOSTNAME** (default: Zima)
168+ 9. Save and restart the app
169+
170+ Your device will now appear in your NetBird dashboard and can connect to other devices in your mesh network.
171+ en_GB : |
172+ ### Getting Started
173+
174+ 1. Visit your NetBird dashboard ([app.netbird.io](https://app.netbird.io) or your self-hosted instance) and log in or create a new account
175+ 2. Navigate to the **Setup Keys** page
176+ 3. Click **Create Setup Key** to create a new key
177+ 4. Give your key a name (e.g., "Zima Server") and copy the generated setup key
178+ 5. In ZimaOS, click the settings icon in the top-right corner of the app tile
179+ 6. Paste the setup key in the **NB_SETUP_KEY** field
180+ 7. (Optional) If using a self-hosted NetBird dashboard, enter the URL in **NB_MANAGEMENT_URL**
181+ 8. (Optional) Customise the hostname in **NB_HOSTNAME** (default: Zima)
182+ 9. Save and restart the app
183+
184+ Your device will now appear in your NetBird dashboard and can connect to other devices in your mesh network.
185+ zh_CN : |
186+ ### 入门
187+
188+ 1. 访问您的 NetBird 仪表板([app.netbird.io](https://app.netbird.io) 或您的自托管实例)并登录或创建新账户
189+ 2. 导航到 **Setup Keys** 页面
190+ 3. 点击 **Create Setup Key** 创建新密钥
191+ 4. 为您的密钥命名(例如"Zima Server")并复制生成的设置密钥
192+ 5. 在 ZimaOS 中,点击应用图块右上角的设置图标
193+ 6. 在 **NB_SETUP_KEY** 字段中粘贴设置密钥
194+ 7. (可选)如果使用自托管的 NetBird 仪表板,请在 **NB_MANAGEMENT_URL** 中输入 URL
195+ 8. (可选)在 **NB_HOSTNAME** 中自定义主机名(默认:Zima)
196+ 9. 保存并重启应用
197+
198+ 您的设备现在将出现在您的 NetBird 仪表板中,并可以连接到网格网络中的其他设备。
199+ ja_JP : |
200+ ### はじめに
201+
202+ 1. NetBirdダッシュボード([app.netbird.io](https://app.netbird.io) またはセルフホストインスタンス)にアクセスしてログインまたは新規アカウントを作成
203+ 2. **Setup Keys** ページに移動
204+ 3. **Create Setup Key** をクリックして新しいキーを作成
205+ 4. キーに名前を付け(例:「Zima Server」)、生成されたセットアップキーをコピー
206+ 5. ZimaOSで、アプリタイルの右上にある設定アイコンをクリック
207+ 6. **NB_SETUP_KEY** フィールドにセットアップキーを貼り付け
208+ 7. (オプション)セルフホストの NetBird ダッシュボードを使用している場合、**NB_MANAGEMENT_URL** に URL を入力
209+ 8. (オプション)**NB_HOSTNAME** でホスト名をカスタマイズ(デフォルト:Zima)
210+ 9. 保存してアプリを再起動
211+
212+ これでデバイスがNetBirdダッシュボードに表示され、メッシュネットワーク内の他のデバイスと接続できるようになります。
0 commit comments