diff mbox series

[bitbake-devel] bitbake-hashserv: Add description of permissions

Message ID 20231215202542.2910797-1-JPEWhacker@gmail.com
State New
Headers show
Series [bitbake-devel] bitbake-hashserv: Add description of permissions | expand

Commit Message

Joshua Watt Dec. 15, 2023, 8:25 p.m. UTC 
Adds a text description of the possible permissions in the hash server
help text

Signed-off-by: Joshua Watt <JPEWhacker@gmail.com>
---
 bitbake/bin/bitbake-hashserv | 13 +++++++++++++
 1 file changed, 13 insertions(+)
diff mbox series

Patch

diff --git a/bitbake/bin/bitbake-hashserv b/bitbake/bin/bitbake-hashserv
index c560b3e58ac..c913c4e3c8e 100755
--- a/bitbake/bin/bitbake-hashserv
+++ b/bitbake/bin/bitbake-hashserv
@@ -53,6 +53,19 @@  mode with an SSL terminating load balancer in front of it (as this server does
 not implement SSL). Otherwise all usernames and passwords will be transmitted
 in the clear. When configured this way, clients can connect using a secure
 websocket, as in "wss://SERVER:PORT"
+
+The following permissions are supported by the server:
+
+    @none       - No permissions
+    @read       - The ability to read equivalent hashes from the server
+    @report     - The ability to report equivalent hashes to the server
+    @db-admin   - Manage the hash database(s). This includes cleaning the
+                  database, removing hashes, etc.
+    @user-admin - The ability to manage user accounts. This includes, creating
+                  users, deleting users, resetting login tokens, and assigning
+                  permissions.
+    @all        - All possible permissions, including any that may be added
+                  in the future
         """,
     )