updated documentation

_site/index.html

@@ -356,17 +356,16 @@
 
 <h1 id="welcome-to-inveniordm-starter">Welcome to InvenioRDM Starter</h1>
 <h2 id="introduction">Introduction</h2>
-<p>InvenioRDM Starter is an implementation of the InvenioRDM repository management
-platform focused on easy deployment and configuration. This is achieved by providing</p>
+<p>InvenioRDM Starter is an implementation of the InvenioRDM Turn-key research data management repository focusing on easy deployment and configuration. 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>
 <h2 id="requirements">Requirements</h2>
 <ul>
-<li>Docker Desktop (Windows, macOS) or Docker Engine (Linux)</li>
+<li>Docker Desktop (<a href="https://docs.docker.com/desktop/install/windows-install/">Windows</a>, <a href="https://docs.docker.com/desktop/install/mac-install/">macOS</a>, <a href="https://docs.docker.com/desktop/install/linux-install/">Linux</a>) or Docker Engine (<a href="https://docs.docker.com/engine/install/">Linux</a>)</li>
 </ul>
-<p>A local installation of Python or Invenio-CLI is not required.</p>
+<p>A local installation of Python or Invenio-CLI is not required. A git client is recommended but not required.</p>
 <h2 id="quickstart">Quickstart</h2>
 <ul>
 <li>Download the <code>docker-compose.yml</code> file from the <a href="https://github.com/front-matter/invenio-rdm-starter">InvenioRDM Starter git repository</a>. Alternatively, clone the repository.</li>
@@ -382,7 +381,7 @@ <h2 id="technology-choices">Technology Choices</h2>
 <li><code>Python:3.12</code> based on Debian Bookworm is used as the Docker base image, instead of <code>Almalinux</code>.</li>
 <li>The Docker image uses <code>Python 3.12</code> and <code>Node 20</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>.</li>
+<li>Docker Compose uses <code>Caddy</code> as the reverse proxy server instead of <code>Nginx</code>. InvenioRDM Starter run at <code>https://localhost</code>, and uses a self-signed 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>
 

_site/search/search_index.json

@@ -1 +1 @@
-{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Welcome to InvenioRDM Starter Introduction InvenioRDM Starter is an implementation of the InvenioRDM repository management platform focused on easy deployment and configuration. This is achieved by providing a prebuilt Invenio-App-RDM Docker image. a Docker Compose configuration file with sensible defaults. Requirements Docker Desktop (Windows, macOS) or Docker Engine (Linux) A local installation of Python or Invenio-CLI is not required. Quickstart Download the docker-compose.yml file from the InvenioRDM Starter git repository . Alternatively, clone the repository. Run docker-compose up in the same directory as the docker-compose.yml file. Open a web browser and navigate to https://localhost . Technology Choices InvenioRDM Starter differs from the Dockerfile and docker-compose.yml generated by the invenio-cli command-line tool in the following ways: invenio-cli is not used. The invenio-app-rdm Docker prebuilt image provided by InvenioRDM Starter is used instead of building the image locally. Python:3.12 based on Debian Bookworm is used as the Docker base image, instead of Almalinux . The Docker image uses Python 3.12 and Node 20 . The Docker image uses gunicorn as the WSGI server instead of uwsgi . Docker Compose uses Caddy as the reverse proxy server instead of Nginx . Docker Compose uses Redis as the message broker instead of RabbitMQ","title":"Welcome to InvenioRDM Starter"},{"location":"#welcome-to-inveniordm-starter","text":"","title":"Welcome to InvenioRDM Starter"},{"location":"#introduction","text":"InvenioRDM Starter is an implementation of the InvenioRDM repository management platform focused on easy deployment and configuration. This is achieved by providing a prebuilt Invenio-App-RDM Docker image. a Docker Compose configuration file with sensible defaults.","title":"Introduction"},{"location":"#requirements","text":"Docker Desktop (Windows, macOS) or Docker Engine (Linux) A local installation of Python or Invenio-CLI is not required.","title":"Requirements"},{"location":"#quickstart","text":"Download the docker-compose.yml file from the InvenioRDM Starter git repository . Alternatively, clone the repository. Run docker-compose up in the same directory as the docker-compose.yml file. Open a web browser and navigate to https://localhost .","title":"Quickstart"},{"location":"#technology-choices","text":"InvenioRDM Starter differs from the Dockerfile and docker-compose.yml generated by the invenio-cli command-line tool in the following ways: invenio-cli is not used. The invenio-app-rdm Docker prebuilt image provided by InvenioRDM Starter is used instead of building the image locally. Python:3.12 based on Debian Bookworm is used as the Docker base image, instead of Almalinux . The Docker image uses Python 3.12 and Node 20 . The Docker image uses gunicorn as the WSGI server instead of uwsgi . Docker Compose uses Caddy as the reverse proxy server instead of Nginx . Docker Compose uses Redis as the message broker instead of RabbitMQ","title":"Technology Choices"}]}
+{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Welcome to InvenioRDM Starter Introduction InvenioRDM Starter is an implementation of the InvenioRDM Turn-key research data management repository focusing on easy deployment and configuration. This is achieved by providing a prebuilt Invenio-App-RDM Docker image. a Docker Compose configuration file with sensible defaults. Requirements Docker Desktop ( Windows , macOS , Linux ) or Docker Engine ( Linux ) A local installation of Python or Invenio-CLI is not required. A git client is recommended but not required. Quickstart Download the docker-compose.yml file from the InvenioRDM Starter git repository . Alternatively, clone the repository. Run docker-compose up in the same directory as the docker-compose.yml file. Open a web browser and navigate to https://localhost . Technology Choices InvenioRDM Starter differs from the Dockerfile and docker-compose.yml generated by the invenio-cli command-line tool in the following ways: invenio-cli is not used. The invenio-app-rdm Docker prebuilt image provided by InvenioRDM Starter is used instead of building the image locally. Python:3.12 based on Debian Bookworm is used as the Docker base image, instead of Almalinux . The Docker image uses Python 3.12 and Node 20 . The Docker image uses gunicorn as the WSGI server instead of uwsgi . Docker Compose uses Caddy as the reverse proxy server instead of Nginx . InvenioRDM Starter run at https://localhost , and uses a self-signed certificate issued by Caddy . Docker Compose uses Redis as the message broker instead of RabbitMQ","title":"Welcome to InvenioRDM Starter"},{"location":"#welcome-to-inveniordm-starter","text":"","title":"Welcome to InvenioRDM Starter"},{"location":"#introduction","text":"InvenioRDM Starter is an implementation of the InvenioRDM Turn-key research data management repository focusing on easy deployment and configuration. This is achieved by providing a prebuilt Invenio-App-RDM Docker image. a Docker Compose configuration file with sensible defaults.","title":"Introduction"},{"location":"#requirements","text":"Docker Desktop ( Windows , macOS , Linux ) or Docker Engine ( Linux ) A local installation of Python or Invenio-CLI is not required. A git client is recommended but not required.","title":"Requirements"},{"location":"#quickstart","text":"Download the docker-compose.yml file from the InvenioRDM Starter git repository . Alternatively, clone the repository. Run docker-compose up in the same directory as the docker-compose.yml file. Open a web browser and navigate to https://localhost .","title":"Quickstart"},{"location":"#technology-choices","text":"InvenioRDM Starter differs from the Dockerfile and docker-compose.yml generated by the invenio-cli command-line tool in the following ways: invenio-cli is not used. The invenio-app-rdm Docker prebuilt image provided by InvenioRDM Starter is used instead of building the image locally. Python:3.12 based on Debian Bookworm is used as the Docker base image, instead of Almalinux . The Docker image uses Python 3.12 and Node 20 . The Docker image uses gunicorn as the WSGI server instead of uwsgi . Docker Compose uses Caddy as the reverse proxy server instead of Nginx . InvenioRDM Starter run at https://localhost , and uses a self-signed certificate issued by Caddy . Docker Compose uses Redis as the message broker instead of RabbitMQ","title":"Technology Choices"}]}

_site/stylesheets/extra.css

@@ -1,5 +1,5 @@
 :root {
-  --md-primary-fg-color:        #ef4444;
+  --md-primary-fg-color:        #b91c1c;
   --md-primary-fg-color--light: #fecaca;
-  --md-primary-fg-color--dark:  #991b1b;
+  --md-primary-fg-color--dark:  #7f1d1d;
 }

docker-compose.yml

@@ -19,11 +19,8 @@ services:
     ports:
       - "80:80"
       - "443:443"
-      - "443:443/udp"
-      - "2019:2019"
     volumes:
       - ./Caddyfile:/etc/caddy/Caddyfile
-      - ./site:/srv
       - caddy_data:/data
       - caddy_config:/config
   web:

docs/index.md

@@ -2,17 +2,16 @@
 
 ## Introduction
 
-InvenioRDM Starter is an implementation of the InvenioRDM repository management
-platform focused on easy deployment and configuration. This is achieved by providing
+InvenioRDM Starter is an implementation of the InvenioRDM Turn-key research data management repository focusing on easy deployment and configuration. This is achieved by providing
 
 * a prebuilt Invenio-App-RDM Docker image.
 * a Docker Compose configuration file with sensible defaults.
 
 ## Requirements
 
-* Docker Desktop (Windows, macOS) or Docker Engine (Linux)
+* Docker Desktop ([Windows](https://docs.docker.com/desktop/install/windows-install/), [macOS](https://docs.docker.com/desktop/install/mac-install/), [Linux](https://docs.docker.com/desktop/install/linux-install/)) or Docker Engine ([Linux](https://docs.docker.com/engine/install/))
 
-A local installation of Python or Invenio-CLI is not required.
+A local installation of Python or Invenio-CLI is not required. A git client is recommended but not required.
 
 ## Quickstart
 
@@ -30,5 +29,5 @@ the `invenio-cli` command-line tool in the following ways:
 * `Python:3.12` based on Debian Bookworm is used as the Docker base image, instead of `Almalinux`.
 * The Docker image uses `Python 3.12` and `Node 20`.
 * The Docker image uses `gunicorn` as the WSGI server instead of `uwsgi`.
-* Docker Compose uses `Caddy` as the reverse proxy server instead of `Nginx`.
+* Docker Compose uses `Caddy` as the reverse proxy server instead of `Nginx`. InvenioRDM Starter run at `https://localhost`, and uses a self-signed certificate issued by `Caddy`.
 * Docker Compose uses `Redis` as the message broker instead of `RabbitMQ`

docs/stylesheets/extra.css

@@ -1,5 +1,5 @@
 :root {
-  --md-primary-fg-color:        #ef4444;
+  --md-primary-fg-color:        #b91c1c;
   --md-primary-fg-color--light: #fecaca;
-  --md-primary-fg-color--dark:  #991b1b;
+  --md-primary-fg-color--dark:  #7f1d1d;
 }