Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
EdiWang committed Oct 4, 2023
1 parent 86cceef commit e13aa45
Showing 1 changed file with 36 additions and 10 deletions.
46 changes: 36 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,19 @@

The [.NET](https://dotnet.microsoft.com/) blog system that optimized for [**Microsoft Azure**](https://azure.microsoft.com/en-us/). Designed for developers, enabling most common blogging features including posts, comments, categories, archive, tags and pages.

**IMPORTANT: Moonglade will move to .NET 8 LTS in November 2023 with v14.x release**

## 📦 Deployment

- It is recommended to use stable code from [Release](https://github.com/EdiWang/Moonglade/releases) rather than master branch.
- Please use stable code from [Release](https://github.com/EdiWang/Moonglade/releases) branch rather than master branch.

- It is recommended to enable HTTP/2 support on your web server.

### ☁ Full Deploy on Azure (Recommend)
### ☁ Full Deploy on Azure

This is the way https://edi.wang is deployed, by taking advantage of as many Azure services as possible, the blog can run very fast and secure.

But there is no automated script to deploy it, you need to manually create all the resources and configure them.
There is no automated script to deploy it, you need to manually create all the resources.

![image](https://cdn-blog.edi.wang/web-assets/ediwang-azure-arch-visio-nov2022.png)

Expand All @@ -41,7 +43,7 @@ To quickly get it running on a new Linux machine without Docker, follow instruct

Tools | Alternative
--- | ---
[Visual Studio 2022 v17.4+](https://visualstudio.microsoft.com/) | [Visual Studio Code](https://code.visualstudio.com/) with [.NET 7.0 SDK](http://dot.net)
[Visual Studio 2022 v17.7+](https://visualstudio.microsoft.com/) | [Visual Studio Code](https://code.visualstudio.com/) with [.NET 7.0 SDK](http://dot.net)
[SQL Server 2022](https://www.microsoft.com/en-us/sql-server/sql-server-2022) | [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

### 💾 Setup Database
Expand Down Expand Up @@ -85,17 +87,17 @@ Build and run `./src/Moonglade.sln`

## ⚙ Configuration

> This section discuss system settings in **appsettings.[env].json**. For blog settings, please use "/admin/settings" UI.
**For production, it is strongly recommended to use Environment Variables over appsetting.json file.**
> This section discuss environment settings in **appsettings.[env].json**. For blog settings, please use "/admin/settings" UI.
### 🛡 Authentication

> You can choose one authentication provider from below.
#### [Microsoft Entra ID](https://azure.microsoft.com/en-us/services/active-directory/)

See [Wiki document](https://github.com/EdiWang/Moonglade/wiki/Use-Microsoft-Entra-ID-Authentication)

#### Local Account (Alternative)
#### Local Account

Set `Authentication:Provider` to `"Local"`. You can manage accounts in `/admin/settings/account`

Expand All @@ -118,7 +120,7 @@ You need to create an [**Azure Blob Storage**](https://azure.microsoft.com/en-us

When configured the image storage to use Azure Blob, you can take advantage of CDN for your image resources. Just enable CDN in admin settings, the blog will get images from CDN.

#### [Minio Blob Storage](https://min.io/) (Free)
#### [Minio Blob Storage](https://min.io/)

You need to hava an [**Minio Server**](https://docs.min.io/).

Expand Down Expand Up @@ -169,7 +171,7 @@ If you need email notification for new comments, new replies and pingbacks, you
- [X] RSD
- [X] MetaWeblog (Basic Support)
- [X] Dublin Core Metadata (Basic Support)
- [ ] BlogML - Under triage
- [ ] BlogML - Not planned
- [ ] APML - Not planned
- [ ] Trackback - Not planned

Expand All @@ -189,3 +191,27 @@ There are a few individuals already setup thier blogs using Moonglade on Azure (
- [王高峰博客](https://blog.wanggaofeng.net)

*Just Submit PR or issue if you want your blog to be listed here*

## Disclaimer

The following disclaimer applies to the software named "Moonglade" developed by Edi Wang and other [contributors](https://github.com/EdiWang/Moonglade/graphs/contributors) (hereinafter referred to as "the software developer"):

This project is not affiliated with Microsoft Corporation. All product names, logos, and brands are property of their respective owners. All company, product and service names used in this website are for identification purposes only. Use of these names, logos, and brands does not imply endorsement.

The software developer does not provide any warranties or guarantees regarding the functionality, performance, or suitability of Moonglade for any specific purpose. The software is provided "as is," and the software developer shall not be held liable for any direct or indirect damages arising from the use or inability to use Moonglade.

### Data Privacy

Moonglade does not send any user data or information to any government, **including the Chinese government**. The software is designed to prioritize and respect user privacy.

### Data Collection

While using Moonglade, please note that the platform on which you deploy the software may collect data and usage information. This data collection is solely the responsibility of the platform and not the software developer. We encourage you to review thier privacy policy and terms of service of the platform to understand how your data is handled.

### User Responsibility

As a user of Moonglade, it is your responsibility to ensure compliance with applicable laws and regulations regarding data privacy and usage. The software developer shall not be held liable for any misuse, unauthorized access, or mishandling of data by the user or the platform on which Moonglade is deployed.

### Updates and Modifications

The software developer may release updates or modifications to Moonglade from time to time. It is recommended that users stay informed about these updates and apply them to ensure optimal performance and security.

0 comments on commit e13aa45

Please sign in to comment.