From 5ee5bd09757fb4d68529c7fcc344026685d8925e Mon Sep 17 00:00:00 2001 From: Michael Mayer Date: Mon, 30 Sep 2024 08:55:24 +0200 Subject: [PATCH] Config: Mention "compose.yaml" in addition to "docker-compose.yml" see https://github.com/photoprism/photoprism/issues/4113 --- docs/developer-guide/setup.md | 4 ++-- docs/developer-guide/technologies/yaml.md | 4 ++-- docs/getting-started/advanced/docker-security.md | 4 ++-- docs/getting-started/advanced/docker-volumes.md | 2 +- .../advanced/migrations/mariadb-to-sqlite.md | 2 +- .../advanced/migrations/sqlite-to-mariadb.md | 2 +- docs/getting-started/advanced/transcoding.md | 4 ++-- docs/getting-started/docker-compose.md | 12 ++++++------ docs/getting-started/faq.md | 2 +- docs/getting-started/ports/freebsd.md | 2 +- docs/getting-started/troubleshooting/docker.md | 4 ++-- docs/getting-started/troubleshooting/mariadb.md | 14 +++++++------- .../getting-started/troubleshooting/performance.md | 2 +- docs/getting-started/updates.md | 2 +- docs/getting-started/using-https.md | 4 ++-- docs/known-issues.md | 2 +- docs/release-notes.md | 4 ++-- docs/user-guide/faq.md | 2 +- docs/user-guide/settings/advanced.md | 2 +- docs/user-guide/sync/dropbox.md | 4 ++-- 20 files changed, 39 insertions(+), 39 deletions(-) diff --git a/docs/developer-guide/setup.md b/docs/developer-guide/setup.md index d339d46255..abe42ee9b4 100644 --- a/docs/developer-guide/setup.md +++ b/docs/developer-guide/setup.md @@ -74,7 +74,7 @@ In the build environment, the default login is `admin` with the password `photop ./photoprism --public start ``` -You can find the default settings in [the docker-compose.yml file](https://github.com/photoprism/photoprism/blob/develop/docker-compose.yml) located in the root of the project. Keep them when [you run tests](tests.md). Otherwise, the tests may fail for others, even if they [succeed in your local environment](code-quality.md#test-automation-guidelines). +You can find the default settings in [the `compose.yaml` or `docker-compose.yml` file](https://github.com/photoprism/photoprism/blob/develop/docker-compose.yml) located in the root of the project. Keep them when [you run tests](tests.md). Otherwise, the tests may fail for others, even if they [succeed in your local environment](code-quality.md#test-automation-guidelines). !!! example "" You can find a list of all `make` targets in the [Makefile](https://github.com/photoprism/photoprism/blob/develop/Makefile). @@ -146,7 +146,7 @@ Once the debugger is running, you can view the app at `http://localhost:2342/` a * Radomir Sohlich wrote a [pragmatic introduction to Makefiles](https://sohlich.github.io/post/go_makefile/) for Go developers * we are using [Go Modules](https://github.com/golang/go/wiki/Modules) for managing our dependencies (new in 1.11) -* this guide was not tested on Windows, you might need to change docker-compose.yml to make it work with Windows specific paths +* this guide was not tested on Windows, you might need to edit your `compose.yaml` or `docker-compose.yml` to make it work with Windows specific paths ### Apple Silicon, Raspberry Pi, and ARM64 diff --git a/docs/developer-guide/technologies/yaml.md b/docs/developer-guide/technologies/yaml.md index 38bdfbe9be..efc29786a4 100644 --- a/docs/developer-guide/technologies/yaml.md +++ b/docs/developer-guide/technologies/yaml.md @@ -65,11 +65,11 @@ services: ## Docker Compose ## -When using [Docker Compose](https://docs.docker.com/compose/compose-file/compose-file-v3/), some additional rules apply, as `docker-compose.yml` files extend the YAML format with features such as [variable interpolation](https://docs.docker.com/compose/compose-file/12-interpolation/#interpolation). +When using [Docker Compose](https://docs.docker.com/compose/compose-file/compose-file-v3/), some additional rules apply, as `compose.yaml` or `docker-compose.yml` files extend the YAML format with features such as [variable interpolation](https://docs.docker.com/compose/compose-file/12-interpolation/#interpolation). ### Dollar Signs ### -If a configuration value [in a `docker-compose.yml` file](../../getting-started/docker-compose.md) contains a literal `$` character, for example in a password, you must use `$$` (a double dollar sign) to escape it so that e.g. `"compo$e"` becomes `"compo$$e"`: +If a configuration value [in a `compose.yaml` or `docker-compose.yml` file](../../getting-started/docker-compose.md) contains a literal `$` character, for example in a password, you must use `$$` (a double dollar sign) to escape it so that e.g. `"compo$e"` becomes `"compo$$e"`: ```yaml services: diff --git a/docs/getting-started/advanced/docker-security.md b/docs/getting-started/advanced/docker-security.md index dce045fb7d..9749150cea 100644 --- a/docs/getting-started/advanced/docker-security.md +++ b/docs/getting-started/advanced/docker-security.md @@ -6,7 +6,7 @@ Even though [PhotoPrism](https://github.com/photoprism/photoprism) is [developed in Go](https://go.dev/) and therefore does not use many of the C libraries installed in our Docker image, external file converters like Darktable and FFmpeg as well as other tools installed as dependencies might use them. They may also be directly affected by [recently discovered vulnerabilities](https://ubuntu.com/security/cves) for which updates are available. -To automatically install these updates when the container starts for the first time, you can add `PHOTOPRISM_INIT: "update"` to the `environment` section of the `photoprism` service in your `docker-compose.yml`: +To automatically install these updates when the container starts for the first time, you can add `PHOTOPRISM_INIT: "update"` to the `environment` section of the `photoprism` service in your `compose.yaml` or `docker-compose.yml`: ```yaml services: @@ -32,7 +32,7 @@ We also recommend making sure that the latest Docker version and security update ## Run Services as Non-Root User -It is recommended that you run the `photoprism` service as a non-root user by setting either the `user` [service property](https://docs.docker.com/compose/compose-file/05-services/#user) or the `PHOTOPRISM_UID` and `PHOTOPRISM_GID` [environment variable](../config-options.md#docker-image) in your `docker-compose.yml` file: +It is recommended that you run the `photoprism` service as a non-root user by setting either the `user` [service property](https://docs.docker.com/compose/compose-file/05-services/#user) or the `PHOTOPRISM_UID` and `PHOTOPRISM_GID` [environment variable](../config-options.md#docker-image) in your `compose.yaml` or `docker-compose.yml` file: | Environment | Default | Description | |--------------------------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| diff --git a/docs/getting-started/advanced/docker-volumes.md b/docs/getting-started/advanced/docker-volumes.md index 6c0e1d578d..644f450d30 100644 --- a/docs/getting-started/advanced/docker-volumes.md +++ b/docs/getting-started/advanced/docker-volumes.md @@ -40,7 +40,7 @@ volumes: SQLite, config, cache, backup, thumbnail and sidecar files are saved in the *storage* folder: -- a *storage* folder mount must always be configured in your `docker-compose.yml` file so that you do not lose these files after a restart or upgrade +- a *storage* folder mount must always be configured in your `compose.yaml` or `docker-compose.yml` file so that you do not lose these files after a restart or upgrade - never configure the *storage* folder to be inside the *originals* folder unless the name starts with a `.` to indicate that it is hidden - we recommend placing the *storage* folder on a [local SSD drive](../troubleshooting/performance.md#storage) for best performance - mounting [symbolic links](https://en.wikipedia.org/wiki/Symbolic_link) or using them inside the *storage* folder is currently not supported diff --git a/docs/getting-started/advanced/migrations/mariadb-to-sqlite.md b/docs/getting-started/advanced/migrations/mariadb-to-sqlite.md index ef55d0d79e..eb52a82317 100644 --- a/docs/getting-started/advanced/migrations/mariadb-to-sqlite.md +++ b/docs/getting-started/advanced/migrations/mariadb-to-sqlite.md @@ -7,7 +7,7 @@ - Add the port to the MariaDB service - On the **host** now run `sudo mysql2sqlite -f /storage/index.db -d photoprism -u root --mysql-password 'insecure'` - Shutdown your current stack fully: `docker compose down` -- Edit your `docker-compose.yml`: +- Edit your `compose.yaml` or `docker-compose.yml`: - Remove the MariaDB service. - Change in the Photoprism settings to use the sqlite driver and remove the other database settings - Start your stack again with `docker compose up -d` diff --git a/docs/getting-started/advanced/migrations/sqlite-to-mariadb.md b/docs/getting-started/advanced/migrations/sqlite-to-mariadb.md index a579b56f20..83762514e5 100644 --- a/docs/getting-started/advanced/migrations/sqlite-to-mariadb.md +++ b/docs/getting-started/advanced/migrations/sqlite-to-mariadb.md @@ -10,7 +10,7 @@ - Stop Photoprism: `docker compose stop photoprism` - On the **host** now run `sudo sqlite3mysql -f /storage/index.db -d photoprism -u root -p` and enter the MariaDB password when prompted (default is `insecure`). - Shutdown your current stack again: `docker compose down` -- Edit your `docker-compose.yml` so it uses the MariaDB database you added before. Don't forget to remove the `ports` +- Edit your `compose.yaml` or `docker-compose.yml` so it uses the MariaDB database you added before. Don't forget to remove the `ports` section of the MariaDB Container. - Start your stack again with `docker compose up -d` - If this worked you may want to delete the file `index.db` in the `storage` mount since it contains out of date diff --git a/docs/getting-started/advanced/transcoding.md b/docs/getting-started/advanced/transcoding.md index a36810185a..693ef5f3fe 100644 --- a/docs/getting-started/advanced/transcoding.md +++ b/docs/getting-started/advanced/transcoding.md @@ -2,7 +2,7 @@ ## AVC Encoders -The encoder used by FFmpeg can be configured with [`PHOTOPRISM_FFMPEG_ENCODER`](../config-options.md#file-conversion) in your `docker-compose.yml` config file: +The encoder used by FFmpeg can be configured with [`PHOTOPRISM_FFMPEG_ENCODER`](../config-options.md#file-conversion) in your `compose.yaml` or `docker-compose.yml` config file: | Encoder | Value | |----------------------------|-------------| @@ -93,7 +93,7 @@ services: - ... ``` -In addition, you can choose to run the `photoprism` service as a non-root user by setting either the `user` [service property](https://docs.docker.com/compose/compose-file/05-services/#user) or the `PHOTOPRISM_UID` and `PHOTOPRISM_GID` [environment variables](../config-options.md#docker-image) in your `docker-compose.yml` file: +In addition, you can choose to run the `photoprism` service as a non-root user by setting either the `user` [service property](https://docs.docker.com/compose/compose-file/05-services/#user) or the `PHOTOPRISM_UID` and `PHOTOPRISM_GID` [environment variables](../config-options.md#docker-image) in your `compose.yaml` or `docker-compose.yml` file: | Environment | Default | Description | |----------------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| diff --git a/docs/getting-started/docker-compose.md b/docs/getting-started/docker-compose.md index 9e0863d203..5bec986c59 100644 --- a/docs/getting-started/docker-compose.md +++ b/docs/getting-started/docker-compose.md @@ -19,7 +19,7 @@ Alternatively, [Podman Compose](troubleshooting/docker.md#podman-compose) is sup Commands on Linux may have to be prefixed with `sudo` when not running as root. Note that this will point the home directory shortcut `~` to `/root` in the `volumes:` - section of your `docker-compose.yml`. Kernel security modules such as AppArmor and SELinux + section of your config file. Kernel security modules such as AppArmor and SELinux have been [reported to cause issues](troubleshooting/docker.md#kernel-security). We recommend that your server has [at least 4 GB of swap](troubleshooting/docker.md#adding-swap) configured and to avoid setting a [hard memory limit](faq.md#why-is-my-configured-memory-limit-exceeded-when-indexing-even-though-photoprism-doesnt-actually-seem-to-use-that-much-memory), as this can lead to unexpected restarts when the indexer temporarily needs more memory to process large files. Indexing [RAW images and high-resolution panoramas](troubleshooting/performance.md#memory) may require additional [swap space](troubleshooting/docker.md#adding-swap) and/or physical memory beyond the [recommended minimum](index.md#system-requirements). @@ -112,7 +112,7 @@ Alternatively, [Podman Compose](troubleshooting/docker.md#podman-compose) is sup Indexing [RAW images and high-resolution panoramas](troubleshooting/performance.md#memory) may require additional [swap space](troubleshooting/docker.md#adding-swap) and/or physical memory beyond the [recommended minimum](index.md#system-requirements). !!! note "" - When editing your `compose.yaml` or `docker-compose.yml` file, please make sure that [related values remain on the same indentation level](../developer-guide/technologies/yaml.md) and that [lists start with a dash](../developer-guide/technologies/yaml.md#multiple-values). + When editing YAML files, please make sure that [related values remain on the same indentation level](../developer-guide/technologies/yaml.md) and that [lists start with a dash](../developer-guide/technologies/yaml.md#multiple-values). If the value of an environment variable contains a literal `$` sign, for example in a password, it [must be escaped](../developer-guide/technologies/yaml.md#dollar-signs) with `$$` (a double dollar sign) so that e.g. `"compo$e"` becomes `"compo$$e"`. !!! danger "" @@ -208,7 +208,7 @@ services: ### Step 2: Start the server -Open a terminal and change to the folder in which your `compose.yaml` or `docker-compose.yml` file has been saved.[^1] +Open a terminal and change to the folder in which your config file has been saved.[^1] Run this command to start the application and database services in the background: ```bash @@ -311,7 +311,7 @@ PhotoPrism's command-line interface is also well suited for job automation using !!! tip "" When using *Docker Compose*, you can prefix the commands you want to run with `docker compose exec [service]` to execute them in the specified service container. - If this fails with *no container found*, please make sure that the service has been started, you have specified an existing service (usually `photoprism`) and you are in the folder where your `compose.yaml` or `docker-compose.yml` file is located. + If this fails with *no container found*, please make sure that the service has been started, you have specified an existing service (usually `photoprism`) and you are in the folder where your config file is located. #### Opening a Terminal @@ -336,7 +336,7 @@ Note, however, that commands that you run without an explicit user ID might be e The currently supported user ID ranges are 0, 33, 50-99, 500-600, 900-1250, and 2000-2100. !!! tip "" - We recommend running the `photoprism` service as a non-root user by setting either the [user service property](https://docs.docker.com/compose/compose-file/05-services/#user) or the `PHOTOPRISM_UID` [environment variable](config-options.md#docker-image) in your `compose.yaml` or `docker-compose.yml` file. Don't forget to update file permissions and/or ownership with the `chown` command when you make changes. + We recommend running the `photoprism` service as a non-root user by setting either the [user service property](https://docs.docker.com/compose/compose-file/05-services/#user) or the `PHOTOPRISM_UID` [environment variable](config-options.md#docker-image) in your config file. Don't forget to update file permissions and/or ownership with the `chown` command when you make changes. #### Examples @@ -389,4 +389,4 @@ The currently supported user ID ranges are 0, 33, 50-99, 500-600, 900-1250, and *[filesystem]: contains your files and folders *[RHEL]: Red Hat Enterprise Linux® -[^1]: The default filename for the [Docker Compose](https://docs.docker.com/compose/) configuration is `docker-compose.yml`. For simplicity, it does not need to be specified if you run commands in the same directory. Config files for other apps and instances should be placed in separate folders. \ No newline at end of file +[^1]: The default name for [Docker Compose](https://docs.docker.com/compose/) config files is `compose.yaml` or `docker-compose.yml`. For simplicity, it does not need to be specified if you run commands in the same directory. Config files for other apps and instances should be placed in separate folders. \ No newline at end of file diff --git a/docs/getting-started/faq.md b/docs/getting-started/faq.md index 161ff35931..025bf7ec2c 100644 --- a/docs/getting-started/faq.md +++ b/docs/getting-started/faq.md @@ -106,7 +106,7 @@ Other [free and open-source software](https://en.wikipedia.org/wiki/Free_and_ope ### How can I activate my membership? -To connect a new instance to your membership account, you will need to log in with the super admin user that is automatically created during setup (see your `docker-compose.yml` file or the app store documentation), and then follow the steps described in our activation guide. +To connect a new instance to your membership account, you will need to log in with the super admin user that is automatically created during setup (see your `compose.yaml` or `docker-compose.yml` file or the app store documentation), and then follow the steps described in our activation guide. [View Activation Guide ›](https://www.photoprism.app/kb/activation) diff --git a/docs/getting-started/ports/freebsd.md b/docs/getting-started/ports/freebsd.md index c3bff24bdd..6a5a8cef4f 100644 --- a/docs/getting-started/ports/freebsd.md +++ b/docs/getting-started/ports/freebsd.md @@ -1,7 +1,7 @@ # Running PhotoPrism On FreeBSD !!! danger "" - Please note that third-party apps may not provide access to the docker-compose.yml file or the command line, and therefore you may not be able to use all of PhotoPrism's features and config options. + Please note that third-party apps may not provide access to the `compose.yaml` or `docker-compose.yml` file or the command line, and therefore you may not be able to use all of PhotoPrism's features and config options. !!! tldr "" Should you experience problems with the installation, we recommend that you ask the FreeBSD community for advice, as we cannot provide support for third-party software and services. You can contribute by clicking :material-file-edit-outline: to send a pull request with your changes. diff --git a/docs/getting-started/troubleshooting/docker.md b/docs/getting-started/troubleshooting/docker.md index 368c89861a..c58928e720 100644 --- a/docs/getting-started/troubleshooting/docker.md +++ b/docs/getting-started/troubleshooting/docker.md @@ -108,7 +108,7 @@ sudo docker compose up -d ``` Note that this will point the home directory shortcut `~` to `/root` in the `volumes:` section -of your `docker-compose.yml`. +of your `compose.yaml` or `docker-compose.yml`. ### IPTables Firewall @@ -239,7 +239,7 @@ Then restart for the changes to take effect: sudo reboot ``` -In addition, you can reduce memory usage and improve stability by setting `PHOTOPRISM_WORKERS` to `1` in your `docker-compose.yml` file to limit the number of indexing workers. +In addition, you can reduce memory usage and improve stability by setting `PHOTOPRISM_WORKERS` to `1` in your `compose.yaml` or `docker-compose.yml` file to limit the number of indexing workers. ### Windows diff --git a/docs/getting-started/troubleshooting/mariadb.md b/docs/getting-started/troubleshooting/mariadb.md index 9818bdc684..58d1aa38d5 100644 --- a/docs/getting-started/troubleshooting/mariadb.md +++ b/docs/getting-started/troubleshooting/mariadb.md @@ -30,7 +30,7 @@ First, verify that you are using the correct port (default is `3306`) and host: - only use `localhost` or `127.0.0.1` if the database port [has been exposed](https://docs.docker.com/compose/compose-file/compose-file-v3/#ports) as described below and you are on the same computer (host) - we recommend [configuring a local hostname](https://dl.photoprism.app/img/docs/pihole-local-dns.png) to access other hosts on your network -To connect to MariaDB from your host or home network, you need to expose port `3306` in your `docker-compose.yml` +To connect to MariaDB from your host or home network, you need to expose port `3306` in your `compose.yaml` or `docker-compose.yml` and [restart the service for changes to take effect](../docker-compose.md#step-2-start-the-server): ```yaml @@ -56,7 +56,7 @@ If this doesn't help, check the [Docker Logs](docker.md#viewing-logs) for messag ## Wrong Password -If the password you are using was specified in a `docker-compose.yml` file and contains one or more `$` characters, these [must be escaped with `$$`](../../developer-guide/technologies/yaml.md#dollar-signs) (a double dollar sign) so that, for example, `"compo$e"` becomes `"compo$$e"`: +If the password you are using was specified in a `compose.yaml` or `docker-compose.yml` file and contains one or more `$` characters, these [must be escaped with `$$`](../../developer-guide/technologies/yaml.md#dollar-signs) (a double dollar sign) so that, for example, `"compo$e"` becomes `"compo$$e"`: ```yaml @@ -87,7 +87,7 @@ Should MariaDB fail to start after upgrading from an earlier version (or migrati However, newer MariaDB Docker images **support automatic upgrades** on startup, so you don't have to worry about that anymore. !!! danger "" - When upgrading from MariaDB 10.x to [11.0](https://mariadb.com/kb/en/release-notes-mariadb-11-0-series/), you [must replace](https://github.com/photoprism/photoprism/commit/bff649469d084498a1e75492c0bd99bda3f5a340#diff-03a31d6e73f48b7bba98b65352ce67a7d153fe2461f9c7b5e76be49a97ebf0cb) `command: mysqld` with `command: ` (followed by the command flags) in your `docker-compose.yml` file, otherwise the database server may fail to start. + When upgrading from MariaDB 10.x to [11.0](https://mariadb.com/kb/en/release-notes-mariadb-11-0-series/), you [must replace](https://github.com/photoprism/photoprism/commit/bff649469d084498a1e75492c0bd99bda3f5a340#diff-03a31d6e73f48b7bba98b65352ce67a7d153fe2461f9c7b5e76be49a97ebf0cb) `command: mysqld` with `command: ` (followed by the command flags) in your `compose.yaml` or `docker-compose.yml` file, otherwise the database server may fail to start. ### Manual Update @@ -97,7 +97,7 @@ To manually upgrade the internal database schema, run this command in a terminal docker compose exec mariadb mariadb-upgrade -uroot -p ``` -Enter the MariaDB "root" password specified in your `docker-compose.yml` when prompted. +Enter the MariaDB "root" password specified in your `compose.yaml` or `docker-compose.yml` when prompted. Alternatively, you can downgrade to the previous version, create a database backup using the `photoprism backup` command, start a new database instance based on the latest version, and then restore your index with @@ -105,7 +105,7 @@ the `photoprism restore` command. ### Auto Upgrade -To enable automatic schema updates, set `MARIADB_AUTO_UPGRADE` to a non-empty value in your `docker-compose.yml` as shown in our [config example](https://dl.photoprism.app/docker/docker-compose.yml): +To enable automatic schema updates, set `MARIADB_AUTO_UPGRADE` to a non-empty value in your `compose.yaml` or `docker-compose.yml` as shown in our [config example](https://dl.photoprism.app/docker/docker-compose.yml): ```yaml services: @@ -186,7 +186,7 @@ Unless you open the storage folder again in macOS Finder, the errors should then In case you forgot the MariaDB "root" password and the one specified in your configuration does not work, you can [start the server with the `--skip-grant-tables` flag](https://mariadb.com/docs/reference/mdb/cli/mariadbd/skip-grant-tables/) -added to the `mysqld` command in your `docker-compose.yml`. This will temporarily give full access +added to the `mysqld` command in your `compose.yaml` or `docker-compose.yml`. This will temporarily give full access to all users after a restart: ```yaml @@ -241,7 +241,7 @@ server that is not based on our [default configuration](https://dl.photoprism.ap - [ ] Before submitting a support request, verify the problem still occurs with a newly created database based on our example Run this command in a terminal to see the current values of the collation and character set variables (change the root -password `insecure` and database name `photoprism` as specified in your `docker-compose.yml`): +password `insecure` and database name `photoprism` as specified in your `compose.yaml` or `docker-compose.yml`): ```bash echo "SHOW VARIABLES WHERE Variable_name LIKE 'character\_set\_%' OR Variable_name LIKE 'collation%';" | \ diff --git a/docs/getting-started/troubleshooting/performance.md b/docs/getting-started/troubleshooting/performance.md index e6a2ac2719..82f136322e 100644 --- a/docs/getting-started/troubleshooting/performance.md +++ b/docs/getting-started/troubleshooting/performance.md @@ -6,7 +6,7 @@ The [InnoDB buffer pool](https://mariadb.com/kb/en/innodb-buffer-pool/) serves a It is a key component for optimizing MariaDB performance. Its size should be as large as possible to keep frequently used data in memory and reduce disk I/O - typically the biggest bottleneck. -By default, the buffer pool size is [between 128 MB and 512 MB](https://github.com/photoprism/photoprism/issues/2390), depending on which configuration example you use. You can change it with the `--innodb-buffer-pool-size` command parameter in the `mariadb:` section of your `docker-compose.yml`. `M` stands for Megabyte, `G` for Gigabyte. Do not use spaces. +By default, the buffer pool size is [between 128 MB and 512 MB](https://github.com/photoprism/photoprism/issues/2390), depending on which configuration example you use. You can change it with the `--innodb-buffer-pool-size` command parameter in the `mariadb:` section of your config file. `M` stands for Megabyte, `G` for Gigabyte. Do not use spaces. If your server has plenty of physical memory, we recommend increasing the size to 1 or 2 GB: diff --git a/docs/getting-started/updates.md b/docs/getting-started/updates.md index 776e0bb91a..5e1be0117f 100644 --- a/docs/getting-started/updates.md +++ b/docs/getting-started/updates.md @@ -41,7 +41,7 @@ docker compose up -d #### Watchtower -Adding [Watchtower](https://github.com/containrrr/watchtower) as a service to your `docker-compose.yml` will +Adding [Watchtower](https://github.com/containrrr/watchtower) as a service to your `compose.yaml` or `docker-compose.yml` will automatically keep images up-to-date: ```yaml diff --git a/docs/getting-started/using-https.md b/docs/getting-started/using-https.md index 8b9c027d10..78c98003ed 100644 --- a/docs/getting-started/using-https.md +++ b/docs/getting-started/using-https.md @@ -18,7 +18,7 @@ Note that after adding or updating certificates, it is required to restart Photo ### 1. HTTPS Reverse Proxy -To run your instance behind an [HTTPS reverse proxy like Traefik](proxies/traefik.md), we recommend that you explicitly disable TLS in PhotoPrism by setting `PHOTOPRISM_DISABLE_TLS` to `"true"` in your `docker-compose.yml` configuration: +To run your instance behind an [HTTPS reverse proxy like Traefik](proxies/traefik.md), we recommend that you explicitly disable TLS in PhotoPrism by setting `PHOTOPRISM_DISABLE_TLS` to `"true"` in your `compose.yaml` or `docker-compose.yml` configuration: ```yaml services: @@ -49,7 +49,7 @@ services: To use your own certificates, you can add a custom TLS certificate and private key to the `storage/config/certificates` folder with the filenames `www.example.com.crt` and `www.example.com.key`, replacing `www.example.com` with the actual server domain. For this, you can set the same config options as when using a self-signed certificate (see above). -Alternatively, you can specify a custom TLS certificate (`*.crt`) and private key (`*.key`) filename within the `storage/config/certificates` folder using the `PHOTOPRISM_TLS_CERT` and `PHOTOPRISM_TLS_KEY` [environment variables](config-options.md) in your `docker-compose.yml`, or use the corresponding [command flags](config-options.md): +Alternatively, you can specify a custom TLS certificate (`*.crt`) and private key (`*.key`) filename within the `storage/config/certificates` folder using the `PHOTOPRISM_TLS_CERT` and `PHOTOPRISM_TLS_KEY` [environment variables](config-options.md) in your `compose.yaml` or `docker-compose.yml`, or use the corresponding [command flags](config-options.md): ```yaml services: diff --git a/docs/known-issues.md b/docs/known-issues.md index f750a55f3c..426e86c773 100644 --- a/docs/known-issues.md +++ b/docs/known-issues.md @@ -136,7 +136,7 @@ As a result, this option is ignored when generating JPEG files with these conver ### Dollar Signs ### -If a configuration value [in a `docker-compose.yml` file](getting-started/docker-compose.md) contains a literal `$` character, for example in a password, you must use `$$` (a double dollar sign) to escape it so that e.g. `"compo$e"` becomes `"compo$$e"`: +If a configuration value [in a `compose.yaml` or `docker-compose.yml` file](getting-started/docker-compose.md) contains a literal `$` character, for example in a password, you must use `$$` (a double dollar sign) to escape it so that e.g. `"compo$e"` becomes `"compo$$e"`: ```yaml services: diff --git a/docs/release-notes.md b/docs/release-notes.md index 1480f3bc92..69f9fbfa88 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -249,7 +249,7 @@ What's new? - Translations: [Updated Japanese](https://translate.photoprism.app/projects/photoprism/) !!! info "" - We recommend that you [explicitly disable TLS](https://docs.photoprism.app/getting-started/config-options/#web-server) by adding `PHOTOPRISM_DISABLE_TLS: "true"` to your `docker-compose.yml` file when running PhotoPrism behind a reverse proxy. HTTPS could otherwise be accidentally enabled if a certificate matching the site URL is found or [`PHOTOPRISM_DEFAULT_TLS` is set to `"true"`](https://docs.photoprism.app/getting-started/config-options/#web-server). + We recommend that you [explicitly disable TLS](https://docs.photoprism.app/getting-started/config-options/#web-server) by adding `PHOTOPRISM_DISABLE_TLS: "true"` to your `compose.yaml` or `docker-compose.yml` file when running PhotoPrism behind a reverse proxy. HTTPS could otherwise be accidentally enabled if a certificate matching the site URL is found or [`PHOTOPRISM_DEFAULT_TLS` is set to `"true"`](https://docs.photoprism.app/getting-started/config-options/#web-server). ### June 25, 2023 ### Build 230625-17242fb07 @@ -298,7 +298,7 @@ PhotoPrism® Plus ### June 3, 2023 ### Build 230603-378d4746a -This service release fixes [recently discovered issues](https://github.com/photoprism/photoprism/issues?q=is%3Aissue+label%3Abug+sort%3Acreated-desc) and improves compatibility with the upcoming [MariaDB v11.0](https://mariadb.com/kb/en/release-notes-mariadb-11-0-series/). If you are upgrading from MariaDB 10.x to 11.0, please [make sure that you replace](https://github.com/photoprism/photoprism/commit/bff649469d084498a1e75492c0bd99bda3f5a340#diff-03a31d6e73f48b7bba98b65352ce67a7d153fe2461f9c7b5e76be49a97ebf0cb) `command: mysqld` with `command: ` (followed by the command flags) in your `docker-compose.yml` file, otherwise the database server might fail to start. Thank you to everyone who contributed with pull requests, [reported bugs](https://www.photoprism.app/kb/reporting-bugs), and helped us test the changes! +This service release fixes [recently discovered issues](https://github.com/photoprism/photoprism/issues?q=is%3Aissue+label%3Abug+sort%3Acreated-desc) and improves compatibility with the upcoming [MariaDB v11.0](https://mariadb.com/kb/en/release-notes-mariadb-11-0-series/). If you are upgrading from MariaDB 10.x to 11.0, please [make sure that you replace](https://github.com/photoprism/photoprism/commit/bff649469d084498a1e75492c0bd99bda3f5a340#diff-03a31d6e73f48b7bba98b65352ce67a7d153fe2461f9c7b5e76be49a97ebf0cb) `command: mysqld` with `command: ` (followed by the command flags) in your `compose.yaml` or `docker-compose.yml` file, otherwise the database server might fail to start. Thank you to everyone who contributed with pull requests, [reported bugs](https://www.photoprism.app/kb/reporting-bugs), and helped us test the changes! What's new? diff --git a/docs/user-guide/faq.md b/docs/user-guide/faq.md index b63381c445..e338825510 100644 --- a/docs/user-guide/faq.md +++ b/docs/user-guide/faq.md @@ -40,7 +40,7 @@ ??? question "How can I activate my membership?" - To connect a new instance to your membership account, you will need to log in with the super admin user that is automatically created during setup (see your `docker-compose.yml` file or the app store documentation), and then follow the steps described in our activation guide. + To connect a new instance to your membership account, you will need to log in with the super admin user that is automatically created during setup (see your `compose.yaml` or `docker-compose.yml` file or the app store documentation), and then follow the steps described in our activation guide. [View Activation Guide ›](https://www.photoprism.app/kb/activation) diff --git a/docs/user-guide/settings/advanced.md b/docs/user-guide/settings/advanced.md index 1c7c774296..549bc4d4ef 100644 --- a/docs/user-guide/settings/advanced.md +++ b/docs/user-guide/settings/advanced.md @@ -13,7 +13,7 @@ on the advanced settings page. You can also disable specific features and enable ![](img/settings-advanced.jpg){ class="shadow" } -All [config options](../../getting-started/config-options.md) can be set in your `docker-compose.yml` or +All [config options](../../getting-started/config-options.md) can be set in your `compose.yaml` or `docker-compose.yml` or via command-line parameters as well. Manually changed values are saved in a config file. It is stored in the `storage/config` folder by default. diff --git a/docs/user-guide/sync/dropbox.md b/docs/user-guide/sync/dropbox.md index 6a1f659cd6..80f5b0b5e8 100644 --- a/docs/user-guide/sync/dropbox.md +++ b/docs/user-guide/sync/dropbox.md @@ -5,7 +5,7 @@ It's possible to use [Dropbox](https://www.dropbox.com/) to store your photos, w 1. Set up a Dropbox account. 2. Install the Dropbox desktop client. 3. Sync your Dropbox to a local directory. -4. If using Docker, configure your `docker-compose.yml` with; +4. If using Docker, configure your `compose.yaml` or `docker-compose.yml` with; ``` volumes: - "~/Dropbox/Photos:/photoprism/originals" @@ -22,7 +22,7 @@ To auto-import uploaded files into PhotoPrism; 2. Enable 'Camera Uploads' in the Dropbox app's settings. 3. Install the Dropbox [desktop client](https://www.dropbox.com/install) on your server or a network-accessible machine 4. Configure the `Camera Uploads` folder as your `import` directory for PhotoPrism. - In your `docker-compose.yml` file, this is; + In your `compose.yaml` or `docker-compose.yml` file, this is; ``` volumes: - "~/Dropbox/Camera Uploads:/photoprism/import"