From d49c66044ad30b24e10e1b4eb7671f73a5acc664 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Henrik=20tom=20W=C3=B6rden?= <henrik@trineo.org>
Date: Fri, 15 Jan 2021 15:24:27 +0100
Subject: [PATCH] DOC: admin
---
src/caosdb/utils/caosdb_admin.py | 10 +++++-----
src/doc/administration.rst | 14 ++++++++++++++
src/doc/index.rst | 3 ++-
3 files changed, 21 insertions(+), 6 deletions(-)
create mode 100644 src/doc/administration.rst
diff --git a/src/caosdb/utils/caosdb_admin.py b/src/caosdb/utils/caosdb_admin.py
index 250c2878..e16efa3f 100755
--- a/src/caosdb/utils/caosdb_admin.py
+++ b/src/caosdb/utils/caosdb_admin.py
@@ -141,20 +141,20 @@ def do_set_user_password(args):
def do_add_user_roles(args):
- roles = admin._get_roles(user=args.user_name, realm=None)
+ roles = admin._get_roles(username=args.user_name, realm=None)
for r in args.user_roles:
roles.add(r)
- admin._set_roles(user=args.user_name, roles=roles)
+ admin._set_roles(username=args.user_name, roles=roles)
def do_remove_user_roles(args):
- roles = admin._get_roles(user=args.user_name, realm=None)
+ roles = admin._get_roles(username=args.user_name, realm=None)
for r in args.user_roles:
if r in roles:
roles.remove(r)
- admin._set_roles(user=args.user_name, roles=roles)
+ admin._set_roles(username=args.user_name, roles=roles)
def do_set_user_entity(args):
@@ -178,7 +178,7 @@ def do_delete_user(args):
def do_retrieve_user_roles(args):
- print(admin._get_roles(user=args.user_name))
+ print(admin._get_roles(username=args.user_name))
def do_retrieve_role_permissions(args):
diff --git a/src/doc/administration.rst b/src/doc/administration.rst
new file mode 100644
index 00000000..91b85344
--- /dev/null
+++ b/src/doc/administration.rst
@@ -0,0 +1,14 @@
+Administration
+==============
+
+The Python script ``caosdb_admin.py`` should be used for administrative tasks.
+Call ``python3 caosdb_admin.py --help`` to see how to use it.
+
+The most common task is to create a new user (in the CaosDB realm) and set a
+password for the user (note that a user typically needs to be activated)::
+
+ python3 caosdb_admin.py create_user anna
+ python3 caosdb_admin.py set_user_password anna
+ python3 caosdb_admin.py add_user_roles anna administration
+ python3 caosdb_admin.py activate_user anna
+
diff --git a/src/doc/index.rst b/src/doc/index.rst
index e8cc93aa..76a2f88f 100644
--- a/src/doc/index.rst
+++ b/src/doc/index.rst
@@ -10,7 +10,8 @@ Welcome to PyCaosDB's documentation!
Getting started <README_SETUP>
tutorials/index
Concepts <concepts>
- Configuration <configuration>
+ Configuration <configuration>
+ Administration <administration>
API documentation<_apidoc/modules>
This is the documentation for the Python client library for CaosDB, ``PyCaosDB``.
--
GitLab