-
-
- Installation for Development and Testing
+
+ Introduction
+
+
+
+
+ -
+
+ Requirements
+
+
+
+
+ -
+
+ Quickstart
+
+
+
+
+ -
+
+ Technology Choices
@@ -313,9 +355,36 @@
Welcome to InvenioRDM Starter
-Installation for Development and Testing
-To install InvenioRDM on your local machine for Testing, use the Docker Compose
-configuration provided by 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
+
diff --git a/_site/search/search_index.json b/_site/search/search_index.json
index 5c540bf..55b6ae0 100644
--- a/_site/search/search_index.json
+++ b/_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 Installation for Development and Testing To install InvenioRDM on your local machine for Testing, use the Docker Compose configuration provided by InvenioRDM Starter.","title":"Welcome to InvenioRDM Starter"},{"location":"#welcome-to-inveniordm-starter","text":"","title":"Welcome to InvenioRDM Starter"},{"location":"#installation-for-development-and-testing","text":"To install InvenioRDM on your local machine for Testing, use the Docker Compose configuration provided by InvenioRDM Starter.","title":"Installation for Development and Testing"}]}
\ No newline at end of file
+{"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"}]}
\ No newline at end of file
diff --git a/_site/sitemap.xml.gz b/_site/sitemap.xml.gz
index 5e9b000..fabba3a 100644
Binary files a/_site/sitemap.xml.gz and b/_site/sitemap.xml.gz differ
diff --git a/docs/index.md b/docs/index.md
index 51360c1..c8a8c70 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,6 +1,34 @@
# Welcome to InvenioRDM Starter
-## Installation for Development and Testing
+## Introduction
-To install InvenioRDM on your local machine for Testing, use the Docker Compose
-configuration provided by InvenioRDM Starter.
+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](https://github.com/front-matter/invenio-rdm-starter). 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`