# symphony

**Repository Path**: emon123/symphony

## Basic Information

- **Project Name**: symphony
- **Description**: 一款用 Java 实现的现代化社区（论坛/BBS/社交网络/博客）平台。主库请访问 https://github.com/b3log/symphony
- **Primary Language**: Java
- **License**: AGPL-3.0
- **Default Branch**: master
- **Homepage**: https://sym.b3log.org
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 327
- **Created**: 2019-07-19
- **Last Updated**: 2024-08-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<p align = "center">
<img alt="Sym" src="https://user-images.githubusercontent.com/873584/52320309-9555a100-2a09-11e9-9252-f04dc47b0a31.png">
<br><br>
下一代的社区系统，为未来而构建
<br><br>
<a title="Build Status" target="_blank" href="https://travis-ci.org/b3log/symphony"><img src="https://img.shields.io/travis/b3log/symphony.svg?style=flat-square"></a>
<a title="Code Size" target="_blank" href="https://github.com/b3log/symphony"><img src="https://img.shields.io/github/languages/code-size/b3log/symphony.svg?style=flat-square"></a>
<a title="AGPLv3" target="_blank" href="https://www.gnu.org/licenses/agpl-3.0.txt"><img src="http://img.shields.io/badge/license-AGPLv3-orange.svg?style=flat-square"></a>
<a title="Releases" target="_blank" href="https://github.com/b3log/symphony/releases"><img src="https://img.shields.io/github/release/b3log/symphony.svg?style=flat-square"></a>
<br>
<a title="Release Date" target="_blank" href="https://github.com/b3log/symphony/releases"><img src="https://img.shields.io/github/release-date/b3log/symphony.svg?style=flat-square&color=99CCFF"></a>
<a title="Downloads" target="_blank" href="https://github.com/b3log/symphony/releases"><img src="https://img.shields.io/github/downloads/b3log/symphony/total.svg?style=flat-square"></a>
<a title="Docker Pulls" target="_blank" href="https://hub.docker.com/r/b3log/symphony"><img src="https://img.shields.io/docker/pulls/b3log/symphony.svg?style=flat-square&color=blueviolet"></a>
<a title="Docker Image Size" target="_blank" href="https://hub.docker.com/r/b3log/symphony"><img src="https://img.shields.io/microbadger/image-size/b3log/symphony.svg?style=flat-square&color=ff96b4"></a>
<br>
<a title="GitHub Commits" target="_blank" href="https://github.com/b3log/symphony/commits/master"><img src="https://img.shields.io/github/commit-activity/m/b3log/symphony.svg?style=flat-square"></a>
<a title="Last Commit" target="_blank" href="https://github.com/b3log/symphony/commits/master"><img src="https://img.shields.io/github/last-commit/b3log/symphony.svg?style=flat-square&color=FF9900"></a>
<a title="GitHub Pull Requests" target="_blank" href="https://github.com/b3log/symphony/pulls"><img src="https://img.shields.io/github/issues-pr-closed/b3log/symphony.svg?style=flat-square&color=FF9966"></a>
<a title="Hits" target="_blank" href="https://github.com/b3log/hits"><img src="https://hits.b3log.org/b3log/symphony.svg"></a>
<br><br>
<a title="GitHub Watchers" target="_blank" href="https://github.com/b3log/symphony/watchers"><img src="https://img.shields.io/github/watchers/b3log/symphony.svg?label=Watchers&style=social"></a>&nbsp;&nbsp;
<a title="GitHub Stars" target="_blank" href="https://github.com/b3log/symphony/stargazers"><img src="https://img.shields.io/github/stars/b3log/symphony.svg?label=Stars&style=social"></a>&nbsp;&nbsp;
<a title="GitHub Forks" target="_blank" href="https://github.com/b3log/symphony/network/members"><img src="https://img.shields.io/github/forks/b3log/symphony.svg?label=Forks&style=social"></a>&nbsp;&nbsp;
<a title="Author GitHub Followers" target="_blank" href="https://github.com/88250"><img src="https://img.shields.io/github/followers/88250.svg?label=Followers&style=social"></a>
</p>

## 简介

[Symphony](https://sym.b3log.org)（[ˈsɪmfəni]，n.交响乐）是一个现代化的社区平台，因为它：

* 实现了面向内容讨论的论坛
* 实现了面向知识问答的社区
* 包含了面向用户分享、交友、游戏的社交网络
* `100%` 开源

欢迎到 [Sym 官方讨论区](https://hacpai.com/tag/sym)了解更多。

## 动机

很多社区论坛系统：

* 界面风格老式，没有跟上时代发展的步伐
* 缺少创新、好玩的特性，缺少现代化的交互元素和用户体验
* 缺乏考虑实际运营需求，管理功能过于单一
* 细节不够精致、缺乏长期维护 

## 客户案例

社区版：

* [宽客网](http://www.cnq.net)
* [AIQ-机器学习](http://www.6aiq.com)
* [许昌IT圈](http://www.xcitq.com)
* [凤凰匯](https://www.fengd.com)
* [猪玩派 | 喜欢游玩  热爱生活  乐于分享！](http://pigplay.net)
* [俩猴网](http://www.xfx77.cn)
* [听雨轩](http://nucode.cn)
* [艺赛旗 RPA](http://support.i-search.com.cn)（商用授权）
* [北极社区](https://begeek.bwae.org)（商用授权）
* [神州邦邦](https://c.shenzhoubb.com)（商用授权）
* ......

商业版：

* [黑客派](https://hacpai.com)
* [IT遇岛](https://www.ityudao.com)
* [汇桔网](https://bbs.wtoip.com)
* [乾学院](http://c.raqsoft.com.cn)
* [GeeCall极客社区](http://geecall.com)
* [金蝶精斗云社区](https://cs.jdy.com)
* ......

## 功能

* [Sym 简介幻灯片](https://sym.b3log.org/syme-intro.pptx)
* [Sym 功能点脑图](http://naotu.baidu.com/file/cd31354ac9abc047569c73c560a5a913)

[![Sym功能点](https://user-images.githubusercontent.com/873584/59412885-07dbf080-8df1-11e9-8088-266d6eaf7dbc.jpg)](http://naotu.baidu.com/file/cd31354ac9abc047569c73c560a5a913)

## 界面

以下截图来自 Sym 商业版。

**首页**

![index](https://user-images.githubusercontent.com/970828/56900939-96a6df00-6ac9-11e9-8ccd-11c632f20506.png)

**列表**

![list](https://user-images.githubusercontent.com/970828/56901344-89d6bb00-6aca-11e9-8123-ba71866b0427.png)

**帖子**

![article](https://user-images.githubusercontent.com/970828/56900937-960e4880-6ac9-11e9-9044-4ed88d073892.png)

**发帖**

![post](https://user-images.githubusercontent.com/970828/56900946-973f7580-6ac9-11e9-93e4-2c195952e427.png)

**用户 - PC 端**

![pc home](https://user-images.githubusercontent.com/970828/56903351-b7256800-6ace-11e9-8ca8-3152d79e78b5.png)

**用户 - 移动端**

<p align="center">
    <img src="https://user-images.githubusercontent.com/970828/56901849-a1fb0a00-6acb-11e9-86f0-4f0a22ef6fca.png" alt="mobile home">
</p>

## 安装

先在 MySQL 中手动建库（库名 `symphony`，字符集使用 `utf8mb4`，排序规则 `utf8mb4_general_ci`），然后按照如下方式之一启动服务。

### war 包启动

[下载](https://github.com/b3log/symphony/releases)最新的 Sym 包解压，进入解压目录执行：

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

如果要将 war 包部署到 Servlet 容器中启动请参考[安装指南](https://hacpai.com/article/1486188905847)。

### Docker 部署

获取最新镜像：

```shell
docker pull b3log/symphony
```

启动容器：

```shell
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 
```
为了简单，使用了主机网络模式来连接主机上的 MySQL。
 
启动参数说明：

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

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

## 文档

* [《提问的智慧》精读注解版](https://hacpai.com/article/1536377163156)
* [Sym 安装指南](https://hacpai.com/article/1486188905847)
* [Sym 配置项说明](https://hacpai.com/article/1524715380797)
* [Sym 贡献指南](https://github.com/b3log/symphony/blob/master/CONTRIBUTING.md)

## 授权

* 社区版：使用 AGPLv3 开源，如果你选择使用社区版，则必须完全遵守 AGPLv3 的相关条款
* 商业版：提供完整源码以便二开，报价 ¥20000
* 云服务：提供开箱即用的云端服务，每年 ¥5000

**关于商业版和社区版的对比请看[这里](https://hacpai.com/article/1500543226433)，企业网站、经营性网站、以营利为目的或实现盈利的网站请购买商业版。**

欢迎联系 QQ `845765` 或邮箱 `d@b3log.org` 进行细节咨询。

## 社区

* [讨论区](https://hacpai.com/tag/sym)
* [报告问题](https://github.com/b3log/symphony/issues/new/choose)

## 鸣谢

* [jQuery](https://github.com/jquery/jquery)：前端 JavaScript 工具库
* [Vditor](https://github.com/b3log/vditor)： 浏览器端的 Markdown 编辑器
* [Highlight.js](https://github.com/isagalaev/highlight.js)：前端代码高亮库
* [pjax](https://github.com/defunkt/jquery-pjax)：pushState + ajax = pjax
* [MathJax](https://github.com/mathjax/MathJax)：前端数学公式渲染引擎
* [Sass](http://sass-lang.com)：前端 CSS 处理工具
* [jsoup](https://github.com/jhy/jsoup)：Java HTML 解析器
* [flexmark](https://github.com/vsch/flexmark-java)：Java Markdown 处理库
* [Apache Commons](http://commons.apache.org)：Java 工具库集
* [Jodd](https://github.com/oblac/jodd)：Java 工具库集
* [Latke](https://github.com/b3log/latke)：以 JSON 为主的 Java Web 框架

安全方面特别感谢：

* [米斯特安全团队](http://www.hi-ourlife.com)
* [@gh0stkey](https://github.com/gh0stkey)
* [@SeagullGR](https://github.com/SeagullGR)
* [长亭科技](https://www.chaitin.cn)

---

## 开源项目推荐

* 如果你需要搭建一个个人博客系统，可以考虑使用 [Solo](https://github.com/b3log/solo)
* 如果你需要搭建一个多用户博客平台，可以考虑使用 [Pipe](https://github.com/b3log/pipe)
* 欢迎加入我们的小众开源社区，详情请看[这里](https://hacpai.com/article/1463025124998)