christianlight/tutor
6
0
Fork 0
mirror of https://github.com/ChristianLight/tutor.git synced 2025-02-14 14:43:42 +00:00
Code Issues Releases Activity

Better docs on logs

Browse Source
This commit is contained in:
Régis Behmo 2020-03-16 21:30:26 +01:00
parent 41f14d528b
commit 325deb4210
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/troubleshooting.rst
View File

@ -19,6 +19,11 @@ Do you need professional assistance with your tutor-managed Open edX platform? O
Logging
-------
.. note::
Logs are of paramount importance for debugging Tutor. When asking for help on the `Tutor forums <https://discuss.overhang.io>`__, **you should always include the unedited logs of your app**. You can get those with::
tutor local logs --tail=100 -f
To view the logs from all containers use the ``tutor local logs`` command, which was modeled on the standard `docker-compose logs <https://docs.docker.com/compose/reference/logs/>`_ command::
tutor local logs --follow
@ -29,7 +34,7 @@ To view the logs from just one container, for instance the web server::
The last commands produce the logs since the creation of the containers, which can be a lot. Similar to a ``tail -f``, you can run::
tutor local logs--tail=0 -f
tutor local logs --tail=0 -f
If you'd rather use a graphical user interface for viewing logs, you are encouraged to try out :ref:`Portainer <portainer>`.