diff --git a/README.md b/README.md index 7fa36391..8af6a51c 100644 --- a/README.md +++ b/README.md @@ -60,12 +60,17 @@ Services that can be integrated with SciCat are: * [LandingPage](./services/landingpage/) - a public interface for published datasets [landingpage](https://github.com/SciCatProject/LandingPageServer) * [JupyterHub](./services/jupyter/) - Adds an instance of JupyterHub which demonstrates ingestion and extraction of metadata using [pyscicat](https://scicatproject.github.io/pyscicat/). -To enable extra services configure them by: +To simply enable one or more of these extra services configure them by setting the proper environment variable(s) and/or compose profile(s) from [this table](#docker-compose-profiles-and-env-variables-configuration-options). -1. setting [docker compose env variables](https://docs.docker.com/compose/environment-variables/envvars-precedence/) -2. using [docker compose profiles](https://docs.docker.com/compose/profiles/) -3. modifying the [service-specific config](#service-specific-config) -4. adding [entrypoints](#entrypoints) +For a complete guide on how to customise or configure any service, including the default ones, please refer to these sections: + +* manually [select the services](#select-the-services) +* use [docker compose env variables](#docker-compose-env-variables) to enable features (supported values from this [table](#docker-compose-profiles-and-env-variables-configuration-options)) +* use [docker compose profiles](#docker-compose-profiles) to enable extra services (supported values from this [table](#docker-compose-profiles-and-env-variables-configuration-options)) +* modify the [service-specific config](#service-specific-config) to customise specific services +* add [entrypoints](#entrypoints) to control startup logic + +For a guide on how to add a new service, please refer to [this section](#add-a-new-service). ### Dependencies @@ -220,8 +225,6 @@ See for example [here](./services/frontend/compose.yaml). - - ## Add a new service Please note that services should, in general, be defined by their responsibility, rather than by their underlying technology, and should be named so.