-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
72 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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":"#technology-choices","title":"Technology Choices","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> is not used.</li> <li>The <code>invenio-app-rdm</code> Docker prebuilt image provided by InvenioRDM Starter is used instead of building the image locally.</li> <li>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>. InvenioRDM Starter will run locally 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>"}]} | ||
| {"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> file 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> <ul> <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> <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_SEARCH_HOSTS</code> - The search hosts 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_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_SQLALCHEMY_DATABASE_URI</code> - The database URI used by InvenioRDM.</li> <li><code>INVENIO_BASE_URL</code> - The base URL used by InvenioRDM.</li> <li><code>INVENIO_MAIL_SUPPRESS_SEND</code> - Set to <code>true</code> to suppress sending emails.</li> </ul>"},{"location":"#technology-choices","title":"Technology Choices","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> is not used.</li> <li>The <code>invenio-app-rdm</code> Docker prebuilt image provided by InvenioRDM Starter is used instead of building the image locally.</li> <li>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>. InvenioRDM Starter will run locally 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>"}]} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters