# Portainer

Portainer is a universal container management tool that helps users deploy and manage container-based applications without needing to know how to write any platform-specific code.

# Portainer Edge Agent

Assuming you have Docker installed on your Synology NAS, you may run the Edge Agent to connect it to Portainer on another host!

For Synolgy NAS you have to change the volume. See below.

[![edge-agent.jpg](https://thehomelab.wiki/uploads/images/gallery/2021-06/scaled-1680-/edge-agent.jpg)](https://thehomelab.wiki/uploads/images/gallery/2021-06/edge-agent.jpg)

On line three of the command you have to change the volume to match that of Synology.

-v /var/lib/docker/volumes:/var/lib/docker/volumes \\

Change that line to

```
-v /volume1/@docker/volumes:/var/lib/docker/volumes \
```

Then run the command and viola! You can now connect to your Synology NAS through portainer using the Edge Agent!

<p class="callout warning">Do not run the below command. You have to get it from your Portainer dahboard!</p>

The command will look similar to this.

docker run -d \\  
-v /var/run/docker.sock:/var/run/docker.sock \\  
-v /volume1/@docker/volumes:/var/lib/docker/volumes \\  
-v /:/host \\  
-v portainer\_agent\_data:/data \\  
\--restart always \\  
-e EDGE=1 \\  
-e EDGE\_ID=YOURSECRETID \\  
-e EDGE\_KEY=YOURSECRETKEY \\  
-e CAP\_HOST\_MANAGEMENT=1 \\  
\--name portainer\_edge\_agent \\  
portainer/agent

See the video instructions below.

<iframe allowfullscreen="allowfullscreen" height="449" src="//www.youtube.com/embed/eyZsjs5ktF8" width="800"></iframe>

# Portainer Git

https://github.com/portainer/portainer

<p align="center">
  <img title="portainer" src='https://github.com/portainer/portainer/blob/develop/app/assets/images/logo_alt.png?raw=true' />
</p>

[![Docker Pulls](https://img.shields.io/docker/pulls/portainer/portainer.svg)](https://hub.docker.com/r/portainer/portainer/)
[![Microbadger](https://images.microbadger.com/badges/image/portainer/portainer.svg)](http://microbadger.com/images/portainer/portainer 'Image size')
[![Build Status](https://portainer.visualstudio.com/Portainer%20CI/_apis/build/status/Portainer%20CI?branchName=develop)](https://portainer.visualstudio.com/Portainer%20CI/_build/latest?definitionId=3&branchName=develop)
[![Code Climate](https://codeclimate.com/github/portainer/portainer/badges/gpa.svg)](https://codeclimate.com/github/portainer/portainer)
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=YHXZJQNJQ36H6)

**_Portainer_** is a lightweight management UI which allows you to **easily** manage your different Docker environments (Docker hosts or Swarm clusters).
**_Portainer_** is meant to be as **simple** to deploy as it is to use. It consists of a single container that can run on any Docker engine (can be deployed as Linux container or a Windows native container, supports other platforms too).
**_Portainer_** allows you to manage all your Docker resources (containers, images, volumes, networks and more!) It is compatible with the _standalone Docker_ engine and with _Docker Swarm mode_.

## Demo

You can try out the public demo instance: http://demo.portainer.io/ (login with the username **admin** and the password **tryportainer**).

Please note that the public demo cluster is **reset every 15min**.

Alternatively, you can deploy a copy of the demo stack inside a [play-with-docker (PWD)](https://labs.play-with-docker.com) playground:

- Browse [PWD/?stack=portainer-demo/play-with-docker/docker-stack.yml](http://play-with-docker.com/?stack=https://raw.githubusercontent.com/portainer/portainer-demo/master/play-with-docker/docker-stack.yml)
- Sign in with your [Docker ID](https://docs.docker.com/docker-id)
- Follow [these](https://github.com/portainer/portainer-demo/blob/master/play-with-docker/docker-stack.yml#L5-L8) steps.

Unlike the public demo, the playground sessions are deleted after 4 hours. Apart from that, all the settings are the same, including default credentials.

## Getting started

- [Deploy Portainer](https://documentation.portainer.io/quickstart/)
- [Documentation](https://documentation.portainer.io)
- [Building Portainer](https://documentation.portainer.io/contributing/instructions/)

## Getting help

For FORMAL Support, please purchase a support subscription from here: https://www.portainer.io/products/portainer-business

For community support: You can find more information about Portainer's community support framework policy here: https://www.portainer.io/products/community-edition/customer-success

- Issues: https://github.com/portainer/portainer/issues
- FAQ: https://documentation.portainer.io
- Slack (chat): https://portainer.io/slack/

## Reporting bugs and contributing

- Want to report a bug or request a feature? Please open [an issue](https://github.com/portainer/portainer/issues/new).
- Want to help us build **_portainer_**? Follow our [contribution guidelines](https://documentation.portainer.io/contributing/instructions/) to build it locally and make a pull request. We need all the help we can get!

## Security

- Here at Portainer, we believe in [responsible disclosure](https://en.wikipedia.org/wiki/Responsible_disclosure) of security issues. If you have found a security issue, please report it to <security@portainer.io>.

## Privacy

**To make sure we focus our development effort in the right places we need to know which features get used most often. To give us this information we use [Matomo Analytics](https://matomo.org/), which is hosted in Germany and is fully GDPR compliant.**

When Portainer first starts, you are given the option to DISABLE analytics. If you **don't** choose to disable it, we collect anonymous usage as per [our privacy policy](https://www.portainer.io/documentation/in-app-analytics-and-privacy-policy/). **Please note**, there is no personally identifiable information sent or stored at any time and we only use the data to help us improve Portainer.

## Limitations

Portainer supports "Current - 2 docker versions only. Prior versions may operate, however these are not supported.

## Licensing

Portainer is licensed under the zlib license. See [LICENSE](./LICENSE) for reference.

Portainer also contains code from open source projects. See [ATTRIBUTIONS.md](./ATTRIBUTIONS.md) for a list.

# Activate Portainer Dark Mode

Portainer has had dark mode since version 2.9.0! Here's how to activate it!

![](https://snip.lol/JipE3/GEYUkemi96/raw.png)

Step 1

Click on "my account" in the upper right.

Step 2

Click Dark Theme

![](https://snip.lol/JipE3/leQEnoXA54/raw.png)

Step 3

Click Update Theme

Did you find this helpful? [Subscribe to me on Youtube](https://www.youtube.com/c/GeekedTV) for more content!

# Install Portainer Agent

Use this docker command to install the Portainer Agent on the remote machine.

```
docker run -d -p 9001:9001 --name portainer_agent --restart=always -v /var/run/docker.sock:/var/run/docker.sock -v /var/lib/docker/volumes:/var/lib/docker/volumes portainer/agent
```