Skip to content

Commit 3df0435

Browse files
authored
Merge pull request #308 from aspnetzero/update-settings-documents-for-email-restriction-dev
Update settings documents added email restriction section
2 parents 9d9d725 + 071d50d commit 3df0435

6 files changed

+44
-28
lines changed

docs/en/Features-Angular-Host-Settings.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Host settings page is used to configure some system settings.
44

55
## General
66

7-
<img src="images/host-settings-general-7.png" alt="General Host Settings" class="img-thumbnail" />
7+
![General Host Settings](images/host-settings-general-7.png)
88

99
**Timezone** is an important setting in this page. ASP.NET Zero can work in multiple zones. Each user can see dates and times in their own time zone. Timezone setting in this page allows you to set default time zone for the application including all tenants and users. Tenants and users can change time zone in their own settings. Timezone setting is available only if you are using UTC clock provider. [See documentation](https://aspnetboilerplate.com/Pages/Documents/Timing) to
1010
switch to UTC. By default ASP.NET Zero uses UnspecifiedClockProvider and in that case ASP.NET Zero doesn't modify dates sent from client to server and vice versa. If you configure your app to use another clock provider, then ASP.NET Zero normalizes dates according to selected clock provider.
@@ -17,17 +17,23 @@ Clock.Provider = ClockProviders.Utc;
1717

1818
## Tenant Management
1919

20-
<img src="images/host-settings-tenant-management.png" alt="Tenant Management Settings" class="img-thumbnail" />
20+
![Tenant Management Settings](images/host-settings-tenant-management.png)
2121

2222
You can configure settings related to tenant management under "Tenant Management" tab. You can enable/disable tenants from registering the system. You can also make newly registered tenants active or passive.
2323

24-
Enable/disable captcha on tenant registration page.
24+
You can enable/disable captcha on tenant registration page.
25+
26+
You can enable/disable captcha on tenant reset password page.
27+
28+
You can enable/disable captcha on tenant email activation page.
29+
30+
You can enable/disable email domain restriction for users.
2531

2632
You can also select a default edition, so a newly registered tenant will be assigned to this edition automatically unless the tenant subscribes to a specific edition.
2733

2834
## User Management
2935

30-
<img src="images/host-settings-user-management-4.png" alt="User Management Settings" class="img-thumbnail" />
36+
![User Management Settings](images/host-settings-user-management-4.png)
3137

3238
User related settings can be configured under this tab. You can force email confirmation for login. You can enable phone number verification. Also, you can enable cookie consent so ASP.NET Zero shows a cookie consent bar for the users to accept cookie policy of your application.
3339

@@ -47,7 +53,7 @@ You can also prevent user's new password from being same as any of last x passwo
4753

4854
## Security
4955

50-
<img src="images/host-settings-security-5.png" alt="Security Settings" class="img-thumbnail" />
56+
![Security Settings](images/host-settings-security-5.png)
5157

5258
**Security** tab in host settings page contains password complexity settings. Host can define system wide password complexity settings in this tab. Each tenant can override this setting in tenant settings page.
5359

@@ -61,21 +67,21 @@ This tab also contains user lock-out settings and two factor login settings as w
6167
6268
## Email
6369

64-
<img src="images/host-settings-email.png" alt="Email Settings" class="img-thumbnail" />
70+
![Email Settings](images/host-settings-email.png)
6571

6672
**Email(SMTP)** tab allows you to configure smtp settings for your app. ASP.NET Zero uses MailKit to send emails. By default, smtp certificate validation is disabled in **YourProjectNameMailKitSmtpBuilder.cs** class. If you are able to validate mail server's certificate, you need to modify **ServerCertificateValidationCallback** in **YourProjectNameMailKitSmtpBuilder.cs**.
6773

6874
If you want each Tenant to configure their own SMTP settings, you can go to **YourProjectNameConsts.cs** which is in ***.Core.Shared** project and set **AllowTenantsToChangeEmailSettings** to true. In that way, each tenant can configure and use their own SMTP settings.
6975

7076
## Invoice
7177

72-
<img src="images/host-settings-invoice-1.png" alt="Invoice Settings" class="img-thumbnail" />
78+
![Invoice Settings](images/host-settings-invoice-1.png)
7379

7480
Under this tab, you can configure the legal name and the address of the Host company which will be displayed on the generated invoices as the service provider.
7581

7682
## Other settings
7783

78-
<img src="images/host-settings-others.png" alt="Other Settings" class="img-thumbnail" />
84+
![Other Settings](images/host-settings-others.png)
7985

8086
Under this tab, there is only one setting which is used to enable/disable quick theme selection icon on the layout of ASP.NET Zero next to language selection dropdown.
8187

docs/en/Features-Angular-Tenant-Settings.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,30 @@ Tenant settings page is used to configure tenant based settings.
44

55
## General
66

7-
<img src="images/tenant-settings-core-general.png" alt="General settings" class="img-thumbnail" />
7+
![General settings](images/tenant-settings-core-general.png)
88

99
Under the general tab, each tenant can configure default time zone setting for users of that tenant. Each user of the tenant can also change this setting for their own account.
1010

1111
If tenant doesn't make any change, time zone setting of host will be used.
1212

1313
## Appearance
1414

15-
<img src="images/tenant-settings-core-appearance.png" alt="Appearance settings" class="img-thumbnail" />
15+
![Appearance settings](images/tenant-settings-core-appearance.png)
1616

1717
Under the appearance tab, each tenant can upload a logo file and upload a custom css file. In this way, each tenant can change the look of the application only for their account. Uploaded logo and css files can be easily removed by using the clear button.
1818

1919
## User Management
2020

21-
<img src="images/tenant-settings-core-user-management-3.png" alt="User management settings" class="img-thumbnail" />
21+
![User management settings](images/tenant-settings-core-user-management-3.png)
2222

2323
Under the user management tab, each tenant can configure some user management settings related to their account. Each tenant can enable/disable user registration for their account. Tenants can also make newly registered users for their account active or passive by default.
2424

25-
Each tenant can also enable/disable captcha on user registration and login page for their account.
25+
Each tenant can also enable/disable captcha on user registration, reset password, email activation and login page for their account.
2626

2727
> Note: **Token Based Authentication** has `ReCaptchaIgnoreWhiteList` located in `WebConsts`. If you want a client app to be ignored for reCaptcha control during login, add a value to `ReCaptchaIgnoreWhiteList` and send the same value in the `User-Agent` request header for your login request from the client app. You can check the Xamarin mobile app in AspNet Zero to see how `ReCaptchaIgnoreWhiteList` works.
2828
29+
Each tenant can also enable or disable email restriction for their own account. When enabled, it can specify the email domain allowed for email restriction.
30+
2931
Each tenant can also enable/disable session timeout control for tenant users. If it is enable and the user does not provide any input to the site during the timeout period, a countdown modal will be displayed to user. If the user still does not provide any input to the site during the modal countdown period, user will be log out.
3032

3133
Also, each tenant can enable/disable cookie consent so ASP.NET Zero shows a cookie consent bar for the users of that tenant to accept cookie policy of the application.
@@ -36,13 +38,13 @@ Each tenant can allow tenant users to use Gravatar profile picture or not.
3638

3739
## Security
3840

39-
<img src="images/tenant-settings-core-security.png" alt="User management settings" class="img-thumbnail" />
41+
![Security settings](images/tenant-settings-core-security.png)
4042

4143
Security tab contains password complexity settings. Each tenant can define password complexity settings in this tab for their account. Each tenant can also configure user lock out settings.
4244

4345
## Invoice
4446

45-
<img src="images/tenant-settings-core-invoice.png" alt="User management settings" class="img-thumbnail" />
47+
![Invoice settings](images/tenant-settings-core-invoice.png)
4648

4749
Under this tab, each tenant can configure their legal name, tax number and address which will be displayed on the generated invoices. Note that, tenants can only generate invoice if they made a payment for a subscription.
4850

docs/en/Features-Mvc-Core-Host-Settings.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Host settings page is used to configure some system settings.
44

55
## General
66

7-
<img src="images/host-settings-general-7.png" alt="General Host Settings" class="img-thumbnail" />
7+
![General Host Settings](images/host-settings-general-7.png)
88

99
**Timezone** is an important setting in this page. ASP.NET Zero can work in multiple zones. Each user can see dates and times in their own time zone. Timezone setting in this page allows you to set default time zone for the application including all tenants and users. Tenants and users can change time zone in their own settings. Timezone setting is available only if you are using UTC clock provider. [See documentation](https://aspnetboilerplate.com/Pages/Documents/Timing) to
1010
switch to UTC. By default ASP.NET Zero uses UnspecifiedClockProvider and in that case ASP.NET Zero doesn't modify dates sent from client to server and vice versa. If you configure your app to use another clock provider, then ASP.NET Zero normalizes dates according to selected clock provider.
@@ -17,17 +17,23 @@ Clock.Provider = ClockProviders.Utc;
1717

1818
## Tenant Management
1919

20-
<img src="images/host-settings-tenant-management.png" alt="Tenant Management Settings" class="img-thumbnail" />
20+
![Tenant Management Settings](images/host-settings-tenant-management.png)
2121

2222
You can configure settings related to tenant management under "Tenant Management" tab. You can enable/disable tenants from registering the system. You can also make newly registered tenants active or passive.
2323

24-
Enable/disable captcha on tenant registration page.
24+
You can enable/disable captcha on tenant registration page.
25+
26+
You can enable/disable captcha on tenant reset password page.
27+
28+
You can enable/disable captcha on tenant email activation page.
29+
30+
You can enable/disable email domain restriction for users.
2531

2632
You can also select a default edition, so a newly registered tenant will be assigned to this edition automatically unless the tenant subscribes to a specific edition.
2733

2834
## User Management
2935

30-
<img src="images/host-settings-user-management-4.png" alt="User Management Settings" class="img-thumbnail" />
36+
![User Management Settings](images/host-settings-user-management-4.png)
3137

3238
User related settings can be configured under this tab. You can force email confirmation for login. You can enable phone number verification. Also, you can enable cookie consent so ASP.NET Zero shows a cookie consent bar for the users to accept cookie policy of your application.
3339

@@ -47,29 +53,29 @@ You can also prevent user's new password from being same as any of last x passwo
4753

4854
## Security
4955

50-
<img src="images/host-settings-security-5.png" alt="Security Settings" class="img-thumbnail" />
56+
![Security Settings](images/host-settings-security-5.png)
5157

5258
**Security** tab in host settings page contains password complexity settings. Host can define system wide password complexity settings in this tab. Each tenant can override this setting in tenant settings page.
5359

5460
This tab also contains user lock-out settings and two factor login settings as well.
5561

5662
## Email
5763

58-
<img src="images/host-settings-email.png" alt="Email Settings" class="img-thumbnail" />
64+
![Email Settings](images/host-settings-email.png)
5965

6066
**Email(SMTP)** tab allows you to configure smtp settings for your app. ASP.NET Zero uses MailKit to send emails. By default, smtp certificate validation is disabled in **YourProjectNameMailKitSmtpBuilder.cs** class. If you are able to validate mail server's certificate, you need to modify **ServerCertificateValidationCallback** in **YourProjectNameMailKitSmtpBuilder.cs**.
6167

6268
If you want each Tenant to configure their own SMTP settings, you can go to **YourProjectNameConsts.cs** which is in ***.Core.Shared** project and set **AllowTenantsToChangeEmailSettings** to true. In that way, each tenant can configure and use their own SMTP settings.
6369

6470
## Invoice
6571

66-
<img src="images/host-settings-invoice-1.png" alt="Invoice Settings" class="img-thumbnail" />
72+
![Invoice Settings](images/host-settings-invoice-1.png)
6773

6874
Under this tab, you can configure the legal name and the address of the Host company which will be displayed on the generated invoices as the service provider.
6975

7076
## Other settings
7177

72-
<img src="images/host-settings-others.png" alt="Other Settings" class="img-thumbnail" />
78+
![Other Settings](images/host-settings-others.png)
7379

7480
Under this tab, there is only one setting which is used to enable/disable quick theme selection icon on the layout of ASP.NET Zero next to language selection dropdown.
7581

docs/en/Features-Mvc-Core-Tenant-Settings.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,30 @@ Tenant settings page is used to configure tenant based settings.
44

55
## General
66

7-
<img src="images/tenant-settings-core-general.png" alt="General settings" class="img-thumbnail" />
7+
![General settings](images/tenant-settings-core-general.png)
88

99
Under the general tab, each tenant can configure default time zone setting for users of that tenant. Each user of the tenant can also change this setting for their own account.
1010

1111
If tenant doesn't make any change, time zone setting of host will be used.
1212

1313
## Appearance
1414

15-
<img src="images/tenant-settings-core-appearance.png" alt="Appearance settings" class="img-thumbnail" />
15+
![Appearance settings](images/tenant-settings-core-appearance.png)
1616

1717
Under the appearance tab, each tenant can upload a logo file and upload a custom css file. In this way, each tenant can change the look of the application only for their account. Uploaded logo and css files can be easily removed by using the clear button.
1818

1919
## User Management
2020

21-
<img src="images/tenant-settings-core-user-management-3.png" alt="User management settings" class="img-thumbnail" />
21+
![User management settings](images/tenant-settings-core-user-management-3.png)
2222

2323
Under the user management tab, each tenant can configure some user management settings related to their account. Each tenant can enable/disable user registration for their account. Tenants can also make newly registered users for their account active or passive by default.
2424

25-
Each tenant can also enable/disable captcha on user registration and login page for their account.
25+
Each tenant can also enable/disable captcha on user registration, reset password, email activation and login page for their account.
2626

2727
> Note: **Token Based Authentication** has `ReCaptchaIgnoreWhiteList` located in `WebConsts`. If you want a client app to be ignored for reCaptcha control during login, add a value to `ReCaptchaIgnoreWhiteList` and send the same value in the `User-Agent` request header for your login request from the client app. You can check the Xamarin mobile app in AspNet Zero to see how `ReCaptchaIgnoreWhiteList` works.
2828
29+
Each tenant can also enable or disable email restriction for their own account. When enabled, it can specify the email domain allowed for email restriction.
30+
2931
Each tenant can also enable/disable session timeout control. If it is enable and the user does not provide any input to the site during the timeout period, a countdown modal will be displayed to user. If the user still does not provide any input to the site during the modal countdown period, user will be log out.
3032

3133
Also, each tenant can enable/disable cookie consent so ASP.NET Zero shows a cookie consent bar for the users of that tenant to accept cookie policy of the application.
@@ -36,13 +38,13 @@ Each tenant can allow tenant users to use Gravatar profile picture or not.
3638

3739
## Security
3840

39-
<img src="images/tenant-settings-core-security.png" alt="User management settings" class="img-thumbnail" />
41+
![Security settings](images/tenant-settings-core-security.png)
4042

4143
Security tab contains password complexity settings. Each tenant can define password complexity settings in this tab for their account. Each tenant can also configure user lock out settings.
4244

4345
## Invoice
4446

45-
<img src="images/tenant-settings-core-invoice.png" alt="User management settings" class="img-thumbnail" />
47+
![Invoice settings](images/tenant-settings-core-invoice.png)
4648

4749
Under this tab, each tenant can configure their legal name, tax number and address which will be displayed on the generated invoices. Note that, tenants can only generate invoice if they made a payment for a subscription.
4850

44.9 KB
Loading
96 KB
Loading

0 commit comments

Comments
 (0)