Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mfenner committed Nov 13, 2024
1 parent 4525167 commit 033e699
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 3 deletions.
18 changes: 17 additions & 1 deletion _site/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -455,6 +455,13 @@
<nav class="md-nav" aria-label="FAQ">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#where-can-i-ask-questions-about-inveniordm-starter" class="md-nav__link">
Where can I ask questions about InvenioRDM Starter?
</a>

</li>

<li class="md-nav__item">
<a href="#how-do-i-get-a-secure-ssl-certificate-on-localhost" class="md-nav__link">
How do I get a secure SSL certificate on localhost?
Expand Down Expand Up @@ -692,6 +699,13 @@
<nav class="md-nav" aria-label="FAQ">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#where-can-i-ask-questions-about-inveniordm-starter" class="md-nav__link">
Where can I ask questions about InvenioRDM Starter?
</a>

</li>

<li class="md-nav__item">
<a href="#how-do-i-get-a-secure-ssl-certificate-on-localhost" class="md-nav__link">
How do I get a secure SSL certificate on localhost?
Expand Down Expand Up @@ -901,6 +915,8 @@ <h2 id="architecture">Architecture</h2>
<li>Initial setup happens via a script running at container startup instead of via invenio-cli.</li>
</ul>
<h2 id="faq">FAQ</h2>
<h3 id="where-can-i-ask-questions-about-inveniordm-starter">Where can I ask questions about InvenioRDM Starter?</h3>
<p>Please use the <a href="https://github.com/front-matter/invenio-rdm-starter/discussions">InvenioRDM Starter GitHub Discussions</a>. You can ask general InvenioRDM questions in the Inveniosoftware Discord Chatroom <a href="https://discord.gg/8qatqBC">https://discord.gg/8qatqBC</a>.</p>
<h3 id="how-do-i-get-a-secure-ssl-certificate-on-localhost">How do I get a secure SSL certificate on localhost?</h3>
<p>The Caddy reverse proxy auto-generates a self-signed SSL certificate on localhost. This is an intermediary certificate, the corresponding root certificate isn't automatically used in a Docker Compose setup. You can copy the root certificate (Caddy Local Authority - 2024 ECC Root) from your running Caddy container (data/caddy/pki/local/root.crt) into your operating system certificate store. The root certificate only works on localhost and is valid for 10 years.</p>
<p>Alternatively allow requests to localhost over HTTPS even when an invalid certificate is presented. In Chrome go to chrome://flags/#allow-insecure-localhost and enable the flag.</p>
Expand All @@ -919,7 +935,7 @@ <h3 id="how-do-i-add-vocabularies-to-a-running-inveniordm-instance-eg-names-or-a
<h3 id="isnt-inveniordm-depending-on-python-39">Isn't InvenioRDM depending on Python 3.9?</h3>
<p>InvenioRDM Starter uses Python 3.12 (<a href="https://devguide.python.org/versions/">the current version</a>), but doesn't use any features of Python 3.10-3.12. Please report any Python 3.12-related issues you encounter. Python 3.9 reaches end-of-life in October 2025.</p>
<h3 id="dont-i-need-rabbitmq-for-the-inveniordm-message-broker">Don't I need RabbitMQ for the InvenioRDM message broker?</h3>
<p>The Python Celery framework can <a href="https://docs.celeryq.dev/en/stable/getting-started/backends-and-brokers/index.html">use either Redis or RabbitMQ</a> as the message broker (and Redis as the backend). I will be doing a detailed comparison of the two brokers for InvenioRDM.</p>
<p>The Python Celery framework can <a href="https://docs.celeryq.dev/en/stable/getting-started/backends-and-brokers/index.html">use either Redis or RabbitMQ</a> as the message broker (and Redis as the backend).</p>
<h3 id="why-use-debian-instead-of-almalinux-as-linux-distribution-for-the-docker-image">Why use Debian instead of Almalinux as Linux distribution for the Docker image?</h3>
<p>The <a href="https://hub.docker.com/_/python">official Python Docker images</a> use either Debian or Alpine, making them a good starting point (e.g. security fixes) for the InvenioRDM Docker image. Almalinux has a <a href="https://almalinux.org/blog/future-of-almalinux/">complicated relationship with RedHat Linux</a>. Alpine generates smaller images compared to Debian but most developers are less familar with Alpine and some people <a href="https://pythonspeed.com/articles/alpine-docker-python/">report issues</a> with building Python packages on Alpine. InvenioRDM Starter uses Debian 12 (Bookworm), released in June 2023.</p>
<h3 id="why-use-gunicorn-instead-of-uwsgi-as-the-python-application-server">Why use <code>gunicorn</code> instead of <code>uwsgi</code> as the Python application server?</h3>
Expand Down
Loading

0 comments on commit 033e699

Please sign in to comment.