immich_ynh/README.md

<!--
N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
It shall NOT be edited by hand.
-->

# Immich for YunoHost

[![Integration level](https://dash.yunohost.org/integration/immich.svg)](https://dash.yunohost.org/appci/app/immich) ![Working status](https://ci-apps.yunohost.org/ci/badges/immich.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/immich.maintain.svg)

[![Install Immich with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=immich)

*[Read this README in other languages.](./ALL_README.md)*

> *This package allows you to install Immich quickly and simply on a YunoHost server.*  
> *If you don't have YunoHost, please consult [the guide](https://yunohost.org/install) to learn how to install it.*

## Overview

Self-hosted photo and video management solution.

### Features

- Simple-to-use backup tool with a native mobile app that can view photos and videos efficiently ;
- Easy-to-use and friendly interface ;


**Shipped version:** 1.103.1~ynh2

## Screenshots

![Screenshot of Immich](./doc/screenshots/immich-screenshots.png)

## Disclaimers / important information

## Disclaimer

This package provides support for the JPEG, PNG, WebP, AVIF (limited to 8-bit depth), TIFF, GIF and SVG (input) image formats.
HEIC/HEIF file format is not supported (see cf. https://github.com/YunoHost-Apps/immich_ynh/issues/40#issuecomment-2096788600).

## Documentation and resources

- Official app website: <https://immich.app>
- Official user documentation: <https://github.com/immich-app/immich#getting-started>
- Official admin documentation: <https://github.com/immich-app/immich#getting-started>
- Upstream app code repository: <https://github.com/immich-app/immich>
- YunoHost Store: <https://apps.yunohost.org/app/immich>
- Report a bug: <https://github.com/YunoHost-Apps/immich_ynh/issues>

## Developer info

Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/immich_ynh/tree/testing).

To try the `testing` branch, please proceed like that:

```bash
sudo yunohost app install https://github.com/YunoHost-Apps/immich_ynh/tree/testing --debug
or
sudo yunohost app upgrade immich -u https://github.com/YunoHost-Apps/immich_ynh/tree/testing --debug
```

**More info regarding app packaging:** <https://yunohost.org/packaging_apps>