diff --git a/docs/config.md b/docs/config.md index 87c35f32..fde1f7c4 100644 --- a/docs/config.md +++ b/docs/config.md @@ -37,6 +37,8 @@ occ memories:index # index existing photo files (can run in parallel, # ^^^ <-- this is required ``` + If you are using Nextcloud AIO, see [this documentation](https://github.com/nextcloud/all-in-one#how-to-run-occ-commands). + ## Storage support The app can work with external storage for photos. Just set the mountpoint as the timeline directory. @@ -91,6 +93,8 @@ By default, previews upto `4096px` size are generated by Nextcloud. Each of the Note that Memories will, by default, load the full image upon zooming in. If you are okay with this, you may use a even smaller size like `1024px` to save more space as well as faster preview generation time. Non-JPEG files will be converted on the server when loading in full-res, which may lead to some server load. +On Nextcloud AIO, these options are set to the recommended values by default. + ```php 'preview_max_x' => 2048, 'preview_max_y' => 2048, diff --git a/docs/file-types.md b/docs/file-types.md index e41d9185..e32efcfb 100644 --- a/docs/file-types.md +++ b/docs/file-types.md @@ -8,6 +8,8 @@ description: Steps to configure support for different image and video formats It is **strongly recommended** that you use the Memories admin interface to configure file type support. This will ensure that your configuration is valid and that you do not accidentally disable support for any file types. +Please note that if Imaginary is configured on your instance like on Nextcloud AIO, you do not need to follow this documentation any further; most file types should work out-of-the-box. + Memories supports the file types supported by Nextcloud. File type support is determined in part by the values listed in the `enabledPreviewProviders` configuration parameter in your configuration file. If your `config.php` does not contain an `enabledPreviewProviders` array, this means you are using Nextcloud's defaults. Copy the array over from `config.sample.php` before adding any of the values below, or else you will effectively disable all of the defaults. If you add support for any one of the file types below, you must run `occ memories:index` to index these files. diff --git a/docs/hw-transcoding.md b/docs/hw-transcoding.md index 29db31bd..e9799d96 100644 --- a/docs/hw-transcoding.md +++ b/docs/hw-transcoding.md @@ -16,7 +16,7 @@ In the directory with the `docker-compose.yml` file, run, git clone https://github.com/pulsejet/go-vod ``` -If you are using docker compose, configure a service to start go-vod with the correct devices and filesystem structure. Otherwise, manually start the container with these parameters. +If you are using docker, configure a service to start go-vod with the correct devices and filesystem structure. Otherwise, manually start the container with these parameters. ```yaml # docker-compose.yml @@ -40,6 +40,10 @@ services: - ncdata:/var/www/html:ro ``` +Make sure to put the container and the container into the same network so that they can talk to each other! + +With Nextcloud AIO, you will need to put the container into the `nextcloud-aio` network. Also the datadir of AIO needs to be mounted at the same place like in its Netxcloud container into the go-vod container. Usually this would be `nextcloud_aio_nextcloud_data:/mnt/ncdata:ro` or `$NEXTCLOUD_DATADIR:/mnt/ncdata:ro`. + Finally, point Memories to the external go-vod instance. In the admin interface, set go-vod to external and configure the connect URL to `go-vod:47788`. Alternatively, add the following configuration to `config.php`: ```php @@ -133,6 +137,9 @@ If you use Docker, you need to: 1. Check the output of `/tmp/go-vod/.log` if playback has issues +### Nextcloud AIO +See https://github.com/nextcloud/all-in-one#how-to-enable-hardware-transcoding-for-nextcloud + ### linuxserver/nextcloud image You can add the following to the `docker-compose.yml` file to install the drivers: diff --git a/docs/install.md b/docs/install.md index e0914e38..680e6e47 100644 --- a/docs/install.md +++ b/docs/install.md @@ -11,8 +11,8 @@ This page describes how to install the latest version of Memories. Memories is an app for [Nextcloud](https://nextcloud.com/), so you need to install Nextcloud first. You can find the installation instructions [here](https://docs.nextcloud.com/server/latest/admin_manual/installation/). For the best experience, we recommend to use the latest stable version of Nextcloud and PHP. -For easy setup and maintenance, you can use the official Nextcloud Docker image, and add extra dependencies -using a custom Dockerfile. +For easy setup and maintenance, you can use the community Nextcloud Docker image, and add extra dependencies using a custom Dockerfile. +Another option is to use [Nextcloud AIO](https://github.com/nextcloud/all-in-one#how-to-use-this), in which case most dependencies are already installed. ## Requirements diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index b3092528..b01fc011 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -8,7 +8,11 @@ This page contains solutions to common problems. If you are facing any issues, p ## Performance -Memories is very fast, but its performance largely depends on how well the Nextcloud instance is tuned. Make sure to follow the following steps: +!!! tip "Nextcloud AIO" + + If you are using [AIO](https://github.com/nextcloud/all-in-one), these options should be configured by default. + +Memories is very fast, but its performance largely depends on how well the Nextcloud instance is tuned. - Make sure you are running the latest stable version of Nextcloud and Memories. - Follow the steps in the [server tuning](https://docs.nextcloud.com/server/latest/admin_manual/installation/server_tuning.html) documentation. @@ -30,7 +34,7 @@ This means that Memories is unable to find any indexed photos in your Nextcloud ## Issues with Docker -Note: Using the official Nextcloud Docker image is the recommended way of running Memories. If you are using a different image, you may run into issues. +Note: Using the community [Nextcloud Docker](https://hub.docker.com/_/nextcloud/) image or [AIO](https://github.com/nextcloud/all-in-one) are the recommended ways of running Memories. If you are using a different image, you may run into issues. Please file any bugs you find on GitHub. ### OCC commands fail @@ -41,6 +45,8 @@ docker exec -it my_nc_container php occ memories:index # ^^^ <-- this is required ``` +If you are using Nextcloud AIO, see [this documentation](https://github.com/nextcloud/all-in-one#how-to-run-occ-commands). + !!! warning "OCCWeb" The OCCWeb app is deprecated, and will not work with Memories. You must use the `occ` command line. @@ -56,6 +62,8 @@ app: - /tmp:exec ``` +`tpmfs` is automatically configured when using Nextcloud AIO v7.0.0. + ## Reverse Geocoding (Places) You need to have a MySQL / MariaDB / Postgres database for reverse geocoding to work. SQLite is not supported.