From c6cad461482fba206804e09f84702dedba1444e6 Mon Sep 17 00:00:00 2001 From: Michael Mayer Date: Mon, 18 Dec 2023 08:35:46 +0100 Subject: [PATCH] Setup: Update Linux package installation docs #3861 Signed-off-by: Michael Mayer --- setup/pkg/linux/README.html | 2 +- setup/pkg/linux/README.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/setup/pkg/linux/README.html b/setup/pkg/linux/README.html index ab736f9a7..e70293970 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 packages available at dl.photoprism.app/pkg/linux/ to install PhotoPrism on compatible Linux distributions without building it from source.

We recommend that only experienced users choose this installation method, since these packages need to be set up manually and do not include the system dependencies required to make use of all the features.

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

Installation Using tar.gz Archives

You can download and install PhotoPrism in /opt/photoprism by running the following commands:

If your server has an ARM-based CPU, please make sure to install arm64.tar.gz instead of amd64.tar.gz when using the commands above. Both are linked to the latest stable release.

Since the packages currently do not include a default configuration, we recommend that you create a defaults.yml in /etc/photoprism next, in which you configure the paths and other settings that you want to use for your instance.

.deb Packages for Ubuntu / Debian Linux

As an alternative to the plain tar.gz archives, that you need to unpack manually, we also offer .deb packages for Debian-based distributions such as Ubuntu Linux.

On servers with a 64-bit Intel or AMD CPU, our latest stable release can be installed as follows:

If your server has an ARM-based CPU, such as a Raspberry Pi, use the following commands instead:

This will install PhotoPrism to /opt/photoprism and add a /usr/local/bin/photoprism symlink for the CLI command.

Since the packages currently do not include a default configuration, we recommend that you create a defaults.yml in /etc/photoprism next, in which you configure the paths and other settings that you want to use for your instance.

Updates

To update your installation, please stop all running PhotoPrism instances and make sure that there are no custom media, database, or config files in the /opt/photoprism directory. You can then delete its contents with the command sudo rm -rf /opt/photoprism/* and install a new version as shown above.

If you used a .deb package for the installation, you may need to remove the currently installed photoprism package by running sudo dpkg -r photoprism before you can install a new version with sudo dpkg -i package.deb. This is a known issue that we hope to resolve with improved packages.

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.

Global config defaults can be defined in a /etc/photoprism/defaults.yml file. 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.

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. To simplify updates, we recommend not to store any media, database, or config files in the same directory where you installed PhotoPrism, e.g. /opt/photoprism, and to use a different base directory for them instead, for example /photoprism, /var/lib/photoprism, or a path relative to each user's home directory.

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 ›

+

PhotoPrism® Installation Packages

As an alternative to our Docker images, you can use the packages available at dl.photoprism.app/pkg/linux/ to install PhotoPrism on compatible Linux distributions without building it from source.

We recommend that only experienced users choose this installation method, since these packages need to be set up manually and do not include the system dependencies required to make use of all the features.

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

Installation Using tar.gz Archives

You can download and install PhotoPrism in /opt/photoprism by running the following commands:

If your server has an ARM-based CPU, please make sure to install arm64.tar.gz instead of amd64.tar.gz when using the commands above. Both are linked to the latest stable release.

Since the packages currently do not include a default configuration, we recommend that you create a defaults.yml in /etc/photoprism next, in which you configure the paths and other settings that you want to use for your instance.

.deb Packages for Ubuntu / Debian Linux

As an alternative to the plain tar.gz archives, that you need to unpack manually, we also offer .deb packages for Debian-based distributions such as Ubuntu Linux.

On servers with a 64-bit Intel or AMD CPU, our latest stable release can be installed as follows:

If your server has an ARM-based CPU, such as a Raspberry Pi, use the following commands instead:

This will install PhotoPrism to /opt/photoprism and add a /usr/local/bin/photoprism symlink for the CLI command.

Since the packages currently do not include a default configuration, we recommend that you create a defaults.yml in /etc/photoprism next, in which you configure the paths and other settings that you want to use for your instance.

Updates

To update your installation, please stop all running PhotoPrism instances and make sure that there are no media, database, or custom config files in the /opt/photoprism directory. You can then delete its contents with the command sudo rm -rf /opt/photoprism/* and install a new version as shown above.

If you used a .deb package for the installation, you may need to remove the currently installed photoprism package by running sudo dpkg -r photoprism before you can install a new version with sudo dpkg -i package.deb. This is a known issue that we hope to resolve with improved packages.

Dependencies

In order to use all PhotoPrism features and have full file format support, additional system dependencies must be installed as they are not included in the packages we provide, for example exiftool, darktable, rawtherapee, libheif, imagemagick, ffmpeg, libavcodec-extra, mariadb, sqlite3, and tzdata. The actual names may vary depending on what distribution you use.

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.

Global config defaults can be defined in a /etc/photoprism/defaults.yml file. 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.

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. To simplify updates, we recommend not to store any media, database, or custom config files in the same directory where you installed PhotoPrism, e.g. /opt/photoprism, and to use a different base directory for them instead, for example /photoprism, /var/lib/photoprism, or a path relative to each user's home directory.

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 ce8453779..63feace05 100644 --- a/setup/pkg/linux/README.md +++ b/setup/pkg/linux/README.md @@ -48,13 +48,13 @@ Since the packages currently do not include a default configuration, we recommen ## Updates -To update your installation, please stop all running PhotoPrism instances and make sure that there are [no custom media, database, or config files](#configuration) in the `/opt/photoprism` directory. You can then delete its contents with the command `sudo rm -rf /opt/photoprism/*` and install a new version as shown above. +To update your installation, please stop all running PhotoPrism instances and make sure that there are [no media, database, or custom config files](#configuration) in the `/opt/photoprism` directory. You can then delete its contents with the command `sudo rm -rf /opt/photoprism/*` and install a new version as shown above. If you used a *.deb* package for the installation, you may need to remove the currently installed `photoprism` package by running `sudo dpkg -r photoprism` before you can install a new version with `sudo dpkg -i package.deb`. This is a known issue that we hope to resolve with improved packages. ## Dependencies -In order to use all PhotoPrism features and have [full file format support](https://www.photoprism.app/kb/file-formats), additional distribution packages must be installed manually as they are not included in the tar.gz archive, for example exiftool, darktable, rawtherapee, [libheif](https://dl.photoprism.app/dist/libheif/README.html), imagemagick, ffmpeg, libavcodec-extra, mariadb, sqlite3, and tzdata. +In order to use all PhotoPrism features and have [full file format support](https://www.photoprism.app/kb/file-formats), additional system dependencies **must be installed** as they are not included in the packages we provide, for example exiftool, darktable, rawtherapee, [libheif](https://dl.photoprism.app/dist/libheif/README.html), imagemagick, ffmpeg, libavcodec-extra, mariadb, sqlite3, and tzdata. The actual names may vary depending on what distribution you use. For details on the packages installed in our official Docker images, see . @@ -64,7 +64,7 @@ Run `photoprism --help` in a terminal to get an [overview of the command flags a Global config defaults [can be defined in a `/etc/photoprism/defaults.yml` file](#defaultsyml). 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`. -If no explicit *originals*, *import* and/or *assets* path has been configured, a list of [default directory paths](https://github.com/photoprism/photoprism/blob/develop/pkg/fs/dirs.go) will be searched and the first existing directory will be used for the respective path. To simplify [updates](#updates), we recommend **not to store** any media, database, or config files in the same directory where you installed PhotoPrism, e.g. `/opt/photoprism`, and to use a different base directory for them instead, for example `/photoprism`, `/var/lib/photoprism`, or a path relative to each user's home directory. +If no explicit *originals*, *import* and/or *assets* path has been configured, a list of [default directory paths](https://github.com/photoprism/photoprism/blob/develop/pkg/fs/dirs.go) will be searched and the first existing directory will be used for the respective path. To simplify [updates](#updates), we recommend **not to store** any media, database, or custom config files in the same directory where you installed PhotoPrism, e.g. `/opt/photoprism`, and to use a different base directory for them instead, for example `/photoprism`, `/var/lib/photoprism`, or a path relative to each user's home directory. 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.