-
Notifications
You must be signed in to change notification settings - Fork 2.6k
docs: add documentation for creating and installing a custom module #19134
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.
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
Merged
sebastienros
merged 3 commits into
OrchardCMS:main
from
Manuel-dev-ing:feature/custom-module-docs
Apr 23, 2026
+50
−0
Merged
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| # Create and install a custom module | ||
|
|
||
| ## Creating a custom module | ||
| Orchard Core offers a way to create a new CMS module. You can find a detailed guide in the official documentation: [Create a new CMS module](https://docs.orchardcore.net/en/latest/getting-started/templates/#create-a-new-cms-module). This guide assumes that a module already exists and focuses on how to install, customize, and enable it. | ||
| ## Module customization | ||
| We can customize how your module appears in the Admin UI by editing the `Manifest.cs` file. | ||
|
|
||
| The manifest file allows you to define the following attributes: | ||
| - Name | ||
| - Description | ||
| - Author | ||
| - Version | ||
| - Category | ||
|
|
||
| After modifying the `Manifest.cs` file, for the changes to take effect, follow these steps: | ||
| 1. Compile the solution | ||
| 2. Run the application | ||
| 3. If changes are not reflected, disable and re-enable the module | ||
|
|
||
| ## Installing the module | ||
| To install a custom module in an Orchard Core CMS application, the module project must be referenced by the main CMS web project. | ||
|
|
||
| For example, in Visual Studio: | ||
| - Open the solution | ||
| - Right-click on **Dependencies** in the project named `Orchard Core.Cms.Web` | ||
| - Click on **Add Project Reference** | ||
| - Select the custom module project | ||
| - Click the Accept button | ||
|
|
||
| After adding the reference, the main CMS project file should include an entry similar to: | ||
|
|
||
| ``` | ||
| <ItemGroup> | ||
| <ProjectReference Include="..\MyModule.OrchardCore\MyModule.OrchardCore.csproj" /> | ||
| </ItemGroup> | ||
| ``` | ||
| This reference allows Orchard Core to discover and load the custom module at runtime. | ||
|
|
||
| ## Enabling the module | ||
| Once the module is installed, it can be enabled from the administration panel: | ||
| 1. Go to the Admin dashboard | ||
| 2. Navigate to **Configuration > Features** | ||
| 3. Search using the name defined in the `Name` property of the manifest file | ||
| 4. Click the **Enable** button | ||
|
|
||
| If the module does not appear in the list, check the following: | ||
| - The module must contain a manifest file (`Manifest.cs`) | ||
| - The module project must be referenced by the CMS web project | ||
|
Manuel-dev-ing marked this conversation as resolved.
Outdated
|
||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is now located in Tools in v3. As this document targets the
mainbranch, it should match that.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice catch