diff --git a/docs/Home.md b/docs/Home.md index 151e379..c0602fe 100644 --- a/docs/Home.md +++ b/docs/Home.md @@ -6,6 +6,7 @@ Table of contents: * [Channels](Channels): Browse your channels, handle subscriptions * [Downloads](Downloads): Scanning subscriptions, handle download queue * [Settings](Settings): All the configuration options +* [Users](Users): User management admin interface ## Getting Started 1. [Subscribe](Channels#channels-overview) to some of your favourite YouTube channels. diff --git a/docs/Settings.md b/docs/Settings.md index 186f706..f0f3008 100644 --- a/docs/Settings.md +++ b/docs/Settings.md @@ -17,6 +17,7 @@ Settings related to the channel management. Settings related to the download process. - **Download Limit**: Stop the download process after downloading the set quantity of videos. - **Download Speed Limit**: Set your download speed limit in KB/s. This will pass the option `--limit-rate` to yt-dlp. +- **Throttled Rate Limit**: Restart download if the download speed drops below this value in KB/s. This will pass the option `--throttled-rate` to yt-dlp. Using this option might have a negative effect if you have an unstable or slow internet connection. - **Sleep Interval**: Time in seconds to sleep between requests to YouTube. It's a good idea to set this to **3** seconds. Might be necessary to avoid throttling. ## Download Format diff --git a/docs/Users.md b/docs/Users.md new file mode 100644 index 0000000..7765375 --- /dev/null +++ b/docs/Users.md @@ -0,0 +1,20 @@ +# User Management + +For now, **Tube Archivist** is a single user application. You can create multiple users with different names and passwords, but for now they will share the same interface. *More is on the roadmap*. + +## Admin Interface +When logged 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. + +## 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. + +## 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. + +## 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. + +NOTE: Future improvements here will most likely require such a reset. \ No newline at end of file