:black_nib: Puti is a blog system written in Golang.
中文 | Engilsh
## 状态 Puti 项目现在仍在开发中。因为是作者接触 Go 语言的第一个项目，所以代码质量不到位之处，将会在未来不断优化，非常欢迎你的贡献。 ## 环境依赖 - Golang 1.11+ (Build using modules) - MySQL - Nginx (Optional) Golang 1.11 版本开始支持 go module，本项目使用了go module；Nginx 为可选配置。 ## 功能与计划 项目计划实现以及已经实现的功能如下： * [ ] 功能 * [ ] 登录注册 * [x] 登录 * [ ] 注册 * [ ] 第三方接入（github等） * [x] 文章 * [x] 页面 * [x] 分类 * [x] 标签 * [x] 专题 * [ ] 链接 * [x] 媒体 * [x] 用户 * [ ] 评论 * [ ] 设置 * [x] 普通设置 * [ ] 第三方设置（接入GItHub，WeChat等） * [ ] 主题 * [X] 主题支持 * [X] 默认主题（Emma） * [X] 自由切换 * [ ] 管理界面直接修改主题模板文件 * [ ] 插件 * [ ] 插件支持 * [ ] 插件管理（上传、删除等） * [ ] 邮件 * [ ] 邮件配置 * [ ] 邮件发送 * [ ] 技术支持 * [ ] 完善的 i18n * [ ] 邮件服务配置 * [ ] TOC (目前在前端主题实现) * [ ] 配置图片裁切 * [X] HTTPS * [x] WebServer 转发 * [ ] 头像接入 * [ ] OAuth * [ ] 媒体文件云存储 * [ ] 生态 * [x] Docker 镜像支持 * [x] 配置化的自动部署脚本 * [ ] 简单的统计系统 ## 截图   ## 快速开始 ### 配置 Puti 的配置文件位于configs下的config.yaml，初次使用可以从config.yaml.example 初始化配置文件。 需要注意的配置： | 配置 | 说明 | | :----- | :----- | | addr | HTTP 端口 | | jwt_secret | Json web token 秘钥 | | tls.https_open | 开启 HTTPS | | tls.addr | HTTPS 端口 | | tls.cert | SSL证书路径 | | tls.key | SSL私钥路径 | | db.name | 数据库名称 | | db.addr | 数据库 HOST:PORT | | db.username | 数据库登录名 | | db.password | 数据库密码 | ### 安装 #### 源码安装 源码安装要求系统已经安装要求版本的 Go 语言，因为建议使用 Go 1.11 及以上版本，所以我们不关注 GOPATH 的问题。 鉴于某种因素，为了有更好的包下载体验，项目中已经内置了 Vendor 目录，并且统一用 go module 来管理。 ```sh # 下载 $ go get -u github.com/puti-projects/puti # 使用Makefile来构建程序 $ cd $GOPATH/src/github.com/puti-projects/puti $ make ``` #### 使用 Docker ##### 使用现成的镜像 我们已经提供了现成的镜像，可以直接拉取使用： ```sh # 从 Docker Hub 拉取镜像 $ docker pull puti/puti # 创建需要挂载的目录，例如：`/data/puti`为应用文件存放目录，`/data/logs/puti`为日志存放目录 $ mkdir -p /data/puti /data/logs/puti # 第一次通过`docker run`来创建一个容器 $ docker run --name=puti -p 80:8000 -p 443:8080 -v /data/puti:/data/puti -v /data/logs/puti:/data/logs/puti puti/puti # 使用 `docker stop``docker start`来停止，关闭容器。 $ docker stop puti $ docker start puti ``` 更多内容查看：[Docker use](./scripts/docker/README.md) ##### 使用可配置的部署脚本 我们提供了简单方便地一键部署 Docker-compose 脚本文件，懒人必备。具体使用查看：[puti-projects/puti-environment](https://github.com/puti-projects/puti-environment) ### 使用 ## 主题 更多主题制作中。目前提供默认主题 Emma 和 Lin，为两种不同风格的主题。 ## 文档 TODO ## 更新日志 Detailed changes for each release are documented in the [changelog file]((https://github.com/axetroy/vscode-gpm/blob/master/CHANGELOG.md)). ## 依赖 | 依赖 | 关于 | | :----- | :----- | | [gin-gonic/gin](https://github.com/gin-gonic/gin) | HTTP web framework written in Go | | [jinzhu/gorm](https://github.com/jinzhu/gorm) | The ORM library for Golang| | [patrickmn/go-cache](https://github.com/patrickmn/go-cache) | An in-memory key:value store/cache| | [spf13/viper](https://github.com/spf13/viper) | Complete configuration solution| | [go.uber.org/zap](https://go.uber.org/zap) | Fast, structured, leveled logging| | [vuejs/vue](https://github.com/vuejs/vue) | JavaScript framework for building UI on the web | | [ElemeFE/element](https://github.com/ElemeFE/element) | A Vue.js 2.0 UI Toolkit for Web | | [PanJiaChen/vue-element-admin](https://github.com/PanJiaChen/vue-element-admin) | A front-end management background integration solution | | [hinesboy/mavonEditor](https://github.com/hinesboy/mavonEditor) | A markdown editor | ## Q & A ## 作者 Puti is a project by - Goozp ([@goozp](https://www.goozp.com)) ## 贡献 | [