diff --git a/_site/index.html b/_site/index.html index 88f8d6b..9f429b4 100644 --- a/_site/index.html +++ b/_site/index.html @@ -356,17 +356,16 @@

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

+

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

Requirements

-

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

diff --git a/_site/search/search_index.json b/_site/search/search_index.json index 55b6ae0..e99bf15 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 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 +{"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"}]} \ No newline at end of file diff --git a/_site/sitemap.xml.gz b/_site/sitemap.xml.gz index fabba3a..8f95e5c 100644 Binary files a/_site/sitemap.xml.gz and b/_site/sitemap.xml.gz differ diff --git a/_site/stylesheets/extra.css b/_site/stylesheets/extra.css index 995676c..dcd6e4b 100644 --- a/_site/stylesheets/extra.css +++ b/_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; } diff --git a/docker-compose.yml b/docker-compose.yml index 2842a73..957b7e8 100644 --- a/docker-compose.yml +++ b/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: diff --git a/docs/index.md b/docs/index.md index c8a8c70..44718d2 100644 --- a/docs/index.md +++ b/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` diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index 995676c..dcd6e4b 100644 --- a/docs/stylesheets/extra.css +++ b/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; }