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 1 commit
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
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 usge
aviv926 marked this conversation as resolved.
Show resolved Hide resolved
Several users report a situation where the page fails to load, in order to solve this problem you should try to allocate more RAM for Immich, if the problem continues, you should stop using the reverse proxy while loading the page.
aviv926 marked this conversation as resolved.
Show resolved Hide resolved
:::

Any other state describes the following 3 states:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sentence doesn't make sense to me.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I still don't understand what you're trying to say with this @aviv926

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah thanks!


- MATCHES - These files are matched by their checksums.

- OFFLINE PATHS - These files are the results of manual deletion of the default upload library.
aviv926 marked this conversation as resolved.
Show resolved Hide resolved

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

- UNTRACKS FILES - These files are not tracked by the application. They can be the results of failed moves, interrupted uploads, or left behind due to a bug.
aviv926 marked this conversation as resolved.
Show resolved Hide resolved

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" />
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.
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