You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
sonic/doc/README_ZH.md

67 lines
2.6 KiB
Markdown

2 years ago
<p align="center">
<img src="https://raw.githubusercontent.com/go-sonic/resources/master/logo/logo.png" />
</p>
<p align="center"><b>Sonic </b> [ˈsɒnɪk] ,Sonic 是一个用Golang开发的博客平台高效快速.</p>
<p align="center">
<a href="https://github.com/go-sonic/sonic/releases"><img alt="GitHub release" src="https://img.shields.io/github/release/go-sonic/sonic.svg?style=flat-square&include_prereleases" /></a>
<a href="https://github.com/go-sonic/sonic/releases"><img alt="GitHub All Releases" src="https://img.shields.io/github/downloads/go-sonic/sonic/total.svg?style=flat-square" /></a>
<a href="https://hub.docker.com/r/go-sonic/sonic"><img alt="Docker pulls" src="https://img.shields.io/docker/pulls/go-sonic/sonic?style=flat-square" /></a>
<a href="https://github.com/go-sonic/sonic/commits"><img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/go-sonic/sonic.svg?style=flat-square" /></a>
<a href="https://github.com/go-sonic/sonic/actions"><img alt="GitHub Workflow Status" src="https://img.shields.io/github/workflow/status/go-sonic/sonic/Sonic%20CI?style=flat-square" /></a>
<br />
<a href="https://t.me/go_sonic">Telegram 频道</a>
</p>
## 📖 介绍
Sonic 意为声速的、声音的,正如它的名字一样, sonic 致力于成为最快速的开源博客平台。
感谢 [Halo](https://github.com/halo-dev/) 项目组本项目的灵感来自Halo前端项目Fork自[Console](https://github.com/halo-dev)
## 🚀 Features:
- 支持多种类型的数据库SQLite、MySQL(TODO: PostgreSQL)
- 体积小: 安装包仅仅只有10Mb
- 高性能: 文章详情页可以达到1000 QPS(压测环境是: Intel Xeon Platinum 8260 4C 8G ,SQLite3)
- 支持更换主题
- 支持 Linux、Windows、Mac OS等主流操作系统支持x86、x64、Arm、Arm64、MIPS等指令集架构
- 支持对象存储(MINIO、Google Cloud、AWS、AliYun)
## 🧰 安装
### 下载对应平台的安装包
> 根据你的操作系统和指令集下载对应的安装包
```bash
wget https://github.com/go-sonic/sonic/releases/download/v1.0.0/sonic-linux-64.zip -O sonic.zip
```
### 解压
```bash
unzip sonic.zip
```
### 运行
> 可以通过 -config选项来指定配置文件的位置
```bash
cd sonic
./sonic -config conf/config.yaml
```
**然后你就可以通过浏览器访问sonic了默认的端口是8080**
后台管理路径是 http://ip:port/admin
## TODO
- [ ] i18n
- [ ] PostgreSQL
- [ ] 更好的错误处理
- [ ] 插件系统(基于 Wasm)
- [ ] 使用新的web框架([Hertz](https://github.com/cloudwego/hertz))
## 📄 License
Source code in `sonic` is available under the [MIT License](/LICENSE.md).