OpenHands (formerly OpenDevin) is a platform for software development agents powered by AI. OpenHands agents can do anything a human developer can: modify code, run commands, browse the web, call APIs. In this step by step guide I will show you how to install OpenHands on your Synology NAS using Docker & Portainer.

💡Note: This guide works perfectly with the latest version of OpenHands v1.12.0

• STEP 1

Please Support My work by Making a Donation.

• STEP 2

Install Portainer using my step by step guide. If you already have Portainer installed on your Synology NAS, skip this STEP. Attention: Make sure you have installed the latest Portainer version.

• STEP 3

Go to File Station and open the docker folder. Inside the docker folder, create one new folder and name it openhands. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

• STEP 4

Now create three new folders inside the openhands folder that you have previously created at STEP 3. Name them data and projects. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

• STEP 5

Log into Portainer using your username and password. On the left sidebar in Portainer, click on Home then Live connect. Follow the instructions in the image below.

On the left sidebar in Portainer, click on Stacks then + Add stack. Follow the instructions in the image below.

• STEP 6

In the Name field type in openhands. Follow the instructions in the image below.

Note: Copy Paste the code below in the Portainer Stacks Web editor.

services:
  openhands:
    image: ghcr.io/openhands/agent-canvas:latest
    container_name: OpenHands
    user: 0:0
    healthcheck:
      test: timeout 10s bash -c ':> /dev/tcp/127.0.0.1/8000' || exit 1
      interval: 10s
      timeout: 5s
      retries: 3
      start_period: 90s
    ports:
      - 3993:8000
    environment:
      PORT: 8000
      LOCAL_BACKEND_API_KEY: dOxZYTTZgXKMHkqLBIQVImayQXAVWdzGBPuFJKggzcgvgPJPXpWzqzKaUOIOGGIr
    volumes:
      - /volume1/docker/openhands/data:/home/openhands/.openhands:rw
      - /volume1/docker/openhands/projects:/projects:rw
    restart: on-failure:5

Note: Before you paste the code above in the Web editor area below, change the value for LOCAL_BACKEND_API_KEY. (Generate your own Random 64 length LOCAL_BACKEND_API_KEY.)

• STEP 7

Scroll down on the page until you see a button named Deploy the stack. Click on it. Follow the instructions in the image below. The installation process can take up to a few minutes. It will depend on your Internet speed connection.

⌛Now just wait because the OpenHands image is about 4,5GB.

• STEP 8

If everything goes right, you will see the following message at the top right of your screen: “Success Stack successfully deployed“.

• STEP 9

Please Support My work by Making a Donation. Almost 99,9% of the people that install something using my guides forget to support my work, or just ignore STEP 1. I’ve been very honest about this aspect of my work since the beginning: I don’t run any ADS, I don’t require subscriptions, paid or otherwise, I don’t collect IPs, emails, and I don’t have any referral links from Amazon or other merchants. I also don’t have any POP-UPs or COOKIES. I have repeatedly been told over the years how much I have contributed to the community. It’s something I love doing and have been honest about my passion since the beginning. But I also Need The Community to Support me Back to be able to continue doing this work.

• STEP 10

The installation process can take up to a few seconds/minutes. It will depend on your Internet speed connection. Now open your browser and type in http://Synology-ip-address:3993 Uncheck “Send anonymous usage data“. Click Confirm preferences. Follow the instructions in the image below.

• STEP 11

Select your favorite Agent. Click Next. Follow the instructions in the image below.

• STEP 12

Select your favorite LLM provider or skip for now to add it later. Follow the instructions in the image below.

• STEP 13

Your OpenHands at a glance!

Enjoy OpenHands!

🆘TROUBLESHOOTING

If you encounter issues by using this container, make sure to check out the Common Docker issues article.

Note: If you want to run the OpenHands container over HTTPS, check How to Run Docker Containers Over HTTPS. In order to make OpenHands work via HTTPS, it’s mandatory to activate WebSocket. ⚠️Warning: I do NOT recommend running OpenHands via Reverse Proxy. This product should be used only on localhost. Why don’t I recommend running it via Reverse Proxy? Because if someone were to know your HTTPS address, then they can use your own API keys for free and charge you if you have a paid plan.

Note: Can I run Docker on my Synology NAS? See the supported models.
Note: How to Back Up Docker Containers on your Synology NAS.
Note: Find out how to update the OpenHands container with the latest image.
Note: How to Free Disk Space on Your NAS if You Run Docker.
Note: How to Schedule Start & Stop For Docker Containers.
Note: How to Activate Email Notifications.
Note: How to Add Access Control Profile on Your NAS.
Note: How to Change Docker Containers Restart Policy.
Note: How to Use Docker Containers With VPN.
Note: Convert Docker Run Into Docker Compose.
Note: How to Clean Docker.
Note: How to Clean Docker Automatically.
Note: Best Practices When Using Docker and DDNS.
Note: Some Docker Containers Need WebSocket.
Note: Find out the Best NAS Models For Docker.
Note: Activate Gmail SMTP For Docker Containers.