Skip to content

Commit

Permalink
update docs for production deployment
Browse files Browse the repository at this point in the history
  • Loading branch information
@mshadbolt
mshadbolt committed Jan 20, 2025
1 parent 40841f4 commit 32672fa
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
4 changes: 3 additions & 1 deletion docs/src/content/docs/deployment/production.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ The following default settings in the `.env` file should be changed when deployi
| value in prod environment | Notes |
|------------------------------------------------------------------------------------------|---------------|
| `CANDIG_DOMAIN=<your.prod.domain>` | Update to correct prod domain |
| `CANDIG_INTERNAL_DOMAIN=${CANDIG_DOMAIN}` or `internal ip address` | Some sites have needed to change this to `127.0.0.1` |
| `CANDIG_INTERNAL_DOMAIN=${CANDIG_DOMAIN}` or `internal ip address` | Some sites have needed to change this to `127.0.0.1` |
| `CANDIG_AUTH_DOMAIN=<your.prod.auth.domain>` | Update to correct prod auth domain |
| `CANDIG_SITE_LOCATION=<your-site-location>` | e.g. UHN, BC-Dev The name of your site, should be unique within a federation. |
| `CANDIG_DEBUG_MODE=0` | Turn off DEBUG mode |
Expand All @@ -71,6 +71,8 @@ The following default settings in the `.env` file should be changed when deployi
| `[email protected]` | Update to a relevant email addresss |
| `TYK_USE_SSL=true` | ensure tyk uses SSL |
| `CANDIG_DATA_PORTAL_URL=https://${CANDIG_DOMAIN}:${CANDIG_DATA_PORTAL_PORT}/data-portal` | ensure dataportal url has https |
| `CANDIG_DATA_PORTAL_SUPPORT_EMAIL=YOUR_SITE_ADMIN_SUPPORT_EMAIL` | Update the value to a valid email that will deal with user requests to access to the portal |
| `DIR_PERMISSIONS=775` | You may not need to change the default here but be aware that this gives anyone in the group of the person that deployed the current instance the ability to recompose services and rebuild the stack |


### Setting location information
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/deployment/user-roles.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Team members and Authorized users are similar in that they can only be granted a
A summary of what each user role can do in CanDIG is in the table below. The full technical breakdown of which endpoints each user can access is controlled through opa and is found in [`paths.json`](https://github.com/CanDIG/candig-opa/blob/develop/defaults/paths.json)

| Role | Register a new program | Edit authorized users in an existing program | ingest/delete data | view ingested data |
|---------------|-------------------------------------------------------|----------------------------------------------------------------------------|----------------------------------------------------------------------------|----------------------------------------------------------------------------|
|-----------------|-------------------------------------------------------|----------------------------------------------------------------------------|----------------------------------------------------------------------------|----------------------------------------------------------------------------|
| Site admin | <Icon name="mdi:checkbox-marked-circle" color="green" text-align="center"/> | <Icon name="mdi:checkbox-marked-circle" color="green"/> | <Icon name="mdi:checkbox-marked-circle" color="green"/> | <Icon name="mdi:checkbox-marked-circle" color="green"/> |
| Site curator | <Icon name="mdi:checkbox-marked-circle" color="green" text-align="center"/> | <Icon name="mdi:checkbox-marked-circle" color="green"/> | <Icon name="mdi:checkbox-marked-circle" color="green"/> | <Icon name="mdi:checkbox-marked-circle" color="green"/> |
| Program curator | <Icon name="mdi:do-not-disturb-alt" color="red" /> | <Icon name="mdi:checkbox-marked-circle" color="green"/>(authorized programs) | <Icon name="mdi:checkbox-marked-circle" color="green"/>(authorized programs) | <Icon name="mdi:checkbox-marked-circle" color="green"/>(authorized programs) |
Expand Down

0 comments on commit 32672fa

Please sign in to comment.