diff --git a/docs/docs/features/hardware-transcoding.md b/docs/docs/features/hardware-transcoding.md index a561bafa80..18c7f6b298 100644 --- a/docs/docs/features/hardware-transcoding.md +++ b/docs/docs/features/hardware-transcoding.md @@ -1,4 +1,4 @@ -# Hardware Transcoding [Experimental] +# Hardware Transcoding This feature allows you to use a GPU to accelerate transcoding and reduce CPU load. Note that hardware transcoding produces significantly larger videos than software transcoding with similar settings, typically with lower quality. Using slow presets and preferring more efficient codecs can narrow this gap. diff --git a/docs/docs/features/ml-hardware-acceleration.md b/docs/docs/features/ml-hardware-acceleration.md index ca1cb8edb1..fdf6149ed9 100644 --- a/docs/docs/features/ml-hardware-acceleration.md +++ b/docs/docs/features/ml-hardware-acceleration.md @@ -1,4 +1,4 @@ -# Hardware-Accelerated Machine Learning [Experimental] +# Hardware-Accelerated Machine Learning This feature allows you to use a GPU to accelerate machine learning tasks, such as Smart Search and Facial Recognition, while reducing CPU load. As this is a new feature, it is still experimental and may not work on all systems. diff --git a/docs/docs/guides/img/jobs-tab.png b/docs/docs/guides/img/jobs-tab.png index 70d2967983..6081ca4669 100644 Binary files a/docs/docs/guides/img/jobs-tab.png and b/docs/docs/guides/img/jobs-tab.png differ diff --git a/docs/docs/install/docker-compose.mdx b/docs/docs/install/docker-compose.mdx index e3d5dd6864..f172968d89 100644 --- a/docs/docs/install/docker-compose.mdx +++ b/docs/docs/install/docker-compose.mdx @@ -30,27 +30,11 @@ wget -O .env https://github.com/immich-app/immich/releases/latest/download/examp You can alternatively download these two files from your browser and move them to the directory that you created, in which case ensure that you rename `example.env` to `.env`. -:::info Optional Features -If you intend to use hardware acceleration for transcoding or machine learning (ML), you can download now the config files you'll need, in the same way: - -```bash title="(Optional) Get hwaccel.transcoding.yml file" -wget -O hwaccel.transcoding.yml https://github.com/immich-app/immich/releases/latest/download/hwaccel.transcoding.yml -``` - -```bash title="(Optional) Get hwaccel.ml.yml file" -wget -O hwaccel.ml.yml https://github.com/immich-app/immich/releases/latest/download/hwaccel.ml.yml -``` - -::: - ## Step 2 - Populate the .env file with custom values -
- - Example .env content - - {ExampleEnv} -
+ + {ExampleEnv} + - Populate `UPLOAD_LOCATION` with your preferred location for storing backup assets. It should be a new directory on the server with enough free space. - Consider changing `DB_PASSWORD` to a custom value. Postgres is not publically exposed, so this password is only used for local authentication. @@ -58,20 +42,14 @@ wget -O hwaccel.ml.yml https://github.com/immich-app/immich/releases/latest/down - Set your timezone by uncommenting the `TZ=` line. - Populate custom database information if necessary. -:::info Optional Features -You can edit `docker-compose.yml` to add external libraries or enable hardware acceleration now by following [their guides](#setting-up-optional-features). -::: - ## Step 3 - Start the containers -From the directory you created in Step 1 (which should now contain your customized `docker-compose.yml` and `.env` files), run this command: +From the directory you created in Step 1 (which should now contain your customized `docker-compose.yml` and `.env` files), run the following command to start Immich as a background service: -```bash title="Start the containers using docker compose command" +```bash title="Start the containers" docker compose up -d ``` -This starts immich as a background service (per the `-d` flag), ensuring it restarts after system reboots or crashes (per the `restart` fields in `docker-compose.yml`). - :::info Docker version If you get an error `unknown shorthand flag: 'd' in -d`, you are probably running the wrong Docker version. (This happens, for example, with the docker.io package in Ubuntu 22.04.3 LTS.) You can correct the problem by following the complete [Docker Engine install](https://docs.docker.com/engine/install/) procedure for your distribution, crucially the "Uninstall old versions" and "Install using the apt/rpm repository" sections. These replace the distro's Docker packages with Docker's official ones. @@ -89,28 +67,22 @@ See the previous paragraph about installing from the official Docker repository. If you get an error `can't set healthcheck.start_interval as feature require Docker Engine v25 or later`, it helps to comment out the line for `start_interval` in the `database` section of the `docker-compose.yml` file. ::: -:::tip -For more information on how to use the application, please refer to the [Post Installation](/docs/install/post-install.mdx) guide. -::: - -:::note GitHub Authentication -Downloading container images might require you to authenticate to the GitHub Container Registry ([steps here][container-auth]). -::: - ## Next Steps -### Setting Up Optional Features +Read the [Post Installation](/docs/install/post-install.mdx) steps or setup optional features below. -You can set up the following now: +### Setting up optional features -- [External Libraries](/docs/features/libraries.md) -- [Hardware Transcoding](/docs/features/hardware-transcoding.md) -- [Hardware-Accelerated Machine Learning](/docs/features/ml-hardware-acceleration.md) +- [External Libraries](/docs/features/libraries.md): Adding your existing photo library to Immich +- [Hardware Transcoding](/docs/features/hardware-transcoding.md): Speeding up video transcoding +- [Hardware-Accelerated Machine Learning](/docs/features/ml-hardware-acceleration.md): Speeding up various machine learning tasks in Immich ### Upgrading -:::danger Breaking Changes -It is important to follow breaking updates to avoid problems. You can see versions that had breaking changes [here][breaking]. +:::tip Read the release notes +Immich is currently under heavy development, which means you can expect [breaking changes][breaking] and bugs. Therefore, we recommend reading the release notes prior to updating and to take special care when using automated tools like [Watchtower][watchtower]. + +You can see versions that had breaking changes [here][breaking]. ::: If `IMMICH_VERSION` is set, it will need to be updated to the latest or desired version. @@ -123,14 +95,10 @@ docker compose pull && docker compose up -d To clean up disk space, the old version's obsolete container images can be deleted with the following command: -```bash title="Delete all obsolete container images" +```bash title="Clean up unused Docker's images" docker image prune ``` -:::caution Automatic Updates -Immich is currently under heavy development, which means you can expect [breaking changes][breaking] and bugs. Therefore, we recommend reading the release notes prior to updating and to take special care when using automated tools like [Watchtower][watchtower]. -::: - [compose-file]: https://github.com/immich-app/immich/releases/latest/download/docker-compose.yml [env-file]: https://github.com/immich-app/immich/releases/latest/download/example.env [watchtower]: https://containrrr.dev/watchtower/ diff --git a/docs/docs/install/post-install.mdx b/docs/docs/install/post-install.mdx index bc1ee80b47..45b5f446fd 100644 --- a/docs/docs/install/post-install.mdx +++ b/docs/docs/install/post-install.mdx @@ -10,19 +10,19 @@ import MobileAppLogin from '/docs/partials/_mobile-app-login.md'; import MobileAppBackup from '/docs/partials/_mobile-app-backup.md'; import ServerBackup from '/docs/partials/_server-backup.md'; -# Post Install Steps +# Post installation steps A list of common steps to take after installing Immich include: -## Step 1 - Register the Admin User +## Step 1 - Register the admin user -## Step 2 - Create a New User (optional) +## Step 2 - Create a new user (optional) -## Step 3 - Update the Storage Template +## Step 3 - Update the storage template diff --git a/docs/docs/install/script.md b/docs/docs/install/script.md index 82c3f687b1..d536c388d6 100644 --- a/docs/docs/install/script.md +++ b/docs/docs/install/script.md @@ -2,15 +2,17 @@ sidebar_position: 20 --- -# Install Script [Experimental] +# Install script [Experimental] :::caution This method is experimental and not currently recommended for production use. For production, please refer to installing with [Docker Compose](/docs/install/docker-compose.mdx). ::: -:::note -The install script only supports Linux operating systems and requires Docker to be already installed on the system. -::: +## Requirements + +Follow the [requirements page](/docs/install/requirements) to get started. + +## Steps In the shell, from a directory of your choice, run the following command: diff --git a/docs/docs/overview/Comparison.md b/docs/docs/overview/Comparison.md index f900ebc7c9..6fa594fc73 100644 --- a/docs/docs/overview/Comparison.md +++ b/docs/docs/overview/Comparison.md @@ -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 photo 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! -::: diff --git a/docs/docs/overview/comparison.md b/docs/docs/overview/comparison.md new file mode 100644 index 0000000000..6fa594fc73 --- /dev/null +++ b/docs/docs/overview/comparison.md @@ -0,0 +1,8 @@ +--- +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 solution. +Here you can see a [comparison between the various OpenSource Photo Libraries](https://meichthys.github.io/foss_photo_libraries/) including Immich. diff --git a/docs/docs/overview/quick-start.mdx b/docs/docs/overview/quick-start.mdx index 9c7ca8bd08..9138341804 100644 --- a/docs/docs/overview/quick-start.mdx +++ b/docs/docs/overview/quick-start.mdx @@ -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'; @@ -26,7 +26,7 @@ Try uploading a picture from your browser. -## Try the Mobile UI +## Try the mobile app ### Download the Mobile App @@ -54,15 +54,14 @@ 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. - + -## Set up Your Backups +## Familiar with 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 a built-in database backup and restore feature. You can refer to the +[database backup](/docs/administration/backup-and-restore) for more information. -## Where to Go From Here +## Where to go from here? You may decide you'd like to install the server a different way; the Install category on the left menu provides many options. diff --git a/docs/docs/partials/_storage-template.md b/docs/docs/partials/_storage-template.md index 0c668d0a3e..f35a705d2c 100644 --- a/docs/docs/partials/_storage-template.md +++ b/docs/docs/partials/_storage-template.md @@ -1,9 +1,5 @@ Immich allows the admin user to set the uploaded filename pattern at the directory and filename level as well as the [storage label for a user](/docs/administration/user-management/#set-storage-label-for-user). -:::note new version -On new machines running version 1.92.0 storage template engine is off by default, for [more info](https://github.com/immich-app/immich/releases/tag/v1.92.0#:~:text=the%20partner%E2%80%99s%20assets.-,Hardening%20storage%20template,-We%20have%20further). -::: - :::tip You can read more about the differences between storage template engine on and off [here](/docs/administration/backup-and-restore#asset-types-and-storage-locations) ::: diff --git a/docs/docs/partials/_user-create.md b/docs/docs/partials/_user-create.md index a8c1c69b9f..3bbbabac52 100644 --- a/docs/docs/partials/_user-create.md +++ b/docs/docs/partials/_user-create.md @@ -5,5 +5,3 @@ If you have friends or family members who want to use the application as well, y In the Administration panel, you can click on the **Create user** button, and you'll be presented with the following dialog: - -You can then set an initial password. If you'd like, you can use an easy password like `password`, and keep the setting **Require user to change password on first login** active. This will prompt the user to change their password on first login, to a password that they choose. diff --git a/docs/docs/partials/img/admin-registration-form.png b/docs/docs/partials/img/admin-registration-form.png index dd2c2caf14..3f6d2fabf9 100644 Binary files a/docs/docs/partials/img/admin-registration-form.png and b/docs/docs/partials/img/admin-registration-form.png differ diff --git a/docs/docs/partials/img/album-selection.png b/docs/docs/partials/img/album-selection.png index e872120b8e..615a859cf1 100644 Binary files a/docs/docs/partials/img/album-selection.png and b/docs/docs/partials/img/album-selection.png differ diff --git a/docs/docs/partials/img/backup-header.png b/docs/docs/partials/img/backup-header.png index 629f13c8a8..523cd6a1f9 100644 Binary files a/docs/docs/partials/img/backup-header.png and b/docs/docs/partials/img/backup-header.png differ diff --git a/docs/package-lock.json b/docs/package-lock.json index ca80d15fd0..c9ae86bec9 100644 --- a/docs/package-lock.json +++ b/docs/package-lock.json @@ -28,7 +28,6 @@ }, "devDependencies": { "@docusaurus/module-type-aliases": "~3.5.2", - "@tsconfig/docusaurus": "^2.0.2", "prettier": "^3.2.4", "typescript": "^5.1.6" }, @@ -3458,12 +3457,6 @@ "node": ">=10.13.0" } }, - "node_modules/@tsconfig/docusaurus": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/@tsconfig/docusaurus/-/docusaurus-2.0.3.tgz", - "integrity": "sha512-3l1L5PzWVa7l0691TjnsZ0yOIEwG9DziSqu5IPZPlI5Dowi7z42cEym8Y35GHbgHvPcBfNxfrbxm7Cncn4nByQ==", - "dev": true - }, "node_modules/@types/acorn": { "version": "4.0.6", "resolved": "https://registry.npmjs.org/@types/acorn/-/acorn-4.0.6.tgz", diff --git a/docs/src/css/custom.css b/docs/src/css/custom.css index f693ce701b..dc3ff4e9ef 100644 --- a/docs/src/css/custom.css +++ b/docs/src/css/custom.css @@ -9,10 +9,18 @@ @import url('https://fonts.googleapis.com/css2?family=Be+Vietnam+Pro:ital,wght@0,100;0,200;0,300;0,400;0,500;0,600;0,700;0,800;0,900;1,100;1,200;1,300;1,400;1,500;1,600;1,700;1,800;1,900&display=swap'); -html, -button { - font-family: 'Be Vietnam Pro', sans-serif; +body { + font-family: 'Be Vietnam Pro', serif; font-optical-sizing: auto; + /* font-size: 1.125rem; + ascent-override: 106.25%; + size-adjust: 106.25%; */ +} + +.breadcrumbs__link { + font-weight: 500; + font-size: 0.875rem; + padding: 8px 16px 8px 16px; } img { @@ -53,13 +61,18 @@ div[class^='announcementBar_'] { .menu__link { padding: 10px; padding-left: 16px; - border-radius: 10px; - font-size: 15px; + border-radius: 24px; + margin-right: 16px; } .menu__list-item-collapsible { border-radius: 10px; - font-size: 15px; + margin-right: 16px; + border-radius: 24px; +} + +.menu__link--active { + font-weight: 500; } code {