https://github.com/ediwang/moonglade
Blog system of https://edi.wang, runs on Microsoft Azure
https://github.com/ediwang/moonglade
aspnet-core azure azure-app-service azure-blob-storage azure-sql-database blog entity-framework-core entra-id sql-server
Last synced: 2 days ago
JSON representation
Blog system of https://edi.wang, runs on Microsoft Azure
- Host: GitHub
- URL: https://github.com/ediwang/moonglade
- Owner: EdiWang
- License: gpl-3.0
- Created: 2019-01-30T05:51:33.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2025-04-02T13:11:50.000Z (12 months ago)
- Last Synced: 2025-04-06T06:01:36.646Z (11 months ago)
- Topics: aspnet-core, azure, azure-app-service, azure-blob-storage, azure-sql-database, blog, entity-framework-core, entra-id, sql-server
- Language: C#
- Homepage: https://edi.wang
- Size: 26.2 MB
- Stars: 531
- Watchers: 14
- Forks: 139
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🌙 Moonglade Blog
**Moonglade** is a personal blogging platform built for developers, optimized for seamless deployment on [**Microsoft Azure**](https://azure.microsoft.com/en-us/). It features essential blogging tools: posts, comments, categories, tags, archives, and pages.
## 🚀 Deployment
> This blogging system must not be used to serve users in mainland China or to publish content prohibited by Chinese law or any applicable regulations.
- **Stable Code:** Always use the [Release](https://github.com/EdiWang/Moonglade/releases) branch. Avoid deploying from `master`.
- **Security:** Enable **HTTPS** and **HTTP/2** on your web server for optimal security and performance.
- **Deployment Options:** While Azure is recommended, Moonglade can run on any cloud provider or on-premises.
### Quick Azure Deploy (App Service on Linux)
Get started in 10 minutes with minimal Azure resources using our [automated deployment script](https://github.com/EdiWang/Moonglade/wiki/Quick-Deploy-on-Azure).
### Quick Local Deploy (Docker)
For local testing or small-scale use, deploy Moonglade using Docker:
```bash
docker compose up -d
```
### Full Azure Deployment
This mirrors how [edi.wang](https://edi.wang) is deployed, utilizing a variety of Azure services for maximum speed and security. **No automated script is provided**—manual resource creation is required.
## 🛠️ Development
| Tools | Alternatives |
|----------------------------|----------------------------------------------------------------------------------------------------|
| [Visual Studio 2026](https://visualstudio.microsoft.com/) | [VS Code](https://code.visualstudio.com/) + [.NET 10.0 SDK](http://dot.net) |
| [SQL Server 2025](https://www.microsoft.com/en-us/sql-server/) | [LocalDB](https://learn.microsoft.com/en-us/sql/database-engine/configure-windows/sql-server-express-localdb?view=sql-server-ver16&WT.mc_id=AZ-MVP-5002809), PostgreSQL, or MySQL |
### Database Setup
> **Tip:** SQL Server Express (free) is sufficient for most production uses.
| Database | Example Connection String (`appsettings.json > ConnectionStrings > MoongladeDatabase`) |
|------------------|----------------------------------------------------------------------------------------------|
| SQL Server | `Server=(local);Database=moonglade;Trusted_Connection=True;` |
| MySQL | `Server=localhost;Port=3306;Database=moonglade;Uid=root;Pwd=***;` |
| PostgreSQL | `User ID=***;Password=***;Host=localhost;Port=5432;Database=moonglade;Pooling=true;` |
Change `ConnectionStrings:DatabaseProvider` in `appsettings.json` to match your database type.`
- SQL Server: `SqlServer`
- MySQL: `MySql`
- PostgreSQL: `PostgreSql`
### Build & Run
1. Build and run `./src/Moonglade.sln`
2. Access your blog:
- **Home:** `https://localhost:10210`
- **Admin:** `https://localhost:10210/admin`
- Default username: `admin`
- Default password: `admin123`
## ⚙️ Configuration
> Most settings are managed in `appsettings.json`. For blog settings, use the `/admin/settings` UI.
### Authentication
- By default: Local accounts (manage via `/admin/settings/account`)
- **Microsoft Entra ID** (Azure AD) supported. [Setup guide](https://github.com/EdiWang/Moonglade/wiki/Use-Microsoft-Entra-ID-Authentication)
### Captcha Shared Key
Please update the default key in `appsettings.json`:
```json
"CaptchaSettings": {
"SharedKey": ""
}
```
To generate a shared key, please see [this document](https://github.com/EdiWang/Edi.Captcha.AspNetCore?tab=readme-ov-file#shared-key-stateless-captcha-recommended-for-scalable-applications-without-dpapi)
### Image Storage
Configure the `ImageStorage` section in `appsettings.json` to choose where blog images are stored.
#### **Azure Blob Storage** (Recommended)
Create an [Azure Blob Storage](https://azure.microsoft.com/en-us/services/storage/blobs/) container with appropriate permissions:
```json
{
"Provider": "azurestorage",
"AzureStorageSettings": {
"ConnectionString": "YOUR_CONNECTION_STRING",
"ContainerName": "YOUR_CONTAINER_NAME"
}
}
```
- Enable CDN in admin settings for faster image delivery.
#### **File System** (Not recommended)
Windows:
```json
{
"Provider": "filesystem",
"FileSystemPath": "C:\\UploadedImages"
}
```
Linux:
```json
{
"Provider": "filesystem",
"FileSystemPath": "/app/images"
}
```
When using the file system, ensure the path exists and has appropriate permissions. If the path does not exist, Moonglade will attempt to create it.
Leave the `FileSystemPath` empty to use the default path (`~/home/moonglade/images` on Linux or `%UserProfile%\moonglade\images` on Windows).
### Comment Moderation
#### Local Moderation Provider
For basic keyword filtering, use the built-in local provider:
```json
"ContentModerator": {
"Provider": "Local",
"LocalKeywords": "fuck|shit",
"ApiEndpoint": "",
"ApiKey": ""
}
```
#### Remote Content Moderator
e.g. [Moonglade.ContentSecurity Azure Function](https://github.com/EdiWang/Moonglade.ContentSecurity):
```json
"ContentModerator": {
"Provider": "remote",
"ApiEndpoint": "",
"ApiKey": "",
"ApiKeyHeader": "x-functions-key"
}
```
Note: You can also implement your own content moderation API by mimicking the interface of Moonglade.ContentSecurity. You are not limited to Azure!
### Email Notifications
For notifications on new comments, replies and webmentions, use [Moonglade.Email Azure Function](https://github.com/EdiWang/Moonglade.Email):
```json
"Email": {
"ApiEndpoint": "",
"ApiKey": ""
}
```
Enable notifications in the admin portal.
### More Settings
- [System Settings](https://github.com/EdiWang/Moonglade/wiki/System-Settings)
- [Security HTTP Headers](https://github.com/EdiWang/Moonglade/wiki/Security-Headers)
## 📡 Protocols & Standards
| Name | Feature | Status | Endpoint |
|--------------|---------------|-------------|-----------------|
| RSS | Subscription | Supported | `/rss` |
| Atom | Subscription | Supported | `/atom` |
| OPML | Subscription | Supported | `/opml` |
| Open Search | Search | Supported | `/opensearch` |
| Pingback | Social | Deprecated | N/A |
| Webmention | Social | Supported | `/webmention` |
| Reader View | Reader Mode | Supported | N/A |
| FOAF | Social | Supported | `/foaf.xml` |
| IndexNow | SEO | Supported | N/A |
| RSD | Discovery | Deprecated | N/A |
| MetaWeblog | Blogging | Deprecated | N/A |
| Dublin Core | SEO | Basic | N/A |
## Health Check
To ensure your Moonglade instance is running, you can use the health check endpoint:
```
GET /health
```
This endpoint returns a simple JSON response indicating the status of your Moonglade instance.