Setup: Update docs for binary installation packages #3861
Signed-off-by: Michael Mayer <michael@photoprism.app>
This commit is contained in:
Michael Mayer
parent
4ffc548287
commit
7801e603f9
2 changed files with 35 additions and 7 deletions
File diff suppressed because one or more lines are too long
|
|
@ -1,16 +1,18 @@
|
|||
# PhotoPrism® Installation Packages
|
||||
|
||||
As an alternative to our [Docker images](https://docs.photoprism.app/getting-started/docker-compose/), you can use the *tar.gz* archives available at [**dl.photoprism.app/pkg/linux/**](https://dl.photoprism.app/pkg/linux/) to install PhotoPrism on compatible Linux distributions without building it from source:
|
||||
As an alternative to our [Docker images](https://docs.photoprism.app/getting-started/docker-compose/), we also provide [installation packages with binaries](https://dl.photoprism.app/pkg/linux/) that allow you to install PhotoPrism on compatible Linux distributions without building it from source:
|
||||
|
||||
- <https://dl.photoprism.app/pkg/linux/amd64.tar.gz>
|
||||
- <https://dl.photoprism.app/pkg/linux/arm64.tar.gz>
|
||||
|
||||
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.
|
||||
We recommend that **only experienced users** choose this installation method, since these packages [need to be set up manually](#configuration) and [do not include the system dependencies](#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:
|
||||
|
||||
```
|
||||
|
|
@ -21,11 +23,37 @@ 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.
|
||||
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](https://github.com/photoprism/photoprism/releases).
|
||||
|
||||
Since the packages currently do not include a default configuration, we recommend that you create a [`defaults.yml`](https://docs.photoprism.app/getting-started/config-files/defaults/) 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**, the [latest stable release](https://github.com/photoprism/photoprism/releases) can be installed as follows:
|
||||
|
||||
```
|
||||
curl -sLO https://dl.photoprism.app/pkg/linux/deb/amd64.deb
|
||||
sudo dpkg -i amd64.deb
|
||||
```
|
||||
|
||||
If your server has an **ARM-based CPU**, such as a [Raspberry Pi](https://docs.photoprism.app/getting-started/raspberry-pi/), you need to run the following instead:
|
||||
|
||||
```
|
||||
curl -sLO https://dl.photoprism.app/pkg/linux/deb/arm64.deb
|
||||
sudo dpkg -i arm64.deb
|
||||
```
|
||||
|
||||
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`](https://docs.photoprism.app/getting-started/config-files/defaults/) 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 replace the contents of the installation directory, e.g. `/opt/photoprism`, with the new version.
|
||||
To update your installation, please stop all running PhotoPrism instances, delete the contents of the `/opt/photoprism` directory by running the command `sudo rm -rf /opt/photoprism/*` and then install the 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 in the future.
|
||||
|
||||
## Dependencies
|
||||
|
||||
|
|
@ -45,7 +73,7 @@ Please keep in mind that any changes to the config options, either [through the
|
|||
|
||||
### `defaults.yml`
|
||||
|
||||
Global config defaults, including the config and storage paths to use, can optionally be [set with a `defaults.yml` file](https://dl.photoprism.app/pkg/linux/defaults.yml) 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.
|
||||
Global config defaults, including the config and storage paths to use, can optionally be [set with a `defaults.yml` file](https://docs.photoprism.app/getting-started/config-files/defaults/) 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.:
|
||||
|
||||
|
|
@ -69,7 +97,7 @@ When specifying values, make sure that the data type is the [same as in the docu
|
|||
|
||||
### `options.yml`
|
||||
|
||||
Default config values can be overridden by values [specified in an `options.yml` file](https://dl.photoprism.app/pkg/linux/options.yml) 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.
|
||||
Default config values can be overridden by values [specified in an `options.yml` file](https://docs.photoprism.app/getting-started/config-files/) 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](https://docs.photoprism.app/getting-started/config-files/#config-options).
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue