38 lines
2.4 KiB
Markdown
38 lines
2.4 KiB
Markdown
---
|
|
description: Create users, reset passwords, access the admin interface.
|
|
---
|
|
|
|
# User Management
|
|
|
|
For now, **Tube Archivist** is *mostly* a single user application. You can create multiple users with different names and passwords, however they will share the same videos and channels. You can configure some permissions, and specific configurations are on a per-user basis. *More is on the roadmap*.
|
|
|
|
## Superuser
|
|
The first user gets created with the environment variables **TA_USERNAME** and **TA_PASSWORD** from your docker-compose file. This first user will automatically have *superuser* privileges.
|
|
|
|
## Admin Interface
|
|
When logged in from your *superuser* account, you are able to access the admin interface from the settings page or at `/admin/`. This interface holds all functionality for user management.
|
|
|
|
!!! tip "Superuser status required"
|
|
This interface is only accessible by users with the **Superuser status** permission.
|
|
|
|
## Create additional users
|
|
From the admin interface when you click on *Accounts* you will get a list of all users. From there you can create additional users by clicking on *Add Account*, provide a name and confirm a password. and then click on *Save* to create the user.
|
|
|
|
## Video Management Permissions
|
|
To create a user that has permissions to modify the download queue, delete items (channels, videos, playlists, etc.) and change general configuration settings, the user will require the **Is Staff** permission for the user.
|
|
|
|
## Read Only User
|
|
To create a user with limited permissions, remove the **Is Staff** and **Superuser status** permissons. This will make this user a *read only* user, meaning this user will not be able to add to the download queue, delete anything, etc.
|
|
|
|
!!! warning "Minimally Tested"
|
|
This is mostly meant as a *kids mode* or similar, this will most likely not hold against a sophisticated attacker.
|
|
|
|
## Changing users
|
|
You can delete or change permissions and password of a user by clicking on the username from the *Accounts* list page and follow the interface from there. Changing the password of the *superuser* here will overwrite the password originally set with the environment variables.
|
|
|
|
## Reset
|
|
Delete all user configurations by deleting the file `cache/db.sqlite3` and restart the container. This will create the superuser again from the environment variables.
|
|
|
|
!!! danger "BE AWARE"
|
|
Future feature improvements here may require resetting the user administration database.
|