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

Update pass configuration default property values docs #30

Merged
merged 7 commits into from
Oct 28, 2024
+96 −100
Merged

Update pass configuration default property values docs #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
003855a
Update pass-core docs
rpoet-jh Oct 25, 2024
d681742
Clean doc
rpoet-jh Oct 25, 2024
a101f9d
Fix env var definitions
rpoet-jh Oct 25, 2024
9214cd1
Clean table
rpoet-jh Oct 25, 2024
e1b482a
Update s3 prefix doc
rpoet-jh Oct 25, 2024
05dbe2d
Update other prop default values
rpoet-jh Oct 25, 2024
1789075
Remove pass_core_password default true
rpoet-jh Oct 28, 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
6 changes: 3 additions & 3 deletions developer-documentation/data-loaders/grant-loader.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,9 +120,9 @@ Once pass-docker is up and the loader container is done running, open a browser
```text
APP_HOME_ENV=/data/grantloader
POLICY_PROP_PATH=file:/data/grantloader/policy.properties
PASS_CLIENT_URL=http://localhost:8080
PASS_CLIENT_USER=<value from .eclipse-pass.local_env in pass-docker PASS_CORE_USER>
PASS_CLIENT_PASSWORD=<value from .eclipse-pass.local_env in pass-docker PASS_CORE_PASSWORD>
PASS_CORE_URL=http://localhost:8080
PASS_CORE_USER=<value from .eclipse-pass.local_env in pass-docker PASS_CORE_USER>
PASS_CORE_PASSWORD=<value from .eclipse-pass.local_env in pass-docker PASS_CORE_PASSWORD>
```
4. Copy your grant CSV file to the `grantloadertest` directory.
5. Open a new terminal and cd to the pass-docker directory.
Expand Down
70 changes: 35 additions & 35 deletions developer-documentation/deposit-service/ds-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,41 +8,41 @@ parameters such as message queues, the base URL of Pass Core, etc.

## Production Configuration Variables

| Environment Variable | Default Value | Description |
|-----------------------------------------|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `DSPACE_HOST` | localhost | IP address or host name of the server running the SWORD protocol version 2 endpoint |
| `DSPACE_PORT` | 8181 | TCP port exposing the SWORD protocol version 2 endpoint |
| `DSPACE_SERVER` | dspace | Domain name of the DSpace server |
| `DSPACE_USER` | [email protected] | DSpace user |
| `DSPACE_PASSWORD` | admin | DSpace password |
| `DSPACE_API_PROTOCOL` | https | Dspace API protocol |
| `DSPACE_API_PATH` | /server/api | Dspace API path |
| `INVENIORDM_API_BASE_URL` | | Base URL for InvenioRDM API |
| `INVENIORDM_VERIFY_SSL_CERT` | true | Required since the localhost InvenioRDM runs with a self-signed certificate |
| `INVENIORDM_API_TOKEN` | | InvenioRDM API token |
| `PMC_FTP_HOST` | localhost | IP address or host name of the NIH FTP server |
| `PMC_FTP_PORT` | 21 | TCP control port of the NIH FTP server |
| `PMC_FTP_USER` | nihmsftpuser | PMC S/FTP user |
| `PMC_FTP_PASSWORD` | nihmsftppass | PMC S/FTP password |
| `PASS_DEPOSIT_QUEUE_SUBMISSION_NAME` | submission | Name of the JMS queue that has messages pertaining to `Submission` resources |
| `PASS_DEPOSIT_QUEUE_DEPOSIT_NAME` | deposit | Name of the JMS queue that has messages pertaining to `Deposit` resources |
| `PASS_DEPOSIT_REPOSITORY_CONFIGURATION` | classpath:/repositories.json | Points to a json file containing the configuration for the transport of custodial content to remote repositories. Values must be [Spring Resource URIs][1]. |
| `PASS_CLIENT_URL` | localhost:8080 | URL used to communicate with the PASS Core API. Normally this variable does not need to be changed. |
| `PASS_CLIENT_PASSWORD` | fakepassword | Password used for `Basic` HTTP authentication to the PASS Core API |
| `PASS_CLIENT_USER` | fakeuser | Username used for `Basic` HTTP authentication to the PASS Core API |
| `NIHMS_MAIL_HOST` | | Host URL of the email service that will receive NIHMS emails regarding deposit statuses. |
| `NIHMS_MAIL_PORT` | | Port of the email service that that will receive NIHMS emails regarding deposit statuses. |
| `NIHMS_MAIL_USERNAME` | | Email address that will receive the NIHMS emails regarding deposit statuses. |
| `NIHMS_MAIL_PASSWORD` | | Password of the email address that will receive the NIHMS emails regarding deposit statuses. |
| `NIHMS_MAIL_TENANT_ID` | | The tenant ID if the `NIHMS_MAIL_HOST` is a cloud provided email services (e.g. Office 365). |
| `NIHMS_MAIL_CLIENT_ID` | | The client ID if the `NIHMS_MAIL_HOST` is a cloud provided email services (e.g. Office 365). |
| `NIHMS_MAIL_CLIENT_SECRET` | | The client secret if the `NIHMS_MAIL_HOST` is a cloud provided email services (e.g. Office 365). |
| `NIHMS_MAIL_AUTH` | | The type of authentication. Valid values are: `MS_EXCHANGE_OAUTH2` and `LOGIN`. |
| `PASS_DEPOSIT_NIHMS_EMAIL_FROM` | [email protected] | The official email address that sends the error messages. | |
| `TEST_DATA_POLICY_TITLE` | | The title of the Policy to associate to the Deployment Test Funder of the Test Grant. |
| `TEST_DATA_USER_EMAIL` | | The email of the User to set as the PI on the Test Grant. |
| `TEST_DATA_SKIP_DEPOSITS` | true | Whether to skip sending the Deployment Test Deposit to the remote repository or not. |
| `TEST_DATA_DSPACE_REPO_KEY` | JScholarship | The repository key of the DSpace repository, if exists, that will be used to delete Deployment Test Deposit Items if made. |
| Environment Variable | Default Value | Description |
|------------------------------------------|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `DSPACE_HOST` | | IP address or host name of the server running the SWORD protocol version 2 endpoint |
| `DSPACE_PORT` | | TCP port exposing the SWORD protocol version 2 endpoint |
| `DSPACE_SERVER` | | Domain name of the DSpace server |
| `DSPACE_USER` | | DSpace user |
| `DSPACE_PASSWORD` | | DSpace password |
| `DSPACE_API_PROTOCOL` | | Dspace API protocol |
| `DSPACE_API_PATH` | | Dspace API path |
| `INVENIORDM_API_BASE_URL` | | Base URL for InvenioRDM API |
| `INVENIORDM_VERIFY_SSL_CERT` | true | Required since the localhost InvenioRDM runs with a self-signed certificate |
| `INVENIORDM_API_TOKEN` | | InvenioRDM API token |
| `PMC_FTP_HOST` | | IP address or host name of the NIH FTP server |
| `PMC_FTP_PORT` | | TCP control port of the NIH FTP server |
| `PMC_FTP_USER` | | PMC S/FTP user |
| `PMC_FTP_PASSWORD` | | PMC S/FTP password |
| `PASS_DEPOSIT_QUEUE_SUBMISSION_NAME` | submission | Name of the JMS queue that has messages pertaining to `Submission` resources |
| `PASS_DEPOSIT_QUEUE_DEPOSIT_NAME` | deposit | Name of the JMS queue that has messages pertaining to `Deposit` resources |
| `PASS_DEPOSIT_REPOSITORY_CONFIGURATION` | classpath:/repositories.json | Points to a json file containing the configuration for the transport of custodial content to remote repositories. Values must be [Spring Resource URIs][1]. |
| `PASS_CORE_URL` | | URL used to communicate with the PASS Core API. Normally this variable does not need to be changed. |
| `PASS_CORE_PASSWORD` | | Password used for `Basic` HTTP authentication to the PASS Core API |
| `PASS_CORE_USER` | | Username used for `Basic` HTTP authentication to the PASS Core API |
| `NIHMS_MAIL_HOST` | | Host URL of the email service that will receive NIHMS emails regarding deposit statuses. |
| `NIHMS_MAIL_PORT` | | Port of the email service that that will receive NIHMS emails regarding deposit statuses. |
| `NIHMS_MAIL_USERNAME` | | Email address that will receive the NIHMS emails regarding deposit statuses. |
| `NIHMS_MAIL_PASSWORD` | | Password of the email address that will receive the NIHMS emails regarding deposit statuses. |
| `NIHMS_MAIL_TENANT_ID` | | The tenant ID if the `NIHMS_MAIL_HOST` is a cloud provided email services (e.g. Office 365). |
| `NIHMS_MAIL_CLIENT_ID` | | The client ID if the `NIHMS_MAIL_HOST` is a cloud provided email services (e.g. Office 365). |
| `NIHMS_MAIL_CLIENT_SECRET` | | The client secret if the `NIHMS_MAIL_HOST` is a cloud provided email services (e.g. Office 365). |
| `NIHMS_MAIL_AUTH` | | The type of authentication. Valid values are: `MS_EXCHANGE_OAUTH2` and `LOGIN`. |
| `PASS_DEPOSIT_NIHMS_EMAIL_FROM` | | The official email address that sends the error messages. | |
| `TEST_DATA_POLICY_TITLE` | | The title of the Policy to associate to the Deployment Test Funder of the Test Grant. |
| `TEST_DATA_USER_EMAIL` | | The email of the User to set as the PI on the Test Grant. |
| `TEST_DATA_SKIP_DEPOSITS` | true | Whether to skip sending the Deployment Test Deposit to the remote repository or not. |
| `TEST_DATA_DSPACE_REPO_KEY` | | The repository key of the DSpace repository, if exists, that will be used to delete Deployment Test Deposit Items if made. |

## Repositories Configuration

Expand Down
10 changes: 5 additions & 5 deletions developer-documentation/notification-service/ns-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,11 +172,11 @@ Supported environment variables (system property analogs) and default values are

* `PASS_NOTIFICATION_QUEUE_EVENT_NAME` (`pass.notification.queue.event.name`): `event`
* `PASS_NOTIFICATION_MODE` (`pass.notification.mode`): `DEMO`
* `PASS_CLIENT_URL` (`pass.client.url`): `{PASS_CLIENT_URL:localhost:8080}`
* `PASS_CLIENT_USER` (`pass.client.user`): `{PASS_CLIENT_USER:fakeuser}`
* `PASS_CLIENT_PASSWORD` (`pass.client.password`): `${PASS_CLIENT_PASSWORD:fakepassword}`
* `SPRING_MAIL_HOST` (`spring.mail.host`): `${SPRING_MAIL_HOST:localhost}`
* `SPRING_MAIL_PORT` (`spring.mail.port`): `${SPRING_MAIL_PORT:587}`
* `PASS_CORE_URL` (`pass.client.url`): `{PASS_CORE_URL}`
* `PASS_CORE_USER` (`pass.client.user`): `{PASS_CORE_USER}`
* `PASS_CORE_PASSWORD` (`pass.client.password`): `${PASS_CORE_PASSWORD}`
* `SPRING_MAIL_HOST` (`spring.mail.host`): `${SPRING_MAIL_HOST}`
* `SPRING_MAIL_PORT` (`spring.mail.port`): `${SPRING_MAIL_PORT}`
* `SPRING_MAIL_USERNAME` (`spring.mail.user`): `{SPRING_MAIL_USERNAME}`
* `SPRING_MAIL_PASSWORD` (`spring.mail.pass`): `{SPRING_MAIL_PASSWORD}`
* `SPRING_MAIL_PROTOCOL` (`spring.mail.transport`): `${SPRING_MAIL_PROTOCOL:SMTP}`
Expand Down
Loading