Skip to content

Commit

Permalink
Update usage settings docs
Browse files Browse the repository at this point in the history
  • Loading branch information
viktorstrate committed Feb 7, 2022
1 parent c8a15e1 commit c77454a
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 9 deletions.
Binary file added src/docs/usage-settings/add-user.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/docs/usage-settings/edit-user.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/docs/usage-settings/periodic-scanner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 10 additions & 9 deletions src/docs/usage-settings/usage-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,22 +7,21 @@ group: Usage

### Add and remove users

> TODO: Write this section explaining how users are added and deleted and what the consequences are.<br/>
> Maybe also how to set a password for new users.
To add a new user, click the `New user` button and fill in the username and a media path for the new user.
After creating a new user, make sure to add a password to the account as well, by clicking on the `Change password` button, next to the user.

{% optimizedImage './add-user.png', 'screenshot of adding a new user', 'class="block w-full my-8"' %}

### Editing users

A user can be edited by clicking on the `Edit` button for the user.

> TODO: Update **Photo path** to explain how this is done in version 2.
> Also explain how paths can be shared across users.
**Photo path:** is the path on the file system of the server from where the media of the user is located.
Note if running Docker, that this refers to the file system of the container and not the host.
Multiple paths can be added, if the media for the user is spread across multiple directories.
For more information, see [File scanner](./usage-scanner).

**Admin:** if the user is marked as admin, they will have access to the settings page.

> TODO: Update screen shot to reflect the settings in version 2.
**Admin:** if the user is marked as admin, they will be able to manually start the scanner and to manage and create new users.

{% optimizedImage './edit-user.png', 'screenshot of editing a user', 'class="block w-full my-8"' %}

Expand All @@ -37,4 +36,6 @@ Photoview will automatically scan all users for new media at a fixed time interv

### Concurrent Workers

> TODO: Explain what the concurrent workers setting does
This setting specifies how many scanner jobs that are allowed to run in the background at once.
The lower the value, the longer time it will take to process all media, but the less system resources it will use at once.
If you are running Photoview on limited hardware such as a Raspberry Pi, it is recommended to keep this value at 1.

0 comments on commit c77454a

Please sign in to comment.