登录 注册

Pipe 用户指南

本贴最后更新于 1626 天前，其中的信息可能已经时移世改

Pipe

小而美的博客平台，为未来而构建





English

💡 简介

Pipe 是一款小而美的开源博客平台，专为程序员设计。Pipe 有着非常活跃的社区，可将文章作为帖子推送到社区，来自社区的回帖将作为博客评论进行联动（具体细节请浏览 B3log 构思 - 分布式社区网络）。

这是一种全新的网络社区体验，让热爱记录和分享的你不再感到孤单！

欢迎到 Pipe 官方讨论区了解更多。同时也欢迎关注 B3log 开源社区微信公众号 B3log开源：

b3logos.jpg

🗃 案例

✨ 功能

  • 多用户博客平台
  • Markdown 编辑器支持三种编辑模式：所见即所得 / 即时渲染 / 分屏预览
  • 聚合分类 / 标签
  • 自定义导航
  • 多主题 / 多语言
  • Atom / RSS / Sitemap
  • 文章搜索
  • Hexo/Jekyll 导入 / 导出
  • 可配置动静分离
  • 支持 SQLite / MySQL / PostgreSQL

🎨 界面

开始使用

start.png

管理后台

console.png

编辑文章

post.png

主题选择

theme.png

主题 Gina

gina.png

🛠️ 安装

Pipe 仅支持通过 Docker 进行部署，如果你需要从源码构建可参考这里。

Docker 部署

获取最新镜像：

docker pull b3log/pipe

  • 使用 MySQL
    先手动建库（库名 pipe ，字符集使用 utf8mb4 ，排序规则 utf8mb4_general_ci ），然后启动容器：

    docker run --detach --name pipe --network=host \
    b3log/pipe --mysql="root:123456@(127.0.0.1:3306)/pipe?charset=utf8mb4&parseTime=True&loc=Local&timeout=1s" --runtime_mode=prod --port=5897 --server=http://localhost:5897

    为了简单，使用了主机网络模式来连接主机上的 MySQL。

  • 使用 SQLite

    docker run --detach --name pipe --volume ~/pipe.db:/opt/pipe/pipe.db --publish 5897:5897 \
    b3log/pipe --sqlite="/opt/pipe/pipe.db" --runtime_mode=prod --port=5897 --server=http://localhost:5897

启动参数说明：

  • --port：进程监听端口
  • --server：访问时的链接

完整启动参数的说明可以使用 -h 来查看。

Docker 升级

  1. 拉取最新镜像
  2. 重启容器

可参考这里编写一个重启脚本，并通过 crontab 每日凌晨运行来实现自动更新。

NGINX 反代

upstream pipe {
    server localhost:5897;
}

server {
    listen 80;
    server_name pipe.b3log.org; # 配置为你自己的域名

    location / {
        proxy_pass http://pipe$request_uri;
        proxy_set_header  Host $host:$server_port;
        proxy_set_header  X-Real-IP  $remote_addr;
        client_max_body_size  10m;
    }
}

另外，可以参考 Pipe 安装补充说明 进行配置。

📜 文档

🏘️ 社区

📄 授权

Pipe 使用 木兰宽松许可证, 第 2 版 开源协议。

🙏 鸣谢

  • jQuery：JavaScript 工具库，用于主题页面
  • Vue.js：渐进式 JavaScript 框架
  • Nuxt.js：Vue.js 框架
  • Vuetify：Vue.js 的 Material 组件框架
  • Vditor： 浏览器端的 Markdown 编辑器
  • Gin：又快又好用的 golang HTTP Web 框架
  • GORM：极好的 golang ORM 库
  • SQLite：使用广泛的嵌入式 SQL 引擎
  • GCache：golang 缓存库
  • Gulu：Go 语言常用工具库，这个轱辘还算圆
  • Lute：一款结构化的 Markdown 引擎，支持 Go 和 JavaScript

特性说明

发布文章

Pipe 的文章编辑器支持 Markdown，并支持复制/粘贴图片、粘贴 HTML 自动转换 Markdown、流程图、数学公式等。

另外，可以为文章启用自动配图，会自动在文章最前面插入所选择的配图。

聚合分类

Pipe 使用“自底向上”的分类方式：

  1. 定义分类，并配置该分类包含的标签
  2. 查询某个分类文章列表时通过分类-> 标签集-> 标签关联的文章进行聚合

也就是说一篇文章在编辑时只需要打标签，访问分类时会根据该分类包含的标签将文章关联出来。这是一个自底向上的信息架构，在使用时更灵活一些，可以随时调整分类而不必重新更新文章。

域名绑定

在 Pipe 平台上的每个博客都可以配置域名，需要博主和服务器运维者分别操作：

  1. 博主在设置 -> 基础配置 -> 博客地址一栏填写域名
  2. 运维者通过配置 NGINX 实现域名到 /blogs/{username} 的反向代理
server {
    listen 80;
    server_name vanessa.b3log.org;

    location / {
        proxy_pass http://pipe/blogs/Vanessa/;
    }
}

导入 / 导出

Pipe 支持导入 Hexo/Jekyll 的 Markdown 文件，将需要导入的 Markdown 文件使用 zip 压缩上传即可。导入时会按标题去重，并自动按原文章的创建时间生成存档。

同样地，Pipe 也支持 Markdown 导出，格式为 Hexo。

链滴

在 Pipe 上发布文章时可选择是否自动推送到链滴上，这样能让更多人看到你创作的内容，更容易引起大家的关注和互动。

运维

数据库

Pipe 使用 SQLite3 数据库引擎，数据文件默认情况下存放在 ~/pipe.db，可以通过修改 pipe.json 的 DataFilePath 指定新的存放路径。

建议定期备份数据文件，避免意外情况导致数据丢失。

版本升级

在管理后台的关于中可以检查版本更新，如果提示有更新请尽快升级，一般来说升级只需要下载新的发布包然后部署重启，实际升级方式以每次版本发布公告为准。

FAQ

如何做友链页面？

Pipe 没有单独的友链管理功能。可以通过发一篇文章，然后在导航管理中新建一个友链导航跳转过去。

结语

  • 如果你在使用 Pipe 的过程中碰到问题或者有需求要提，欢迎跟帖，我们会在第一时间回复 😄
  • 如果你想自己开发 Pipe，请参考 Pipe 开发指南
  • 如果你想自己开发 Pipe 主题，请参考 Pipe 主题开发指南
21 引用
(已解答)pipe-blog 是一个很好的博客，那么如何配置自定义域名呢？官方会关服吗？可以长久使用吗？ • ieras
PIPE 的 docker 安装 • 88250
pipe 支持独立域名么？ • 88250
Go 博客平台 Pipe v1.8.6 发布，支持标签管理 Go 博客平台 Pipe 1.8.5 发布，新皮肤 Littlewin Go 博客平台 Pipe 1.7.0 发布，支持本地账号 pipe 支持独立域名么？ Go 开源博客平台 Pipe 1.0.0 发布！ Go 开源博客平台 Pipe 1.1.0 发布！ Go 开源博客平台 Pipe 1.2.0 发布！ Go 开源博客平台 Pipe 1.3.0 发布！ Go 开源博客平台 Pipe 1.4.0 发布！ Go 开源博客平台 Pipe 1.5.0 发布！ Go 博客平台 Pipe 1.6.0 发布，支持 sitemap Go 博客平台 Pipe 1.7.0 发布，支持本地账号 Go 博客平台 Pipe 1.8.0 发布，支持摘要编辑 Pipe 搭建经历 Go 博客平台 Pipe 1.8.1 发布，新主题 Fara Go 博客平台 Pipe 1.8.2 发布，支持 GitHub 登录 Go 博客平台 Pipe 1.8.3 发布，支持 PJAX Go 博客平台 Pipe 1.8.4 发布，调整推荐阅读
6 操作
88250 在 2020-05-24 08:54:03 更新了该帖
88250 在 2020-04-13 11:29:41 更新了该帖
88250 在 2020-04-13 11:07:12 更新了该帖
88250 在 2020-04-02 19:34:08 更新了该帖 88250 在 2020-01-25 15:45:53 更新了该帖 88250 在 2019-12-22 18:28:15 更新了该帖
昆明 位置
1 感谢
10 关注
2 收藏
21 引用
6 操作
138 回帖
5
4
3
2
2
41.0k 1.4k 4.4k 7.4k 3 6.0k 2.7k 77 2.6k 16.0k

相关帖子

优质回帖
  • itstudying • • 1 赞同

    请教下 怎么配置一级域名直接到我的博客，而不是跳转到受欢迎的博客那页呢。

  • zonghua • • 1 • 1 赞同

    trollface 去掉了所有 /blogs/{username} 前缀，不让 D 大的阴谋得逞。trollface

        rewrite ^/(?!theme|console|admin|api|init) /blogs/zohar$request_uri break;

    location /{
        proxy_pass http://pipe/;
        proxy_set_header  Host $host:$server_port;
        proxy_set_header  X-Real-IP  $remote_addr;
        client_max_body_size  10m;
    }
  • nzmd • • 1

    请问下 1.89 版本 fara 主题，添加新的导航，没有配置图标，样式似乎有些问题
    微信截图 20191119115528.png

138 回帖
Pipe 用户指南

欢迎来到这里！

我们正在构建一个小众社区，大家在这里相互信任，以平等 • 自由 • 奔放的价值观进行分享交流。最终，希望大家能够找到与自己志同道合的伙伴，共同成长。

注册 关于
请输入回帖内容 ...
  • 6859 • 
    docker run --detach --name pipe --volume ~/pipe.db:/opt/pipe/pipe.db --publish 5897:5897 b3log/pipe --sqlite="/opt/pipe/pipe.db" --runtime_mode=prod --port=5897 --server=http://localhost:5897

    运行上面 docker 命令后，遇到如下错误，请问该怎么解决：

    docker logs --since 30m  428f103d5ee5
D 2020/03/24 19:22:59 confs.go:130: ${home} [/root]
D 2020/03/24 19:22:59 confs.go:148: ${time} [1585048979162434350]
D 2020/03/24 19:22:59 confs.go:183: configurations [&model.Configuration{Server:"http://localhost:5897", StaticServer:"http://localhost:5897", StaticResourceVersion:"1584632121767", LogLevel:"debug", ShowSQL:false, SessionSecret:"Zzr2pzi9CWE7sJ2qMhZFOet1VqYtYhx9", SessionMaxAge:86400, RuntimeMode:"prod", SQLite:"/opt/pipe/pipe.db", MySQL:"user:password@(localhost:3306)/pipe?charset=utf8mb4&parseTime=True&loc=Local&timeout=1s&readTimeout=16s&writeTimeout=16s", Port:"5897", AxiosBaseURL:"/api", MockServer:"http://localhost:8888"}]
D 2020/03/24 19:22:59 themes.go:43: loaded [7] themes
F 2020/03/24 19:22:59 db.go:44: opens database failed: unable to open database file: is a directory
    1 回复
  • 其他回帖
  • meizhaohui •

    为何我按"docker run --detach --name pipe --network=host
    b3log/pipe --mysql="root:123456@(127.0.0.1:3306)/pipe?charset=utf8mb4&parseTime=True&loc=Local" --runtime_mode=prod --port=5897 --server=http://localhost:5897"
    这条命令替换成自己的域名执行后，docker ps 查看不到正在运行的容器，浏览器也不能访问 http://mydomain.com:5897。

    希望楼主能改进一下用户指导手册，对小白更有帮助。谢谢。

    1 回复
  • zonghua • • 1 • 1 赞同

    trollface 去掉了所有 /blogs/{username} 前缀，不让 D 大的阴谋得逞。trollface

        rewrite ^/(?!theme|console|admin|api|init) /blogs/zohar$request_uri break;

    location /{
        proxy_pass http://pipe/;
        proxy_set_header  Host $host:$server_port;
        proxy_set_header  X-Real-IP  $remote_addr;
        client_max_body_size  10m;
    }
    4 回复
  • zxffffffff • 
    root@VM-0-10-ubuntu:/home/ubuntu# docker run --detach --name pipe --volume ~/pipe.db:/opt/pipe/pipe.db --publish 5897:5897 \
>     b3log/pipe --sqlite="/opt/pipe/pipe.db" --runtime_mode=prod --port=5897 --server=http://localhost:5897
0d3a2aadb27b2c621e6eb64c75d5cbe2b6c7cbe8e1522e3acb7b1295f80d4b82

root@VM-0-10-ubuntu:/home/ubuntu# curl http://localhost:5897
curl: (7) Failed to connect to localhost port 5897: Connection refused
  • 查看全部回帖
88250
但行好事莫问前程 昆明
回帖
33717
 帖子
712
 积分
168155