https://github.com/007revad/synology_docker_export

Export Synology Container Manager or Docker containers' settings as json files
https://github.com/007revad/synology_docker_export

container-manager docker-compose synology synology-docker

Last synced: 4 months ago
JSON representation

Export Synology Container Manager or Docker containers' settings as json files

Host: GitHub
URL: https://github.com/007revad/synology_docker_export
Owner: 007revad
License: mit
Created: 2024-09-26T05:03:37.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2025-12-18T10:14:39.000Z (6 months ago)
Last Synced: 2026-01-22T03:50:08.029Z (5 months ago)
Topics: container-manager, docker-compose, synology, synology-docker
Language: Shell
Homepage:
Size: 354 KB
Stars: 40
Watchers: 4
Forks: 3
Open Issues: 2
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.txt
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

# Synology Docker Export

![Badge](https://hitscounter.dev/api/hit?url=https%3A%2F%2Fgithub.com%2F007revad%2FSynology_Docker_Export&label=Visitors&icon=github&color=%23198754&message=&style=flat&tz=Australia%2FSydney)
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/paypalme/007revad)
[![](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/007revad)

### Description

Export all Synology Container Manager or Docker containers' settings as json files to your docker shared folder

- Works with DSM 7's Container Manager and DSM 6's Docker.
- Exports settings for running and stopped containers.
- Optionally specify containers to ignore.
- Optionally set age of old exports to delete.

The exported json files can later be [imported in Synology's Container Manager ui or Docker ui](#importing).

The advantage of the exported json files is they are truly portable as each container's mapped volumes are **not** hard coded to a specific volume. DSM knows what volume each shared folder is located on.

### Download the script

1. Download the latest version _Source code (zip)_ from https://github.com/007revad/Synology_Docker_Export/releases
2. Save the download zip file to a folder on the Synology.
3. Unzip the zip file.

### Options

There are 2 options you can set in the script:
```
# Delete json exports older than X days
DeleteOlder=7

# Specify containers to ignore if you don't want to export their settings
# For example:
# IgnoredContainers=(jitsi_jicofo jitsi_jvb jitsi_prosody jitsi_web synology_docviewer_2)
IgnoredContainers=
```

### To run the script via task scheduler

See [How to run from task scheduler](https://github.com/007revad/Synology_Docker_Export/blob/main/how_to_run_from_scheduler.md)

### To run the script via SSH

[How to enable SSH and login to DSM via SSH](https://kb.synology.com/en-global/DSM/tutorial/How_to_login_to_DSM_with_root_permission_via_SSH_Telnet)

```YAML
sudo -s /volume1/scripts/syno_docker_export.sh
```

**Note:** Replace /volume1/scripts/ with the path to where the script is located.

### Troubleshooting

If the script won't run check the following:

1. Make sure you download the zip file and unzipped it to a folder on your Synology (not on your computer).
2. If the path to the script contains any spaces you need to enclose the path/scriptname in double quotes:
```YAML
sudo -s "/volume1/my scripts/syno_docker_export.sh"
```
3. Make sure you unpacked the zip or rar file that you downloaded and are trying to run the syno_docker_export.sh file.
4. Set the script file as executable:
```YAML
sudo chmod +x "/volume1/scripts/syno_docker_export.sh"
```

### Screenshots