Skip to content

Commit 75e1aa0

Browse files
committed
docs: update credentials schema in the readme
1 parent 393da8a commit 75e1aa0

1 file changed

Lines changed: 33 additions & 8 deletions

File tree

README.md

Lines changed: 33 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,35 @@ Create a file name `cli-credentials.json` in the root of the repository:
1111

1212
```json
1313
{
14-
"host": "{DATABASE HOST}",
15-
"port": 5432, // DATABASE PORT
16-
"username": "DATABASE USERNAME",
17-
"password": "DATABASE PASSWORD"
14+
"database": {
15+
"__description": "Database details and credentials",
16+
"host": "{DATABASE HOST}",
17+
"port": 5432, // DATABASE PORT
18+
"root_secret_name": "{ROOT DATABASE SECRET NAME}",
19+
"root_role_name": "{ROOT DATABASE ROLE NAME}",
20+
"root_secret_password": "{ROOT DATABASE SECRET PASSWORD}",
21+
"setup_user": {
22+
"__description": "User to use when migrating and setting up database, should have higher permissions",
23+
"username": "{DB USER}",
24+
"password": "{DB PASSWORD}"
25+
}
26+
},
27+
"secrets": {
28+
"__description": "Secrets manager configurations",
29+
"provider": "aws"
30+
},
31+
"search": {
32+
"__description": "Search index factory configuration",
33+
"provider": "typesense",
34+
"url": "http://localhost:8108",
35+
"api_key": "typesensedev"
36+
},
37+
"storage": {
38+
"provider": "s3",
39+
"endpoint": {
40+
"type": "aws"
41+
}
42+
}
1843
}
1944
```
2045

@@ -37,11 +62,11 @@ Create a new file in this case `demo-tenant.json` this will contain the followin
3762
"db_name": "docbox-{tag}-{dev/prod}",
3863
"db_secret_name": "postgres/docbox/{dev/prod}/{tag}",
3964
"db_role_name": "{TENANT DB ROLE NAME}",
40-
"s3_name": "docbox-{tag}-{dev/prod}",
41-
"os_index_name": "docbox-{tag}-{dev/prod}",
42-
"s3_queue_arn": "arn:aws:sqs:ap-southeast-2:{YOUR_S3_UPLOADS_QUEUE_ARN}",
65+
"storage_bucket_name": "docbox-{tag}-{dev/prod}",
66+
"search_index_name": "docbox-{tag}-{dev/prod}",
67+
"storage_s3_queue_arn": "arn:aws:sqs:ap-southeast-2:{YOUR_S3_UPLOADS_QUEUE_ARN}",
4368
"event_queue_url": "https://sqs.ap-southeast-2.amazonaws.com/{YOUR_EVENT_QUEUE_ARN}",
44-
"origins": [
69+
"storage_cors_origins": [
4570
"https://{SOME_ORIGIN}"
4671
]
4772
}

0 commit comments

Comments
 (0)