Skip to content

Commit 28a8168

Browse files
committed
Update github links to use main instead of master
1 parent 46ddcd6 commit 28a8168

2 files changed

Lines changed: 6 additions & 6 deletions

File tree

config/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ ubuntu
3030
`NODE_ENV=mine npm start`
3131

3232
## Setting parameters via WEBGME_* env vars
33-
Since [v2.22.2](https://github.com/webgme/webgme-engine/blob/master/CHANGELOG.md#v2222-2018-12-11) individual configuration parameters can be set using environment variables.
33+
Since [v2.22.2](https://github.com/webgme/webgme-engine/blob/main/CHANGELOG.md#v2222-2018-12-11) individual configuration parameters can be set using environment variables.
3434

35-
Important! - before attempting to set any of these make sure the `config/index.js` in your repository requires and calls `overrideFromEnv(config)` (was not generated in `webgme-cli < 2.8.2`). If not you can copy the content of this [index.js](https://github.com/webgme/bindings/blob/master/config/index.js) and override your file.
35+
Important! - before attempting to set any of these make sure the `config/index.js` in your repository requires and calls `overrideFromEnv(config)` (was not generated in `webgme-cli < 2.8.2`). If not you can copy the content of this [index.js](https://github.com/webgme/bindings/blob/main/config/index.js) and override your file.
3636

3737
To set a configuration variable `config.<configGroup>.<configSubGroup1>.<configSubGroup2>.<cfgName>=<value>` defined the env var `WEBGME_<configGroup>_<configSubGroup1>_<configSubGroup2>_<cfgName>=<value>`. For example:
3838

@@ -66,7 +66,7 @@ Modification of arrays is not support, but non-existing config sub-group (object
6666
- `config.authentication.adminAccount = null`
6767
- If specified, will create an admin account at the given username at server startup. By default a random password will be generated and logged in the terminal - to specify a password separate it with a `:`, e.g. `'admin:password'`. (Once the admin exists the password will not be updated at startup.)
6868
- `config.authentication.allowUserRegistration = true`
69-
- Allows user-creation via the REST api without being an authenticated site admin. Provide a path to a module if you want to add your own custom registration path (see [default register end-point](https://github.com/webgme/webgme/blob/master/src/server/api/defaultRegisterEndPoint.js) for structure).
69+
- Allows user-creation via the REST api without being an authenticated site admin. Provide a path to a module if you want to add your own custom registration path (see [default register end-point](https://github.com/webgme/webgme/blob/main/src/server/api/defaultRegisterEndPoint.js) for structure).
7070
- `config.authentication.registeredUsersCanCreate = true`
7171
- Use this option if user registration is set to `true` and you want to control if registered users should be able to create projects directly after registered (site-admins can edit the `canCreate` property post-hoc for existing users).
7272
- `config.authentication.inferredUsersCanCreate = false`
@@ -217,7 +217,7 @@ Modification of arrays is not support, but non-existing config sub-group (object
217217

218218
#### mailer
219219
- `config.mailer.enable = false`
220-
- Switch to turn on the mail sending services of WebGME. To see what this service can do, please check the [mailer readme](https://github.com/webgme/webgme-engine/blob/master/src/server/middleware/mailer/README.md).
220+
- Switch to turn on the mail sending services of WebGME. To see what this service can do, please check the [mailer readme](https://github.com/webgme/webgme-engine/blob/main/src/server/middleware/mailer/README.md).
221221
- `config.mailer.service = ''`
222222
- Allows for shorthand configuraiton of SMTP servers for known services like gmail. For furhter details on what can be configured, please check [nodemailer](https://nodemailer.com/about/).
223223
- `config.mailer.host = ''`

src/server/middleware/mailer/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Here, we collect some example setup and usage guidance related to the e-mail services that made available to your WebGME environment.
33

44
### Setup-scenarios
5-
For further information on different setup informations, please check out the [nodemailer](https://nodemailer.com/about/) and [gmeConfig](https://github.com/webgme/webgme-engine/blob/master/config/README.md) descriptions.
5+
For further information on different setup informations, please check out the [nodemailer](https://nodemailer.com/about/) and [gmeConfig](https://github.com/webgme/webgme-engine/blob/main/config/README.md) descriptions.
66
#### Gmail
77
Probably the easiest way to drive your e-mail services is to connect it to a gmail account. Just follow these steps and you should be good to go:
88
- Go to your [google account](https://myaccount.google.com/) and make sure that among the security settings you turn on the `Less secure app access` - otherwise google will block your login attempts.
@@ -26,7 +26,7 @@ config.mailer.pwd = 'myVerySecretPassword';
2626
### Usage
2727
As we setup our mailer service, here are some ways how you can use it.
2828
#### Password reset
29-
Accidents happen and so far, the only way to give a user a new password in this case was to contact the maintainer of the deployment who was able to set some password using the built-in [usermanager](https://github.com/webgme/webgme-engine/blob/master/src/bin/usermanager.js#L126-L147) command. Now, with careful setup the default [profile page](https://github.com/webgme/user-management-page) can provide a 'reset' functionality to the user, that is combined with the mailer service. The following elements of your configuration must be set on top of the [basic mailer settings](#Setup-scenarios):
29+
Accidents happen and so far, the only way to give a user a new password in this case was to contact the maintainer of the deployment who was able to set some password using the built-in [usermanager](https://github.com/webgme/webgme-engine/blob/main/src/bin/usermanager.js#L126-L147) command. Now, with careful setup the default [profile page](https://github.com/webgme/user-management-page) can provide a 'reset' functionality to the user, that is combined with the mailer service. The following elements of your configuration must be set on top of the [basic mailer settings](#Setup-scenarios):
3030
```
3131
config.authentication.allowPasswordReset = true; /* to allow reset functionality */
3232
config.authentication.allowedResetInterval = 3600000; /* interval of allowed reset requests that should be long enough so malicious actors cannot abuse it */

0 commit comments

Comments
 (0)