# Self-host netboot.xyz

> Network boot menu for installers and rescue tools, served by the official container with its web configuration page and asset mirror.

- Page: https://levelrail.com/templates/netbootxyz/
- JSON: https://levelrail.com/templates/netbootxyz.json
- Category: Infrastructure
- Licence: Apache-2.0 (Permissive license)
- Source: https://github.com/netbootxyz/netboot.xyz
- Upstream docs: https://netboot.xyz/docs/

## Requirements
- Memory: about 256 MiB
- amd64: unknown, arm64: unknown
- Needs configuration before start: no
- Pinned image tag: 0.7.6-nbxyz27

## Services

| Service | Image | Tag | Ports | Volumes |
| --- | --- | --- | --- | --- |
| netbootxyz | netbootxyz/netbootxyz | 0.7.6-nbxyz27 | 3000, 8080 | config -> /config; assets -> /assets |

## Deploy

### CLI

```bash
levelrail-cli templates deploy netbootxyz --name my-netbootxyz
```

### API

```bash
curl -X POST -H "Authorization: Bearer $TOKEN" \
  https://levelrail.example.com/api/v1/service-templates/netbootxyz/deploy
```

Create a token in the dashboard first. This one-click route deploys it as a trial app you can keep or remove.

## First run
1. Open the address to manage menus and download boot assets. Boot clients still need DHCP options pointing at this host's TFTP port.

## Questions

### Can I deploy netboot.xyz on Dokploy or Dokku?

The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list we compared does not have an entry with the same id for netboot.xyz, so on Dokploy you would use a Docker Compose application with the file from this page. Dokku deploys container images with its own commands, so the pinned image netbootxyz/netbootxyz:0.7.6-nbxyz27 is what you deploy there.

Self-host netboot.xyz, netboot.xyz docker compose file, deploy netboot.xyz on a VPS: this page lists the pinned image, ports, volumes and the commands for each.
