tutor/docs/tutorials/portainer.rst

.. _portainer:

Running a Docker container web UI with `Portainer <https://portainer.io/>`__
----------------------------------------------------------------------------

Portainer is a web UI for managing docker containers. It lets you view your entire Open edX platform at a glace. Try it! It's really cool::

    docker run --rm \
        --volume=/var/run/docker.sock:/var/run/docker.sock \
        --volume=/tmp/portainer:/data \
        -p 9000:9000 \
        portainer/portainer:latest --bind=:9000

You can then view the portainer UI at `http://localhost:9000 <http://localhost:9000>`_. You will be asked to define a password for the admin user. Then, select a "Local environment" to work on; hit "Connect" and select the "local" group to view all running containers.

.. image:: ../img/portainer.png
    :alt: Portainer demo

Among many other things, you'll be able to view the logs for each container, which is really useful.
docs: reorganize local guides in tutorials There is too much information in each of the local/k8s/dev docs pages. The "guides" that are listed in each one of those pages are moved either to "common tasks" or to a dedicated "tutorials" section. This paves the way for more comprehensive tutorials, where we describe how to run the latest master branches of Open edX. I am well aware that, as they stand, the tutorials are of poor quality and should be rewritten. This is a task for another day/commit. For now, we only move the contents to a separate part of the docs. Also, we should add a "reference" section to the docs, where we add the result of `tutor <subcommand> --help`. 2021-09-16 08:53:52 +00:00			`.. _portainer:`

			Running a Docker container web UI with `Portainer <https://portainer.io/>`__
			`----------------------------------------------------------------------------`

			`Portainer is a web UI for managing docker containers. It lets you view your entire Open edX platform at a glace. Try it! It's really cool::`

			`docker run --rm \`
			`--volume=/var/run/docker.sock:/var/run/docker.sock \`
			`--volume=/tmp/portainer:/data \`
			`-p 9000:9000 \`
			`portainer/portainer:latest --bind=:9000`

			You can then view the portainer UI at `http://localhost:9000 <http://localhost:9000>`_. You will be asked to define a password for the admin user. Then, select a "Local environment" to work on; hit "Connect" and select the "local" group to view all running containers.

			`.. image:: ../img/portainer.png`
			`:alt: Portainer demo`

			`Among many other things, you'll be able to view the logs for each container, which is really useful.`