diff --git a/modules/account/src/Volo.Abp.Account.Installer/InstallationNotes.md b/modules/account/src/Volo.Abp.Account.Installer/InstallationNotes.md index 3789062c54..2289069146 100644 --- a/modules/account/src/Volo.Abp.Account.Installer/InstallationNotes.md +++ b/modules/account/src/Volo.Abp.Account.Installer/InstallationNotes.md @@ -4,61 +4,6 @@ Account module implements the basic authentication features like login, register This module is based on [Microsoft's Identity library](https://docs.microsoft.com/en-us/aspnet/core/security/authentication/identity?view=aspnetcore-6.0&tabs=visual-studio) and the [Identity Module](https://docs.abp.io/en/abp/latest/modules/identity). It has [IdentityServer](https://docs.abp.io/en/abp/latest/modules/identity-server) integration (based on the [IdentityServer Module](https://docs.abp.io/en/abp/latest/modules/identity-server)) and [OpenIddict](https://github.com/openiddict) integration (based on the [Openiddict Module](https://docs.abp.io/en/abp/latest/modules/openiddict)) to provide single sign-on, access control and other advanced authentication features. -## Required Dependencies - -The Account module depends on the following modules: -- Identity Module -- Either OpenIddict Module or IdentityServer Module (for single sign-on capabilities) - -## Installation Steps - -The Account module is pre-installed in the ABP startup templates. If you need to manually install it, follow these steps: - -1. Add the following NuGet packages to your project: - - `Volo.Abp.Account.Application` - - `Volo.Abp.Account.HttpApi` - - `Volo.Abp.Account.Web` (for MVC UI) - - `Volo.Abp.Account.Blazor` (for MVC UI) - -2. Add the following module dependencies to your module class: - -```csharp -[DependsOn( - typeof(AbpAccountApplicationModule), - typeof(AbpAccountHttpApiModule), - typeof(AbpAccountEntityFrameworkCoreModule), - typeof(AbpAccountWebModule) // For MVC UI - typeof(AbpAccountBlazorModule ) // For BLAZOR UI -)] -public class YourModule : AbpModule -{ -} -``` - -3. For OpenIddict integration, add the `Volo.Abp.Account.Web.OpenIddict` package and its module dependency: - -```csharp -[DependsOn( - // Other dependencies - typeof(AbpAccountWebOpenIddictModule) -)] -public class YourModule : AbpModule -{ -} -``` - -4. For IdentityServer integration, add the `Volo.Abp.Account.Web.IdentityServer` package and its module dependency: - -```csharp -[DependsOn( - // Other dependencies - typeof(AbpAccountWebIdentityServerModule) -)] -public class YourModule : AbpModule -{ -} -``` - ## Documentation For detailed information and usage instructions, please visit the [Account Module documentation](https://abp.io/docs/latest/Modules/Account). \ No newline at end of file diff --git a/modules/audit-logging/src/Volo.Abp.AuditLogging.Installer/InstallationNotes.md b/modules/audit-logging/src/Volo.Abp.AuditLogging.Installer/InstallationNotes.md index c4f45bc6d3..35bd77d32d 100644 --- a/modules/audit-logging/src/Volo.Abp.AuditLogging.Installer/InstallationNotes.md +++ b/modules/audit-logging/src/Volo.Abp.AuditLogging.Installer/InstallationNotes.md @@ -4,63 +4,6 @@ The ABP Audit Logging module provides automatic audit logging for web requests, This module is part of the ABP Framework and provides comprehensive audit logging capabilities including entity history tracking, exception logging, and user activity monitoring. -## Installation Steps - -1. Add the following NuGet packages to your project: - - `Volo.Abp.AuditLogging.EntityFrameworkCore` (for EF Core) - - `Volo.Abp.AuditLogging.MongoDB` (for MongoDB) - -2. Add the following module dependencies to your module class: - -```csharp -[DependsOn( - typeof(AbpAuditLoggingEntityFrameworkCoreModule) // For EF Core - typeof(AbpAuditLoggingMongoDbModule) // For MongoDB -)] -public class YourModule : AbpModule -{ -} -``` - -## EntityFramework Core Configuration - -For `EntityFrameworkCore`, further configuration is needed in the `OnModelCreating` method of your `DbContext` class: - -```csharp -using Volo.Abp.AuditLogging.EntityFrameworkCore; - -//... - -protected override void OnModelCreating(ModelBuilder builder) -{ - base.OnModelCreating(builder); - - builder.ConfigureAuditLogging(); - - //... -} -``` - -Also, you will need to create a new migration and apply it to the database: - -```bash -dotnet ef migrations add Added_AuditLogging -dotnet ef database update -``` - -Configure the audit logging middleware in your `OnApplicationInitialization` method: - -```csharp -public override void OnApplicationInitialization(ApplicationInitializationContext context) -{ - var app = context.GetApplicationBuilder(); - - app.UseAuditing(); // Enable audit logging middleware - - //... -} -``` - ## Documentation For detailed information and usage instructions, please visit the [Audit Logging documentation](https://abp.io/docs/latest/framework/infrastructure/audit-logging). \ No newline at end of file diff --git a/modules/background-jobs/src/Volo.Abp.BackgroundJobs.Installer/InstallationNotes.md b/modules/background-jobs/src/Volo.Abp.BackgroundJobs.Installer/InstallationNotes.md index 5eebc16ff5..953695c647 100644 --- a/modules/background-jobs/src/Volo.Abp.BackgroundJobs.Installer/InstallationNotes.md +++ b/modules/background-jobs/src/Volo.Abp.BackgroundJobs.Installer/InstallationNotes.md @@ -7,50 +7,6 @@ Background jobs are used to queue some tasks to be executed in the background. Y Background jobs are **persistent** that means they will be **re-tried** and **executed** later even if your application crashes. -## Installation Steps - -1. Add the following NuGet packages to your project: - - `Volo.Abp.BackgroundJobs.EntityFrameworkCore` (for EF Core) - - `Volo.Abp.BackgroundJobs.MongoDB` (for MongoDB) - -2. Add the following module dependencies to your module class: - -```csharp -[DependsOn( - typeof(AbpBackgroundJobsDomainModule), - typeof(AbpBackgroundJobsDomainSharedModule), - typeof(AbpBackgroundJobsEntityFrameworkCoreModule) // For EF Core - // OR typeof(AbpBackgroundJobsMongoDbModule) // For MongoDB -)] -public class YourModule : AbpModule -{ -} -``` - -## EntityFramework Core Configuration - -For `EntityFrameworkCore`, further configuration is needed in the `OnModelCreating` method of your `DbContext` class: - -```csharp -using Volo.Abp.BackgroundJobs.EntityFrameworkCore; - -protected override void OnModelCreating(ModelBuilder builder) -{ - base.OnModelCreating(builder); - - builder.ConfigureBackgroundJobs(); - - //... -} -``` - -Also, you will need to create a new migration and apply it to the database: - -```bash -dotnet ef migrations add Added_BackgroundJobs -dotnet ef database update -``` - ## Documentation For detailed information and usage instructions, please visit the [Background Jobs documentation](https://abp.io/docs/latest/framework/infrastructure/background-jobs). \ No newline at end of file diff --git a/modules/basic-theme/src/Volo.Abp.AspNetCore.Mvc.UI.Theme.Basic.Installer/InstallationNotes.md b/modules/basic-theme/src/Volo.Abp.AspNetCore.Mvc.UI.Theme.Basic.Installer/InstallationNotes.md index 380532b2c3..dc655f430f 100644 --- a/modules/basic-theme/src/Volo.Abp.AspNetCore.Mvc.UI.Theme.Basic.Installer/InstallationNotes.md +++ b/modules/basic-theme/src/Volo.Abp.AspNetCore.Mvc.UI.Theme.Basic.Installer/InstallationNotes.md @@ -8,24 +8,6 @@ If you are looking for a professional, enterprise ready theme, you can check the See the [Theming document](https://github.com/abpframework/abp/blob/rel-9.1/docs/en/framework/ui/mvc-razor-pages/theming.md) to learn about themes. -## Installation Steps - -The Basic Theme module is pre-installed in the ABP MVC startup templates. If you need to manually install it, follow these steps: - -1. Add the following NuGet package to your project: - - `Volo.Abp.AspNetCore.Mvc.UI.Theme.Basic` - -2. Add the following module dependency to your module class: - -```csharp -[DependsOn( - typeof(AbpAspNetCoreMvcUiThemeBasicModule) -)] -public class YourModule : AbpModule -{ -} -``` - ## Documentation For detailed information and usage instructions, please visit the [Basic Theme documentation](https://abp.io/docs/latest/framework/ui/mvc-razor-pages/basic-theme). \ No newline at end of file diff --git a/modules/basic-theme/src/Volo.Abp.BasicTheme.Installer/InstallationNotes.md b/modules/basic-theme/src/Volo.Abp.BasicTheme.Installer/InstallationNotes.md index c9f37d4b21..088628d830 100644 --- a/modules/basic-theme/src/Volo.Abp.BasicTheme.Installer/InstallationNotes.md +++ b/modules/basic-theme/src/Volo.Abp.BasicTheme.Installer/InstallationNotes.md @@ -2,40 +2,6 @@ The Basic Theme is a theme implementation for the Blazor UI. It is a minimalist theme that doesn't add any styling on top of the plain [Bootstrap](https://getbootstrap.com/). You can take the Basic Theme as the base theme and build your own theme or styling on top of it. See the Customization section. -## Installation Steps - -The Basic Theme module is pre-installed in the ABP Blazor startup templates. If you need to manually install it, follow these steps: - -1. Add the following NuGet packages to your project based on your Blazor hosting model: - - **For Blazor Server:** - - `Volo.Abp.AspNetCore.Components.Server.BasicTheme` - - **For Blazor WebAssembly:** - - `Volo.Abp.AspNetCore.Components.WebAssembly.BasicTheme` - -2. Add the following module dependencies to your module class: - - **For Blazor Server:** - ```csharp - [DependsOn( - typeof(AbpAspNetCoreComponentsServerBasicThemeModule), - )] - public class YourModule : AbpModule - { - } - ``` - - **For Blazor WebAssembly:** - ```csharp - [DependsOn( - typeof(AbpAspNetCoreComponentsWebAssemblyBasicThemeModule), - )] - public class YourModule : AbpModule - { - } - ``` - ## Documentation For detailed information and usage instructions, please visit the [Blazor UI Basic Theme documentation](https://abp.io/docs/latest/framework/ui/blazor/basic-theme?UI=BlazorServer). \ No newline at end of file diff --git a/modules/blob-storing-database/src/Volo.Abp.BlobStoring.Database.Installer/InstallationNotes.md b/modules/blob-storing-database/src/Volo.Abp.BlobStoring.Database.Installer/InstallationNotes.md index 95961eb2cd..dcd9293ef3 100644 --- a/modules/blob-storing-database/src/Volo.Abp.BlobStoring.Database.Installer/InstallationNotes.md +++ b/modules/blob-storing-database/src/Volo.Abp.BlobStoring.Database.Installer/InstallationNotes.md @@ -11,54 +11,6 @@ You can then easily change your BLOB storage without changing your application c If you want to create reusable application modules, you don't need to make assumption about how the BLOBs are stored. ABP BLOB Storage system is also compatible to other ABP features like multi-tenancy. -## Required Dependencies - -The Blob Storing Database module depends on the following ABP modules: -- ABP BlobStoring module - -## Installation Steps - -1. Add the following NuGet packages to your project: - - `Volo.Abp.BlobStoring.Database.EntityFrameworkCore` (for EF Core) - - `Volo.Abp.BlobStoring.Database.MongoDB` (for MongoDB) - -2. Add the following module dependencies to your module class: - -```csharp -[DependsOn( - typeof(AbpBlobStoringDatabaseEntityFrameworkCoreModule) // Or AbpBlobStoringDatabaseMongoDBModule -)] -public class YourModule : AbpModule -{ -} -``` - -## Database Integration - -### EntityFramework Core Configuration - -For `EntityFrameworkCore`, add the following configuration to the `OnModelCreating` method of your `DbContext` class: - -```csharp -using Volo.Abp.BlobStoring.Database.EntityFrameworkCore; - -protected override void OnModelCreating(ModelBuilder builder) -{ - base.OnModelCreating(builder); - - builder.ConfigureBlobStoring(); - - // ... other configurations -} -``` - -Then create a new migration and apply it to the database: - -```bash -dotnet ef migrations add Added_BlobStoring -dotnet ef database update -``` - -## 6. **Documentation** +## Documentation For detailed information and usage instructions, please visit the [BLOB Storing documentation](https://abp.io/docs/latest/framework/infrastructure/blob-storing). \ No newline at end of file diff --git a/modules/blogging/src/Volo.Blogging.Installer/InstallationNotes.md b/modules/blogging/src/Volo.Blogging.Installer/InstallationNotes.md index c41587e796..9ef0de0d04 100644 --- a/modules/blogging/src/Volo.Blogging.Installer/InstallationNotes.md +++ b/modules/blogging/src/Volo.Blogging.Installer/InstallationNotes.md @@ -9,68 +9,19 @@ Key features of the Blogging module: - Social media sharing - Admin interface for content management -## Required Dependencies +## Required Configurations -The Blogging module depends on the following ABP modules: -- ABP Blob Storing module (for media management) +The Blogging module requires **permission** settings to be configured after installation. Ensure that the necessary roles have the appropriate access rights for managing blogs, posts, comments and others. -## Installation Steps +### Update Database -1. Add the following NuGet packages to your project: - - `Volo.Blogging.Application` - - `Volo.Blogging.HttpApi` - - `Volo.Blogging.EntityFrameworkCore` (for EF Core) - - `Volo.Blogging.MongoDB` (for MongoDB) - - `Volo.Blogging.Web` (for MVC UI) +The Blogging module requires database migrations to be applied. Following installation, you must update the database to create the necessary tables. - // Admin UI - - `Volo.Blogging.Admin.Application` - - `Volo.Blogging.Admin.HttpApi` - - `Volo.Blogging.Admin.Web` (for MVC UI) +### Permissions -2. Add the following module dependencies to your module class: +Enable the following permissions for the roles that require access to the Blogging module: -```csharp -[DependsOn( - // Other dependencies - typeof(BloggingApplicationModule), - typeof(BloggingHttpApiModule), - typeof(BloggingEntityFrameworkCoreModule), // For EF Core - typeof(BloggingMongoDbModule) // For MongoDB - typeof(BloggingWebModule) // For MVC UI - // Admin UI - typeof(BloggingAdminApplicationModule), - typeof(BloggingAdminHttpApiModule), - typeof(BloggingAdminWebModule) // For MVC UI -)] -public class YourModule : AbpModule -{ -} -``` - -### EntityFramework Core Configuration - -For `EntityFrameworkCore`, add the following configuration to the `OnModelCreating` method of your `DbContext` class: - -```csharp -using Volo.Blogging.EntityFrameworkCore; - -protected override void OnModelCreating(ModelBuilder builder) -{ - base.OnModelCreating(builder); - - builder.ConfigureBlogging(); - - // ... other configurations -} -``` - -Then create a new migration and apply it to the database: - -```bash -dotnet ef migrations add Added_Blogging -dotnet ef database update -``` +![Blogging Permissions](blogging-permissions.png) ## Documentation diff --git a/modules/blogging/src/Volo.Blogging.Installer/blogging-permissions.png b/modules/blogging/src/Volo.Blogging.Installer/blogging-permissions.png new file mode 100644 index 0000000000..f9b724592a Binary files /dev/null and b/modules/blogging/src/Volo.Blogging.Installer/blogging-permissions.png differ diff --git a/modules/cms-kit/src/Volo.CmsKit.Installer/InstallationNotes.md b/modules/cms-kit/src/Volo.CmsKit.Installer/InstallationNotes.md index d0fc767b50..1a037cf1e3 100644 --- a/modules/cms-kit/src/Volo.CmsKit.Installer/InstallationNotes.md +++ b/modules/cms-kit/src/Volo.CmsKit.Installer/InstallationNotes.md @@ -4,90 +4,44 @@ The ABP CMS Kit module provides a set of reusable Content Management System (CMS This module is part of the ABP Framework and provides features like comments, ratings, tags, blogs, and more to help you build content-rich applications. -## Required Dependencies +## Required Configurations -The CMS Kit module depends on the following modules: -- Blob Storing module (for media management) +The CmsKit module requires **permission** settings to be configured after installation. Ensure that the necessary roles have the appropriate access rights for managing blogs, posts, comments and others. -## Installation Steps +### Enable CmsKit -You can manually add the required NuGet packages: - -1. Add the following NuGet packages to your project: - - `Volo.CmsKit.Public.Application` (for public features) - - `Volo.CmsKit.Public.HttpApi` (for public API) - - `Volo.CmsKit.Public.Web` (for public UI) - - `Volo.CmsKit.EntityFrameworkCore` (for EF Core) - - `Volo.CmsKit.MongoDB` (for MongoDB) - // admin - - `Volo.CmsKit.Admin.Application` (for admin features) - - `Volo.CmsKit.Admin.HttpApi` (for admin API) - - `Volo.CmsKit.Admin.Web` (for admin UI) - - - -2. Add the following module dependencies to your module class: +To enable the CmsKit module, add the following line to the `GlobalFeatureConfigurator` class of your module: ```csharp -[DependsOn( - typeof(CmsKitAdminApplicationModule), // For admin features - typeof(CmsKitPublicApplicationModule), // For public features - typeof(CmsKitAdminHttpApiModule), // For admin API - typeof(CmsKitPublicHttpApiModule), // For public API - typeof(CmsKitAdminWebModule), // For admin UI - typeof(CmsKitPublicWebModule), // For public UI - typeof(CmsKitEntityFrameworkCoreModule) // For EF Core - // OR typeof(CmsKitMongoDbModule) // For MongoDB -)] -public class YourModule : AbpModule +public static void Configure() { + OneTimeRunner.Run(() => + { + /* You can configure (enable/disable) global features of the used modules here. + * Please refer to the documentation to learn more about the Global Features System: + * https://docs.abp.io/en/abp/latest/Global-Features + */ + + GlobalFeatureManager.Instance.Modules.CmsKit(cmsKit => + { + cmsKit.EnableAll(); + // or + // cmsKit.Tags.Enable(); + // cmsKit.Comments.Enable(); + }); + }); } ``` -### EntityFramework Core Configuration +### Database Migrations -For `EntityFrameworkCore`, further configuration is needed in the `OnModelCreating` method of your `DbContext` class: +The CmsKit module requires database migrations to be applied. After enable **CmsKit**, Add a new migration and update the database to create the necessary tables. -```csharp -using Volo.CmsKit.EntityFrameworkCore; +### Permissions -protected override void OnModelCreating(ModelBuilder builder) -{ - base.OnModelCreating(builder); - - builder.ConfigureCmsKit(); - - //... -} -``` +Enable the following permissions for the roles that require access to the CmsKit module: -Also, you will need to create a new migration and apply it to the database: - -```bash -dotnet ef migrations add Added_CmsKit -dotnet ef database update -``` - -## Feature Management - -By default, all CMS Kit features are disabled. You need to enable the features you want to use in your application. Open the `GlobalFeatureConfigurator` class in the `Domain.Shared` project and add the following code to the `Configure` method: - -```csharp -GlobalFeatureManager.Instance.Modules.CmsKit(cmsKit => -{ - // Enable all features - cmsKit.EnableAll(); - - // Or enable specific features - // cmsKit.Comments.Enable(); - // cmsKit.Tags.Enable(); - // cmsKit.Ratings.Enable(); - // cmsKit.Reactions.Enable(); - // cmsKit.Blogs.Enable(); - // cmsKit.Pages.Enable(); - // cmsKit.MediaDescriptors.Enable(); -}); -``` +![CmsKit Permissions](cmskit-permissions.png) ## Documentation diff --git a/modules/cms-kit/src/Volo.CmsKit.Installer/cmskit-permissions.png b/modules/cms-kit/src/Volo.CmsKit.Installer/cmskit-permissions.png new file mode 100644 index 0000000000..5e86f0f5e8 Binary files /dev/null and b/modules/cms-kit/src/Volo.CmsKit.Installer/cmskit-permissions.png differ diff --git a/modules/docs/src/Volo.Docs.Installer/InstallationNotes.md b/modules/docs/src/Volo.Docs.Installer/InstallationNotes.md index 09ed7afd01..a0c172d27c 100644 --- a/modules/docs/src/Volo.Docs.Installer/InstallationNotes.md +++ b/modules/docs/src/Volo.Docs.Installer/InstallationNotes.md @@ -11,60 +11,20 @@ Key features of the Docs module: - Multi-language support - Admin interface for documentation management -## Installation Steps -1. Add the following NuGet packages to your project: - - `Volo.Docs.Application` - - `Volo.Docs.HttpApi` - - `Volo.Docs.Web` (for MVC UI) - - `Volo.Docs.EntityFrameworkCore` (for EF Core) - - `Volo.Docs.MongoDB` (for MongoDB) +## Required Configurations - For the admin UI: - - `Volo.Docs.Admin.Application` - - `Volo.Docs.Admin.HttpApi` - - `Volo.Docs.Admin.Web` +The Docs module requires **permission** settings to be configured after installation and database update. -2. Add the following module dependencies to your module class: +### Update Database -```csharp -[DependsOn( - typeof(DocsApplicationModule), - typeof(DocsHttpApiModule), - typeof(DocsWebModule), // For MVC UI - typeof(DocsEntityFrameworkCoreModule), // Or DocsMongoDbModule - typeof(DocsAdminApplicationModule), - typeof(DocsAdminHttpApiModule), - typeof(DocsAdminWebModule) -)] -public class YourModule : AbpModule -{ -} -``` +The Docs module requires database migrations to be applied. Following installation, you must update the database to create the necessary tables. -## EntityFramework Core Configuration +### Permissions -For `EntityFrameworkCore`, add the following configuration to the `OnModelCreating` method of your `DbContext` class: +Enable the following permissions for the roles that require access to the Docs module: -```csharp -using Volo.Docs.EntityFrameworkCore; - -protected override void OnModelCreating(ModelBuilder builder) -{ - base.OnModelCreating(builder); - - builder.ConfigureDocs(); - - // ... other configurations -} -``` - -Then create a new migration and apply it to the database: - -```bash -dotnet ef migrations add Added_Docs -dotnet ef database update -``` +![Docs Permissions](docs-permissions.png) ## Documentation diff --git a/modules/docs/src/Volo.Docs.Installer/docs-permissions.png b/modules/docs/src/Volo.Docs.Installer/docs-permissions.png new file mode 100644 index 0000000000..30b41db145 Binary files /dev/null and b/modules/docs/src/Volo.Docs.Installer/docs-permissions.png differ diff --git a/modules/virtual-file-explorer/src/Volo.Abp.VirtualFileExplorer.Installer/InstallationNotes.md b/modules/virtual-file-explorer/src/Volo.Abp.VirtualFileExplorer.Installer/InstallationNotes.md new file mode 100644 index 0000000000..c4e86630dc --- /dev/null +++ b/modules/virtual-file-explorer/src/Volo.Abp.VirtualFileExplorer.Installer/InstallationNotes.md @@ -0,0 +1,7 @@ +# Installation Notes for Docs Module + +The Virtual File System makes it possible to manage files that do not physically exist on the file system (disk). It's mainly used to embed (js, css, image..) files into assemblies and use them like physical files at runtime. + +## Documentation + +For detailed information and usage instructions, please visit the [Virtual File System Module documentation](https://abp.io/docs/latest/framework/infrastructure/virtual-file-system). \ No newline at end of file