From be10bacb40c9f86c997b88b83df5c425177220ae Mon Sep 17 00:00:00 2001 From: Michael Mayer Date: Thu, 9 Nov 2023 10:13:22 +0100 Subject: [PATCH] Setup: Update Linux package install guide #3861 Signed-off-by: Michael Mayer --- setup/pkg/linux/README.html | 2 +- setup/pkg/linux/README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/setup/pkg/linux/README.html b/setup/pkg/linux/README.html index 3deee5b9f..0d61508dc 100644 --- a/setup/pkg/linux/README.html +++ b/setup/pkg/linux/README.html @@ -672,6 +672,6 @@ header, .context-menu, .megamenu-content, footer{ README
-

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 experienced 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:

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. Relative paths can also be specified via ./pathname.

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.

A defaults.yml file affects all users and should only contain values for options for which you want to set a global default, e.g.:

For a list of supported options and their names, see https://docs.photoprism.app/getting-started/config-files/#config-options.

When specifying values, make sure that the data type is the same as in the documentation, e.g. bool values must be either true or false and int values must be whole numbers without any quotes like in the example above.

options.yml

Default config values can be overridden by values specified in an options.yml file as well as with command flags and environment variables. To load values from an existing options.yml file, you can specify its storage path (excluding the filename) by setting the ConfigPath option in your defaults.yml file, using the --config-path command flag, or with the PHOTOPRISM_CONFIG_PATH environment variable.

The values in an options.yml file are not global and can be used to customize individual instances e.g. based on the default values in a defaults.yml file. Both files allow you to set any of the supported options.

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.

View Support Options ›

+

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 experienced 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:

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. Relative paths can also be specified via ./pathname.

Please keep in mind that any changes to the 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.

A defaults.yml file affects all users and should only contain values for options for which you want to set a global default, e.g.:

For a list of supported options and their names, see https://docs.photoprism.app/getting-started/config-files/#config-options.

When specifying values, make sure that the data type is the same as in the documentation, e.g. bool values must be either true or false and int values must be whole numbers without any quotes like in the example above.

options.yml

Default config values can be overridden by values specified in an options.yml file as well as with command flags and environment variables. To load values from an existing options.yml file, you can specify its storage path (excluding the filename) by setting the ConfigPath option in your defaults.yml file, using the --config-path command flag, or with the PHOTOPRISM_CONFIG_PATH environment variable.

The values in an options.yml file are not global and can be used to customize individual instances e.g. based on the default values in a defaults.yml file. Both files allow you to set any of the supported options.

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.

View Support Options ›

\ No newline at end of file diff --git a/setup/pkg/linux/README.md b/setup/pkg/linux/README.md index 8a3f3abd3..12a50c442 100644 --- a/setup/pkg/linux/README.md +++ b/setup/pkg/linux/README.md @@ -41,7 +41,7 @@ If no explicit *originals*, *import* and/or *assets* path has been configured, a 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`. Relative paths can also be specified via `./pathname`. -Please keep in mind that any changes to the global config options, either [through the UI](https://docs.photoprism.app/user-guide/settings/advanced/), [config files](https://docs.photoprism.app/getting-started/config-files/), or by [setting environment variables](https://docs.photoprism.app/getting-started/config-options/), require a restart to take effect. +Please keep in mind that any changes to the config options, either [through the UI](https://docs.photoprism.app/user-guide/settings/advanced/), [config files](https://docs.photoprism.app/getting-started/config-files/), or by [setting environment variables](https://docs.photoprism.app/getting-started/config-options/), require a restart to take effect. ### `defaults.yml`