diff options
Diffstat (limited to 'src/pybind/mgr/dashboard/README.rst')
| -rw-r--r-- | src/pybind/mgr/dashboard/README.rst | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/src/pybind/mgr/dashboard/README.rst b/src/pybind/mgr/dashboard/README.rst new file mode 100644 index 000000000..623ba2528 --- /dev/null +++ b/src/pybind/mgr/dashboard/README.rst @@ -0,0 +1,35 @@ +Ceph Dashboard +============== + +Overview +-------- + +The Ceph Dashboard is a built-in web-based Ceph management and monitoring +application to administer various aspects and objects of the cluster. It is +implemented as a Ceph Manager module. + +Enabling and Starting the Dashboard +----------------------------------- + +If you want to start the dashboard from within a development environment, you +need to have built Ceph (see the toplevel ``README.md`` file and the `developer +documentation <https://ceph.readthedocs.io/en/latest/dev/quick_guide/>`_ for +details on how to accomplish this. + +If you use the ``vstart.sh`` script to start up your development cluster, it +will configure and enable the dashboard automatically. The URL and login +credentials are displayed when the script finishes. + +Please see the `Ceph Dashboard documentation +<https://ceph.readthedocs.io/en/latest/mgr/dashboard/>`_ for details on how to +enable and configure the dashboard manually and how to configure other settings, +e.g. access to the Ceph object gateway. + +Working on the Dashboard Code +----------------------------- + +If you're interested in helping with the development of the dashboard, please +see ``/doc/dev/dev_guide/dash_devel.rst`` or the `online version +<https://ceph.readthedocs.io/en/latest/dev/developer_guide/dash-devel/>`_ for +details on how to set up a development environment and other development-related +topics. |