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.

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

chore: add details to configure REMS-Synchronizer #37

Merged
merged 1 commit into from
Aug 23, 2024
Merged
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
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,34 @@ To start the containers:

Choose the command that matches your container runtime. We recommend using `podman compose up` for most setups.

## Setting up
brunopacheco1 marked this conversation as resolved.
Show resolved Hide resolved

* create bot user in REMS
```
POST <REMS_URL>/api/users/create
x-rems-api-key: existing-api-key
x-rems-user-id: owner-id
Content-Type: application/json

{
"userid": "<BOT_USER_ID>",
"name": "<BOT_USER_NAME>",
"email": "<BOT_USER_EMAIL>"
}
brunopacheco1 marked this conversation as resolved.
Show resolved Hide resolved

* add a new api-key for this user
```
xxxxxxx:/rems# java -Dconfig.rems=config/config.edn -jar rems.jar grant-role owner <BOT_USER_ID>
xxxxxxx:/rems# java -Dconfig.rems=config/config.edn -jar rems.jar api-key add <TEST_BOT_API_KEY>
xxxxxxx:/rems# java -Dconfig.rems=config/config.edn -jar rems.jar api-key set-users <TEST_BOT_API_KEY> <BOT_USER_ID>
xxxxxxx:/rems# java -Dconfig.rems=config/config.edn -jar rems.jar api-key allow <TEST_BOT_API_KEY> any '/api/organizations.*'
xxxxxxx:/rems# java -Dconfig.rems=config/config.edn -jar rems.jar api-key allow <TEST_BOT_API_KEY> any '/api/forms.*'
xxxxxxx:/rems# java -Dconfig.rems=config/config.edn -jar rems.jar api-key allow <TEST_BOT_API_KEY> any '/api/workflows.*'
xxxxxxx:/rems# java -Dconfig.rems=config/config.edn -jar rems.jar api-key allow <TEST_BOT_API_KEY> any '/api/resources.*'
xxxxxxx:/rems# java -Dconfig.rems=config/config.edn -jar rems.jar api-key allow <TEST_BOT_API_KEY> any '/api/catalogue-items.*'
xxxxxxx:/rems# java -Dconfig.rems=config/config.edn -jar rems.jar api-key allow <TEST_BOT_API_KEY> any '/api/licenses.*'
brunopacheco1 marked this conversation as resolved.
Show resolved Hide resolved
```

## License

- All original source code is licensed under [Apache-2.0](./LICENSES/Apache-2.0.txt).
Expand Down