How to Install PlantUML on Your Synology NAS

How to Install PlantUML on Your Synology NAS

PlantUML is an open-source tool allowing users to create diagrams from a plain text language. Besides various UML diagrams, PlantUML has support for various other software development related formats, as well as visualization of JSON and YAML files. The language of PlantUML is an example of a domain-specific language. In this step by step guide I will show you how to install PlantUML on your Synology NAS using Docker & Portainer.

💡Note: This guide works perfectly with the latest PlantUML v1.2024.7 release.

  • 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 folders and name it plantuml. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

PlantUML Synology NAS Set up 1

  • STEP 4

Log into Portainer using your username and password. On the left sidebar in Portainer, click on Stacks then + Add stack. Follow the instructions in the image below.

1 Synology Portainer Add Stack

  • STEP 5

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

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

version: "3.9"
services:
  plantuml:
    image: plantuml/plantuml-server:latest
    container_name: PlantUML
    hostname: plantuml
    mem_limit: 2g
    cpu_shares: 768
    security_opt:
      - no-new-privileges:true
    user: 1026:100
    healthcheck:
      test: wget --no-verbose --tries=1 --spider http://localhost:8080
    ports:
      - 9816:8080
    volumes:
      - /volume1/docker/plantuml:/tmp/jetty:rw
    environment:
      TZ: Europe/Bucharest
    restart: on-failure:5

Note: Before you paste the code above in the Web editor area below, change the value numbers for PUID and PGID with your own values. (Follow my step by step guide on how to do this.)
Note: Before you paste the code above in the Web editor area below, change the value for TZ. (Select your current Time Zone from this list.)

PlantUML Synology NAS Set up 2

  • STEP 6

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.

PlantUML Synology NAS Set up 3

  • STEP 7

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

PlantUML Synology NAS Set up 4

  • STEP 8

Go back to STEP 1 or you will deal with karma 🙂

  • STEP 9

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:9816

PlantUML Synology NAS Set up 5

Enjoy PlantUML!

🆘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 PlantUML container over HTTPS, check How to Run Docker Containers Over HTTPS. In order to make PlantUML work via HTTPS, it’s mandatory to activate WebSocket.

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 PlantUML 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.

This post was updated on Monday / September 23rd, 2024 at 6:10 PM