Skip to content

Commit

Permalink
Add configuration details to README
Browse files Browse the repository at this point in the history
  • Loading branch information
cc-a committed Mar 20, 2024
1 parent 5bfcd9b commit ae71993
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,24 @@ Following is an overview of the generated files and folders:
To learn how to configure, customize, deploy and much more, visit the
[InvenioRDM Documentation](https://inveniordm.docs.cern.ch/).

## Configuration

This project extends the [configuration approach] used by Invenio RDM.

Inspired by Django the following changes have been made:

- Configuration is stored in the module `ic_data_repo.config`.
- The module to use as settings can be specified at runtime via the environment variable
INVENIO_SETTINGS_MODULE. This defaults to `ic_data_repo.config`.
- The standard InvenioRDM config file (`invenio.cfg`) now contains only the necessary
import machinery to facilitate the above.

Note that overriding settings by environment variable still works.

The default configuration is suitable for development. A production oriented settings
file is also provided in `ic_data_repo.config.production`.

[configuration approach]: https://inveniordm.docs.cern.ch/install/configuration/
[getting started]: #getting-started
[invenio-cli]: https://github.com/inveniosoftware/invenio-cli
[pre-commit]: https://pre-commit.com/
Expand Down

0 comments on commit ae71993

Please sign in to comment.