Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .github/mkdocs/mkdocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ nav:
- backendconfig/index.md
- backendconfig/authorization/index.md
- backendconfig/dois.md
- frontendconfig/index.md


- About:
Expand Down
36 changes: 36 additions & 0 deletions docs/backendconfig/jobs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# SciCat jobs - how to use them

If you want to post a jobs, check the structure of the job's body. From swagger endpoints we see that there are 4 fields:

* types (mandatory)
* jobsParams (mandatory)
* ownerUser
* ownerGroup


## **jobTypes**

Possible values can be seen from the [example config file](https://github.com/SciCatProject/scicat-backend-next/blob/master/jobConfig.example.yaml):

1. jobType: template_job
2. jobType: archive
3. jobType: retrieve
4. jobType: public
5. jobType: email_demo
6. jobType: url_demo
7. jobType: rabbitmq_demo
8. jobType: switch_demo
9. jobType: validate_demo


## **actionTypes**

Per job one can execute several actions. There are these actionTypes:

1. actionType: log
2. actionType: validate
3. actionType: rabbitmq
4. actionType: url
5. actionType: switch
6. actionType: email
7. actionType: error
11 changes: 11 additions & 0 deletions docs/frontendconfig/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Frontend configuration

In only two json files SciCat's frontend configuration is managed, both as part of the backend configuration:

1. [frontend.config.json](https://github.com/SciCatProject/scicat-backend-next/blob/master/src/config/frontend.config.json) and
2. [frontend.theme.json](https://github.com/SciCatProject/scicat-backend-next/blob/master/src/config/frontend.theme.json)

Please write about
- Why the frontend config is in the backend config?
- What the scope is of these two files?
- Please provide examples for enabling/disabling buttons.
5 changes: 5 additions & 0 deletions docs/operator-guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@ These two components together comprise the "backend" of the architecture.
### Configuration of the backend
There is one central place where one has a handle on how the backend is configured in SciCat: the [dotenv](../backendconfig/index.md) file.


### Example: How to connect your scicat to an external service
One useful feature of SciCat is to be able to connect your scicat to some external service via "SciCat jobs". Traditionally there were three fixed types, a job to archive, to retrieve and to publish, visible from the GUI through the respective buttons. Since recently (summer 2025) there are in total 9 types available. How to use them for your site, start with this documentation [here](../backendconfig/jobs.md) for admins. For now, stick to the developers documentation directly in the [code repo](https://github.com/SciCatProject/documentation/blob/master/Development/v4.x/backend/configuration/jobconfig.md).


### Example: How to integrate to OIDC using keycloak

Integration with an identity provider, Keycloak, can be done using Open ID Connect, a protocol for authentication.
Expand Down