# halo-dev/halo architecture

> Architecture diagram of the GitHub repository halo-dev/halo, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-09). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/halo-dev/halo
- Repository: https://github.com/halo-dev/halo

## Overview

Halo is a website-building and CMS platform for blogs, knowledge bases, and business sites. Its principal product workflow is managing content in the console and presenting public pages through themes; the tree also shows separate capabilities for comments, search, authentication, attachments, plugins, and extensions. The excerpts substantiate some service-level relationships, but not the full console-to-server request flow or most subsystem wiring, so those links are omitted rather than inferred.

Main entry points: [`application/src/main/java/run/halo/app/theme/finders/impl/CommentPublicQueryServiceImpl.java`](https://github.com/halo-dev/halo/blob/main/application/src/main/java/run/halo/app/theme/finders/impl/CommentPublicQueryServiceImpl.java) (Public comment queries), [`application/src/main/java/run/halo/app/security/authentication/oauth2/OAuth2RegistrationService.java`](https://github.com/halo-dev/halo/blob/main/application/src/main/java/run/halo/app/security/authentication/oauth2/OAuth2RegistrationService.java) (OAuth registration), [`application/src/main/java/run/halo/app/theme/finders/PostPublicQueryService.java`](https://github.com/halo-dev/halo/blob/main/application/src/main/java/run/halo/app/theme/finders/PostPublicQueryService.java) (Public post queries), [`application/src/main/java/run/halo/app/search/lucene/LuceneSearchEngine.java`](https://github.com/halo-dev/halo/blob/main/application/src/main/java/run/halo/app/search/lucene/LuceneSearchEngine.java) (Search engine)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_content["Content management"]
  node_console["Admin console<br/>[main.ts]"]
  node_post_service["Post services"]
  node_page_service["Page services"]
  node_comment_service["Comment services"]
  node_post_model["Post model<br/>[Post.java]"]
  node_comment_model["Comment model<br/>[Comment.java]"]
end

subgraph group_public["Public site"]
  node_public_posts["Public post queries"]
  node_public_comments["Public comment queries"]
  node_comment_view["Comment view model<br/>[CommentVo.java]"]
  node_theme_engine["Theme rendering"]
  node_post_content["Post content handling"]
end

subgraph group_platform["Extension platform"]
  node_extension_api["Extension API"]
  node_extension_controller["Extension controllers<br/>[Controller.java]"]
  node_extension_index["Indexed queries"]
  node_plugin_service["Plugin management<br/>[PluginService.java]"]
end

subgraph group_identity["Identity and access"]
  node_auth_providers["Authentication providers"]
  node_oauth_registration["OAuth registration"]
  node_user_service["User management<br/>[UserService.java]"]
end

subgraph group_capabilities["Site capabilities"]
  node_search_service["Search service<br/>[SearchService.java]"]
  node_search_engine[("Search engine")]
  node_attachment_service["Attachment service"]
  node_marketplace["Themes and plugins<br/>[PluginService.java]"]
end

node_site_author(("Site administrator"))

node_site_author -.->|"manages site"| node_console
node_public_posts -->|"loads content"| node_post_content
node_public_comments -->|"converts to"| node_comment_view
node_public_comments -.->|"queries comments"| node_comment_service
node_public_comments -->|"maps comments"| node_comment_model
node_oauth_registration -->|"creates users"| node_user_service
node_oauth_registration -->|"uses client"| node_extension_api
node_search_engine -->|"implements contract"| node_search_service
node_marketplace -.->|"manages plugins"| node_plugin_service

click node_console "https://github.com/halo-dev/halo/blob/main/ui/console-src/main.ts"
click node_post_service "https://github.com/halo-dev/halo/blob/main/application/src/main/java/run/halo/app/content/impl/PostServiceImpl.java"
click node_page_service "https://github.com/halo-dev/halo/blob/main/application/src/main/java/run/halo/app/content/impl/SinglePageServiceImpl.java"
click node_comment_service "https://github.com/halo-dev/halo/blob/main/application/src/main/java/run/halo/app/content/comment/CommentServiceImpl.java"
click node_post_model "https://github.com/halo-dev/halo/blob/main/api/src/main/java/run/halo/app/core/extension/content/Post.java"
click node_comment_model "https://github.com/halo-dev/halo/blob/main/api/src/main/java/run/halo/app/core/extension/content/Comment.java"
click node_public_posts "https://github.com/halo-dev/halo/blob/main/application/src/main/java/run/halo/app/theme/finders/PostPublicQueryService.java"
click node_public_comments "https://github.com/halo-dev/halo/blob/main/application/src/main/java/run/halo/app/theme/finders/impl/CommentPublicQueryServiceImpl.java"
click node_comment_view "https://github.com/halo-dev/halo/blob/main/application/src/main/java/run/halo/app/theme/finders/vo/CommentVo.java"
click node_theme_engine "https://github.com/halo-dev/halo/blob/main/application/src/main/java/run/halo/app/theme/TemplateEngineManager.java"
click node_post_content "https://github.com/halo-dev/halo/blob/main/api/src/main/java/run/halo/app/content/PostContentService.java"
click node_extension_api "https://github.com/halo-dev/halo/blob/main/api/src/main/java/run/halo/app/extension/AbstractExtension.java"
click node_extension_controller "https://github.com/halo-dev/halo/blob/main/api/src/main/java/run/halo/app/extension/controller/Controller.java"
click node_extension_index "https://github.com/halo-dev/halo/blob/main/api/src/main/java/run/halo/app/extension/index/IndexedQueryEngine.java"
click node_plugin_service "https://github.com/halo-dev/halo/blob/main/application/src/main/java/run/halo/app/plugin/PluginService.java"
click node_auth_providers "https://github.com/halo-dev/halo/blob/main/application/src/main/java/run/halo/app/security/AuthProviderService.java"
click node_oauth_registration "https://github.com/halo-dev/halo/blob/main/application/src/main/java/run/halo/app/security/authentication/oauth2/OAuth2RegistrationService.java"
click node_user_service "https://github.com/halo-dev/halo/blob/main/api/src/main/java/run/halo/app/core/user/service/UserService.java"
click node_search_service "https://github.com/halo-dev/halo/blob/main/api/src/main/java/run/halo/app/search/SearchService.java"
click node_search_engine "https://github.com/halo-dev/halo/blob/main/application/src/main/java/run/halo/app/search/lucene/LuceneSearchEngine.java"
click node_attachment_service "https://github.com/halo-dev/halo/blob/main/api/src/main/java/run/halo/app/core/extension/service/AttachmentService.java"
click node_marketplace "https://github.com/halo-dev/halo/blob/main/application/src/main/java/run/halo/app/plugin/PluginService.java"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_console,node_post_service,node_page_service,node_comment_service,node_post_model,node_comment_model toneBlue
class node_public_posts,node_public_comments,node_comment_view,node_theme_engine,node_post_content toneAmber
class node_extension_api,node_extension_controller,node_extension_index,node_plugin_service toneMint
class node_auth_providers,node_oauth_registration,node_user_service toneRose
class node_search_service,node_search_engine,node_attachment_service,node_marketplace,node_site_author toneIndigo
```

## Components

### Content management

- [Admin console](https://github.com/halo-dev/halo/blob/main/ui/console-src/main.ts): `ui/console-src/main.ts`
- [Post services](https://github.com/halo-dev/halo/blob/main/application/src/main/java/run/halo/app/content/impl/PostServiceImpl.java): `application/src/main/java/run/halo/app/content/impl/PostServiceImpl.java`
- [Page services](https://github.com/halo-dev/halo/blob/main/application/src/main/java/run/halo/app/content/impl/SinglePageServiceImpl.java): `application/src/main/java/run/halo/app/content/impl/SinglePageServiceImpl.java`
- [Comment services](https://github.com/halo-dev/halo/blob/main/application/src/main/java/run/halo/app/content/comment/CommentServiceImpl.java): `application/src/main/java/run/halo/app/content/comment/CommentServiceImpl.java`
- [Post model](https://github.com/halo-dev/halo/blob/main/api/src/main/java/run/halo/app/core/extension/content/Post.java): `api/src/main/java/run/halo/app/core/extension/content/Post.java`
- [Comment model](https://github.com/halo-dev/halo/blob/main/api/src/main/java/run/halo/app/core/extension/content/Comment.java): `api/src/main/java/run/halo/app/core/extension/content/Comment.java`

### Public site

- [Public post queries](https://github.com/halo-dev/halo/blob/main/application/src/main/java/run/halo/app/theme/finders/PostPublicQueryService.java): `application/src/main/java/run/halo/app/theme/finders/PostPublicQueryService.java`
- [Public comment queries](https://github.com/halo-dev/halo/blob/main/application/src/main/java/run/halo/app/theme/finders/impl/CommentPublicQueryServiceImpl.java): `application/src/main/java/run/halo/app/theme/finders/impl/CommentPublicQueryServiceImpl.java`
- [Comment view model](https://github.com/halo-dev/halo/blob/main/application/src/main/java/run/halo/app/theme/finders/vo/CommentVo.java): `application/src/main/java/run/halo/app/theme/finders/vo/CommentVo.java`
- [Theme rendering](https://github.com/halo-dev/halo/blob/main/application/src/main/java/run/halo/app/theme/TemplateEngineManager.java): `application/src/main/java/run/halo/app/theme/TemplateEngineManager.java`
- [Post content handling](https://github.com/halo-dev/halo/blob/main/api/src/main/java/run/halo/app/content/PostContentService.java): `api/src/main/java/run/halo/app/content/PostContentService.java`

### Extension platform

- [Extension API](https://github.com/halo-dev/halo/blob/main/api/src/main/java/run/halo/app/extension/AbstractExtension.java): `api/src/main/java/run/halo/app/extension/AbstractExtension.java`
- [Extension controllers](https://github.com/halo-dev/halo/blob/main/api/src/main/java/run/halo/app/extension/controller/Controller.java): `api/src/main/java/run/halo/app/extension/controller/Controller.java`
- [Indexed queries](https://github.com/halo-dev/halo/blob/main/api/src/main/java/run/halo/app/extension/index/IndexedQueryEngine.java): `api/src/main/java/run/halo/app/extension/index/IndexedQueryEngine.java`
- [Plugin management](https://github.com/halo-dev/halo/blob/main/application/src/main/java/run/halo/app/plugin/PluginService.java): `application/src/main/java/run/halo/app/plugin/PluginService.java`

### Identity and access

- [Authentication providers](https://github.com/halo-dev/halo/blob/main/application/src/main/java/run/halo/app/security/AuthProviderService.java): `application/src/main/java/run/halo/app/security/AuthProviderService.java`
- [OAuth registration](https://github.com/halo-dev/halo/blob/main/application/src/main/java/run/halo/app/security/authentication/oauth2/OAuth2RegistrationService.java): `application/src/main/java/run/halo/app/security/authentication/oauth2/OAuth2RegistrationService.java`
- [User management](https://github.com/halo-dev/halo/blob/main/api/src/main/java/run/halo/app/core/user/service/UserService.java): `api/src/main/java/run/halo/app/core/user/service/UserService.java`

### Site capabilities

- [Search service](https://github.com/halo-dev/halo/blob/main/api/src/main/java/run/halo/app/search/SearchService.java): `api/src/main/java/run/halo/app/search/SearchService.java`
- [Search engine](https://github.com/halo-dev/halo/blob/main/application/src/main/java/run/halo/app/search/lucene/LuceneSearchEngine.java): `application/src/main/java/run/halo/app/search/lucene/LuceneSearchEngine.java`
- [Attachment service](https://github.com/halo-dev/halo/blob/main/api/src/main/java/run/halo/app/core/extension/service/AttachmentService.java): `api/src/main/java/run/halo/app/core/extension/service/AttachmentService.java`
- [Themes and plugins](https://github.com/halo-dev/halo/blob/main/application/src/main/java/run/halo/app/plugin/PluginService.java): `application/src/main/java/run/halo/app/plugin/PluginService.java`

### Other components

- **Site administrator**

## Connections

- Site administrator → Admin console: manages site
- Public post queries → Post content handling: loads content (evidence: `application/src/main/java/run/halo/app/theme/finders/PostPublicQueryService.java`)
- Public comment queries → Comment view model: converts to (evidence: `application/src/main/java/run/halo/app/theme/finders/impl/CommentPublicQueryServiceImpl.java`)
- Public comment queries → Comment services: queries comments
- Public comment queries → Comment model: maps comments (evidence: `application/src/main/java/run/halo/app/theme/finders/impl/CommentPublicQueryServiceImpl.java`)
- OAuth registration → User management: creates users (evidence: `application/src/main/java/run/halo/app/security/authentication/oauth2/OAuth2RegistrationService.java`)
- OAuth registration → Extension API: uses client (evidence: `application/src/main/java/run/halo/app/security/authentication/oauth2/OAuth2RegistrationService.java`)
- Search engine → Search service: implements contract (evidence: `application/src/main/java/run/halo/app/search/lucene/LuceneSearchEngine.java`)
- Themes and plugins → Plugin management: manages plugins
