2022-07-23 01:37:45 +00:00
# photoprism
2022-07-22 15:48:06 +00:00
2022-07-23 01:37:45 +00:00
![Version: 10.0.25 ](https://img.shields.io/badge/Version-10.0.25-informational?style=flat-square ) ![AppVersion: 220629 ](https://img.shields.io/badge/AppVersion-220629-informational?style=flat-square )
2022-07-22 15:48:06 +00:00
2022-07-23 01:37:45 +00:00
PhotoPrism® is a server-based application for browsing, organizing and sharing your personal photo collection
2022-07-22 15:48:06 +00:00
TrueCharts can be installed as both *normal* Helm Charts or as Apps on TrueNAS SCALE.
This readme is just an automatically generated general guide on installing our Helm Charts and Apps.
2022-07-23 01:37:45 +00:00
For more information, please click here: [photoprism ](https://truecharts.org/docs/charts/stable/photoprism )
2022-07-22 15:48:06 +00:00
2022-07-22 17:03:23 +00:00
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here ](https://github.com/truecharts/charts/issues/new/choose )**
2022-07-22 15:48:06 +00:00
## Source Code
2022-07-23 01:37:45 +00:00
* < https: // github . com / photoprism / photoprism >
* < https: // hub . docker . com / r / photoprism / photoprism >
2022-07-22 15:48:06 +00:00
## Requirements
Kubernetes: `>=1.16.0-0`
## Dependencies
| Repository | Name | Version |
|------------|------|---------|
2022-07-23 01:37:45 +00:00
| https://charts.truecharts.org/ | mariadb | 3.0.40 |
| https://library-charts.truecharts.org | common | 10.4.6 |
2022-07-22 15:48:06 +00:00
## Installing the Chart
### TrueNAS SCALE
2022-07-22 17:03:23 +00:00
To install this App on TrueNAS SCALE check our [Quick-Start Guide ](https://truecharts.org/docs/manual/Quick-Start%20Guides/02-Installing-an-App/ ).
2022-07-22 15:48:06 +00:00
### Helm
2022-07-23 01:37:45 +00:00
To install the chart with the release name `photoprism`
2022-07-22 15:48:06 +00:00
```console
helm repo add TrueCharts https://helm.truecharts.org
helm repo update
2022-07-23 01:37:45 +00:00
helm install photoprism TrueCharts/photoprism
2022-07-22 15:48:06 +00:00
```
## Uninstall
### TrueNAS SCALE
**Upgrading, Rolling Back and Uninstalling the Chart**
2022-07-22 17:03:23 +00:00
To upgrade, rollback or delete this App from TrueNAS SCALE check our [Quick-Start Guide ](https://truecharts.org/docs/manual/Quick-Start%20Guides/04-Upgrade-rollback-delete-an-App/ ).
2022-07-22 15:48:06 +00:00
### Helm
2022-07-23 01:37:45 +00:00
To uninstall the `photoprism` deployment
2022-07-22 15:48:06 +00:00
```console
2022-07-23 01:37:45 +00:00
helm uninstall photoprism
2022-07-22 15:48:06 +00:00
```
## Configuration
### Helm
#### Available Settings
Read through the [values.yaml ](./values.yaml ) file. It has several commented out suggested values.
Other values may be used from the [values.yaml ](https://github.com/truecharts/library-charts/tree/main/charts/stable/common/values.yaml ) from the [common library ](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common ).
#### Configure using the Commandline
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install` .
```console
2022-07-23 01:37:45 +00:00
helm install photoprism \
2022-07-22 15:48:06 +00:00
--set env.TZ="America/New York" \
2022-07-23 01:37:45 +00:00
TrueCharts/photoprism
2022-07-22 15:48:06 +00:00
```
#### Configure using a yaml file
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
```console
2022-07-23 01:37:45 +00:00
helm install photoprism TrueCharts/photoprism -f values.yaml
2022-07-22 15:48:06 +00:00
```
#### Connecting to other apps
2022-07-22 17:03:23 +00:00
If you need to connect this App to other Apps on TrueNAS SCALE, please refer to our [Linking Apps Internally ](https://truecharts.org/docs/manual/Quick-Start%20Guides/06-linking-apps/ ) quick-start guide.
2022-07-22 15:48:06 +00:00
## Support
- Please check our [quick-start guides for TrueNAS SCALE ](https://truecharts.org/docs/manual/SCALE%20Apps/Quick-Start%20Guides/Important-MUST-READ ).
- See the [Website ](https://truecharts.org )
- Check our [Discord ](https://discord.gg/tVsPTHWTtr )
- Open a [issue ](https://github.com/truecharts/apps/issues/new/choose )
---
## Sponsor TrueCharts
TrueCharts can only exist due to the incredible effort of our staff.
Please consider making a [donation ](https://truecharts.org/docs/about/sponsor ) or contributing back to the project any way you can!
---
All Rights Reserved - The TrueCharts Project