Solo 用户指南

简介

Solo 是一款小而美的开源博客系统，专为程序员设计。Solo 有着非常活跃的社区，文章自动推送到社区后可以让很多人看到，产生丰富的交流互动。

安装

本地试用

下载最新的 Solo 包解压，进入解压目录执行：

Windows: java -cp "WEB-INF/lib/*;WEB-INF/classes" org.b3log.solo.Starter
Unix-like: java -cp "WEB-INF/lib/*:WEB-INF/classes" org.b3log.solo.Starter

如果你有 Java 开发环境，可参考这里通过源码构建运行。

请注意：我们不建议通过 war 发布包或者源码构建部署，因为这样的部署方式在将来有新版本发布时升级会比较麻烦。这两种方式请仅用于本地试用，线上生产环境建议通过 Docker 部署。

Docker 部署

获取最新镜像：

docker pull b3log/solo

使用 MySQL

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

docker run --detach --name solo --network=host \
    --env RUNTIME_DB="MYSQL" \
    --env JDBC_USERNAME="root" \
    --env JDBC_PASSWORD="123456" \
    --env JDBC_DRIVER="com.mysql.cj.jdbc.Driver" \
    --env JDBC_URL="jdbc:mysql://127.0.0.1:3306/solo?useUnicode=yes&characterEncoding=UTF-8&useSSL=false&serverTimezone=UTC" \
    b3log/solo --listen_port=8080 --server_scheme=http --server_host=localhost

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

使用 H2 Database

docker run --detach --name solo --volume ~/solo_h2/:/opt/solo/h2/ --publish 8080:8080 \
    --env RUNTIME_DB="H2" \
    --env JDBC_USERNAME="root" \
    --env JDBC_PASSWORD="123456" \
    --env JDBC_DRIVER="org.h2.Driver" \
    --env JDBC_URL="jdbc:h2:/opt/solo/h2/db;MODE=MYSQL" \
    b3log/solo --listen_port=8080 --server_scheme=http --server_host=localhost

启动参数说明：

--listen_port：进程监听端口
--server_scheme：最终访问协议，如果反代服务启用了 HTTPS 这里也需要改为 https
--server_host：最终访问域名或公网 IP，不要带端口号

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

Docker 升级

拉取最新镜像
重启容器

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

NGINX 反代

upstream backend {
    server localhost:8080; # Solo 监听端口
}

server {
    listen       80;
    server_name  88250.b3log.org; # 博客域名

    access_log off;

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

初始化后

初始化成功后请务必查看自动发布的第一篇文章，里面有一些必要的操作，请务必完成。然后请到管理后台 -> 工具 -> 偏好设定中进行一下博客的细节配置。

信息配置

博客基本信息：标题、子标题、SEO 信息
HTML head：可以配置脚本，比如百度统计
公告：可以使用 HTML 和脚本进行配置
页脚：主要用来放备案信息，也可以使用 HTML 和脚本进行配置

签名档

最多可以配置 3 个签名档，发布文章的时候选择一个使用，可以使用 HTML 和脚本进行配置。

参数设置

下面是一些比较有特色或重要的参数：

列表显示方式：仅标题 / 标题 + 摘要 / 标题 + 正文
各种分页参数
文章更新提示：启用后一旦某篇文章更新过，则会在文章标题处显示“有更新”的提示，并且排序靠前
允许同步 GitHub 仓库：将文章数据自动导出到 GitHub 仓库，用于展示和备份

导入 Markdown

请参考 Solo 支持 Hexo/Jekyll 数据导入。

备份

安全第一，血泪的教训 😢

H2：备份用户 home 目录下的 solo_h2 文件夹
MySQL：使用 MySQL 相关备份工具，或者到博客后台工具 -> 其他中进行 SQL 导出

其他一些特性

多用户

可以几个用户同时使用一个博客发布文章，主要用在团队博客这个场景。权限方面做了简单隔离，非管理员用户可以看到其他用户的博文 / 评论列表，但是不能进行操作。

RSS/Atom

提供两种订阅供稿：Atom 1.0、RSS 2.0：

Atom: /rss.xml
RSS: /atom.xml

浏览器直接打开可能会出现编码，可使用阅读器查看。

Sitemap

自动生成全站文章的 sitemap.xml，有利于 SEO。

前台皮肤切换

通过 URL 带参（比如 http://88250.b3log.org/?skin=Finding）来确定渲染使用的皮肤。

使用场景举例：

在不安装 Solo 的情况下可以方便预览各个皮肤（在 Demo 上）
方便二次开发时集成切换皮肤
博主可以让访客体验到不同的效果，比如：这个皮肤好看？还是这个好看？

只有在首页（/）会取参数skin=xxx
如果带有就记录到 Cookie 里面，如果带有skin=default或皮肤不存在则清空 Cookie
如果要切换成后台默认的皮肤，在首页带参skin=default

站外相关文章

“站外相关文章”指的是其他人使用 Solo 发布的文章，该文章含有与你的文章相同的标签。该功能主要是为了加强各个 Solo 博客之间的互动性，让博客访问者可以更有效地访问到相关的内容。

这是 B3log 构思的一部分实现，请大家积极参与进来 💓

FAQ

服务器内存太小？

可以考虑使用内嵌的 H2 数据库代替 MySQL。如果一台服务器上要部署多个 Solo，可以考虑通过 war 包方式将它们部署到同一个 Tomcat/Jetty 中运行。

如何引入自定义静态资源，比如 .mp3？

请通过 NGINX 反代静态资源实现。

如何获得更好的 Markdown 渲染效果？

Solo 默认是使用内建的 flexmark 进行 md 渲染，可能对有的场景下的渲染效果不是很好。如果你想要获得更好的 md 渲染效果请参考这里。

如何指定移动端皮肤

可在 solo.props 中配置 mobile.skin 来指定移动端访问时的皮肤。请配置成目录名，区分大小写。

结语

如果你在使用 Solo 过程中碰到问题或者有需求要提，欢迎跟帖，我们会在第一时间回复。另外，如果你想对 Solo 进行定制开发，请参考 Solo 从设计到实现。

黑客派 Give the codes a soul.

简介

安装