https://github.com/scottgigawatt/portainer

Container management for Synology NAS
https://github.com/scottgigawatt/portainer

docker-compose portainer portainer-ce synology

Last synced: about 7 hours ago
JSON representation

Container management for Synology NAS

• Host: GitHub
• URL: https://github.com/scottgigawatt/portainer
• Owner: scottgigawatt
• License: apache-2.0
• Created: 2024-05-26T01:51:25.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-06-29T01:08:22.000Z (5 months ago)
• Last Synced: 2024-06-29T02:26:05.560Z (5 months ago)
• Topics: docker-compose, portainer, portainer-ce, synology
• Homepage:
• Size: 13.7 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 🚢 Portainer for Synology

This repository contains a Docker Compose configuration tailored for Synology NAS environments, simplifying the setup process for managing Docker containers by integrating Portainer.

## 🌟 Overview

The `docker-compose.yml` file in this repository configures a Portainer container to provide an easy-to-use web interface for managing Docker containers on a Synology NAS.

For more details on the Docker Compose configuration, refer to the [docker-compose.yml](docker-compose.yml) file in this repository.

## 🛠️ Included Tool

- **Portainer**: Manages Docker containers through a user-friendly web interface. [More info](https://www.portainer.io/)

## 🚀 Usage

### 🏁 Starting the Service

Follow these steps to start the Portainer service:

1. Open a terminal and SSH into your Synology NAS.

2. Clone this repository to your Synology NAS.

3. Copy the [`example.env`](example.env) file to `.env` and update it to customize default settings.

4. Run `docker-compose up -d` to start the container in detached mode.

5. Access the Portainer web interface at `https://:9443`.

### 🔧 Managing Docker Config Environment Variables

Manage Docker configuration environment variables in the `.env` file. The [`example.env`](example.env) file can be copied to `.env` and updated to change the behavior. Override these variables easily on the command line when starting the Docker Compose stack:

```bash

PORTAINER_TAG="2.21.0" docker-compose up -d

```

Adjust the values of these environment variables to suit your requirements.

### 🔒 Secure Access to Synology Applications

Use DSM 7 Reverse Proxy to configure secure access to Synology applications. Follow the guide [here](https://mariushosting.com/synology-how-to-use-reverse-proxy-on-dsm-7/) for DSM 7.

> **Note**: If you encounter "Socket closed" errors when accessing the DSM UI via reverse proxy and trying to open terminals for running containers, enable WebSocket for the reverse proxy record:

>

> 1. Go to `Control Panel -> Application Portal -> Reverse Proxy`.

> 2. Select `Edit` for your reverse proxy record.

> 3. Navigate to the `Custom Header` tab.

> 4. From the `Create` dropdown, select `WebSocket`.

> 5. Save the changes to resolve the issue.

## 🖥️ Environment Details

Tested on Synology DS916+ running DSM 7.2.1-69057 Update 5, with Docker Compose version v2.9.0-6413-g38f6acd.

## 📄 License

Licensed under the Apache 2 License - see [LICENSE](LICENSE) for details.

---

Contribute or provide feedback to improve this repository. Happy container management with Portainer! 🎉