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

Add new lines for mkdocs rendering #337

Merged
merged 1 commit into from
Oct 15, 2024
Merged

Add new lines for mkdocs rendering #337

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,17 +48,20 @@ By running `docker compose up -d` these steps take place:
SciCat has extra features as part of its core as well as integrating with external services.

SciCat features that extend the backend are:

* Jobs - this mechanism posts to a [message broker](./services/backend/services/v3/services/rabbitmq/), which can then trigger [down stream processes](./services/backend/services/v3/services/archivemock/). To use this a RabbitMQ server is enabled.
* [Elasticsearch](./services/backend/services/v4/services/elastic/) - creates an elasticsearch service to provide full text search in the backend.

Services that can be integrated with SciCat are:

* [LDAP](./services/backend/services/ldap/) - authentication and authorization from an LDAP server
* [OIDC](./services/backend/services/keycloak/) - authentication and authorization using an OIDC provider
* [SearchAPI](./services/searchapi/) - for better free text search in the metadata based on the PANOSC [search-api](https://github.com/SciCatProject/panosc-search-api/)
* [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:

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)
Expand Down Expand Up @@ -264,4 +267,4 @@ To add a new service, with advanced configuration (see the [backend](./services/

## General use of SciCat

To use SciCat, please refer to the [original documentation](https://scicatproject.github.io/documentation/).
To use SciCat, please refer to the [original documentation](https://scicatproject.github.io/documentation/).