From: Zac Dover <zac.dover@proton.me>
Date: Tue, 17 Jun 2025 06:05:08 +0000 (+1000)
Subject: doc: mgr/dashboard: add --enable-auth flag
X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=30dc60b81493537daf0805faf50b47460c2f80d1;p=ceph.git

doc: mgr/dashboard: add --enable-auth flag

Add an instruction that includes the --enable-auth flag in a "git orch
apply mgmt-gateway" command, in accordance with a request made by
afreen23 here: https://github.com/ceph/ceph/pull/60440#discussion_r1953530599

Signed-off-by: Zac Dover <zac.dover@proton.me>
---

diff --git a/doc/mgr/dashboard.rst b/doc/mgr/dashboard.rst
index 7a41c6542cde2..c117dbaa9d62f 100644
--- a/doc/mgr/dashboard.rst
+++ b/doc/mgr/dashboard.rst
@@ -780,6 +780,14 @@ the following logout_url: `https://<host_name>|<IP_address>/ /oauth2/sign_out`
 Again, from the IDP, we will need a user with a valid role, this user will be the one to perform
 authorization against, we can create a role like: 'administator' to give admin level access to the user.
 
+Make certain that the ``enable_auth`` flag has been included in the ``ceph orch
+apply mgmt-gateway`` command and that it has been set to ``true`` by running a
+command of the following form:
+
+.. prompt:: bash $
+
+   ceph orch apply mgmt-gateway --enable_auth=true --placement=<ceph-node-02>
+
 To disable SSO:
 
 .. prompt:: bash $