mirror of https://github.com/abpframework/abp.git
4 changed files with 54 additions and 1 deletions
@ -1,3 +1,56 @@ |
|||
# Tenant Management Module |
|||
|
|||
TODO |
|||
[Multi-Tenancy](../Multi-Tenancy.md) is one of the core features of ABP Framework. It provides the fundamental infrastructure to build your own SaaS (Software-as-a-Service) solution. ABP's multi-tenancy system abstracts where your tenants are stored, by providing the `ITenantStore` interface. All you need to do is to implement that interface. |
|||
|
|||
**The Tenant Management module is an implementation of the the `ITenantStore` interface. It stores tenants in a database. It also provides UI to manage your tenants and their [features](../Features.md).** |
|||
|
|||
> Please **refer to the [Multi-Tenancy](../Multi-Tenancy.md) documentation** to understand the multi-tenancy system of the ABP Framework. This document focuses on the Tenant Management module. |
|||
|
|||
### About the ABP Commercial SaaS Module |
|||
|
|||
The [SaaS Module](https://commercial.abp.io/modules/Volo.Saas) is an alternative implementation of this module with more features and possibilities. It is distributed as a part of the [ABP Commercial](https://commercial.abp.io/) subscription. |
|||
|
|||
## How to Install |
|||
|
|||
This module comes as pre-installed (as NuGet packages) when you [create a new solution](https://abp.io/get-started) with the ABP Framework. You can continue to use it via NuGet packages and get updates easily, or you can include its source code into your solution (see `get-source` [CLI](../CLI.md) command) to develop your custom module. |
|||
|
|||
## User Interface |
|||
|
|||
This module adds "*Administration -> Tenant Management -> Tenants*" menu item to the main menu of the application, which opens the page shown below: |
|||
|
|||
 |
|||
|
|||
In this page, you see the all the tenants. You can create a new tenant as shown below: |
|||
|
|||
 |
|||
|
|||
In this modal; |
|||
|
|||
* **Name**: The unique name of the tenant. If you use subdomains for your tenants (like https://some-tenant.your-domain.com), this will be the subdomain name. |
|||
* **Admin Email Address**: Email address of the admin user for this tenant. |
|||
* **Admin Password**: The password of the admin user for this tenant. |
|||
|
|||
When you click to *Actions* button near to a tenant, you will see the actions you can take: |
|||
|
|||
 |
|||
|
|||
### Managing the Tenant Features |
|||
|
|||
The Features action opens a modal to enable/disable/set [features](../Features.md) for the related tenant. Here, an example modal: |
|||
|
|||
 |
|||
|
|||
### Managing the Host Features |
|||
|
|||
*Manage Host features* button is used to set features for the host side, if you use the features of your application also in the host side. |
|||
|
|||
## Internals |
|||
|
|||
This section can be used as a reference if you want to [customize](../Customizing-Application-Modules-Guide.md) this module without changing it source code. |
|||
|
|||
*TODO: Internals* |
|||
|
|||
## See Also |
|||
|
|||
* [Multi-Tenancy](../Multi-Tenancy.md) |
|||
* [ABP Commercial SaaS Module](https://docs.abp.io/en/commercial/latest/modules/saas) |
|||
|
After Width: | Height: | Size: 8.9 KiB |
|
After Width: | Height: | Size: 15 KiB |
|
After Width: | Height: | Size: 21 KiB |
Loading…
Reference in new issue