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 05ea3f2 commit e330b93
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ the `invenio-cli` command-line tool in the following ways:

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/authorities/local/root.crt) into your operating system certificate store. The root certificate only works on localhost and is valid for 10 years.

Alternatively allow requests to localhost over HTTPS even when an invalid certificate is presented. In Chrome go to chrome://flags/#allow-insecure-localhost
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.

### How do I delete the InvenioRDM Postgres database?

Expand Down
22 changes: 21 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,13 @@ Run `docker-compose up` in the same directory as the `docker-compose.yml` file.
docker compose up
```

Open a web browser and navigate to [https://localhost](https://localhost). One default admin user is created during setup: email `[email protected]`, password `changeme`.
When you run Docker Compose for the first time, run the setup script to set up the InvenioRDM database and Elasticsearch indexes.

```bash
docker exec -it invenio-rdm-starter-worker-1 setup.sh
```

Open a web browser and navigate to [https://localhost](https://localhost). One default admin user is created during setup: email `[email protected]`. The password is generated randomly.

## Configuration

Expand Down Expand Up @@ -138,6 +144,8 @@ the `invenio-cli` command-line tool in the following ways:

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.

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.

### How do I delete the InvenioRDM Postgres database?

```bash
Expand All @@ -150,6 +158,18 @@ docker exec -it invenio-rdm-starter-web-1 invenio db drop --yes-i-know
docker exec -it invenio-rdm-starter-web-1 invenio index destroy --force --yes-i-know
```

### How do I schedule a reindex of the InvenioRDM database?

```bash
docker exec -it invenio-rdm-starter-web-1 invenio rdm rebuild-all-indices
```

### How do I add vocabularies to a running InvenioRDM instance, e.g. names or affiliations?

```bash
docker exec -it invenio-rdm-starter-web-1 invenio rdm-records add-to-fixture affiliations
```

### Isn't InvenioRDM depending on Python 3.9?

InvenioRDM Starter uses Python 3.12 ([the current version](https://devguide.python.org/versions/)), 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.
Expand Down

0 comments on commit e330b93

Please sign in to comment.