portainer/README.md at 6c520907ad8f9d4e4c6f2783451490046472ee3f

mirror of https://github.com/portainer/portainer.git synced 2025-07-18 21:09:40 +02:00

Andrea Kao 6c520907ad chore(license): update license info so that GitHub recognizes it (#1924 )

GitHub uses a library called Licensee to identify a project's license
type. It shows this information in the status bar and via the API if it
can unambiguously identify the license.

This commit modifies a few of Portainer's docs so that Licensee is able
to recognize the repository's license type. It updates LICENSE so that
it contains only the text of the zlib license. It also moves the info
concerning 3rd-party software to a new "Licensing" section in the
README.

Collectively, these changes allow Licensee to successfully identify the
license type of Portainer as zlib.

Signed-off-by: Andrea Kao <eirinikos@gmail.com>

2018-05-23 14:47:43 +02:00

4.2 KiB

Raw Blame History

portainer

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).

Portainer allows you to manage your Docker 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) playground:

Browse PWD/?stack=portainer-demo/play-with-docker/docker-stack.yml
Sign in with your Docker ID
Follow these steps.

Unlike the public demo, the playground sessions are deleted after 4 hours. Apart from that, all the settings are same, including default credentials.

Getting started

Getting help

Issues: https://github.com/portainer/portainer/issues
FAQ: https://portainer.readthedocs.io/en/latest/faq.html
Slack (chat): https://portainer.io/slack/
Gitter (chat): https://gitter.im/portainer/Lobby

Reporting bugs and contributing

Want to report a bug or request a feature? Please open an issue.
Want to help us build portainer? Follow our contribution guidelines to build it locally and make a pull request. We need all the help we can get!

Limitations

Portainer has full support for the following Docker versions:

Docker 1.10 to the latest version
Docker Swarm >= 1.2.3

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

Docker 1.9

Licensing

Portainer is licensed under the zlib license. See LICENSE for reference.

Portainer also contains the following code, which is licensed under the MIT license:

4.2 KiB Raw Blame History