Skip to content

Commit 9f6453f

Browse files
committed
Add docs for setting up on a Synology NAS
1 parent 370ba9f commit 9f6453f

File tree

1 file changed

+59
-0
lines changed

1 file changed

+59
-0
lines changed

docs/kb/hardware/synology.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
id: synology
3+
title: Installing netboot.xyz on Synology NAS
4+
sidebar_label: Synology NAS
5+
description: Installing netboot.xyz onto a Synology NAS in a container
6+
hide_table_of_contents: false
7+
---
8+
9+
## Overview
10+
11+
This guide will walk you through the steps to install netboot.xyz onto a [Synology NAS](https://amzn.to/430KH1n) using Docker.
12+
13+
## Requirements
14+
15+
- [Synology NAS](https://amzn.to/430KH1n) with Container Manager support
16+
- Docker package installed on the Synology NAS
17+
- Internet connection
18+
19+
### Install Container Manager
20+
21+
Open the Synology Package Center, search for "Container Manager", and click "Install".
22+
23+
### Download netboot.xyz Docker Image
24+
25+
Open Container Manager from the main menu, go to the "Registry" tab, and search for `netbootxyz`. Select the `netbootxyz/netboot.xyz` image from the list, click "Download", and choose the latest version.
26+
27+
### Create and Configure the Container
28+
29+
Go to the "Image" tab in Docker, select the `netbootxyz/netboot.xyz` image, and click "Run". In the "Create Container" wizard, configure the following settings:
30+
31+
- **General Settings**:
32+
- Container Name: `netbootxyz`
33+
- Enable "Auto-restart"
34+
35+
- **Advanced Settings**:
36+
- **Port Settings**:
37+
- Map port `3000/TCP` on the container to a desired port on the NAS, e.g., `3000`.
38+
- Map port `80/TCP` on the container to a desired port on the NAS, e.g., `8080` so it doesn't conflict with the UI.
39+
- Map port `69/UDP` on the container to a desired port on the NAS, e.g., `69` so it doesn't conflict with the UI.
40+
- **Volume**:
41+
- Click "Add Folder" and map a folder on your NAS to `/config` in the container.
42+
- Click "Add Folder" and map a folder on your NAS to `/assets` in the container.
43+
- **Network**: Set the network mode to "Bridge".
44+
- **Environment**:
45+
- Remove `TFTP_OPTS` if you aren't going to use it. Ensure NGINX port lines up to the port you mapped in the port settings. Ensure `WEB_APP_PORT` lines up to the port you mapped in the port settings.
46+
47+
Click "Apply" to create the container.
48+
49+
### Start the Container
50+
51+
Go to the "Container" tab in Docker, select the `netbootxyz` container, and click "Start".
52+
53+
### Access netboot.xyz
54+
55+
Open a web browser and navigate to the IP address of your Synology NAS on port 3000 (e.g., `http://<NAS_IP>:3000`). You should see the netboot.xyz interface. The asset folder will be mapped to `8080`, or whatever you set it to, so you can access the UI at `http://<NAS_IP>:8080`.
56+
57+
## Conclusion
58+
59+
You have successfully installed netboot.xyz on your Synology NAS using Docker. You can now use netboot.xyz to manage and boot various operating systems over the network.

0 commit comments

Comments
 (0)