-
Notifications
You must be signed in to change notification settings - Fork 85
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Add Immich documentation to sandbox apps This commit adds a new file `immich.md` to the `sandbox/apps` directory. The file contains information about Immich, a self-hosted photo and video backup tool with various features including bulk upload, facial recognition, hardware transcoding, OAuth and/or password login, libraries, mobile app, partner sharing, reverse geocoding, smart search, and XMP sidecars. The commit also includes instructions for installation, accessing Immich through a specific URL, and setup details. Additionally, it provides a link to the Immich documentation. * Add immich application to sandbox index The immich application has been added to the sandbox index, with the associated tag `sandbox-immich`. * Add Immich to the list of applications in mkdocs.yml This change adds Immich to the list of applications in `mkdocs.yml`.
- Loading branch information
1 parent
07c9a5e
commit 89b8dcd
Showing
3 changed files
with
58 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
# Immich | ||
|
||
## What is it? | ||
|
||
[Immich](https://immich.app/) is a self-hosted photo and video backup tool, similar to google photos and apple photos. | ||
|
||
### Features | ||
|
||
- Bulk Upload (Using the CLI) | ||
- Facial Recognition | ||
- Hardware Transcoding (Experimental) | ||
- Oauth and/or password login | ||
- Libraries | ||
- Mobile App | ||
- Partner Sharing | ||
- Reverse Geocoding | ||
- Smart Search | ||
- XMP Sidecars | ||
|
||
!!!info | ||
By default, Immich is NOT protected behind your Authelia/SSO middleware. You have to create a user with an email and password for Immich upon start up. Its recommended that you use the email and password you set up upon instalation for consistencies sake. | ||
|
||
| Details | | | | ||
|-------------|-------------|-------------| | ||
| [:material-home: Project home](https://immich.app/){: .header-icons } | [:octicons-link-16: Docs](https://immich.app/docs/overview/introduction){: .header-icons } | [:octicons-mark-github-16: Github](https://github.com/immich-app/immich){: .header-icons }| | ||
|
||
### 1. Installation | ||
|
||
``` shell | ||
|
||
sb install sandbox-immich | ||
|
||
``` | ||
|
||
### 2. URL | ||
|
||
- To access Immich, visit `https://immich._yourdomain.com_` | ||
|
||
### 3. Setup | ||
|
||
!!!info | ||
📢 Again, no default user is configured until you run through the setup screen, so you would ideally run through setup as soon as immich is deployed to secure the site. It is not behind authelia by default. | ||
|
||
???tip | ||
In Administration > Settings is a button to copy the current admin configuration to your clipboard. So you can just grab it from there, and paste it into a file. | ||
|
||
If you would like to have the config file available, create a new config file (e.g. immich.config, and the config format is `.json`) and map it in inventory; just keep in mind that this disallows you from configuring Immich admin settings from the web ui. | ||
|
||
``` yaml | ||
|
||
immich_docker_envs_custom: | ||
IMMICH_CONFIG_FILE: "/config/immich.config" | ||
|
||
``` | ||
|
||
- [:octicons-link-16: Documentation: Immich Docs](https://immich.app/docs/overview/introduction){: .header-icons } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters