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

email verification docs #27

Merged
merged 4 commits into from
Apr 24, 2022
Merged

email verification docs #27

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b2d804b
added new email config options to server/configuration
luwol03 Feb 11, 2022
7832066
Added emailSetup page
luwol03 Apr 14, 2022
472043b
improved language
luwol03 Apr 14, 2022
1d2898f
Added info box that the base_url should be set
luwol03 Apr 17, 2022
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
37 changes: 30 additions & 7 deletions docs/vocascan-server/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,13 @@ There are 2 ways to configure a vocascan-server.

## Server (`server`)

| Name | Default | Description |
| --------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `port` | `5000` | Defines the port on which the server is listening. |
| `jwt_secret` | | Secret is used to sign the payload of the jwt token, change this to a unique string. Everyone who knows that secret is able to act as other vocascan users. |
| `salt_rounds` | `10` | The salt rounds define the coast efficiency factor to hash passwords with bcrypt. For more info, see [bcrypts documentation](https://github.com/kelektiv/node.bcrypt.js#a-note-on-rounds). |
| `registration_locked` | `false` | Locks the server and only allows registrations with an invite code. |
| `cors` | `false` | This can be either a boolean (`true`/`false`), a string with a single domain (`http://localhost:3000`) or a asterisk (`*`) to allow all domains, or a array (`["http://localhost:3000", "http://localhost:4000"]`). |
| Name | Default | Description |
| ------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `base_url` | | Base url of the API server. Used for links in emails. (E.g. `http://example.com`) |
| `port` | `5000` | Defines the port on which the server is listening. |
| `jwt_secret` | | Secret is used to sign the payload of the jwt token, change this to a unique string. Everyone who knows that secret is able to act as other vocascan users. |
| `salt_rounds` | `10` | The salt rounds define the coast efficiency factor to hash passwords with bcrypt. For more info, see [bcrypts documentation](https://github.com/kelektiv/node.bcrypt.js#a-note-on-rounds). |
| `cors` | `false` | This can be either a boolean (`true`/`false`), a string with a single domain (`http://localhost:3000`) or a asterisk (`*`) to allow all domains, or a array (`["http://localhost:3000", "http://localhost:4000"]`). |

## Database (`database`)

Expand Down Expand Up @@ -124,3 +124,26 @@ For more information about the logger section see [logging guide](vocascan-serve
| Name | Default | Description |
| ---------------- | ------- | --------------------------------------------- |
| `enable_swagger` | `true` | Enables serving of the swagger documentation. |

## Mailer (`mailer`)

| Name | Default | Description |
| ----------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `enabled` | `false` | Enable/Disable mailer. |
| `host` | | Email server host. |
| `port` | | Email server port. |
| `secure` | `false` | If `true` the connection will use TLS when connecting to server, otherwise TLS is used if server supports the `STARTTLS` extension. In most cases set this value to `true` if you are connecting to port 465. For port 587 or 25 keep it `false`. |
| `auth.user` | | Email server user. |
| `auth.pass` | | Email server password. |
| `from` | `false` | The email address of vocascan should use a the sender. |

## Service (`service`)

| Name | Default | Description |
| ------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `invite_code` | `false` | Locks the server and only allows registrations with an invite code. |
| `email_confirm` | `false` | Enables email confirmation. |
| `email_confirm_live_time` | `2h` | Defines the time how long the link in the email is valid. This option is parsed with [ms](https://github.com/vercel/ms) (E.g. `2d`, `2.5h`, `30d`, ...) |
| `email_confirm_level` | `medium` | Define what a user can do if the account is not verified. `low` - no restrictions, `medium` - user can use vocascan for a specific time set by `service.email_confirm_time`, `high` - user cannot do anything except logging in. |
| `email_confirm_time` | `14d` | Defines the time a user can use vocascan without restrictions without verification. (Takes only effect, if `service.email_confirm_level` is `medium`) This option is parsed with [ms](https://github.com/vercel/ms) (E.g. `2d`, `2.5h`, `30d`, ...) |
| `access_live_time` | `30d` | Defines the time how long a jwt access token is valid. This option is parsed with [ms](https://github.com/vercel/ms) (E.g. `2d`, `2.5h`, `30d`, ...) |