安装

请参考 Sym 安装指南。

🏘️ 社区

📄 授权

社区版：使用 AGPLv3 开源，如果你选择使用社区版，则必须完全遵守 AGPLv3 的相关条款；公司使用必须购买商用授权
商业版：提供完整源码以便二开，报价 ¥20000，详情请看这里
云服务：提供开箱即用的云端服务，每年 ¥5000（暂时售罄）

关于商业版和社区版的对比请看这里，企业网站、经营性网站、以营利为目的或实现盈利的网站请购买商业版。

🙏 鸣谢

jQuery：前端 JavaScript 工具库
Vditor：浏览器端的 Markdown 编辑器
Highlight.js：前端代码高亮库
pjax：pushState + AJAX = pjax
Sass：前端 CSS 处理工具
jsoup：Java HTML 解析器
flexmark：Java Markdown 处理库
Apache Commons：Java 工具库集
Jodd：Java 工具库集
Latke：以 JSON 为主的 Java Web 框架

安全方面特别感谢：

from

https://github.com/88250/symphony

----------------------------------------------

Sym 安装指南

数据库

建议用 MySQL 8，最低支持 5.7
手动新建数据库 b3log_symphony，字符集用 utf8mb4，排序规则 utf8mb4_general_ci

数据库准备好后可选择如下方式部署。

源码编译

后端

拉源码 git clone https://github.com/88250/symphony.git
按需修改 src/main/resources/local.properties 中的数据库口令配置
```
jdbc.username=root  
jdbc.password=  
```
执行 mvn package 编译打包，完成后会生成 target/symphony 目录
在 symphony 目录下执行：
- Windows: java -cp "lib/*;." org.b3log.symphony.Server
- Unix-like：java -cp "lib/*:." org.b3log.symphony.Server

也可以下载我们打好的包解压后在根目录通过以上命令启动；在 IDE 中的话可以直接运行 Server.java

前端

下载 node
根目录命令行运行
```
npm i
```
开发时运行，以便调试
```
npm run dev
```
部署前运行，以便进行代码合并和压缩
```
npm run build
```

Docker

拉镜像 docker pull b3log/symphony

启动容器

docker run --detach --name sym --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/symphony?useUnicode=yes&characterEncoding=UTF-8&useSSL=false&serverTimezone=UTC" \
    b3log/symphony --listen_port=8080 --server_scheme=http --server_host=localhost --server_port=

启动参数说明：

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

完整启动参数的说明可以使用 -h 来查看。另外，sym.props 配置文件请用挂卷方式覆盖容器内的配置文件。

细节说明

数据库表会在第一次启动时自动创建，管理员账号 admin/admin
端口、访问路径等配置请参考 Latke 配置剖析
生产环境建议使用 NGINX 进行反向代理，并需要配置好 WebSocket 代理
千万不要手动修改数据库，否则可能会引发各种莫名其妙的问题

环境变量

配置文件 latke.props、local.props 以及 sym.props 均支持通过环境变量指定文件路径：

latke.props: LATKE_PROPS
local.props: LATKE_LOCAL_PROPS
symphony.props: SYM_PROPS

常用配置

图片上传默认是上传服务器本地，要使用七牛可配置 symphony.properties 中的 qiniu.* 属性
搜索需要使用 Algolia，配置 symphony.properties 中的 algolia.* 属性，也支持本地 Elasticsearch 但需要少量开发，具体请参考相关代码
邮件发送可以配置 3 种渠道：本地 JavaMail，SendCloud，阿里云邮件推送。具体请参考配置 symphony.properties 中的 mail.* 属性
用户注册需要验证邮箱，所以必须先配置好邮件；也可以通过管理员在后台的用户管理中直接添加用户

完整的配置项说明请参考 Sym 配置项说明（请注意该文档中提到的生产环境配置必须修改，否则可能存在安全隐患）

NGINX 示例

Sym 的回帖实时推送用了 WebSocket 技术，所以也需要对其配置反代。下面的示例仅供参考：

upstream backend_symphony {
    server localhost:8081;
}

map $http_upgrade $connection_upgrade {
  default upgrade;
  ''      close;
}

server {
    listen       80;
    server_name  hacpai.com;

    location / {
        proxy_pass http://backend_symphony$request_uri;
        proxy_http_version 1.1;
        proxy_set_header  Host $host:$server_port;
        proxy_set_header  X-Real-IP  $remote_addr;

        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection $connection_upgrade;
    }
}

技术资料

FAQ

部署后界面样式乱了

F12 看下网络请求，然后参考这里修改配置。

Logo 修改

方法一：src/main/webapp/js/symbol-defs.js 中修改 <symbol id="logo"...</symbol> 为对应的 svg
方法二：src/main/webapp/skins/classic/header.ftl 及 src/main/webapp/skins/mobile/header.ftl 中修改 <svg><use xlink:href="#logo"></use></svg> 为对应的图片

更好的 Markdown 渲染

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

关于版本升级

参考 CHANGE_LOGS 进行代码合并
留意 sym.props 配置项的增减
留意 repository.json 数据库表结构变更

链接：https://ld246.com/article/1486188905847

login url: www.hatena.ne.jp/login, 文章分类：https://briteming.hatenablog.com/categories

基于JDK+MySQL的论坛网站程序symphony

安装