|
|
||
|---|---|---|
| .. | ||
| README.html | ||
| README.md | ||
PhotoPrism® Installation Packages
As an alternative to our Docker images, you can use the tar.gz archives available at dl.photoprism.app/pkg/linux/ to install PhotoPrism on compatible Linux distributions without building it from source:
Since these packages need to be set up manually and do not include the system dependencies required to make use of all the features, we recommend that only advanced users choose this installation method.
Also note that the minimum required glibc version is 2.35, so for example Ubuntu 22.04 and Debian Bookworm will work with these binaries, but older Linux distributions may not be compatible.
Usage
You can download and install PhotoPrism in /opt/photoprism by running the following commands:
sudo mkdir -p /opt/photoprism
cd /opt/photoprism
wget -c https://dl.photoprism.app/pkg/linux/amd64.tar.gz -O - | sudo tar -xz
sudo ln -sf /opt/photoprism/bin/photoprism /usr/local/bin/photoprism
photoprism --version
If your server has an ARM-based CPU, make sure to install arm64.tar.gz instead of amd64.tar.gz when using the commands above. Both are linked to the latest available build.
Updates
To update your installation, please stop all running PhotoPrism instances and replace the contents of the installation directory, e.g. /opt/photoprism, with the new version.
Dependencies
In order to use all PhotoPrism features and have full file format support, additional distribution packages must be installed manually as they are not included in the tar.gz archive, for example exiftool, darktable, rawtherapee, libheif, imagemagick, ffmpeg, libavcodec-extra, mariadb, sqlite3, and tzdata.
For details on the packages installed in our official Docker images, see https://github.com/photoprism/photoprism/tree/develop/docker/develop.
Configuration
Run photoprism --help in a terminal to get an overview of the command flags and environment variables available for configuration. Their current values can be displayed with the photoprism config command.
If no explicit originals, import and/or assets path has been configured, a list of default directory paths will be searched and the first existing directory will be used for the respective path.
Global config defaults can be defined in a /etc/photoprism/defaults.yml file (see below). When specifying paths, ~ is supported as a placeholder for the current user's home directory, e.g. ~/Pictures.
Please keep in mind that any changes to the global config options, either through the UI, config files, or by setting environment variables, require a restart to take effect.
defaults.yml
Global config defaults, including the config and storage paths to use, can optionally be set with a defaults.yml file in the /etc/photoprism directory (requires root privileges). A custom filename for loading the defaults can be specified with the PHOTOPRISM_DEFAULTS_YAML environment variable or the --defaults-yaml command flag.
Since you only need to add the values for which you want to have a custom default, a defaults.yml file does not need to contain all available options and can thus be kept to a minimum, e.g.:
Debug: false
JpegQuality: 85
ConfigPath: "~/.photoprism"
options.yml
Default config values in the defaults.yml file can be overridden by values specified in a options.yml file, the command flags, and the environment variables. The config path from which the options.yml file is loaded, if it exists, can be set by adding a ConfigPath value to the defaults.yml, using the --config-path command flag, or with the PHOTOPRISM_CONFIG_PATH environment variable.
For a list of supported options and their names, see https://docs.photoprism.app/getting-started/config-files/.
Documentation
For detailed information on specific features and related resources, see our Knowledge Base, or check the User Guide for help navigating the user interface, a complete list of config options, and other installation methods:
Getting Support
If you need help installing our software at home, you are welcome to post your question in GitHub Discussions or ask in our Community Chat. Common problems can be quickly diagnosed and solved using our Troubleshooting Checklists. Silver, Gold, and Platinum members are also welcome to email us for technical support and advice.