Sym 安装指南

本贴最后更新于 1598 天前,其中的信息可能已经渤澥桑田

本文档主要面向 Sym 社区版开发者,商业版采购后有单独的开发指南提供。

数据库

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

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

源码编译

后端

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

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

前端

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

Docker

  1. 拉镜像 docker pull b3log/symphony
  2. 启动容器
    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 配置文件请用挂卷方式覆盖容器内的配置文件。

细节说明

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

环境变量

配置文件 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.ftlsrc/main/webapp/skins/mobile/header.ftl 中修改 <svg><use xlink:href="#logo"></use></svg> 为对应的图片

更好的 Markdown 渲染

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

关于版本升级

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

    Sym 是一款用 Java 实现的现代化社区(论坛/BBS/社交网络/博客)系统平台。

    下一代的社区系统,为未来而构建

    522 引用 • 4581 回帖 • 687 关注
  • 安装

    你若安好,便是晴天。

    128 引用 • 1183 回帖
  • 部署
    21 引用 • 280 回帖
  • 文档
    56 引用 • 1288 回帖 • 2 关注
5 操作
88250 在 2019-11-12 10:07:23 更新了该帖
88250 在 2019-11-07 23:27:35 更新了该帖
88250 在 2019-11-06 20:05:21 更新了该帖
88250 在 2019-11-06 20:03:15 更新了该帖 88250 在 2019-11-06 19:56:16 更新了该帖

相关帖子

优质回帖
  • 88250 1 赞同

    看下 repository.json,里面有定义。

  • 88250 1 赞同

    应该是 mvn 打包不对引起的。

  • Andy123 1 赞同

    抱歉,没仔细看说明

171 回帖

欢迎来到这里!

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

注册 关于
请输入回帖内容 ...
  • 295524115

    如果我不用 CSRFCheck 会有什么严重的后果么

    1 回复
  • 其他回帖
  • xzy

    http://35.165.100.173:8080/symphony/admin 只是小白,想做个社区,可最后。。为什么会这个样子,是哪没弄对么
    和 https 有关么
    77a5925917ad4fef87201cf54c195875.png

    1 回复
  • EricIsCoding

    想问下 如何在 帖子里面 加入 想播放的音乐呢 ?
    我尝试了 先录音,生成了如下代码:

    <audio controls="controls" src="http://localhost:8080/upload/2160de8be73c46148348d39ecee11cce_blob.wav"></audio>
    

    于是 将 目标 音频地址 替换 中 SRC 结果
    还是无法播放。
    是否 限制了 必须是来自于本地的资源呢 ?

    还是可以配置 域名 IP 白名单呢?
    求大神 给个 思路😄

  • luoyafeng

    mvn install 之后,报如下错误:
    Tests run: 13, Failures: 1, Errors: 0, Skipped: 0, Time elapsed: 1.813 sec <<< FAILURE! - in TestSuite
    QueryDslBuilder(org.b3log.symphony.util.ElasticsearchTestCase) Time elapsed: 0.04 sec <<< FAILURE!
    java.lang.NoClassDefFoundError: org/joda/time/format/ISODateTimeFormat
    at java.net.URLClassLoader.findClass(URLClassLoader.java:381)
    at java.lang.ClassLoader.loadClass(ClassLoader.java:424)
    at sun.misc.Launcher$AppClassLoader.loadClass(Launcher.java:349)
    at java.lang.ClassLoader.loadClass(ClassLoader.java:357)
    at org.elasticsearch.common.xcontent.XContentBuilder.(XContentBuilder.java:72)
    at org.elasticsearch.common.xcontent.json.JsonXContent.contentBuilder(JsonXContent.java:38)
    at org.elasticsearch.common.xcontent.XContentFactory.contentBuilder(XContentFactory.java:122)
    at org.elasticsearch.common.xcontent.XContentFactory.jsonBuilder(XContentFactory.java:49)
    at org.elasticsearch.action.support.ToXContentToBytes.toString(ToXContentToBytes.java:73)
    at org.b3log.symphony.util.ElasticsearchTestCase.QueryDslBuilder(ElasticsearchTestCase.java:39)

    Results :

    Failed tests:
    ElasticsearchTestCase.QueryDslBuilder:39 » NoClassDefFound org/joda/time/forma...

    Tests run: 13, Failures: 1, Errors: 0, Skipped: 0

    [INFO] ------------------------------------------------------------------------
    [INFO] BUILD FAILURE
    [INFO] ------------------------------------------------------------------------

    1 回复
  • 查看全部回帖