From f0a36695f44837429a28930277e39e418acfea15 Mon Sep 17 00:00:00 2001
From: David Ball <david@daball.me>
Date: Fri, 24 May 2024 15:40:16 -0400
Subject: [PATCH] Document .env files.

---
 README.md | 43 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)

diff --git a/README.md b/README.md
index 4804b461..68e3fe60 100644
--- a/README.md
+++ b/README.md
@@ -40,6 +40,49 @@ Installing Docker is beyond the scope of this document. You may choose to instal
 
 [https://docs.docker.com/get-docker/](https://docs.docker.com/get-docker/)
 
+# Creating a .env file
+
+You will need a .env file if you want to use Docker Compose. Here's an example that will run the Docker fullstack configuration.
+
+    # You will need a .env file to use with the Docker containers. This is set up for localhost use with the Docker Compose fullstack.
+
+    # SITE_NAME is used for page generation.
+    SITE_NAME="No Moss 3 Landfill Online Library"
+    # SITE_URL is used for generating links for the search index. (If you leave this blank it should work using relative paths.)
+    SITE_URL="https://localhost"
+
+    # APP_HTTP_LISTEN_PORT is the TCP port used to access the Node application's HTTP interface (usually by a reverse proxy).
+    APP_HTTP_HOST="nm3clol"
+    # APP_HTTP_LISTEN_PORT is the TCP port used to access the Node application's HTTP interface (usually by a reverse proxy).
+    APP_HTTP_LISTEN_PORT=3000
+    # APP_URL is the URL used to access the Node application (usually by a reverse proxy).
+    APP_HTTP_URL="http://$APP_HTTP_HOST:$APP_HTTP_LISTEN_PORT"
+
+    # SOLR_DOCS_HOST is the host for Apache Solr's core for indexed documents.
+    SOLR_DOCS_HOST="solr"
+    # SOLR_DOCS_PORT is the port for Apache Solr's core for indexed documents.
+    SOLR_DOCS_PORT=8983
+    # SOLR_DOCS_CORE_NAME is the core name for Apache Solr's core for indexed documents.
+    SOLR_DOCS_CORE_NAME="nm3clol_core"
+    # SOLR_DOCS_URL is the URL to access Apache Solr's core for indexed documents. It is used by Gulp and the Search feature.
+    SOLR_DOCS_URL="http://$SOLR_DOCS_HOST:$SOLR_DOCS_PORT/solr/$SOLR_DOCS_CORE_NAME"
+
+    # SOLR_LAW_HOST is the host for Apache Solr's core for indexed laws.
+    SOLR_LAW_HOST="$SOLR_DOCS_HOST"
+    # SOLR_LAW_PORT is the host for Apache Solr's core for indexed laws.
+    SOLR_LAW_PORT=$SOLR_DOCS_PORT
+    # SOLR_LAW_CORE_NAME is the core name for Apache Solr's core for indexed laws.
+    SOLR_LAW_CORE_NAME="vacode_core"
+    # SOLR_LAW_URL is the URL to access Apache Solr's core for indexed laws. It is used by Gulp (and eventually the Search feature.)
+    SOLR_LAW_URL="http://$SOLR_LAW_HOST:$SOLR_LAW_PORT/solr/$SOLR_LAW_CORE_NAME"
+
+    # TIKA_HOST is the URL to access the host running Apache Tika.
+    TIKA_HOST="tika"
+    # TIKA_PORT is the URL to access the host running Apache Tika.
+    TIKA_PORT=9998
+    # TIKA_URL is the URL to access the host running Apache Tika.
+    TIKA_URL="http://tika:$TIKA_PORT"
+
 # Installing Solr with Tika and Tesseract
 
 Installing Solr with Tika and Tesseract is beyond the scope of this document. It is the search engine I am currently using.