From d0a1b60b2c8aff21466b3d96597a5763980dc9bc Mon Sep 17 00:00:00 2001
From: Martin Fenner <martin@front-matter.io>
Date: Tue, 11 Jun 2024 00:30:57 +0200
Subject: [PATCH] update docs

---
 _site/index.html               | 2 +-
 _site/search/search_index.json | 2 +-
 docs/index.md                  | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/_site/index.html b/_site/index.html
index c180016..eccc3ba 100644
--- a/_site/index.html
+++ b/_site/index.html
@@ -633,7 +633,7 @@ <h2 id="architecture">Architecture</h2>
 <p>InvenioRDM Starter differs from the <code>Dockerfile</code> and <code>docker-compose.yml</code> generated by
 the <code>invenio-cli</code> command-line tool in the following ways:</p>
 <ul>
-<li><code>invenio-cli</code>, a local Python installation, and Python virtual environment are not used.</li>
+<li><code>invenio-cli</code>, a local Python installation, and a Python virtual environment are not used on the host computer.</li>
 <li>The <a href="https://github.com/front-matter/invenio-rdm-starter/pkgs/container/invenio-rdm-starter">invenio-app-rdm</a> prebuilt Docker image provided by InvenioRDM Starter is used instead of building the image locally.</li>
 <li><a href="https://www.debian.org/releases/bookworm/">Debian Bookworm</a> is used as the Docker image Linux distribution instead of <code>Almalinux</code>.</li>
 <li>The Docker image uses <code>Python 3.12</code> (not <code>3.9</code>) and <code>Node 20</code> (not <code>18</code>).</li>
diff --git a/_site/search/search_index.json b/_site/search/search_index.json
index 4a26fbd..9f8d837 100644
--- a/_site/search/search_index.json
+++ b/_site/search/search_index.json
@@ -1 +1 @@
-{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"InvenioRDM Starter","text":""},{"location":"#introduction","title":"Introduction","text":"<p>InvenioRDM is the turn-key research data management platform. Detailed documentation is available here. InvenioRDM Starter allows easy deployment and configuration of InvenioRDM. This is achieved by providing</p> <ul> <li>a prebuilt Invenio-App-RDM Docker image.</li> <li>a Docker Compose configuration file with sensible defaults.</li> </ul> <p>InvenioRDM Starter is coordinated by the InvenioRDM partner Front Matter.</p>"},{"location":"#requirements","title":"Requirements","text":"<ul> <li>Docker Desktop (Windows, macOS, Linux) or Docker Engine (Linux)</li> </ul> <p>A local installation of Python or Invenio-CLI is not required. A git client is recommended but not required.</p>"},{"location":"#quickstart","title":"Quickstart","text":"<p>Download the <code>docker-compose.yml</code> file from the InvenioRDM Starter git repository. Alternatively, clone the repository with git.</p> <pre><code>git clone https://github.com/front-matter/invenio-rdm-starter.git\n</code></pre> <pre><code>cd invenio-rdm-starter\n</code></pre> <p>Run <code>docker-compose up</code> in the same directory as the <code>docker-compose.yml</code> file.</p> <pre><code>docker compose up\n</code></pre> <p>Open a web browser and navigate to https://localhost.</p>"},{"location":"#configuration","title":"Configuration","text":"<p>The <code>docker-compose.yml</code> configuration can be modified to suit your needs. The following environment variables can be set via an <code>.env</code> file in the same folder:</p>"},{"location":"#web-and-worker","title":"Web and Worker","text":"<ul> <li><code>INVENIO_SITE_UI_URL</code> - The site UI URL used by InvenioRDM.</li> <li><code>INVENIO_SITE_API_URL</code> - The site API URL used by InvenioRDM.</li> <li><code>INVENIO_THEME_FRONTPAGE_TITLE</code> - The frontpage title used by InvenioRDM.</li> <li><code>INVENIO_THEME_SHOW_FRONTPAGE_INTRO_SECTION</code> - Set to <code>true</code> to show the frontpage intro section.</li> <li><code>INVENIO_LOGGING_CONSOLE_LEVEL</code> - The logging console level used by InvenioRDM.</li> <li><code>INVENIO_BABEL_DEFAULT_LOCALE</code> - The default locale used by InvenioRDM.</li> <li><code>INVENIO_WSGI_PROXIES</code> - The number of proxies used by InvenioRDM.</li> <li><code>INVENIO_SITE_UI_URL</code> - The site UI URL used by InvenioRDM.</li> <li><code>INVENIO_SITE_API_URL</code> - The site API URL used by InvenioRDM.</li> <li><code>INVENIO_SECRET_KEY</code> - The secret key used by InvenioRDM.</li> <li><code>INVENIO_BASE_URL</code> - The base URL used by InvenioRDM.</li> </ul>"},{"location":"#cache","title":"Cache","text":"<ul> <li><code>INVENIO_CACHE_TYPE</code> - The cache type used by InvenioRDM.</li> <li><code>INVENIO_CACHE_REDIS_URL</code> - The cache Redis URL used by InvenioRDM.</li> <li><code>INVENIO_ACCOUNTS_SESSION_REDIS_URL</code> - The accounts session Redis URL used by InvenioRDM.</li> <li><code>INVENIO_CELERY_RESULT_BACKEND</code> - The Celery result backend used by InvenioRDM.</li> <li><code>INVENIO_RATELIMIT_STORAGE_URL</code> - The ratelimit storage URL used by InvenioRDM.</li> <li><code>INVENIO_COMMUNITIES_IDENTITIES_CACHE_REDIS_URL</code> - The communities identities cache Redis URL used by InvenioRDM.</li> <li><code>INVENIO_BROKER_URL</code> - The broker URL used by InvenioRDM.</li> <li><code>INVENIO_CELERY_BROKER_URL</code> - The Celery broker URL used by InvenioRDM.</li> </ul>"},{"location":"#database","title":"Database","text":"<ul> <li><code>INVENIO_SQLALCHEMY_DATABASE_URI</code> - The database URI used by InvenioRDM.</li> </ul>"},{"location":"#search","title":"Search","text":"<ul> <li><code>INVENIO_SEARCH_HOSTS</code> - The search host and port.</li> </ul>"},{"location":"#mail","title":"Mail","text":"<ul> <li><code>INVENIO_MAIL_SUPPRESS_SEND</code> - Set to <code>true</code> to suppress sending emails.</li> </ul>"},{"location":"#architecture","title":"Architecture","text":"<p>InvenioRDM Starter differs from the <code>Dockerfile</code> and <code>docker-compose.yml</code> generated by the <code>invenio-cli</code> command-line tool in the following ways:</p> <ul> <li><code>invenio-cli</code>, a local Python installation, and Python virtual environment are not used.</li> <li>The invenio-app-rdm prebuilt Docker image provided by InvenioRDM Starter is used instead of building the image locally.</li> <li>Debian Bookworm is used as the Docker image Linux distribution instead of <code>Almalinux</code>.</li> <li>The Docker image uses <code>Python 3.12</code> (not <code>3.9</code>) and <code>Node 20</code> (not <code>18</code>).</li> <li>The Docker image uses <code>gunicorn</code> as the WSGI server instead of <code>uwsgi</code>.</li> <li>Docker Compose uses <code>Caddy</code> as the reverse proxy server instead of <code>Nginx</code>. InvenioRDM Starter will run locally at <code>https://localhost</code>, and uses a self-signed ssl certificate issued by <code>Caddy</code>.</li> <li>Docker Compose uses <code>Redis</code> as the message broker instead of <code>RabbitMQ</code></li> </ul>"}]}
\ No newline at end of file
+{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"InvenioRDM Starter","text":""},{"location":"#introduction","title":"Introduction","text":"<p>InvenioRDM is the turn-key research data management platform. Detailed documentation is available here. InvenioRDM Starter allows easy deployment and configuration of InvenioRDM. This is achieved by providing</p> <ul> <li>a prebuilt Invenio-App-RDM Docker image.</li> <li>a Docker Compose configuration file with sensible defaults.</li> </ul> <p>InvenioRDM Starter is coordinated by the InvenioRDM partner Front Matter.</p>"},{"location":"#requirements","title":"Requirements","text":"<ul> <li>Docker Desktop (Windows, macOS, Linux) or Docker Engine (Linux)</li> </ul> <p>A local installation of Python or Invenio-CLI is not required. A git client is recommended but not required.</p>"},{"location":"#quickstart","title":"Quickstart","text":"<p>Download the <code>docker-compose.yml</code> file from the InvenioRDM Starter git repository. Alternatively, clone the repository with git.</p> <pre><code>git clone https://github.com/front-matter/invenio-rdm-starter.git\n</code></pre> <pre><code>cd invenio-rdm-starter\n</code></pre> <p>Run <code>docker-compose up</code> in the same directory as the <code>docker-compose.yml</code> file.</p> <pre><code>docker compose up\n</code></pre> <p>Open a web browser and navigate to https://localhost.</p>"},{"location":"#configuration","title":"Configuration","text":"<p>The <code>docker-compose.yml</code> configuration can be modified to suit your needs. The following environment variables can be set via an <code>.env</code> file in the same folder:</p>"},{"location":"#web-and-worker","title":"Web and Worker","text":"<ul> <li><code>INVENIO_SITE_UI_URL</code> - The site UI URL used by InvenioRDM.</li> <li><code>INVENIO_SITE_API_URL</code> - The site API URL used by InvenioRDM.</li> <li><code>INVENIO_THEME_FRONTPAGE_TITLE</code> - The frontpage title used by InvenioRDM.</li> <li><code>INVENIO_THEME_SHOW_FRONTPAGE_INTRO_SECTION</code> - Set to <code>true</code> to show the frontpage intro section.</li> <li><code>INVENIO_LOGGING_CONSOLE_LEVEL</code> - The logging console level used by InvenioRDM.</li> <li><code>INVENIO_BABEL_DEFAULT_LOCALE</code> - The default locale used by InvenioRDM.</li> <li><code>INVENIO_WSGI_PROXIES</code> - The number of proxies used by InvenioRDM.</li> <li><code>INVENIO_SITE_UI_URL</code> - The site UI URL used by InvenioRDM.</li> <li><code>INVENIO_SITE_API_URL</code> - The site API URL used by InvenioRDM.</li> <li><code>INVENIO_SECRET_KEY</code> - The secret key used by InvenioRDM.</li> <li><code>INVENIO_BASE_URL</code> - The base URL used by InvenioRDM.</li> </ul>"},{"location":"#cache","title":"Cache","text":"<ul> <li><code>INVENIO_CACHE_TYPE</code> - The cache type used by InvenioRDM.</li> <li><code>INVENIO_CACHE_REDIS_URL</code> - The cache Redis URL used by InvenioRDM.</li> <li><code>INVENIO_ACCOUNTS_SESSION_REDIS_URL</code> - The accounts session Redis URL used by InvenioRDM.</li> <li><code>INVENIO_CELERY_RESULT_BACKEND</code> - The Celery result backend used by InvenioRDM.</li> <li><code>INVENIO_RATELIMIT_STORAGE_URL</code> - The ratelimit storage URL used by InvenioRDM.</li> <li><code>INVENIO_COMMUNITIES_IDENTITIES_CACHE_REDIS_URL</code> - The communities identities cache Redis URL used by InvenioRDM.</li> <li><code>INVENIO_BROKER_URL</code> - The broker URL used by InvenioRDM.</li> <li><code>INVENIO_CELERY_BROKER_URL</code> - The Celery broker URL used by InvenioRDM.</li> </ul>"},{"location":"#database","title":"Database","text":"<ul> <li><code>INVENIO_SQLALCHEMY_DATABASE_URI</code> - The database URI used by InvenioRDM.</li> </ul>"},{"location":"#search","title":"Search","text":"<ul> <li><code>INVENIO_SEARCH_HOSTS</code> - The search host and port.</li> </ul>"},{"location":"#mail","title":"Mail","text":"<ul> <li><code>INVENIO_MAIL_SUPPRESS_SEND</code> - Set to <code>true</code> to suppress sending emails.</li> </ul>"},{"location":"#architecture","title":"Architecture","text":"<p>InvenioRDM Starter differs from the <code>Dockerfile</code> and <code>docker-compose.yml</code> generated by the <code>invenio-cli</code> command-line tool in the following ways:</p> <ul> <li><code>invenio-cli</code>, a local Python installation, and a Python virtual environment are not used on the host computer.</li> <li>The invenio-app-rdm prebuilt Docker image provided by InvenioRDM Starter is used instead of building the image locally.</li> <li>Debian Bookworm is used as the Docker image Linux distribution instead of <code>Almalinux</code>.</li> <li>The Docker image uses <code>Python 3.12</code> (not <code>3.9</code>) and <code>Node 20</code> (not <code>18</code>).</li> <li>The Docker image uses <code>gunicorn</code> as the WSGI server instead of <code>uwsgi</code>.</li> <li>Docker Compose uses <code>Caddy</code> as the reverse proxy server instead of <code>Nginx</code>. InvenioRDM Starter will run locally at <code>https://localhost</code>, and uses a self-signed ssl certificate issued by <code>Caddy</code>.</li> <li>Docker Compose uses <code>Redis</code> as the message broker instead of <code>RabbitMQ</code></li> </ul>"}]}
\ No newline at end of file
diff --git a/docs/index.md b/docs/index.md
index 9def6f4..31c0ffa 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -88,7 +88,7 @@ The `docker-compose.yml` configuration can be modified to suit your needs. The f
 InvenioRDM Starter differs from the `Dockerfile` and `docker-compose.yml` generated by
 the `invenio-cli` command-line tool in the following ways:
 
-* `invenio-cli`, a local Python installation, and Python virtual environment are not used.
+* `invenio-cli`, a local Python installation, and a Python virtual environment are not used on the host computer.
 * The [invenio-app-rdm](https://github.com/front-matter/invenio-rdm-starter/pkgs/container/invenio-rdm-starter) prebuilt Docker image provided by InvenioRDM Starter is used instead of building the image locally.
 * [Debian Bookworm](https://www.debian.org/releases/bookworm/) is used as the Docker image Linux distribution instead of `Almalinux`.
 * The Docker image uses `Python 3.12` (not `3.9`) and `Node 20` (not `18`).