Skip to content

Commit

Permalink
docs(authentication): document user administration
Browse files Browse the repository at this point in the history
  • Loading branch information
chaoran-chen committed Apr 12, 2024
1 parent ec8b835 commit fe14f64
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ export default defineConfig({
items: [
// Each item here is one entry in the navigation menu.
{ label: "Getting started", link: "/guides/getting-started/" },
{ label: "User administration", link: "/guides/user-administration/" },
],
},
{
Expand Down
24 changes: 24 additions & 0 deletions docs/src/content/docs/guides/user-administration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: User administration
description: How to manage (technical and non-technical) users
---

User accounts are managed by [Keycloak](https://www.keycloak.org/) which offers a web interface for managing users. It can be used to manage both technical and non-technical users.

## Accessing the Keycloak admin console

TODO: Describe how to find the admin console.

TODO: How to get the initial admin credentials.

The Loculus-specific users are stored in the `loculus` realm which can be selected in the selection box in the left navigation bar.

## Superusers/curators

Superusers have the privilege to submit, revise, revoke and approve sequences on behalf of other groups. This role is envisioned to be assigned to curators.

To grant superuser privileges to a user, click on "Users" in the left navigation bar, select the user, click on "Role Mappings" and assign the `super_user` role.

## Processing pipeline

The processing pipeline requires a technical user to authenticate with the Loculus API. To create a new technical user, you can use the usual user registration form on the website. Afterwards, go to the Keycloak admin console, click on "Users" in the left navigation bar, select the user, click on "Role Mappings" and assign the `preprocessing_pipeline` role.

0 comments on commit fe14f64

Please sign in to comment.