Skip to content

Commit

Permalink
docs: general updates
Browse files Browse the repository at this point in the history
Signed-off-by: Varun Patil <radialapps@gmail.com>
  • Loading branch information
pulsejet committed Oct 17, 2023
1 parent 65b1de8 commit 4400307
Show file tree
Hide file tree
Showing 4 changed files with 166 additions and 114 deletions.
3 changes: 2 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,8 @@
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[markdown]": {
"files.trimTrailingWhitespace": false
"files.trimTrailingWhitespace": false,
"editor.formatOnSave": false,
},
"search.exclude": {
"**/l10n": true,
Expand Down
74 changes: 36 additions & 38 deletions docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Steps to configure Memories for the best experience and performance

# Configuration

!!! danger "Use the admin interface"
!!! success "Use the admin interface"

Starting with v5.0.0, you can fully configure memories using the admin panel. With an admin account in Nextcloud, go to `Settings -> Memories`.
Using the admin interface for configuration is **strongly recommended** in most cases.
Expand Down Expand Up @@ -39,6 +39,15 @@ occ memories:index # index existing photo files (can run in parallel,

If you are using Nextcloud AIO, see [this documentation](https://github.com/nextcloud/all-in-one#how-to-run-occ-commands).

## Recommended apps

For the best experience and performance, the following apps are recommended.

- [Preview Generator](https://github.com/rullzer/previewgenerator) - For pre-generating image previews (**required** for performance)
- [Recognize](https://github.com/nextcloud/recognize) - The official Nextcloud app for AI tagging of images and people.
- [Photos](https://github.com/nextcloud/photos) - The official Nextcloud Photos app, required for albums support.
- [Face Recognition](https://github.com/matiasdelellis/facerecognition) - An alternative face recognition app, which offers more fine-tuning. Alpha stage integration.

## Storage support

The app can work with external storage for photos. Just set the mountpoint as the timeline directory.
Expand All @@ -55,12 +64,7 @@ The app can work with external storage for photos. Just set the mountpoint as th

To get support for all file types including HEIC, TIFF and RAW, refer to [this page](./file-types.md).

To enable support for high resolution images, you need to update Nextcloud's `config.php` to include

```php
'preview_max_memory' => 4096,
'preview_max_filesize_image' => 256,
```
To enable support for high resolution images, you need to update the preview generation configuration from the admin panel.

## Transcoding

Expand All @@ -76,28 +80,25 @@ Read the following considerations carefully regarding transcoding:
1. If transcoding fails, the video player will fall back to the original video stream. Check the output of `/tmp/go-vod/<instanceid>.log`
1. For better performance, you may configure the transcoder to use hardware acceleration. See [this page](./hw-transcoding.md).

## Reverse geocoding
!!! tip "Hardware acceleration"

Memories supports reverse geocoding to find the location of photos. To set up geocoding you need to download the planet boundary dataset and store it in the database. This works only on MySQL/MariaDB/Postgres (no SQLite support). To set up, go to the admin panel. Note that all your files will be re-indexed after downloading the planet database.
Memories supports hardware acceleration for transcoding using VA-API and NVENC.
If you have supported hardware, using hardware acceleration can significantly improve performance.
See the instructions on [this page](./hw-transcoding.md) for more information.

## Recommended apps
## Reverse geocoding

- [Preview Generator](https://github.com/rullzer/previewgenerator) - For pre-generating image previews (**required** for best performance)
- [Recognize](https://github.com/nextcloud/recognize) - The official Nextcloud app for AI tagging of images and people.
- [Photos](https://github.com/nextcloud/photos) - The official Nextcloud Photos app, required for albums support.
- [Face Recognition](https://github.com/matiasdelellis/facerecognition) - An alternative face recognition app, which offers more fine-tuning. Alpha stage integration.
Memories supports reverse geocoding to find the location of photos. To set up geocoding you need to download the planet boundary dataset and store it in the database. This works only on MySQL/MariaDB/Postgres (no SQLite support). To set up reverse geocoding, go to the Memories admin panel.

## Preview storage

By default, previews upto `4096px` size are generated by Nextcloud. Each of the largest previews might be a few megabytes in size. This may not be ideal if you have limited storage space, since the preview size may become larger than the originals (especially if you use efficient image formats like HEIC). In this case, you can limit previews to a smaller size like `2048px`.

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.
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. These options are also configurable through the admin panel.

```php
'preview_max_x' => 2048,
'preview_max_y' => 2048,
```bash
occ config:system:set preview_max_x --value="2048"
occ config:system:set preview_max_y --value="2048"
```

You can also set the preview JPEG quality to 80 to save more space.
Expand All @@ -113,21 +114,7 @@ rm -rf <nextcloud-data-dir>/appdata_*/preview
occ files:scan-app-data
```

## Migration

Memories directly uses EXIF metadata from files, so migration should be generally easy. The file structure of your photos is preserved as-is.

If you are migrating from Nextcloud Photos, you don't need to do anything. Your albums and tags will be carried to Memories as-is.

If you are migrating from Google Takeout, you may run the following command to move JSON metadata to EXIF.

```bash
occ memories:migrate-google-takeout
```

## Customization

### Header Logo
## Header logo

Nextcloud supports customizing the logo for your instance. To properly theme the logo to match the user's theme, the logo you use in `Admninistration => Theming` must follow the following criteria:

Expand All @@ -144,9 +131,20 @@ A sample SVG that follows these criteria is shown below (from [here](https://git

Note that you may skip these steps and also use a PNG file, but the logo will not be colored according to the user's theme. This can be especially troublesome since Nextcloud mostly shows the logo on a dark background while Memories uses both light and dark backgrounds.
## Migration
Memories directly uses EXIF metadata from files, so migration should be generally easy. The file structure of your photos is preserved as-is.
If you are migrating from Nextcloud Photos, you don't need to do anything. Your albums and tags will be carried to Memories as-is.

If you are migrating from Google Takeout, you may run the following command to move JSON metadata to EXIF.

```bash
occ memories:migrate-google-takeout
```

## Other notes

- For optimal performance, enable HTTP/2 on your reverse proxy (nginx/apache)
- Make sure your server timezone is configured correctly. If a photo does not contain an EXIF date, the server time is used.
- Perform additional server tuning for Nextcloud. See [the docs](https://docs.nextcloud.com/server/latest/admin_manual/installation/server_tuning.html).
- The archive feature moves photos to a separate folder called `.archive` at the root of your timeline. You can, for example, mount this folder to a cold storage.
- Perform additional server tuning for Nextcloud. See [performance](/troubleshooting/#performance) section of troubleshooting.
- The archive feature moves photos to a separate folder called `.archive` at the root of your timeline or the current storage. You can, for example, mount this folder to a cold storage.

0 comments on commit 4400307

Please sign in to comment.