From db5af6d24b40b45c69635596f58ee17fee18d4f0 Mon Sep 17 00:00:00 2001 From: TheCatLady <52870424+TheCatLady@users.noreply.github.com> Date: Sun, 4 Apr 2021 21:33:53 -0400 Subject: [PATCH] docs: preliminary user management documentation (#1310) [skip ci] * docs: preliminary user management documentation * docs: fix heading * docs: add quota info * docs: remove mention of image caching (for now) * docs: update FAQ to link to Users page --- docs/SUMMARY.md | 1 + docs/support/faq.md | 10 ++- docs/using-overseerr/notifications/README.md | 6 +- docs/using-overseerr/settings/README.md | 26 +++---- docs/using-overseerr/users/README.md | 75 ++++++++++++++++++++ 5 files changed, 96 insertions(+), 22 deletions(-) create mode 100644 docs/using-overseerr/users/README.md diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 0e84bdeb7..e51ada771 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -9,6 +9,7 @@ ## Using Overseerr - [Settings](using-overseerr/settings/README.md) +- [Users](using-overseerr/users/README.md) - [Notifications](using-overseerr/notifications/README.md) - [Email](using-overseerr/notifications/email.md) - [Discord](using-overseerr/notifications/discord.md) diff --git a/docs/support/faq.md b/docs/support/faq.md index 5302cbd9e..b74bf9189 100644 --- a/docs/support/faq.md +++ b/docs/support/faq.md @@ -74,17 +74,15 @@ Please see [these instructions on how to locate and share your logs](./asking-fo ### Why can't I see all of my Plex users? -Navigate to your **User List** in Overseerr and click **Import Users from Plex** button. - -Don't forget to set the [default user permissions](../settings/README.md#default-user-permissions) before importing users. +Please see the [documentation for importing users from Plex](../using-overseerr/users#importing-users-from-plex). ### Can I create local users in Overseerr? -Head to the **Users** page and hit **Create Local User**. Keep in mind that local user accounts need a valid email address. +Yes! Please see the [documentation for creating local users](../using-overseerr/users#creating-local-users). ### Is is possible to set user roles in Overseerr? -User roles can be set for each user on the **Users** page. The list of assignable permissions is still growing, so if you have any suggestions, [submit a feature request](https://github.com/sct/overseerr/issues/new/choose)! +Permissions can be configured for each user via the **User List** or their **User Settings** page. The list of assignable permissions is still growing, so if you have any suggestions, [submit a feature request](https://github.com/sct/overseerr/issues/new/choose)! ## Requests @@ -96,7 +94,7 @@ Verify you are running v3 of both Radarr and Sonarr. Overseerr is not backwards- Yes! If you keep both non-4K and 4K content in your media libraries, you can link separate 4K Radarr/Sonarr servers to allow users to submit 4K requests. (You must configure default non-4K **and** default 4K Radarr/Sonarr servers.) -Please see the [Services documentation](../settings/README.md#services) for details on how to configure your Radarr and/or Sonarr servers. +Please see the [Services documentation](../using-overseerr/settings/README.md#services) for details on how to configure your Radarr and/or Sonarr servers. Note that users must also have the **Request 4K**, **Request 4K Movies**, and/or **Request 4K Series** permissions in order to submit requests for 4K content. diff --git a/docs/using-overseerr/notifications/README.md b/docs/using-overseerr/notifications/README.md index 05005233f..afb3e5cd9 100644 --- a/docs/using-overseerr/notifications/README.md +++ b/docs/using-overseerr/notifications/README.md @@ -1,9 +1,9 @@ # Notifications -Overseerr already supports a good number of notification agents, such as **Discord**, **Slack** and **Pushover**. New agents are always considered for development, if there is enough demand for it. - ## Supported Notification Agents +Overseerr currently supports the following notification agents: + - [Email](./email.md) - [Discord](./discord.md) - Pushbullet @@ -22,4 +22,4 @@ Note that some notifications are intended for the user who submitted the relevan ## Requesting New Notification Agents -If we do not currently support a notification agent you would like, feel free to request it on [GitHub](https://github.com/sct/overseerr/issues). However, please be sure to search first and confirm that there is not already an existing request for the agent! +If we do not currently support your preferred notification agent, feel free to [submit a feature request on GitHub](https://github.com/sct/overseerr/issues). However, please be sure to search first and confirm that there is not already an existing request for the agent! diff --git a/docs/using-overseerr/settings/README.md b/docs/using-overseerr/settings/README.md index 9b4c5a2e2..1753c9447 100644 --- a/docs/using-overseerr/settings/README.md +++ b/docs/using-overseerr/settings/README.md @@ -38,18 +38,6 @@ If you enable this setting and find yourself unable to access Overseerr, you can This setting is **disabled** by default. -### Enable Image Caching - -{% hint style="danger" %} -**This feature is experimental.** Enable it at your own risk! -{% endhint %} - -When enabled, all images (including media posters from TMDb) will be cached locally on your server. Images will also be optimized for client devices; i.e., if you access Overseerr using a mobile device, smaller versions will be served compared to when accessing Overseerr on desktop. - -Note that this feature requires and will use a significant amount of disk space, and there is currently no automated deletion of old or expired images. If running Overseerr using Docker, it is possible to manually clear the image cache by simply removing and recreating the container. - -This setting is **disabled** by default. - ### Discover Region & Discover Language These settings filter content shown on the "Discover" home page based on regional availability and original language, respectively. Users can override these global settings by configuring these same options in their user settings. @@ -78,9 +66,21 @@ When disabled, Plex OAuth becomes the only sign-in option, and any "local users" This setting is **enabled** by default. +### Global Movie Request Limit & Global Series Request Limit + +Select the request limits you would like granted to users. + +Unless an [override](../users/README.md#movie-request-limit-and-series-request-limit) is configured, users are granted these global request limits. + +Note that users with the **Manage Users** permission are exempt from request limits, since that permission also grants the ability to submit requests on behalf of other users. + ### Default User Permissions -Select the permissions you would like new users to have by default. It is important to set these, as any user with access to your Plex server will be able to log in to Overseerr, and they will be granted the permissions you select here. +Select the permissions you would like assigned to new users to have by default upon account creation. + +It is important to configure this, as any user with access to your Plex server will be able to sign in to Overseerr, and they will be granted the permissions you select here upon first sign-in. + +This setting only affects new users, and has no impact on existing users. In order to modify permissions for existing users, you will need to [edit the users](../users/README.md#editing-users). ## Plex diff --git a/docs/using-overseerr/users/README.md b/docs/using-overseerr/users/README.md new file mode 100644 index 000000000..bff049bac --- /dev/null +++ b/docs/using-overseerr/users/README.md @@ -0,0 +1,75 @@ +# Users + +## Owner Account + +The user account created during Overseerr setup is the "Owner" account, which cannot be deleted or modified by other users. This account's credentials are used to authenticate with Plex. + +## Adding Users + +There are currently two methods to add users to Overseerr: importing Plex users and creating "local users." All new users are created with the [default permissions](../settings/README.md#default-user-permissions) defined in **Settings → Users**. + +### Importing Users from Plex + +Clicking the **Import Users from Plex** button on the **User List** page will fetch the list of users with access to the Plex server from [plex.tv](https://www.plex.tv/), and add them to Overseerr automatically. + +Importing Plex users is not required, however. Any user with access to the Plex server can log in to Overseerr even if they have not been imported, and will be assigned the configured [default permissions](../settings/README.md#default-user-permissions) upon their first login. + +### Creating Local Users + +If you would like to grant Overseerr access to a user who doesn't have their own Plex account and/or access to the Plex server, you can manually add them by clicking the **Create Local User** button. + +#### Email Address + +Enter a valid email address at which the user can receive messages pertaining to their account and other notifications. The email address currently cannot be modified after the account is created. + +#### Automatically Generate Password + +If [email notifications](../notifications/email.md) have been configured and enabled, Overseerr can automatically generate a password for the new user. + +#### Password + +If you would prefer to manually configure a password, enter a password here that is a minimum of 8 characters. + +## Editing Users + +From the **User List**, you can click the **Edit** button to modify a particular user's settings. + +You can also click the check boxes and click the **Bulk Edit** button to set user permissions for multiple users at once. + +### General + +#### Display Name + +You can optionally set a "friendly name" for any user. This name will be used in lieu of their Plex username (for users imported from Plex) or their email address (for manually-created local users). + +#### Discover Region & Discover Language + +Users can override the [global filter settings](../settings/README.md#discover-region-and-discover-language) to suit their own preferences. + +#### Movie Request Limit & Series Request Limit + +You can override the default settings and assign different request limits for specific users by checking the **Enable Override** box and selecting the desired request limit and time period. + +Unless an override is configured, users are granted the global request limits. + +Note that users with the **Manage Users** permission are exempt from request limits, since that permission also grants the ability to submit requests on behalf of other users. + +Users are also unable to modify their own request limits. + +### Password + +All "local users" are assigned passwords upon creation, but users imported from Plex can also optionally configure passwords to enable sign-in using their email address. + +Passwords must be a minimum of 8 characters long. + +### Notifications + +Users can configure their personal notification settings here. Please see [Notifications](../notifications/README.md) for details on configuring and enabling notifications. + +### Permissions + +Users cannot modify their own permissions. Users with the **Manage Users** permission can manage permissions of other users, except those of users with the **Admin** permission. + +## Deleting Users + +When users are deleted, all of their data and request history is also cleared from the database.