Files
apache--hertzbeat/home/docs/help/template_marketplace.md
T
wehub-resource-sync c8cebdfeee
MCP Bash Server CI / Test MCP Bash Server (dev) (push) Has been cancelled
MCP Bash Server CI / Test MCP Bash Server (release) (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 13:11:39 +08:00

153 lines
4.8 KiB
Markdown

---
id: template_marketplace
title: Template Marketplace
sidebar_label: Template Marketplace
---
> HertzBeat official template marketplace: users can freely upload, download, view, search and share monitoring template files.
## Basic Functions
### Search
💡 Guest availability
> Display template name, brief description, favorites, downloads, views and other information
1. **No filter: displayed in order of upload**
![search.png](/img/template-marketplace/search.png)
2. **Filtering by category: currently divided into six categories**
> **📋Todo:** develop tag function, subdivided within the category, such as database monitoring template can be divided into MySQL, Oracle, etc.
![search-category.png](/img/template-marketplace/search-category.png)
3. **Fuzzy search by Title**
![search-name.png](/img/template-marketplace/search-name.png)
4. **Hover window function: download the latest version, view details, favorite/un-favorite**
> Show if the user has favorites after logging in
![img.png](/img/template-marketplace/hover-window-guest.png)![img_1.png](/img/template-marketplace/hover-window-user.png)
5. **Sort: Eight Sorting Methods**
> **📋Todo:** Waiting for the actual installation
### Template Detail
💡 Guest availability
> Display basic information about the template, such as name, author, update time, version information, etc.
1. **Info: Summary information, detailed information and other information**
> **📋Todo:** Upgrade to MarkDown format
![img.png](/img/template-marketplace/detail-info.png)
2. **Version: Historical version download, sharing and basic information display**
> **📋Todo:** Set up a view function for each historical version to display information such as the version description.
![img.png](/img/template-marketplace/detail-version.png)
3. **FAQ**
> **📋Todo:** Discussion or issue Q&A section
![img.png](/img/template-marketplace/detail-faq.png)
4. **Download**
> The latest version can be downloaded directly from the list hover window.
> The latest version can also be downloaded directly from the template detail page.
> The historical version can be downloaded from the version page.
![img.png](/img/template-marketplace/download.png)
5. **Share**
> Template details page to share the latest version.
> Version page to share historical versions.
> Sharing will automatically copy the sharing URL to the clipboard, and the person being shared can download the file via that URL
>
> **📋Todo:** Shared template detail page is accessed through the URL of the shared template, and the shared person is free to choose whether to download or not.
![img.png](/img/template-marketplace/share.png)
### User Center
💡 User availability
> Provide asset management, collection management and upload function
>
> **📋Todo:** Overview page, notification page, user settings page
1. **Asset: Manage all templates uploaded by user themselves**
> Provides the ability to download the latest version and view details
>
> **📋Todo:** Function to update template information
![img_1.png](/img/template-marketplace/user-center-asset.png)
![img.png](/img/template-marketplace/asset-detail.png)
2. **Version Upgrade**
> The user defines the new version number under this template family, updates the version information, and uploads the latest version of the file
![img.png](/img/template-marketplace/asset-upgrade.png)
3. **Star**
![img.png](/img/template-marketplace/user-center-star.png)
![img.png](/img/template-marketplace/user-center-star-detail.png)
4. **Upload**
> Create a new template series and upload the first version of the file
>
> Fill in the template name, select the template category, fill in the description information and version information, and upload files
![img.png](/img/template-marketplace/user-center-upload.png)
### Sign Up & Login
💡 Guest availability
1. **Sign up**
> Usernames can be duplicated, but email addresses are unique
>
> **📋Todo:** Captcha function, email verification function
![img.png](/img/template-marketplace/sign-up.png)
2. **Login**
> **📋Todo:** Captcha function and forgot password function
![img.png](/img/template-marketplace/email-login.png)
## Development Steps
> Download `template-marketplace/hertzbeat-template-hub` and `template-marketplace/hertzbeat-template-hub-web-app` projects respectively
The front-end project in accordance with README.md directly start
The back-end project steps:
1. Run the `sql` script in the `template-marketplace/hertzbeat-template-hub/sql` to create database tables
2. Install MinIO
3. Config `MySQL` and `MinIO` in the `application.yml`
4. Start the back-end project
Other issues can be fed back through the communication group ISSUE!