Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(docs): New repair and statistics pages #8030

Merged
merged 6 commits into from
Mar 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/blog/2022/11-10/release-1.36.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Hello everyone, it is my pleasure to deliver the new release of Immich to you. T

Some notable features are:

- [OAuth integration](#livephoto-ios-support-)
- [LivePhoto support on iOS](#oauth-integration-)
- OAuth integration
- LivePhoto support on iOS
- User config system

<!--truncate-->
Expand Down
Binary file added docs/docs/administration/img/repair-page-1.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 added docs/docs/administration/img/repair-page.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 added docs/docs/administration/img/server-stats.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
31 changes: 31 additions & 0 deletions docs/docs/administration/repair-page.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Repair Page

The repair page is designed to give information to the system administrator about files that are not tracked, or offline paths.

## Natural State

In this situation, everything is in its place and there is no problem that the system administrator should be aware of.

<img src={require('./img/repair-page.png').default} title="server statistic" />

## Any Other Situation

:::note RAM Usage
Several users report a situation where the page fails to load. In order to solve this problem you should try to allocate more RAM to Immich, if the problem continues, you should stop using the reverse proxy while loading the page.
:::

In any other situation, there are 3 different options that can appear:

- MATCHES - These files are matched by their checksums.

- OFFLINE PATHS - These files are the result of manually deleting files in the upload library or a failed file move in the past (losing track of a file).

:::tip
To get rid of Offline paths you can follow this [guide](/docs/guides/remove-offline-files.md)
:::

- UNTRACKED FILES - These files are not tracked by the application. They can be the result of failed moves, interrupted uploads, or left behind due to a bug.

In addition, you can download the information from a page, mark everything (in order to check hashing) and correct the problem if a match is found in the hashing.

<img src={require('./img/repair-page-1.png').default} title="server statistic" />
13 changes: 13 additions & 0 deletions docs/docs/administration/server-stats.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Server Stats

Server statistics to show the total number of videos, photos, and usage per user.

:::info
If a storage quota has been defined for the user, the usage number will be displayed as a percentage of the total storage quota allocated to him.
:::

:::info External library
External library is not included in the storage quota.
:::

<img src={require('./img/server-stats.png').default} title="server statistic" />
Loading