Skip to content

Commit b0cb311

Browse files
mirceaalexandrumirceaalexandru
committed
updated documentation
1 parent b058478 commit b0cb311

File tree

3 files changed

+30
-25
lines changed

3 files changed

+30
-25
lines changed

‎doc/configuring-clients.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,6 @@ Managing applications can be done from using the Applications option from main m
1111

1212
The main properties of an application are:
1313

14-
* name
15-
* internal key - appkey - communication key string identifying the external application as a Concorda client. This should be the same as the appkey set in the concorda's [client ](./install-clients.md) options.
14+
* `name`
15+
* internal key - `appkey` - communication key string identifying the external application as a Concorda client. This should be the same as the appkey set in the concorda's [client ](./install-clients.md) options.
1616
* others - TBD

‎doc/deploy-microservice.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -37,17 +37,17 @@ TRANSPORT_TYPE=tcp
3737
When using without Concorda Dashboard, the only way to configure Concorda is by using the env configuration file.
3838
On `config/production.env` file you will find these variables:
3939

40-
* PUBLIC_REGISTER - allowed values "0"/"1" - disable/enable public user register. If public register is disabled ("0") then user register can be done only based on user invitation.
41-
* PASSWORD_POLICY - this will define the password policy to be used to enforce stronger user passwords.
42-
* requireLowercase - allowed values "0"/"1" - activate if lowercase characters are required in password
43-
* requireUppercase - allowed values "0"/"1" - activate if uppercase characters are required in password
44-
* requireNumeric - allowed values "0"/"1" - activate if numeric characters are required in password
45-
* minLength - numeric value - minimum length for user passwords.
46-
* AUTH_TYPE - this will define the allowed authentication types.
47-
* google - allowed values "0"/"1" - disable/enable google login
48-
* github - allowed values "0"/"1" - disable/enable github login
49-
* twitter - allowed values "0"/"1" - disable/enable twitter login
50-
* MAIL_TEMPLATE_FOLDER - absolute path to mail template folder. Example of mail templates can be found [here](https://github.com/Concorda/concorda/tree/master/lib/email-templates)
40+
* `PUBLIC_REGISTER` - allowed values "0"/"1" - disable/enable public user register. If public register is disabled ("0") then user register can be done only based on user invitation.
41+
* `PASSWORD_POLICY` - this will define the password policy to be used to enforce stronger user passwords.
42+
* `requireLowercase` - allowed values "0"/"1" - activate if lowercase characters are required in password
43+
* `requireUppercas` - allowed values "0"/"1" - activate if uppercase characters are required in password
44+
* `requireNumeric` - allowed values "0"/"1" - activate if numeric characters are required in password
45+
* `minLength` - numeric value - minimum length for user passwords.
46+
* `AUTH_TYPE` - this will define the allowed authentication types.
47+
* `google` - allowed values "0"/"1" - disable/enable google login
48+
* `github` - allowed values "0"/"1" - disable/enable github login
49+
* `twitter` - allowed values "0"/"1" - disable/enable twitter login
50+
* `MAIL_TEMPLATE_FOLDER` - absolute path to mail template folder. Example of mail templates can be found [here](https://github.com/Concorda/concorda/tree/master/lib/email-templates)
5151

5252

5353
IMPORTANT NOTES

‎doc/deploy-plugin.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,11 @@ module.exports = function (options) {
2525

2626
seneca
2727
.use(Concorda, {
28-
.....options.....
28+
appkey: 'concorda',
29+
auth: {
30+
restrict: '/api',
31+
password: process.env.COOKIE_PASSWORD || 'some long password'
32+
}
2933
})
3034

3135
return {
@@ -40,17 +44,18 @@ module.exports = function (options) {
4044

4145
When using it as a Seneca plugin some options should be passed to control various features of Concorda.
4246

43-
* publicRegister - allowed values "0"/"1" - disable/enable public user register. If public register is disabled ("0") then user register can be done only based on user invitation.
44-
* passwordPolicy - this will define the password policy to be used to enforce stronger user passwords.
45-
* requireLowercase - allowed values "0"/"1" - activate if lowercase characters are required in password
46-
* requireUppercase - allowed values "0"/"1" - activate if uppercase characters are required in password
47-
* requireNumeric - allowed values "0"/"1" - activate if numeric characters are required in password
48-
* minLength - numeric value - minimum length for user passwords.
49-
* authType - this will define the allowed authentication types.
50-
* google - allowed values "0"/"1" - disable/enable google login
51-
* github - allowed values "0"/"1" - disable/enable github login
52-
* twitter - allowed values "0"/"1" - disable/enable twitter login
53-
* emailTemplateFolder - absolute path to mail template folder. Example of mail templates can be found [here](https://github.com/Concorda/concorda/tree/master/lib/email-templates)
47+
* `appkey` - the application key - leave it with 'concorda' as this application is create by default in the DB. If you want another application key, plate create another application and set corresponding appkey here.
48+
* `publicRegister` - allowed values "0"/"1" - disable/enable public user register. If public register is disabled ("0") then user register can be done only based on user invitation.
49+
* `passwordPolicy` - this will define the password policy to be used to enforce stronger user passwords.
50+
* `requireLowercase` - allowed values "0"/"1" - activate if lowercase characters are required in password
51+
* `requireUppercase` - allowed values "0"/"1" - activate if uppercase characters are required in password
52+
* `requireNumeric` - allowed values "0"/"1" - activate if numeric characters are required in password
53+
* `minLength` - numeric value - minimum length for user passwords.
54+
* `authType` - this will define the allowed authentication types.
55+
* `google` - allowed values "0"/"1" - disable/enable google login
56+
* `github` - allowed values "0"/"1" - disable/enable github login
57+
* `twitter` - allowed values "0"/"1" - disable/enable twitter login
58+
* `emailTemplateFolder` - absolute path to mail template folder. Example of mail templates can be found [here](https://github.com/Concorda/concorda/tree/master/lib/email-templates)
5459

5560
An example of default settings used internally be Concorda is:
5661

0 commit comments

Comments
 (0)