AllMyPrinters

For NAS and Raspberry Pi

Install the agent, step by step

Pick your system, copy each line with one click and paste it. You don’t need to know Docker. It takes about 10 minutes.

Your settings

Choose a password for the agent’s web page. We put it into every command below, so you only copy and paste. It stays in this browser tab and is not sent anywhere.

At least 6 characters: letters, numbers, - _ . (no spaces), so the commands work everywhere. Leave 8090 unless another program already uses it.

Pick your system

Not sure? A mini PC (like a NUC) or a Raspberry Pi with Ubuntu, Debian or Raspberry Pi OS counts as “Linux”. If you already manage your containers in Portainer, pick Portainer.

Linux: mini PC, NUC, Raspberry Pi, home server

  1. Open a terminal on the device

    Sitting at the device: open the Terminal app. From another computer: open PowerShell (Windows) or Terminal (Mac) and connect with SSH. Replace user with your user name on the device and the numbers with its IP address (your router’s device list shows it):

    The first time you connect, type yes. While you type the password, nothing appears on the screen. That is normal, just press Enter.

  2. Check that Docker is installed

    Paste this and press Enter:

    docker --version

    You see something like Docker version 27.3.1? Then go on to step 3. You see command not found? Then install Docker with this line, it takes a few minutes:

    curl -fsSL https://get.docker.com | sudo sh

    On a Raspberry Pi, also run uname -m. It has to say aarch64. If it says armv7l, the Pi runs a 32-bit system: install Raspberry Pi OS (64-bit) first.

  3. Start the agent

    Paste this line. It already contains your password from above. If sudo asks for a password, it is the one of your user on the device:

    sudo docker run -d --name allmyprinters-agent --restart unless-stopped --network host -e AMP_PASSWORD=YourPassword -e AMP_PORT=8090 -e AMP_LANG=en -v allmyprinters-agent:/data ghcr.io/nolimitek/allmyprinters-agent:latest

    The first start downloads the agent, which can take a minute or two. At the end you see a long line of letters and numbers. That means it worked.

  4. Check that it runs and find the address

    Paste this:

    sudo docker ps --filter name=allmyprinters-agent

    Under STATUS it should say Up, and after about a minute (healthy). Now get the address of the device:

    hostname -I

    The first number, for example 192.168.1.50, is the address. Continue below with “Open the agent”.

Update later

Run this line. It downloads the newest version and starts the agent again with the same settings. Your data stays.

sudo docker pull ghcr.io/nolimitek/allmyprinters-agent:latest && sudo docker rm -f allmyprinters-agent && sudo docker run -d --name allmyprinters-agent --restart unless-stopped --network host -e AMP_PASSWORD=YourPassword -e AMP_PORT=8090 -e AMP_LANG=en -v allmyprinters-agent:/data ghcr.io/nolimitek/allmyprinters-agent:latest
Remove the agent

Stops and removes the agent. Your data stays, so you can start it again at any time:

sudo docker rm -f allmyprinters-agent

To also delete all of its data (printers, spools, history, library). This cannot be undone:

sudo docker volume rm allmyprinters-agent

Synology NAS (DSM 7.2 or newer)

  1. Install Container Manager

    In DSM, open Package Center, search for Container Manager and install it. If your DSM is older than 7.2, update it first: before 7.2 the package was called Docker and could not create projects.

  2. Create a folder

    Open File Station. In the shared folder docker (Container Manager created it), create a new folder named allmyprinters-agent.

  3. Create the project

    Open Container Manager → Project → Create and fill in:

    • Project name: allmyprinters-agent
    • Path: click Set path and pick docker → allmyprinters-agent
    • Source: Create docker-compose.yml

    Paste this into the text box. It already contains your password:

    services:
      allmyprinters-agent:
        image: ghcr.io/nolimitek/allmyprinters-agent:latest
        container_name: allmyprinters-agent
        restart: unless-stopped
        network_mode: host
        environment:
          AMP_PASSWORD: "YourPassword"
          AMP_PORT: "8090"
          AMP_LANG: "en"
        volumes:
          - allmyprinters-agent:/data
    volumes:
      allmyprinters-agent:
        name: allmyprinters-agent

    Click Next. Leave the web portal (Web Station) switched off, click Next again and then Done. Container Manager downloads the agent and starts it, which can take a minute or two.

  4. Check that it runs

    Under Container, allmyprinters-agent should show Running. The address is the one you use to open DSM, without :5000, for example 192.168.1.50. Continue below with “Open the agent”.

Update later

Container Manager looks for new versions about once a day. When Image shows “Update available” next to the agent, select it and choose Update. Container Manager restarts the agent with the new version, your data stays.

Remove the agent

Project → allmyprinters-agent → Action → Stop, then Delete. The agent’s data stays on the NAS. To delete it too, run this over SSH (cannot be undone):

sudo docker volume rm allmyprinters-agent

Unraid

  1. Make sure Docker is on

    Settings → Docker: “Enable Docker” has to be Yes. It is on by default.

  2. Open the terminal

    Click the terminal icon >_ at the top right of the Unraid web interface.

  3. Start the agent

    Paste this line and press Enter. It already contains your password:

    docker run -d --name allmyprinters-agent --restart always --network host -e AMP_PASSWORD=YourPassword -e AMP_PORT=8090 -e AMP_LANG=en -v allmyprinters-agent:/data ghcr.io/nolimitek/allmyprinters-agent:latest

    The first start downloads the agent. At the end you see a long line of letters and numbers. That means it worked.

  4. Check that it runs

    In the Docker tab, allmyprinters-agent now shows as started. Unraid marks it as a container without a template, that is fine. The address is the one of your Unraid server, for example 192.168.1.50. Continue below with “Open the agent”.

Update later

Unraid’s own update button does not work for containers started this way. Open the terminal and run this line instead. Your data stays:

docker pull ghcr.io/nolimitek/allmyprinters-agent:latest && docker rm -f allmyprinters-agent && docker run -d --name allmyprinters-agent --restart always --network host -e AMP_PASSWORD=YourPassword -e AMP_PORT=8090 -e AMP_LANG=en -v allmyprinters-agent:/data ghcr.io/nolimitek/allmyprinters-agent:latest
Remove the agent

Stops and removes the agent. Your data stays:

docker rm -f allmyprinters-agent

To also delete all of its data. This cannot be undone:

docker volume rm allmyprinters-agent

Portainer

  1. Add a stack

    Log in to Portainer, pick your environment (usually local) and click Stacks → Add stack.

  2. Paste the agent

    Name: allmyprinters-agent. Build method: Web editor. Paste this into the editor. It already contains your password:

    services:
      allmyprinters-agent:
        image: ghcr.io/nolimitek/allmyprinters-agent:latest
        container_name: allmyprinters-agent
        restart: unless-stopped
        network_mode: host
        environment:
          AMP_PASSWORD: "YourPassword"
          AMP_PORT: "8090"
          AMP_LANG: "en"
        volumes:
          - allmyprinters-agent:/data
    volumes:
      allmyprinters-agent:
        name: allmyprinters-agent
  3. Start it

    Scroll down and click Deploy the stack. Portainer downloads the agent and starts it, which can take a minute.

  4. Check that it runs

    Under Containers, allmyprinters-agent should show running, and after about a minute healthy. The address is the IP of the device Portainer runs on, for example 192.168.1.50. Continue below with “Open the agent”.

Update later

Stacks → allmyprinters-agent → Editor → Update the stack. In the dialog, switch on Re-pull image and redeploy and confirm. Your data stays.

Remove the agent

Stacks → tick allmyprinters-agent → Remove. The agent’s data stays in the volume allmyprinters-agent. To delete it too, remove that volume under Volumes (cannot be undone).

Windows PC or Mac with Docker Desktop

Docker Desktop cannot give the agent direct access to your network. The agent works, but its search does not find Bambu Lab and Elegoo printers: add those with their IP address. The computer has to stay on and must not go to sleep, otherwise the agent stops too.

  1. Install Docker Desktop

    Already installed, for example for another container? Then skip this step. Otherwise download Docker Desktop from docker.com, install it and start it.

    Then in Docker Desktop open Settings → General and switch on “Start Docker Desktop when you sign in to your computer”, so the agent comes back after a restart.

  2. Find the address of this computer

    Windows: open PowerShell (Start menu, type “PowerShell”) and run ipconfig. Take the IPv4 Address of your network adapter (Ethernet or Wi-Fi), for example 192.168.1.50.

    Mac: System Settings → Network → your connection shows the IP address.

    Enter it here, the command in step 3 updates itself:

  3. Start the agent

    Paste this line into PowerShell (Windows) or Terminal (Mac) and press Enter. It already contains your password and the address:

    docker run -d --name allmyprinters-agent --restart unless-stopped -p 8090:8090 -e AMP_PASSWORD=YourPassword -e AMP_PORT=8090 -e AMP_LANG=en -e AMP_LAN_IP=192.168.1.50 -v allmyprinters-agent:/data ghcr.io/nolimitek/allmyprinters-agent:latest

    The first start downloads the agent, which can take a minute or two. If Windows asks whether Docker may use the network, allow it for private networks.

  4. Check that it runs

    In Docker Desktop under Containers, allmyprinters-agent should show as running. On this computer you can open the agent at http://localhost:8090. Continue below with “Open the agent”.

Update later

Run this line in PowerShell or Terminal. It downloads the newest version and starts the agent again. Your data stays:

docker pull ghcr.io/nolimitek/allmyprinters-agent:latest; docker rm -f allmyprinters-agent; docker run -d --name allmyprinters-agent --restart unless-stopped -p 8090:8090 -e AMP_PASSWORD=YourPassword -e AMP_PORT=8090 -e AMP_LANG=en -e AMP_LAN_IP=192.168.1.50 -v allmyprinters-agent:/data ghcr.io/nolimitek/allmyprinters-agent:latest
Remove the agent

Stops and removes the agent. Your data stays:

docker rm -f allmyprinters-agent

To also delete all of its data. This cannot be undone:

docker volume rm allmyprinters-agent

Home Assistant OS (app)

Needs Home Assistant OS or a Supervised installation. If your Home Assistant itself runs in Docker, follow the Linux steps on that machine instead. You don’t need the password field at the top: Home Assistant takes care of the login.

  1. Add the repository

    Click the button. Your Home Assistant opens and asks whether to add the AllMyPrinters repository. Confirm with Add.

    Add to Home Assistant

    The button needs you to be signed in to Home Assistant in this browser. Otherwise open the app store in Home Assistant, ⋮ at the top right → Repositories, and add this address:

    https://github.com/nolimitek/ha-allmyprinters
  2. Install the app

    Reload the app store and open AllMyPrinters Agent. Click Install, then Start, and switch on Show in sidebar.

  3. Open it

    Click AllMyPrinters in the sidebar. That is the agent, with printers, spools and settings just like in the app. You can skip “Open the agent” below.

  4. Optional: entities and dashboards

    For printers, spools, camera and pause/cancel as entities, install the AllMyPrinters integration in HACS (custom repository, same address as above, type Integration) and restart Home Assistant. It then shows up under Settings → Devices & services → Discovered, you only confirm it.

Update later

Home Assistant offers updates under Settings → Updates, like for every other app. Your data stays and is part of your Home Assistant backups.

Remove the agent

Settings → Apps → AllMyPrinters Agent → Uninstall. This also deletes the agent’s data in Home Assistant. To keep it, save a file first in the agent under Settings → Backup.

Then, on every system

  1. Open the agent

    On any computer, tablet or phone in your home network, open http://<address>:8090 in the browser, for example http://192.168.1.50:8090. Log in with your password and save the page as a bookmark.

  2. Connect the app

    In the agent: More → Settings → Pair devices → Add device. A QR code appears, valid for 10 minutes.

    In the app: More → Settings → Connect to agent → Scan QR code.

    The app then asks which data to keep. If your printers and spools are already in the app, choose Use the app’s data: everything moves to the agent. You need app version 0.8.1 or newer.

  3. Add more printers

    Printers that are not in the app yet can be added in the agent, just like in the app: the search looks through your network, and the guide for each brand tells you what to switch on at the printer.

  4. Optional: access from anywhere

    In the agent: More → Settings → Access from anywhere → Turn on. Then your paired devices also reach the agent on the go, and on a PC or iPhone you open it at allmyprinters.com/web. It stays off until you switch it on, and everything is end-to-end encrypted.

  5. Optional: Home Assistant

    Printers, spools, filament boxes and the camera in Home Assistant: install the AllMyPrinters integration in HACS (custom repository https://github.com/nolimitek/ha-allmyprinters, type Integration). Then add it under Settings → Devices & services with the agent’s address and the key from More → Settings → Home Assistant in the agent.

Something doesn’t work?

“permission denied”

Put sudo in front of the command. In our Linux commands it is already there.

“The container name … is already in use”

The agent is already installed. To start it with new settings (for example a new password), first remove the old container with sudo docker rm -f allmyprinters-agent (on Windows, Mac and Unraid without sudo). Your data stays. Then run the start command again.

“port is already allocated”, or the log says the port is in use

Another program already uses port 8090. Enter a different number at the top, for example 8091, remove the container (see above) and start it again with the new command. Then open the agent with the new port.

“no matching manifest” or “exec format error”

The device runs a 32-bit system, and the agent needs 64-bit. On a Raspberry Pi 3, 4 or 5, install Raspberry Pi OS (64-bit).

The page doesn’t open

Check that the agent runs (last step for your system) and that you use the right address and port. The log often tells you why: sudo docker logs --tail 30 allmyprinters-agent. A firewall can block the port: on Ubuntu with ufw, run sudo ufw allow 8090/tcp. On Synology, allow the port under Control Panel → Security → Firewall.

I forgot the password

Enter a new one at the top, remove the container (your data stays) and start it again with the new command. With Synology or Portainer, change the password in the compose text and update the project or stack.

The search doesn’t find my printer

Add it with its IP address. You find it on the printer’s screen or in your router. On Windows and Mac this is always needed for Bambu Lab and Elegoo.

Home Assistant OS, Proxmox, TrueNAS, OpenMediaVault, CasaOS?

Home Assistant OS: pick the Home Assistant tab above, the agent runs there as an app. Proxmox: create a small Debian or Ubuntu VM with Docker and follow the Linux steps in it. TrueNAS SCALE, OpenMediaVault and CasaOS: open a shell over SSH and follow the Linux steps, or use Portainer if you have it.

Still stuck?

Tap “Report a problem” in the app and describe what happens. The last lines of the log help a lot: sudo docker logs --tail 30 allmyprinters-agent.