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

Jump to bottom

Update documentation: Privacy & Replicaset Name #13

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

Update documentation: Privacy & Replicaset Name #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 6 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ Set to `none` if you intend use Sugarizer Chart independent of Sugarizer School
- **production:** Boolean. Use to switch between letsencrypt Staging and Production server. Set it to `true` to switch to Production server.

**[database]**
- **databaseUrl:** The URL of the MongoDB database. If replicaset is used, it can be the name of your replicaset like `mymongodb` which maps to `mymongodb-mongodb-replicaset-0.mymongodb-mongodb-replicaset.default.svc.cluster.local:27017,mymongodb-mongodb-replicaset-1.mymongodb-mongodb-replicaset.default.svc.cluster.local:27017,mymongodb-mongodb-replicaset-2.mymongodb-mongodb-replicaset.default.svc.cluster.local:27017` in the .ini file or if a single database without replicaset is used, then it can be like `sugarizer-service-db-mymongodb.sugarizer-mymongodb.svc.cluster.local`.
- **databaseUrl:** The URL of the MongoDB database. If replicaset is used, it can be the name of your replicaset like `ssp-mongodb` which maps to `ssp-mongodb-mongodb-replicaset-0.ssp-mongodb-mongodb-replicaset.default.svc.cluster.local:27017,ssp-mongodb-mongodb-replicaset-1.ssp-mongodb-mongodb-replicaset.default.svc.cluster.local:27017,ssp-mongodb-mongodb-replicaset-2.ssp-mongodb-mongodb-replicaset.default.svc.cluster.local:27017` in the .ini file or if a single database without replicaset is used, then it can be like `sugarizer-service-db-ssp-mongodb.sugarizer-ssp-mongodb.svc.cluster.local`.

- **replicaset:** Boolean. Defines if databaseUrl is the URL of a replicaset or a single database. Set it to `true` if MongoDB replicaset chart is used. `false` if database is used without replicasets.

Expand Down Expand Up @@ -250,6 +250,11 @@ Set to `none` if you intend use Sugarizer Chart independent of Sugarizer School
- **serviceName:** The issuer parameter is a string value indicating the provider or service this account is associated with, URL-encoded according to [RFC 3986](http://tools.ietf.org/html/rfc3986).
- **secret:** The JWT Secret which is used to encrypt JSON Web Token. It should be replaced with a unique value to keep the SSP Server secure.

**[privacy]**: The privacy section describes the privacy settings.
**consentNeed:** Can either be `true` or `false`. If the value is set to `true`, the Sugarizer client will ask for a consent to user before they will be allowed to do their first connection to the server.
**policy:** Policy is the URL that Sugarizer client shows in consent popup displayed to the user.


### Install Chart Using Helm
Go into chart directory and run:
```bash
Expand Down