docs: minor update

Signed-off-by: Varun Patil <radialapps@gmail.com>
pull/788/head
Varun Patil 2023-08-22 12:41:34 -07:00
parent 1a443b8bff
commit d7447d24e1
4 changed files with 13 additions and 10 deletions

View File

@ -37,7 +37,7 @@ occ memories:index # index existing photo files (can run in parallel,
# ^^^ <-- this is required # ^^^ <-- this is required
``` ```
With Nextcloud AIO, see https://github.com/nextcloud/all-in-one#how-to-run-occ-commands If you are using Nextcloud AIO, see [this documentation](https://github.com/nextcloud/all-in-one#how-to-run-occ-commands).
## Storage support ## Storage support
@ -93,7 +93,7 @@ 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. 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, you don't need to configure the below options, as they are already set to the recommended values by default. On Nextcloud AIO, these options are set to the recommended values by default.
```php ```php
'preview_max_x' => 2048, 'preview_max_x' => 2048,

View File

@ -8,7 +8,7 @@ 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. 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 as previews for mos file types should work out-of-the-box. 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. 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.

View File

@ -11,9 +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/). 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 the best experience, we recommend to use the latest stable version of Nextcloud and PHP.
For easy setup and maintenance, you can use the community Nextcloud Docker image, and add extra dependencies For easy setup and maintenance, you can use the community Nextcloud Docker image, and add extra dependencies using a custom Dockerfile.
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.
Another good option is to use [Nextcloud AIO](https://github.com/nextcloud/all-in-one#how-to-use-this). There you don't need to build your custom Nextcloud container as everything needed is bundled.
## Requirements ## Requirements

View File

@ -8,7 +8,11 @@ This page contains solutions to common problems. If you are facing any issues, p
## Performance ## Performance
Memories is very fast, but its performance largely depends on how well the Nextcloud instance is tuned. If you are using Nextcloud AIO, you don't need to read any further as all mentioned things are automatically configured. Otherwise 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. - 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. - 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 ## Issues with Docker
Note: Using the community Nextcloud Docker image is the recommended way of running Memories. If you are using a different image, you may run into issues. Nextcloud AIO is a good options as well. 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 ### OCC commands fail
@ -41,7 +45,7 @@ docker exec -it my_nc_container php occ memories:index
# ^^^ <-- this is required # ^^^ <-- this is required
``` ```
With Nextcloud AIO, see https://github.com/nextcloud/all-in-one#how-to-run-occ-commands If you are using Nextcloud AIO, see [this documentation](https://github.com/nextcloud/all-in-one#how-to-run-occ-commands).
!!! warning "OCCWeb" !!! warning "OCCWeb"
@ -58,7 +62,7 @@ app:
- /tmp:exec - /tmp:exec
``` ```
TMPFS is automatically configured when using Nextcloud AIO. `tpmfs` is automatically configured when using Nextcloud AIO v7.0.0.
## Reverse Geocoding (Places) ## Reverse Geocoding (Places)