Docker Compose for Unraid

Install Docker Compose Manager

Head over to Community Applications store under the App tab and search docker compose manger. Click on install plug-in. This will add docker compose manager to the Unraid plug-ins tab and a webui to the bottom of the Unraid docker tab.

Adding a stack

To add your first stack under the docker tab, scroll to the bottom and select add new stack

Name your new stack, then select OK

PLEASE NOTE

the stack is saved to the unraid usb just like docker templates*

Click on the cog next to stack you just created, and it will give you options to edit name, edit description, edit stack, edit env, delete stack and logs.

To create the docker compose yml select edit stack. You will then be presented with an on-screen editor.

You can then simply copy/paste the docker compose of the application you desire. For this example, I used hotio's radarr.

Edit the volumes to match where you keep your current docker appdata

volumes:
  - /mnt/user/appdata/radarr:/config

Edit ports if needed to avoid conflict with already allocated ports on your Unraid server

ports:
  - "7878:7878"

By default, the network given will be <stackname>-default. To change that, we will add in a few lines to the compose.yml

    volumes:
      - /mnt/user/appdata/radarr:/config
    networks:
      - proxy
networks:
  proxy:
    external: true
    name: proxy        

After editing your compose.yml select save changes.

On the far right of your stack name click on compose pull to pull down the image named in the stack.

Then after compose pull select compose up. You should now have a running container docker section of Unraid. Compose down will remove the container.

PLEASE NOTE

Currently there is no way that I am aware of to add a webui button when clicking on the app icon, use <serverip>:<port>(will check on that). There is also currently no way to change the icon from question mark(dev says he's working on it). Do not use the update button from the drop down when clicking app icon (update the same way you would standard docker compose).

Extra for Docker Folders

You can add compose up and down buttons to the folder's dropdown options(this doesn't add it to the app drop down, only the actual folder drop down)

Select add docker folder and set it up how you normally would. Be sure to select advanced view in the upper right. Select add another button at the bottom.

Select bash for the config type, give it a name, e.g. Compose up or compose down. Select an icon from the dropdown. Then edit the command, replacing <stack name> with the name of your stack(case-sensitive). Create a button for each with the provided commands.

Docker Compose Up Command

docker compose -f /boot/config/plugins/compose.manager/projects/<stack name>/compose.yml up

Docker Compose Down Command

docker compose -f /boot/config/plugins/compose.manager/projects/<stack name>/compose.yml down

At the bottom of the folder page, select submit, and you should be good to go.

PLEASE NOTE

No hyphen between docker and compose in the command. Would have to create a new folder for each stack or add more buttons with separate commands for each stack.

Last updated