← Directory

NUT

NUT is a Docker container for a Nintendo Switch NSP/XCI transfer server that serves game files to Tinfoil over your local network, making it easy to install…

  • Game Servers
  • Other
NUT is a Docker container for a Nintendo Switch NSP/XCI transfer server that serves game files to Tinfoil over your local network, making it easy to install and manage homebrew Switch titles from your homelab.

Platform availability

Available on 1 of 9 platforms

  • Unraid
  • TrueNAS (not listed)
  • Umbrel (not listed)
  • ZimaOS (not listed)
  • Proxmox (not listed)
  • Helm (not listed)
  • Mac (not listed)
  • Windows (not listed)
  • Linux (not listed)

Health score?A 0-100 score computed nightly from four factors: maintained (40%: recent commits and steady activity), popular (25%: GitHub stars, log scale), easy to install (20%: platforms, install notes, setup guides, Docker image) and light to run (15%: minimum RAM, ARM support). When the source code has been checked, a fifth factor, security check (20%: automated scan for committed secrets, unsafe desktop-app settings, known-vulnerable dependencies and project hygiene; any serious finding caps it at 20), is added. Factors without data are left out and the rest are rescaled.

45/100 Fair

Maintained
59last commit 163 days ago
Popular
3984 GitHub stars
Easy to install
351 install platform, install notes, Docker image
Light to run
304 GB minimum RAM

Availability: platform listings confirmed today, links checked 10 days ago

GitHub stars
84
Open issues
4
Last commit
2026-05-05
Latest release
v3.4.0
License
GPL-3.0
Activity
stale

Checked 7 days ago - source: GitHub (shawly/docker-nut)

Resources & Compatibility

Minimum requirements: 4 GB RAM, 2 GB disk. ARM (e.g. Raspberry Pi) is not supported.

Checked 17 days ago - source: Docker Hub image tags and published docs

First-install notes

  • Install Node.js 22 or newer first Make sure Node.js 22.x or later is installed, then run npm install @nut-tree/nut-js in your project. Node.js is the program that runs nut.js, and older versions can cause the install or startup to fail. source
  • Run a quick mouse test after installing Run the docs' small mouse-position test with tsx, a tool that lets Node.js run TypeScript directly, to confirm nut.js can talk to your system. If it errors, the library is not set up correctly and your automation will not work. source
  • Set nut.js options once before automating Set keyboard, mouse, and screen options once at the start, such as delays between actions, mouse speed, the image folder, and how sure an image match must be. Skipping this can make actions too fast, image searches look in the wrong folder, or matching miss targets. source
  • Basic Setup Install Tinfoil on your Nintendo Switch, then connect it to the NUT Docker container at your homelab's IP address to transfer NSP and XCI game files. source

Fetched yesterday - each note links to its source

Alternatives

No alternatives collected yet.

Common questions

Which Docker image tag should a cautious self-hoster use?

Use latest or a version tag such as v3. The edge tag is a development build and can contain bugs or breaking changes.

Does the quick start command publish a port?

Yes, it uses docker run -d --name=nut and includes a -p flag to publish a port.

Is there a Docker Compose example in the docs?

Yes, the README includes a Docker Compose File section.

Does the documentation cover using the NUT API?

Yes, the README includes a Using the NUT API section.

Answers sourced from github.com

Community

Collected 11 days ago - public community threads