From 481cdcd30811556e6a4eba7ab6cb9f9a0d5f192a Mon Sep 17 00:00:00 2001 From: David Ball Date: Sun, 26 May 2024 07:05:46 -0400 Subject: [PATCH] Documented git submodule. --- README.md | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index be13886..e8fd1d9 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,20 @@ # Docker Compose configurations -## Create an `.env` file. +## Cloning the repository (for deployment) -You can copy the example file if you want. +You can use git to clone this repository: + + git clone https://gitea.daball.me/No-Moss-3-Carbo-Landfill-Online-Library/nm3clol-docker.git + +## Cloning the repository (for development) + +You can use git to clone this repository: + + git clone --recursive https://gitea.daball.me/No-Moss-3-Carbo-Landfill-Online-Library/nm3clol-docker.git + +## Create an environment file + +You can copy the example file if you want, adjusting anything you need to suit the environment: cp .env.example .env @@ -10,10 +22,6 @@ You can copy the example file if you want. Here are some Docker Compose configuration examples. -## fullstack - -Example fullstack Solr, Tika with Tesseract, Web App, and Reverse Proxy instance. - ## frontend Minimal Web App only, no reverse proxy. @@ -33,3 +41,7 @@ Solr and Tika with Tesseract together. ## tika Minimal Tika with Tesseract instance. + +## fullstack + +Example fullstack Solr, Tika with Tesseract, Web App, and Reverse Proxy instance.