chore(docs): clean up and add new content (#15003)

* wip: Install

* wip: sharing

* wip: features

* wip: features

* wip: tags and folder view

* update links

* fix: broken reference to page sections

* pr feedback

* Update docs/docs/overview/comparison.md

Co-authored-by: Daniel Dietzler <36593685+danieldietzler@users.noreply.github.com>

* webp

* webp is glory

* webp is glory

---------

Co-authored-by: Daniel Dietzler <36593685+danieldietzler@users.noreply.github.com>
This commit is contained in:
Alex
2025-01-02 10:04:14 -06:00
committed by GitHub
parent 8641ab82e1
commit 6239365f68
258 changed files with 311 additions and 530 deletions

View File

@@ -4,9 +4,5 @@ sidebar_position: 2
# Comparison
If you're new here and came from other photo self-hosting alternatives you might want to look at a comparison between Immich and your current self-hosting.
If you're new here and came from other asset self-hosting alternatives you might want to look at a comparison between Immich and your current solution.
Here you can see a [comparison between the various OpenSource Photo Libraries](https://meichthys.github.io/foss_photo_libraries/) including Immich.
:::note
It is important to remember, Immich is under very active development. Expect bugs and changes. Do not use it as the only way to store your photos and videos!
:::

View File

@@ -0,0 +1,8 @@
---
sidebar_position: 2
---
# Comparison
If you're new here and came from other asset self-hosting alternatives you might want to look at a comparison between Immich and your current solution.
Here you can see a [comparison between the various OpenSource Photo Libraries](https://meichthys.github.io/foss_photo_libraries/) including Immich.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 115 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 58 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 758 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 51 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 688 B

View File

@@ -4,7 +4,7 @@ sidebar_position: 1
# Introduction
<img src={require('./img/feature-panel.png').default} alt="Immich - Self-hosted photos and videos backup tool" />
<img src={require('./img/feature-panel.webp').default} alt="Immich - Self-hosted photos and videos backup tool" />
## Welcome!

View File

@@ -2,7 +2,7 @@
sidebar_position: 3
---
# Quick Start
# Quick start
Here is a quick, no-choices path to install Immich and take it for a test drive.
Once you've tried it, you might use one of the many other ways
@@ -12,11 +12,11 @@ to install and use it.
Check the [requirements page](/docs/install/requirements) to get started.
## Install and Launch via Docker Compose
## Set up the server
Follow the [Docker Compose (Recommended)](/docs/install/docker-compose) instructions to install the server.
## Try the Web UI
## Try the web app
import RegisterAdminUser from '/docs/partials/_register-admin.md';
@@ -24,9 +24,9 @@ import RegisterAdminUser from '/docs/partials/_register-admin.md';
Try uploading a picture from your browser.
<img src={require('./img/upload-button.png').default} title="Upload button" />
<img src={require('./img/upload-button.webp').default} title="Upload button" />
## Try the Mobile UI
## Try the mobile app
### Download the Mobile App
@@ -54,29 +54,25 @@ To quickly get going, you can selectively upload few photos first, by following
You can select the **Jobs** tab to see Immich processing your photos.
<img src={require('/docs/guides/img/jobs-tab.png').default} title="Jobs tab" />
<img src={require('/docs/guides/img/jobs-tab.webp').default} title="Jobs tab" width={300} />
## Set up Your Backups
## Review the database backup and restore process
You may want to back up the content of your Immich instance
along with other parts of your server; be sure to read about
[database backup](/docs/administration/backup-and-restore).
Immich has built-in database backups. You can refer to the
[database backup](/docs/administration/backup-and-restore) for more information.
## Where to Go From Here
:::danger
The database only contains metadata and user information. You must setup manual backups of the images and videos stored in `UPLOAD_LOCATION`.
:::
You may decide you'd like to install the server a different way;
the Install category on the left menu provides many options.
## Where to go from here?
You may decide you'd like to add the _rest_ of your photos from Google Photos,
even those not on your mobile device, via Google Takeout.
You can use [immich-go](https://github.com/simulot/immich-go) for this.
You may decide you'd like to install the server a different way; the Install category on the left menu provides many options.
You may want to
[upload photos from your own archive](/docs/features/command-line-interface).
You may decide you'd like to add the _rest_ of your photos from Google Photos, even those not on your mobile device, via Google Takeout. You can use [immich-go](https://github.com/simulot/immich-go) for this.
You may want to incorporate an immutable archive of photos from an
[External Library](/docs/features/libraries#external-libraries);
there's a [Guide](/docs/guides/external-library) for that.
You may want to [upload photos from your own archive](/docs/features/command-line-interface).
You may want your mobile device to
[back photos up to your server automatically](/docs/features/automatic-backup).
You may want to incorporate a pre-existing archive of photos from an [External Library](/docs/features/libraries); there's a [guide](/docs/guides/external-library) for that.
You may want your mobile device to [back photos up to your server automatically](/docs/features/automatic-backup).