Pipe 用户指南

简介

Pipe 是一款小而美的博客平台,通过黑客派账号登录即可使用。

安装与配置

启动

下载最新版本的发布包解压,修改 pipe.json。其中最关键的配置项是 Server,该项用于配置最终访问时的 IP 或域名。修改配置文件后运行 pipe,正常的话服务就启动了。

另外,运行 pipe 时可以带参数,用于覆盖 pipe.json 中的对应配置,具体可执行 pipe -h 进行参考。

数据库

默认的配置是使用 SQLite 作为数据库,如果要使用 MySQL 请将 SQLite 配置项的值改为空字符串:

{
    "Server": "http://localhost:5897",
    "StaticServer": "",
    "StaticResourceVersion": "1514429331501",
    "RuntimeMode": "dev",
    "LogLevel": "debug",
    "SessionSecret": "BEYOND",
    "SessionMaxAge": 86400,
    "SQLite": "",
    "MySQL": "user:password@(localhost:3306)/pipe?charset=utf8&parseTime=True&loc=Local",
    "StaticRoot": "",
    "Port": "5897",
    "AxiosBaseURL": "/api",
    "MockServer": "http://localhost:8888"
}

手动建立对应配置的数据库,字符集使用 utf8mb4 以支持 emoji 存储。

主题

下载的发布包中自带了所有官方皮肤,如果你是自己拉源码构建的,可以到这里下载主题。

下载后放到 theme/x 目录下后重启服务,在设置 -> 主题切换中选择使用即可。

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 的文章编辑器支持 Markdown,并支持复制 / 粘贴图片、粘贴 HTML 自动转换 Markdown、流程图、数学公式等。

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

聚合分类

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

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

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

域名绑定

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

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

导入 / 导出

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

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

黑客派

登录黑客派后访问 Pipe 就会自动创建一个博客。在 Pipe 上发布的文章将自动同步到黑客派上,这样能让更多人看到你创作的内容,更容易引起大家的关注和互动。

运维

数据库

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

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

版本升级

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

FAQ

一定要用黑客派账号登录吗?

是的,这是 Pipe 这个产品诞生的动机之一。通过建立【独立博客 - 聚合社区】的生态系统实现下一代的网络社交体验,详情请看 B3log 构思。如果你不赞同这个想法,请放弃使用。

如何做友链页面?

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

结语

如果你在使用 Pipe 的过程中碰到问题或者有需求要提,欢迎跟帖,我们会在第一时间回复 😄

另外,如果你想自己开发 Pipe 主题,请参考 Pipe 主题开发指南