Go to file

Anthony Lapenna 134416c9a3 fix(container-console): use xterm.js v2 (#262 )		8 years ago
.github	chore(github): add github issue template	8 years ago
api	chore(version): bump version number	8 years ago
app	fix(container-console): use xterm.js v2 (#262 )	8 years ago
assets	feat(templates): template configuration is now placed on top of template list (#253 )	8 years ago
test/unit	fix(general): fix the size display using the filesize library (#246 )	8 years ago
.dockerignore	Added docker-compose config for nginx-basic-auth.	9 years ago
.gitignore	docs(project): new documentation (#229 )	8 years ago
.godir	refactor(global): rename uifd to portainer	8 years ago
CONTRIBUTING.md	chore(project): update contribution guidelines	8 years ago
Dockerfile	refactor(global): rename uifd to portainer	8 years ago
LICENSE	chore(global): replace CloudInovasi with Portainer.io	8 years ago
README.md	docs(badges): add the dockerhub version badge	8 years ago
bower.json	fix(container-console): use xterm.js v2 (#262 )	8 years ago
build.sh	chore(build): add a build script to archive binary	8 years ago
gruntFile.js	fix(container-console): use xterm.js v2 (#262 )	8 years ago
index.html	feat(index): hide Events and Docker view when swarm-mode is enabled (#250 )	8 years ago
package.json	chore(version): bump version number	8 years ago

README.md

Portainer

The easiest way to manage Docker.

Portainer is a lightweight management UI which allows you to easily manage your Docker host or Swarm cluster.

Usage

It's really simple to deploy it using Docker:

$ docker run -d -p 9000:9000 portainer/portainer -H tcp://<DOCKER_HOST>:<DOCKER_PORT>

Just point it at your targeted Docker host and then access Portainer by hitting http://localhost:9000 with a web browser.

If your target is a Docker Swarm cluster or a Docker cluster using swarm mode, just add the flag --swarm:

$ docker run -d -p 9000:9000 portainer/portainer -H tcp://<SWARM_HOST>:<SWARM_PORT> --swarm

If you don't specify any target, its default behaviour is to use a bind mount on the Docker socket so you can easily deploy it to manage your local Docker host:

$ docker run -d -p 9000:9000 -v /var/run/docker.sock:/var/run/docker.sock portainer/portainer

Have a look at our documentation for more deployment options.

Configuration

Portainer is easy to tune using CLI flags.

Hiding specific containers

Portainer allows you to hide container with a specific label by using the -l flag.

For example, take a container started with the label owner=acme:

$ docker run -d --label owner=acme nginx

Simply add the -l owner=acme option on the CLI when starting Portainer:

$ docker run -d -p 9000:9000 -v /var/run/docker.sock:/var/run/docker.sock portainer/portainer -l owner=acme

Use your own templates

Portainer allows you to rapidly deploy containers using App Templates.

By default Portainer templates will be used but you can also define your own templates.

Add the --templates flag and specify the external location of your templates when starting Portainer:

$ docker run -d -p 9000:9000 -v /var/run/docker.sock:/var/run/docker.sock portainer/portainer --templates http://my-host.my-domain/templates.json

For more information about hosting your own template definitions and the format, see the templates documentation.

Check our documentation for more configuration options.

FAQ

Be sure to check our FAQ if you are missing some information.

Limitations

Portainer has full support for the following Docker versions:

Docker 1.10 to Docker 1.12 (including swarm-mode)
Docker Swarm >= 1.2.3

Partial support for the following Docker versions (some features may not be available):

Docker 1.9