memories/README.md

# Memories

**📷 Yet another photo management app for Nextcloud**

![Screenshot](appinfo/screencap.webp)

## How is this different?

* **📸 Photo and Video Timeline**: Sorts photos by date taken, parsed from Exif data.
* **🤔 Quick Recap**: Jump to anywhere in the timeline instantly.
* **🖼️ Folders**: Browse your and shared folders with a similar, efficient timeline.
* **🎦 Slideshow**: View photos from your timeline and folders easily.
* **📱 Mobile Support**: Relive your memories on devices of any shape and size through the web app.
* **🗑️ Recycle**: Select and delete multiple photos and videos at once.
* **✏️ Edit Metadata**: Edit Exif dates on photos quickly and easily.
* **📦 Archive**: Store photos you don't want to see in your timeline in a separate folder.
* **⚡️ Fast**: Memories is extremely fast. Period. More details below.

## 🚀 Installation

1. Install the app from the Nextcloud app store
1. ⚒️ Install `exiftool` (see below).
1. Run `php ./occ memories:index` to generate metadata indices for existing photos.
1. Open the 📷 Memories app in Nextcloud and set the directory containing your photos. Photos from this directory will be displayed in the timeline, including any photos in nested subdirectories.
1. Installing the [preview generator](https://github.com/rullzer/previewgenerator) for pre-generating thumbnails is strongly recommended.

## 🔨 Installing Dependencies
The exact steps depend on your Nextcloud platform. If you use Docker for your Nextcloud instance, you can install Exiftool by using a custom docker image.
- **Ubuntu/Debian**: `sudo apt install libimage-exiftool-perl`
- **Fedora**: `sudo dnf install perl-Image-ExifTool`
- **Arch Linux**: `sudo pacman -S perl-image-exiftool`
- **Alpine**: `apk add --no-cache exiftool`
- **MacOS**: `brew install exiftool`
- **FreeBSD**: `sudo pkg install p5-Image-ExifTool`

## 🏗 Development setup

1. ☁ Clone this into your `apps` folder of your Nextcloud.
1. 👩‍💻 In a terminal, run the command `make dev-setup` to install the dependencies.
1. 🏗 Then to build the Javascript whenever you make changes, run `make build-js`. To create a pull request use `make build-js-production`. Watch changes with: `make watch-js`.
1. ✅ Enable the app through the app management of your Nextcloud.
1. 🎉 Partytime!

## 🤔 Why a separate app?
The approach of this app is fundamentally different from the official Nextcloud Photos app, which is very lightweight and works entirely using webdav. This app instead maintains special metadata in a separate table on the backend, and thus can be considered to have different objectives.

## ⚡ Performance
- Once properly configured, Memories is **extremely fast**, possibly one of the fastest web photo viewers.
- On a server with relatively cheap hardware (`Intel Pentium G6400 / 8GB RAM / SSD`), loading the timeline takes only `~400ms` without cache on a laptop (`Intel Core i5-1035G1 / Windows 11 / Chrome`) for a library of `~17000 photos` totaling `100GB`. The test was performed on Nextcloud 24 with `nginx`, `php-fpm` and `mariadb` running in Docker.
- For best performance, install the [preview generator](https://github.com/rullzer/previewgenerator) and make sure HTTP/2 is enabled for your Nextcloud instance.

## 📝 Notes
- You may need to configure the Nextcloud preview generator and Imagemagick / ffmpeg to support all types of images and videos (e.g. HEIC). If using the official docker image, add `OC\Preview\HEIC` to `enabledPreviewProviders` in your `config.php`.
- If local time is not found in the photo (especially for videos), the server timezone is used.
- All photos in the timeline _must_ be on a single storage. For example, you cannot have a mounted directory inside your photos directory.
- The app can work with external storage for photos. Just set the mountpoint as the timeline directory.
    - If you add any photos from outside Nextcloud, you must run the scan and index commands.
    - Indexing may be slow, since all files must be downloaded from the storage. The app currently assumes that the Exif data is present with the first 20MB of each file.
    - This function is experimental and may not work as expected. Please report any issues.

## Special Thanks
Nextcloud team. At least one half of the code is based on the work of the [Nextcloud Photos](https://github.com/nextcloud/photos).
Rename again to memories Fix the migration directly because I'm the only user right now. If this is a problem for you, drop the oc_polaroid table and the corresponding index on the oc_filecache table. 2022-08-18 18:27:25 +00:00			`# Memories`
Initial Commit 2022-08-13 01:58:37 +00:00
Update readme 2022-08-20 01:07:39 +00:00			`📷 Yet another photo management app for Nextcloud`
Initial Commit 2022-08-13 01:58:37 +00:00
Update README 2022-09-08 01:40:24 +00:00			`![Screenshot](appinfo/screencap.webp)`
Add screenshot 2022-08-18 03:36:37 +00:00
Update README 2022-08-16 01:28:40 +00:00			`## How is this different?`
Initial Commit 2022-08-13 01:58:37 +00:00
Update to use exiftool 2022-08-17 21:45:01 +00:00			`* 📸 Photo and Video Timeline: Sorts photos by date taken, parsed from Exif data.`
Update README 2022-08-16 01:28:40 +00:00			`* 🤔 Quick Recap: Jump to anywhere in the timeline instantly.`
Rename album to folder 2022-09-08 23:57:50 +00:00			`* 🖼️ Folders: Browse your and shared folders with a similar, efficient timeline.`
			`* 🎦 Slideshow: View photos from your timeline and folders easily.`
Add mobile support feature 2022-08-20 01:10:28 +00:00			`* 📱 Mobile Support: Relive your memories on devices of any shape and size through the web app.`
Update README 2022-09-08 01:40:24 +00:00			`* 🗑️ Recycle: Select and delete multiple photos and videos at once.`
Add disclaimer 2022-09-25 15:06:27 +00:00			`* ✏️ Edit Metadata: Edit Exif dates on photos quickly and easily.`
Update art and docs 2022-09-25 23:26:17 +00:00			`* 📦 Archive: Store photos you don't want to see in your timeline in a separate folder.`
Add perf. notes 2022-09-13 03:42:02 +00:00			`* ⚡️ Fast: Memories is extremely fast. Period. More details below.`
Initial Commit 2022-08-13 01:58:37 +00:00
Update README 2022-08-16 01:28:40 +00:00			`## 🚀 Installation`
Initial Commit 2022-08-13 01:58:37 +00:00
Prevent confusion 2022-09-09 00:46:16 +00:00			`1. Install the app from the Nextcloud app store`
Update dep instructions 2022-09-13 19:23:20 +00:00			1. ⚒️ Install `exiftool` (see below).
Rename again to memories Fix the migration directly because I'm the only user right now. If this is a problem for you, drop the oc_polaroid table and the corresponding index on the oc_filecache table. 2022-08-18 18:27:25 +00:00			1. Run `php ./occ memories:index` to generate metadata indices for existing photos.
Update readme 2022-08-20 01:07:39 +00:00			`1. Open the 📷 Memories app in Nextcloud and set the directory containing your photos. Photos from this directory will be displayed in the timeline, including any photos in nested subdirectories.`
Recommend the preview generator 2022-09-12 06:22:56 +00:00			`1. Installing the [preview generator](https://github.com/rullzer/previewgenerator) for pre-generating thumbnails is strongly recommended.`
Initial Commit 2022-08-13 01:58:37 +00:00
Update dep instructions 2022-09-13 19:23:20 +00:00			`## 🔨 Installing Dependencies`
			`The exact steps depend on your Nextcloud platform. If you use Docker for your Nextcloud instance, you can install Exiftool by using a custom docker image.`
			- Ubuntu/Debian: `sudo apt install libimage-exiftool-perl`
			- Fedora: `sudo dnf install perl-Image-ExifTool`
			- Arch Linux: `sudo pacman -S perl-image-exiftool`
			- Alpine: `apk add --no-cache exiftool`
			- MacOS: `brew install exiftool`
			- FreeBSD: `sudo pkg install p5-Image-ExifTool`

Update README 2022-08-16 01:28:40 +00:00			`## 🏗 Development setup`
Initial Commit 2022-08-13 01:58:37 +00:00
Update README 2022-08-16 01:28:40 +00:00			1. ☁ Clone this into your `apps` folder of your Nextcloud.
			1. 👩‍💻 In a terminal, run the command `make dev-setup` to install the dependencies.
			1. 🏗 Then to build the Javascript whenever you make changes, run `make build-js`. To create a pull request use `make build-js-production`. Watch changes with: `make watch-js`.
			`1. ✅ Enable the app through the app management of your Nextcloud.`
			`1. 🎉 Partytime!`
Initial Commit 2022-08-13 01:58:37 +00:00
Add some emo 2022-09-13 07:41:06 +00:00			`## 🤔 Why a separate app?`
Fix readme 2022-08-16 01:59:28 +00:00			`The approach of this app is fundamentally different from the official Nextcloud Photos app, which is very lightweight and works entirely using webdav. This app instead maintains special metadata in a separate table on the backend, and thus can be considered to have different objectives.`
Initial Commit 2022-08-13 01:58:37 +00:00
Add some emo 2022-09-13 07:41:06 +00:00			`## ⚡ Performance`
Update perf docs 2022-09-13 18:49:10 +00:00			`- Once properly configured, Memories is extremely fast, possibly one of the fastest web photo viewers.`
			- On a server with relatively cheap hardware (`Intel Pentium G6400 / 8GB RAM / SSD`), loading the timeline takes only `~400ms` without cache on a laptop (`Intel Core i5-1035G1 / Windows 11 / Chrome`) for a library of `~17000 photos` totaling `100GB`. The test was performed on Nextcloud 24 with `nginx`, `php-fpm` and `mariadb` running in Docker.
Add perf. notes 2022-09-13 03:42:02 +00:00			`- For best performance, install the [preview generator](https://github.com/rullzer/previewgenerator) and make sure HTTP/2 is enabled for your Nextcloud instance.`

Add some emo 2022-09-13 07:41:06 +00:00			`## 📝 Notes`
Add perf. notes 2022-09-13 03:42:02 +00:00			- You may need to configure the Nextcloud preview generator and Imagemagick / ffmpeg to support all types of images and videos (e.g. HEIC). If using the official docker image, add `OC\Preview\HEIC` to `enabledPreviewProviders` in your `config.php`.
			`- If local time is not found in the photo (especially for videos), the server timezone is used.`
Update README for 2.0 2022-09-24 02:58:12 +00:00			`- All photos in the timeline _must_ be on a single storage. For example, you cannot have a mounted directory inside your photos directory.`
			`- The app can work with external storage for photos. Just set the mountpoint as the timeline directory.`
Add external storage docs (#30) 2022-09-13 18:49:18 +00:00			`- If you add any photos from outside Nextcloud, you must run the scan and index commands.`
Add external storage note 2022-09-15 01:26:56 +00:00			`- Indexing may be slow, since all files must be downloaded from the storage. The app currently assumes that the Exif data is present with the first 20MB of each file.`
Add external storage docs (#30) 2022-09-13 18:49:18 +00:00			`- This function is experimental and may not work as expected. Please report any issues.`
Add MySQL caveat 2022-08-16 02:13:04 +00:00
Add some emo 2022-09-13 07:41:06 +00:00			`## Special Thanks`
Update README 2022-08-16 01:28:40 +00:00			`Nextcloud team. At least one half of the code is based on the work of the [Nextcloud Photos](https://github.com/nextcloud/photos).`