From 3c9c34f0df1de067c713be6f2d38eff8f923e03b Mon Sep 17 00:00:00 2001 From: Frank Rousseau Date: Wed, 4 Feb 2015 15:30:03 +0100 Subject: [PATCH] improve dashboard documentation Add information about how to run it and the port on which it listens. --- docs/dashboard.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/dashboard.md b/docs/dashboard.md index e9446054..bb1ecf15 100644 --- a/docs/dashboard.md +++ b/docs/dashboard.md @@ -7,4 +7,17 @@ A strong focus was put on the tools and particularly the dashboard. After all it ![Jobs view](http://i.imgur.com/SNsYhuQ.png) +#### How to run + +To run the dashboard, make sur that mrq is properly installed. Then, use the +following command: + +```bash +mrq-dashboard +``` + +The Dashboard will be available on the `5555` port (http://localhost:5555). + +#### Main goal + There are too many features on the dashboard to list, but the goal is to have complete visibility and control over what your workers are doing!