memories/docs/install.md

2.7 KiB

description
Setting up Memories and Nextcloud

Installation

This page describes how to install the latest version of Memories.

Nextcloud

Memories is an app for Nextcloud, so you need to install Nextcloud first. You can find the installation instructions here.

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 using a custom Dockerfile. Another option is to use Nextcloud AIO, in which case most dependencies are already installed.

!!! success "Recommended Configuration"

If you plan to use hardware transcoding, using **Docker Compose** or **Nextcloud AIO** is recommended.

Requirements

Before installing Memories, make sure that the following requirements are met:

  1. Nextcloud 26 or later.
  2. PHP 8.0 or later.
  3. MySQL, MariaDB, or PostgreSQL database.
  4. Imagick PHP extension.
  5. ffmpeg and ffprobe binaries.

Installing Memories

Memories can be installed from the Nextcloud app store page. Alternatively, you can install it manually by following these steps:

  1. Download the latest release from the releases page
  2. Extract the archive to the apps or custom_apps directory of your Nextcloud installation.
  3. Enable the app in the Nextcloud app settings page.
  4. Make sure you follow the configuration instructions carefully.

Installing from source

To build the app from source, you need to have node.js installed.

  1. Clone the repository to the apps or custom_apps directory of Nextcloud.
  2. Run make dev-setup to install the dependencies.
  3. Run make patch-external to apply patches to external dependencies.
  4. Run make build-js-production to build the JavaScript files.
  5. Enable the app in the Nextcloud app settings page.

Mobile Apps

An Android client for Memories is available in early access on Google Play or GitHub Releases.

For automatic uploads, you can use the official Nextcloud mobile apps. These are available for Android (F-Droid) and iOS.