codimd/config.json.example

133 lines
4.5 KiB
Plaintext
Raw Normal View History

2016-10-05 02:58:05 +00:00
{
2016-12-22 14:03:04 +00:00
"test": {
2016-12-24 14:04:18 +00:00
"db": {
"dialect": "sqlite",
"storage": ":memory:"
2016-12-24 14:04:18 +00:00
}
2016-12-22 14:03:04 +00:00
},
2016-10-05 02:58:05 +00:00
"development": {
"loglevel": "debug",
"hsts": {
"enable": false
},
2016-10-05 02:58:05 +00:00
"db": {
"dialect": "sqlite",
"storage": "./db.codimd.sqlite"
2016-10-05 02:58:05 +00:00
}
},
"production": {
"domain": "localhost",
"loglevel": "info",
"hsts": {
"enable": true,
"maxAgeSeconds": 31536000,
"includeSubdomains": true,
"preload": true
},
"csp": {
"enable": true,
"directives": {
},
"upgradeInsecureRequests": "auto",
"addDefaults": true,
"addDisqus": true,
"addGoogleAnalytics": true
},
2016-10-05 02:58:05 +00:00
"db": {
"username": "",
"password": "",
"database": "codimd",
2016-10-05 02:58:05 +00:00
"host": "localhost",
"port": "5432",
"dialect": "postgres"
},
"facebook": {
"clientID": "change this",
"clientSecret": "change this"
},
"twitter": {
"consumerKey": "change this",
"consumerSecret": "change this"
},
"github": {
"clientID": "change this",
"clientSecret": "change this"
},
"gitlab": {
"baseURL": "change this",
"clientID": "change this",
"clientSecret": "change this",
"scope": "use 'read_user' scope for auth user only or remove this property if you need gitlab snippet import/export support (will result to be default scope 'api')",
"version": "use 'v4' if gitlab version > 11, 'v3' otherwise. Default to 'v4'"
2016-10-05 02:58:05 +00:00
},
2017-10-29 10:16:40 +00:00
"mattermost": {
"baseURL": "change this",
"clientID": "change this",
"clientSecret": "change this"
},
2016-10-05 02:58:05 +00:00
"dropbox": {
"clientID": "change this",
"clientSecret": "change this",
"appKey": "change this"
2016-10-05 02:58:05 +00:00
},
"google": {
"clientID": "change this",
"clientSecret": "change this",
"apiKey": "change this"
2016-10-05 02:58:05 +00:00
},
"ldap": {
"url": "ldap://change_this",
"bindDn": null,
"bindCredentials": null,
"searchBase": "change this",
"searchFilter": "change this",
"searchAttributes": ["change this"],
"usernameField": "change this e.g. cn",
"useridField": "change this e.g. uid",
"tlsOptions": {
"changeme": "See https://nodejs.org/api/tls.html#tls_tls_connect_options_callback"
}
},
"saml": {
"idpSsoUrl": "change: authentication endpoint of IdP",
"idpCert": "change: certificate file path of IdP in PEM format",
"issuer": "change or delete: identity of the service provider (default: serverurl)",
"identifierFormat": "change or delete: name identifier format (default: 'urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress')",
"disableRequestedAuthnContext": "change or delete: true to allow any authentication method, false restricts to password authentication method (default: false)",
"groupAttribute": "change or delete: attribute name for group list (ex: memberOf)",
"requiredGroups": [ "change or delete: group names that allowed" ],
"externalGroups": [ "change or delete: group names that not allowed" ],
"attribute": {
"id": "change or delete this: attribute map for `id` (default: NameID)",
"username": "change or delete this: attribute map for `username` (default: NameID)",
"email": "change or delete this: attribute map for `email` (default: NameID)"
}
},
2016-10-05 02:58:05 +00:00
"imgur": {
"clientID": "change this"
},
"minio": {
"accessKey": "change this",
"secretKey": "change this",
"endPoint": "change this",
"secure": true,
"port": 9000
},
"s3": {
"accessKeyId": "change this",
"secretAccessKey": "change this",
"region": "change this"
},
"s3bucket": "change this",
"azure":
{
"connectionString": "change this",
"container": "change this"
},
"plantuml":
{
"server": "https://www.plantuml.com/plantuml"
}
2016-10-05 02:58:05 +00:00
}
}