Skip to content

Commit

Permalink
Merge pull request #308 from aspnetzero/update-settings-documents-for…
Browse files Browse the repository at this point in the history
…-email-restriction-dev

Update settings documents added email restriction section
  • Loading branch information
ismcagdas authored Jul 22, 2024
2 parents 9d9d725 + 071d50d commit 3df0435
Show file tree
Hide file tree
Showing 6 changed files with 44 additions and 28 deletions.
22 changes: 14 additions & 8 deletions docs/en/Features-Angular-Host-Settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Host settings page is used to configure some system settings.

## General

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

**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
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.
Expand All @@ -17,17 +17,23 @@ Clock.Provider = ClockProviders.Utc;

## Tenant Management

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

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.

Enable/disable captcha on tenant registration page.
You can enable/disable captcha on tenant registration page.

You can enable/disable captcha on tenant reset password page.

You can enable/disable captcha on tenant email activation page.

You can enable/disable email domain restriction for users.

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.

## User Management

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

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.

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

## Security

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

**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.

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

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

**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**.

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.

## Invoice

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

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.

## Other settings

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

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.

Expand Down
14 changes: 8 additions & 6 deletions docs/en/Features-Angular-Tenant-Settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,30 @@ Tenant settings page is used to configure tenant based settings.

## General

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

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.

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

## Appearance

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

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.

## User Management

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

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.

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

> 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.
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.

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.

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.
Expand All @@ -36,13 +38,13 @@ Each tenant can allow tenant users to use Gravatar profile picture or not.

## Security

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

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.

## Invoice

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

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.

Expand Down
22 changes: 14 additions & 8 deletions docs/en/Features-Mvc-Core-Host-Settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Host settings page is used to configure some system settings.

## General

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

**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
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.
Expand All @@ -17,17 +17,23 @@ Clock.Provider = ClockProviders.Utc;

## Tenant Management

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

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.

Enable/disable captcha on tenant registration page.
You can enable/disable captcha on tenant registration page.

You can enable/disable captcha on tenant reset password page.

You can enable/disable captcha on tenant email activation page.

You can enable/disable email domain restriction for users.

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.

## User Management

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

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.

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

## Security

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

**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.

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

## Email

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

**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**.

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.

## Invoice

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

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.

## Other settings

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

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.

Expand Down
14 changes: 8 additions & 6 deletions docs/en/Features-Mvc-Core-Tenant-Settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,30 @@ Tenant settings page is used to configure tenant based settings.

## General

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

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.

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

## Appearance

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

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.

## User Management

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

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.

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

> 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.
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.

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.

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.
Expand All @@ -36,13 +38,13 @@ Each tenant can allow tenant users to use Gravatar profile picture or not.

## Security

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

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.

## Invoice

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

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.

Expand Down
Binary file modified docs/en/images/host-settings-tenant-management.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/en/images/tenant-settings-core-user-management-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3df0435

Please sign in to comment.