tubearchivist
/
docs
mirror of https://github.com/tubearchivist/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

add docs for read only user

This commit is contained in:
Simon 2023-11-09 21:35:58 +07:00
parent c7b4c07a06
commit a44127731d
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
mkdocs/docs/users.md
View File

@ -1,13 +1,13 @@
---
description: Create users, reset passwords, acces the admin interface.
description: Create users, reset passwords, access the admin interface.
---
# User Management
For now, **Tube Archivist** is a single user application. You can create multiple users with different names and passwords, they will share the same videos and permissions but some interface configurations are on a per user basis. *More is on the roadmap*.
For now, **Tube Archivist** is *mostly* a single user application. You can create multiple users with different names and passwords, they will share the same videos and and channels. You can configure some permissions and some 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. That first user will automatically have *superuser* privileges.
The first user gets created with the environment variables **TA_USERNAME** and **TA_PASSWORD** from your docker-compose file. That 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.
@ -15,6 +15,12 @@ When logged in from your *superuser* account, you are able to access the admin i
## 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 password and click on *Save* to create 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 among others, this user will not be able to add anything to the download queue, delete anything, etc.
!!! note "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.
@ -22,4 +28,4 @@ You can delete or change permissions and password of a user by clicking on the u
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.
!!! note "BE AWARE"
Future improvements here will most likely require such a reset.
Future improvements here will most likely require such a reset.