Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(authentication): document user administration #1593

Merged
merged 1 commit into from
Apr 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.
chaoran-chen marked this conversation as resolved.
Show resolved Hide resolved
Loading