CTRoadmap is a local-first, Docker-based web application for creating and maintaining an interactive infrastructure atlas. It lets homelab and self-hosted users visually map servers, nodes, services, storage, containers, scripts, configs, URLs, and relationships on a canvas, while maintaining rich documentation in a human-readable JSON file. Key aspects include a flexible canvas editor with layers, families, stacks, planning mode, handbook view, custom icons, multiple export formats (Markdown, YAML, Mermaid), and optional passcode protection, all focused purely on documentation without executing any commands on your infrastructure. In this step by step guide I will show you how to install CTRoadmap on your UGREEN NAS using Docker & Portainer.

💡Note: This guide works perfectly with the latest CTRoadmap v0.3.0 release.

💡Note: Check out my guide on how to Install CTRoadmap on Your Synology NAS.

• 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 UGREEN NAS, skip this STEP. Attention: Make sure you have installed the latest Portainer version.

• STEP 3

⚠️Mandatory: Add Read & Write Permissions to the Docker Folder.

• STEP 4

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

• STEP 5

Now create two new folders inside the ctroadmap folder that you have previously created at STEP 4 and name them data and exports. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

• STEP 6

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 7

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

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

services:
  ctroadmap:
    image: ghcr.io/noobcity99/ctroadmap:v0.3.0-beta
    container_name: CTRoadmap
    healthcheck:
      test: timeout 10s bash -c ':> /dev/tcp/127.0.0.1/8088' || exit 1
      interval: 10s
      timeout: 5s
      retries: 3
      start_period: 90s
    ports:
      - 8988:8088
    volumes:
      - /volume1/docker/ctroadmap/data:/app/data:rw
      - /volume1/docker/ctroadmap/exports:/app/exports:rw
    restart: on-failure:5

• STEP 8

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.

• STEP 9

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

• STEP 10

🟢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 11

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://ugreen-ip-address:8988 Click Set Access Passcode. Follow the instructions in the image below.

• STEP 12

Choose your favorite theme, then click Set Access Passcode. Follow the instructions in the image below.

• STEP 13

Type in your own password. Click Set Access Passcode. Follow the instructions in the image below.

• STEP 14

Your CTRoadmap app at a glance!

🆘TROUBLESHOOTING

Note: If you want to run the CTRoadmap container over HTTPS, check out How to Run Docker Containers Over HTTPS on Your UGREEN NAS.

🆙Note/Update/Container: How to Update Your Docker Containers on UGREEN NAS Using Portainer.
🐳Note: How to Create Docker Shortcuts on Desktop.
🆕Note: How to Update Portainer to the latest version.
🆕Note: How to Clean Docker.