From 23bd89a70d228a3a3a9c545dae57658dddcf0ca2 Mon Sep 17 00:00:00 2001 From: Varun Patil Date: Fri, 22 Mar 2024 12:23:54 -0700 Subject: [PATCH] docs: link to docker example Signed-off-by: Varun Patil --- .examples/Docker/docker-compose.yml | 13 ++++++++----- CHANGELOG.md | 4 ++++ docs/install.md | 6 +++--- 3 files changed, 15 insertions(+), 8 deletions(-) diff --git a/.examples/Docker/docker-compose.yml b/.examples/Docker/docker-compose.yml index b55ea8003..503648fe9 100644 --- a/.examples/Docker/docker-compose.yml +++ b/.examples/Docker/docker-compose.yml @@ -5,15 +5,18 @@ # This file is provided as an example only and is not intended to be used as-is. # You will need all files in this directory for the example to work. # +# The example assumes the existence of two disks, hdd and ssd. +# You can replace both with a single mount point if you don't have separate disks. +# # 1. Make sure all placeholders are replaced with the correct values. -# 2. Choose a strong password for the database. -# 3. Use an appropriate nginx.conf, and adjust it according to your needs. +# Choose a strong password for the database. +# 2. Use an appropriate nginx.conf, and adjust it according to your needs. # If you intend to use a second reverse proxy for TLS, you can use this example: # https://github.com/nextcloud/docker/blob/master/.examples/docker-compose/insecure/mariadb/fpm/web/nginx.conf # In the example below, Nextcloud will be exposed on port 8500 -# 4. Make sure the Dockerfile uses the Nextcloud version you want to see (first line) -# 5. Tune the PHP-FPM parameters in the Dockerfile according to your hardware -# 6. The preview generator cron job is pre-configured, but you still need to install the app +# 3. Make sure the Dockerfile uses the Nextcloud version you want to see +# To update Nextcloud, you can simply change the version and run `docker compose build` +# 4. The preview generator cron job is pre-configured, but you still need to install the app # and do the initial generation run. https://github.com/nextcloud/previewgenerator # =================================================================================================================== diff --git a/CHANGELOG.md b/CHANGELOG.md index cf569431a..4a4fc5021 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ All notable changes to this project will be documented in this file. +## [Unreleased] + +- A Docker Compose example using the community Nextcloud image is now available in the repo. + ## [v7.0.2] - 2024-03-19 - **Breaking**: You must run `occ memories:places-setup` again after this update diff --git a/docs/install.md b/docs/install.md index 643cb0c02..add2f5cca 100644 --- a/docs/install.md +++ b/docs/install.md @@ -8,10 +8,10 @@ This page describes how to install the latest version of Memories. ## Nextcloud -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 easy setup and maintenance, you can use the community Nextcloud Docker image, and add extra dependencies using a custom Dockerfile. A [Docker Compose example](https://github.com/pulsejet/memories/tree/master/.examples/Docker) can be found in the repository. Make sure to read the instructions in `docker-compose.yml` carefully. -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](https://github.com/nextcloud/all-in-one#how-to-use-this), in which case most dependencies are already installed. !!! success "Recommended Configuration"