Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify customisation summary #354

Merged
merged 4 commits into from
Nov 13, 2024
Merged

Clarify customisation summary #354

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
15bd0e2
Clarify customisation summary
minottic Nov 8, 2024
51abe03
Add more advanced comment
minottic Nov 8, 2024
85df8ee
Fix anchor
minottic Nov 8, 2024
0e75aec
Add more descriptions
minottic Nov 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -220,8 +225,6 @@ See for example [here](./services/frontend/compose.yaml).

</details>



## 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.
Expand Down