{"id":1821,"date":"2025-02-28T12:33:47","date_gmt":"2025-02-28T17:33:47","guid":{"rendered":"https:\/\/www.onebyte.org\/blog\/?p=1821"},"modified":"2025-02-28T12:37:52","modified_gmt":"2025-02-28T17:37:52","slug":"setting-up-portainer-on-synology-nas-via-compose","status":"publish","type":"post","link":"https:\/\/www.onebyte.org\/blog\/2025\/02\/28\/setting-up-portainer-on-synology-nas-via-compose\/","title":{"rendered":"Setting up Portainer on Synology NAS via Compose"},"content":{"rendered":"\n
\n
\n

This guide will walk you through the process of adding Portainer-ce to your Synology NAS and setting up connectivity to manage your existing Synology containers.<\/p>\n

This was validated working on DSM 7.2.2-72806 Update 3<\/strong>
Model: DS723+<\/strong><\/p>\n<\/div>\n\n\n\n

\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t<\/div>\n<\/div><\/div>\n\n\n\n

STEP 1<\/h1>\n\n\n\n

Install Container Manager<\/strong> via Synology \u201cPackage Center<\/strong>\u201d. If you run an older DSM version (under 7.2), search for Docker<\/strong> instead of Container Manager.<\/p>\n\n\n\n

\"\"\n\t\t\t\n\t\t\t\t\n\t\t\t<\/svg>\n\t\t<\/button><\/figure>\n\n\n\n

STEP 2<\/h1>\n\n\n\n

Go to File Station<\/strong> and open the docker folder. Inside the docker folder, create a new folder and name it portainer<\/strong>. Follow the instructions in the image below.
Note<\/strong>: Be careful to use only lowercase, not uppercase letters.<\/p>\n\n\n\n

\"\"\n\t\t\t\n\t\t\t\t\n\t\t\t<\/svg>\n\t\t<\/button><\/figure>\n\n\n\n

STEP 3<\/h1>\n\n\n\n

Go to the Container Manager <\/strong>and open the Registry <\/strong>tab. Search for portainer <\/strong>in the top right. The version you’re looking for is portainer-ce<\/strong>. Select the proper version and click Download. I default to the latest version and click apply.<\/p>\n\n\n\n

\"\"\n\t\t\t\n\t\t\t\t\n\t\t\t<\/svg>\n\t\t<\/button><\/figure>\n\n\n\n

STEP 4<\/h1>\n\n\n\n

Go to the Container Manager<\/strong> and open the Project <\/strong>tab. Click on the Create <\/strong>button to create a new project. Define the path of the portainer folder previously created (don’t just blindly follow my screenshots<\/em>). You’ll paste the Docker Compose yaml configuration here in the next step.<\/p>\n\n\n\n

\"\"\n\t\t\t\n\t\t\t\t\n\t\t\t<\/svg>\n\t\t<\/button><\/figure>\n\n\n\n

STEP 5<\/h1>\n\n\n\n

Update the below docker compose.yaml to accomodate our needs. For me, I had conflicts with some of my ports, so I re-mapped them. Also make sure you define the volume path for your portainer data.<\/p>\n\n\n\n

version: '3'\nservices:\nsystem.portainer:\nimage: portainer\/portainer-ce:latest\ncontainer_name: system.portainer\nhostname: portainer\nrestart: unless-stopped\nmem_limit: 128m\nmem_reservation: 48m\ncpu_shares: 128\nports:\n- \"1000:8000\" #CHANGE_IF_CONFLICT\n- \"2000:9000\" #CHANGE_IF_CONFLICT\n- \"9443:9443\" #CHANGE_IF_CONFLICT<\/mark><\/strong>\nsecurity_opt:\n- no-new-privileges:true\nenvironment:\n- PUID=1234 #CHANGE_TO_YOUR_UID\n- PGID=6754 #CHANGE_TO_YOUR_GID\nvolumes:\n- \/etc\/localtime:\/etc\/localtime:ro\n- \/var\/run\/docker.sock:\/var\/run\/docker.sock\n- \/volume2\/docker1\/portainer:\/data #CHANGE_TO_YOUR_PATH\n<\/mark><\/strong>logging:\ndriver: json-file\noptions:\nmax-file: \"3\"\nmax-size: \"10m\"<\/code><\/pre>\n\n\n\n
STEP 6<\/h1>\n\n\n\n
Open your browser and type in http:\/\/Synology-ip-address:9000<\/strong> Follow the instructions in the image below. Choose a Username<\/strong> and a strong Password<\/strong>, confirm the password, then press Create user<\/strong>.<\/p>\n\n\n\n
\"\"\n\t\t\t\n\t\t\t\t\n\t\t\t<\/svg>\n\t\t<\/button><\/figure>\n\n\n\n
STEP 7<\/h1>\n\n\n\n
Click Get Started<\/strong> (proceed using the local environment in which Portainer is running). Follow the instructions in the image below.<\/p>\n\n\n\n
\"\"\n\t\t\t\n\t\t\t\t\n\t\t\t<\/svg>\n\t\t<\/button><\/figure>\n\n\n\n
STEP 8<\/h1>\n\n\n\n
On the right in the Environments are, click on the little pencil<\/strong>. Follow the instructions in the image below.<\/p>\n\n\n\n
\"\"\n\t\t\t\n\t\t\t\t\n\t\t\t<\/svg>\n\t\t<\/button><\/figure>\n\n\n\n
STEP 9<\/h1>\n
After you click on the little pencil a new page will open. On the Public IP area type in your own NAS Local IP<\/strong> which, in this example’s case, is 192.168.1.18 then click Update <\/strong>environment<\/b>. Follow the instructions in the image below. If everything goes right, you will see this message at the top right of your screen: \u201cEnvironment updated<\/strong>\u201c.<\/p>\n\n\n\n
\"\"\n\t\t\t\n\t\t\t\t\n\t\t\t<\/svg>\n\t\t<\/button><\/figure>\n\n\n\n
\n
STEP 10<\/h1>\n\n\n\n
On the left Portainer sidebar, click on Registries<\/strong> then Click + Add registry<\/strong>. Follow the instructions in the image below.<\/p>\n<\/div><\/div>\n\n\n\n
\"\"\n\t\t\t\n\t\t\t\t\n\t\t\t<\/svg>\n\t\t<\/button><\/figure>\n\n\n\n
STEP 12<\/h2>\n\n\n\n
Click on\u00a0Custom registry<\/strong>. In the Name field area type in\u00a0GHCR<\/strong>\u00a0and in the Registry URL area type in\u00a0ghcr.io<\/strong>
Click\u00a0Add registry<\/strong>\u00a0to save the settings. Follow the instructions in the image below.
Note<\/strong>: The ghcr.io registry is mandatory if you want to update Docker containers via Portainer that are served via ghcr.io registry.<\/p>\n\n\n\n
\"\"\n\t\t\t\n\t\t\t\t\n\t\t\t<\/svg>\n\t\t<\/button><\/figure>\n\n\n\n
STEP 13<\/h2>\n\n\n\n
Click on Custom registry<\/strong>. In the Name field area type in CODEBERG<\/strong> and in the Registry URL area type in codeberg.org<\/strong>
Click Add registry<\/strong> to save the settings. Follow the instructions in the image below.
Note<\/strong>: The codeberg.org registry is mandatory if you want to update Docker containers via Portainer that are served via codeberg.org registry.<\/p>\n\n\n\n
\"\"<\/a><\/figure>\n\n\n\n
STEP 14<\/h2>\n\n\n\n
Click on Custom registry<\/strong>. In the Name field area type in Quay.io<\/strong> and in the Registry URL area type in quay.io<\/strong>
Click Add registry<\/strong> to save the settings. Follow the instructions in the image below.
Note<\/strong>: The quay.io registry is mandatory if you want to update Docker containers via Portainer that are served via quay.io registry.<\/p>\n\n\n\n
\"\"<\/a><\/figure>\n\n\n\n
STEP 15<\/h2>\n\n\n\n
Verify that everything went well and the registries are properly showing up. You should see something like this under Registries<\/strong>:<\/p>\n\n\n\n
\"\"<\/a><\/figure>\n\n\n\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\n\n\n
– moo –<\/p>\n\n\n\n\n\n\n","protected":false},"excerpt":{"rendered":"
This guide will walk you through the process of adding Portainer-ce to your Synology NAS and setting up connectivity to manage your existing Synology containers.<\/p>\n
This was validated working on DSM 7.2.2-72806 Update 3
\nModel: DS723+<\/p>\n","protected":false},"author":1,"featured_media":1860,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_uag_custom_page_level_css":"","footnotes":""},"categories":[3,2,23,21],"tags":[33,34,32],"class_list":["post-1821","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-linux","category-server","category-smarthome","category-software","tag-nas","tag-portainer","tag-synology"],"uagb_featured_image_src":{"full":["https:\/\/www.onebyte.org\/blog\/wp-content\/uploads\/2025\/02\/portainer_synology_setup_moo.jpg",1280,720,false],"thumbnail":["https:\/\/www.onebyte.org\/blog\/wp-content\/uploads\/2025\/02\/portainer_synology_setup_moo-150x150.jpg",150,150,true],"medium":["https:\/\/www.onebyte.org\/blog\/wp-content\/uploads\/2025\/02\/portainer_synology_setup_moo-300x169.jpg",300,169,true],"medium_large":["https:\/\/www.onebyte.org\/blog\/wp-content\/uploads\/2025\/02\/portainer_synology_setup_moo-768x432.jpg",768,432,true],"large":["https:\/\/www.onebyte.org\/blog\/wp-content\/uploads\/2025\/02\/portainer_synology_setup_moo-1024x576.jpg",1024,576,true],"1536x1536":["https:\/\/www.onebyte.org\/blog\/wp-content\/uploads\/2025\/02\/portainer_synology_setup_moo.jpg",1280,720,false],"2048x2048":["https:\/\/www.onebyte.org\/blog\/wp-content\/uploads\/2025\/02\/portainer_synology_setup_moo.jpg",1280,720,false],"post-thumbnail":["https:\/\/www.onebyte.org\/blog\/wp-content\/uploads\/2025\/02\/portainer_synology_setup_moo.jpg",1280,720,false],"modality-logo":["https:\/\/www.onebyte.org\/blog\/wp-content\/uploads\/2025\/02\/portainer_synology_setup_moo-142x80.jpg",142,80,true]},"uagb_author_info":{"display_name":"Mr-Moo","author_link":"https:\/\/www.onebyte.org\/blog\/author\/ahess\/"},"uagb_comment_info":0,"uagb_excerpt":"This guide will walk you through the process of adding Portainer-ce to your Synology NAS and setting up connectivity to manage your existing Synology containers. This was validated working on DSM 7.2.2-72806 Update 3 Model: DS723+","_links":{"self":[{"href":"https:\/\/www.onebyte.org\/blog\/wp-json\/wp\/v2\/posts\/1821","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.onebyte.org\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.onebyte.org\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.onebyte.org\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.onebyte.org\/blog\/wp-json\/wp\/v2\/comments?post=1821"}],"version-history":[{"count":1,"href":"https:\/\/www.onebyte.org\/blog\/wp-json\/wp\/v2\/posts\/1821\/revisions"}],"predecessor-version":[{"id":1867,"href":"https:\/\/www.onebyte.org\/blog\/wp-json\/wp\/v2\/posts\/1821\/revisions\/1867"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.onebyte.org\/blog\/wp-json\/wp\/v2\/media\/1860"}],"wp:attachment":[{"href":"https:\/\/www.onebyte.org\/blog\/wp-json\/wp\/v2\/media?parent=1821"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.onebyte.org\/blog\/wp-json\/wp\/v2\/categories?post=1821"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.onebyte.org\/blog\/wp-json\/wp\/v2\/tags?post=1821"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}