erudikaltd/scoold

Scoold - JAR包中的Stack Overflow

!https://raw.githubusercontent.com/Erudika/scoold/master/assets/header.png

镜像概述和主要用途

Scoold 是一个用Java编写的Q&A/知识库平台。该项目始于2008年，2012年作为受Stack Overflow启发的学校社交网络发布，2017年经过重构、重新打包并开源。

Scoold可在任何环境运行——Heroku、DigitalOcean、AWS、Azure或任何VPS hosting提供商。它轻量级（约7000行代码），后端由名为https://github.com/Erudika/para%E7%9A%84%E7%8B%AC%E7%AB%8B%E6%9C%8D%E5%8A%A1%E5%A4%84%E7%90%86%E3%80%82Scoold%E4%B8%8D%E9%9C%80%E8%A6%81%E6%95%B0%E6%8D%AE%E5%BA%93%EF%BC%8C%E6%8E%A7%E5%88%B6%E5%99%A8%E9%80%BB%E8%BE%91%E7%AE%80%E5%8D%95%EF%BC%8C%E5%9B%A0%E4%B8%BA%E6%89%80%E6%9C%89%E5%A4%8D%E6%9D%82%E5%B7%A5%E4%BD%9C%E9%83%BD%E5%A7%94%E6%89%98%E7%BB%99Para%EF%BC%8C%E8%BF%99%E4%BD%BF%E5%BE%97%E4%BB%A3%E7%A0%81%E6%98%93%E4%BA%8E%E9%98%85%E8%AF%BB%EF%BC%8C%E5%88%9D%E7%BA%A7%E5%BC%80%E5%8F%91%E4%BA%BA%E5%91%98%E5%8F%AF%E5%BF%AB%E9%80%9F%E5%AD%A6%E4%B9%A0%E3%80%82

Scoold Pro 是Scoold的付费版本，具备高级特性，是企业或团队理想的知识共享平台。

本项目由Erudika完全资助和支持——一家独立的自举公司。

核心功能和特性

免费版特性

• 全功能Q&A平台
• 数据库无关，优化云部署
• 全文搜索
• 分布式对象缓存
• 基于位置的搜索和“附近”帖子筛选
• 国际化支持（含RTL语言）
• 带徽章的声望和投票系统
• 空间（团队）——隔离的问题和用户组
• 带签名的Webhooks
• Zapier集成
• 基于jQuery的最小前端JS代码
• 由Materialize CSS驱动的现代响应式布局
• 相似问题建议和重复帖子提示
• 帖子回复和评论的邮件通知
• 备份和恢复
• OpenAPI 3.0定义的RESTful API
• Spring Boot项目（单个JAR）
• LDAP认证支持
• 社交登录（、Google、GitHub、LinkedIn、Microsoft、Slack、Amazon、），支持Gravatar
• 帖子代码语法高亮，支持GFM markdown（表格、任务列表、删除线）
• 从Stack Overflow for Teams导入数据
• 表情支持 - cheat sheet
• SEO友好
• Cookie同意（GDPR、CCPA等）

购买Scoold Pro 可获得额外高级特性：

• Slack集成
• Mattermost集成
• Microsoft Teams集成
• SAML认证支持
• 自定义认证支持
• 带通知的@提及功能
• 文件上传（本地、S3或Imgur）
• 账号封禁（永久封禁）
• ***帖子
• 无限空间
• 多管理员
• 多身份域
• 置顶/收藏帖子
• 高级语法高亮
• 近期问题邮件摘要
• 安全通知
• Wiki风格回答

...以及更多！

在线演示

Scoold演示 | Scoold Pro演示

管理员访问：打开Scoold Pro演示，使用“Demo login”登录。

演示有时可能需要一分钟加载。

Scoold架构介绍

Scoold是Para后端服务器的客户端应用。几乎每个Scoold请求都会生成至少一个Para请求。例如，在Scoold上提问时，会向Para发送POST /v1/questions请求。该架构的关键点：

• Para服务器可托管在任何地方，数据可存储在任何https://github.com/Erudika/para#database-integrations%E4%B8%AD
• Para是多租户服务器，数据存储在名为“apps”的隔离环境中
• 每个Scoold服务器实例需要一个Para应用用于数据存储
• 两个或多个Scoold实例（如集群）可连接到同一个Para应用环境并共享数据
• 多个独立的Scoold网站可使用不同的Para应用由同一个Para后端提供支持
• 每个应用环境完全隔离，有自己的数据库表和搜索索引
• Scoold和Para可托管在同一台机器或多台机器上，不同网络中
• Scoold通过HTTP与Para通信，因此Para必须可被Scoold直接访问，也可托管在私有网络中

架构概览：

                              ┌────────────┐
                          ┌───►  Database  │
┌──────────┐  ┌────────┐  │   ┌────────────┤
│ Scoold 1 ├──►        │  │   └────────────┤
├──────────┤  │  Para  ◄──┼───►   Search   │
│ Scoold 2 ├──►        │  │   ┌────────────┤
└──────────┘  └────────┘  │   └────────────┤
                          └───►   Cache    │
                              └────────────┘

快速开始

使用托管Para后端（更简单）

需要https://openjdk.java.net/%E6%9D%A5%E6%9E%84%E5%BB%BA%E5%92%8C%E8%BF%90%E8%A1%8C%E9%A1%B9%E7%9B%AE%EF%BC%8C%E6%94%AF%E6%8C%81%E6%89%80%E6%9C%89%E4%B8%BB%E6%B5%81%E6%93%8D%E4%BD%9C%E7%B3%BB%E7%BB%9F%E3%80%82

1. 在ParaIO.com创建新应用，将访问密钥复制到文件中
2. 创建名为application.conf的Scoold配置文件，添加以下属性：

ini
para.env = "development"
para.app_name = "Scoold"
para.access_key = "app:your_para_app"
para.secret_key = "your_app_secret_key"
para.endpoint = "https://paraio.com"
para.admins = "my@email.com"

3. 使用java -jar -Dconfig.file=./application.conf scoold-*.jar启动Scoold
4. 在浏览器中打开http://localhost:8000/signin/register
5. 使用配置中的***（如***）注册新账号

如果要使用社交账号登录，需先在***、[***]

重要： Google和***的授权重定向URL应格式化为：https://{your_scoold_host}、https://{your_scoold_host}/signin。其他身份提供商需将Para主机及其相应认证端点加入白名单。例如，GitHub的重定向URL为：https://paraio.com/github_auth，OAuth 2为https://paraio.com/oauth2_auth，依此类推。

使用自托管Para后端（更复杂）

注意：Para后端服务器需单独部署，是Scoold运行的必要条件。

1. 在本地端口8080运行Para，通过GET localhost:8080/v1/_setup初始化
2. 保存根Para应用的访问密钥，配置Para CLI工具时需要
3. 创建Scoold目录，包含application.conf文件，粘贴示例配置
4. 使用https://github.com/Erudika/para-cli%E5%B7%A5%E5%85%B7%E5%88%9B%E5%BB%BA%E5%90%8D%E4%B8%BA%60scoold%60%E7%9A%84%E6%96%B0Para%E5%BA%94%E7%94%A8%EF%BC%9A

sh
# 需先安装Node.js和NPM
$ npm install -g para-cli
# 运行setup，输入根应用密钥和端点'http://localhost:8080'
$ para-cli setup
$ para-cli ping
$ para-cli new-app "scoold" --name "Scoold"

5. 将密钥保存到Scoold的application.conf中，文件内容如下：

ini
para.env = "development"
para.app_name = "Scoold"
para.access_key = "app:scoold"
para.secret_key = "scoold_secret_key"
para.endpoint = "http://localhost:8080"
para.admins = "my@email.com"

6. 使用java -jar -Dconfig.file=./application.conf scoold-*.jar启动Scoold，关注日志中的错误信息
7. 在浏览器中打开http://localhost:8000，使用配置中的***注册账号

重要：不要将同一个application.conf文件用于Para和Scoold！ 保持两个应用在不同目录，各有自己的配置文件。若要使用***密码登录，生产环境部署前必须配置SMTP设置。

阅读Para文档了解如何运行和配置Scoold后端。

硬件要求

Scoold和Para可托管在同一台机器，至少需要3GB RAM。Scoold要求：

• 至少500MB RAM
• 1个或更多vCPU
• 10GB或更多磁盘空间（主要用于日志和存储图片）

Para要求：

• 至少1GB RAM
• 1个vCPU（推荐2个）
• 10GB或更多磁盘空间（除非数据库在其他机器上）

JVM参数示例：java -jar -Xms600m -Xmx600m scoold-*.jar

配置说明

最重要的设置是para.endpoint（Para服务器URL）、para.access_key和para.secret_key。Scoold运行必须连接到Para服务器。

复制以下Scoold示例配置到**application.conf**并根据需要编辑：

ini
### 基本配置 ###
# 应用名称
para.app_name = "Scoold"
# Scoold端口
para.port = "8000"
# 后续改为"production"
para.env = "development"
# Scoold的公开URL
para.host_url = "http://localhost:8000"
# Para的URL，也可使用"https://paraio.com"
para.endpoint = "http://localhost:8080"
# Para应用的访问密钥
para.access_key = "app:scoold"
# Para应用的密钥
para.secret_key = ""
# 管理员用户的邮箱或标识符 - 查看Para用户对象
para.admins = "admin@domain.com"
##############################

####### 认证 #######
# 启用/禁用邮箱密码认证
para.password_auth_enabled = true
# 会话cookie名称
para.auth_cookie = "scoold-auth"
# Facebook - 需先创建自己的Facebook应用！
para.fb_app_id = "123456789"
# Google - 需先创建自己的Google应用！
para.google_client_id = "123-abcd.apps.googleusercontent.com"
###############################

### 其他 ###
# 若为false，需100+声望才能评论
para.new_users_can_comment = true
# 若为true，新用户的帖子需管理员审核
para.posts_need_approval = false
# 帖子自动审核所需声望
para.posts_rep_threshold = 100
# 帖子地理定位筛选所需
para.gmaps_api_key = ""
# 启用/禁用“附近”功能（地理定位）
para.nearme_feature_enabled = false
# 启用帖子代码语法高亮
para.code_highlighting_enabled = true
# 若为true，默认空间对所有人可见
para.is_default_space_public = true
# 若为true，用户可更改头像
para.avatar_edits_enabled = true
# 若为true，用户可更改名称
para.name_edits_enabled = true
# 启用/禁用Webhooks支持
para.webhooks_enabled = true
# 启用/禁用Wiki风格回答
para.wiki_answers_enabled = true
# 评论限制
para.max_comments_per_id = 1000
para.max_comment_length = 255
# 帖子内容限制（字符）
para.max_post_length = 20000
# 每个帖子的标签限制，必须<100
para.max_tags_per_post = 5
# 新问题的默认标签
para.default_question_tag = "question"
# 启用/禁用数字分页（< 1 2 3...N >）
para.numeric_pagination_enabled = false
# 启动时加载的默认语言，默认为'en'
para.default_language_code = ""
# 启用/禁用文本编辑器中的基本HTML标签
para.html_in_markdown_enabled = false

启动时，Scoold会尝试连接Para 10次，每次间隔10秒。之后若失败，设置不会持久化。若将最大重试次数设为-1，则会无限尝试连接Para。这些参数由以下配置控制：

para.connection_retries_max = 10
para.connection_retry_interval_sec = 10

Docker部署

Scoold的标记Docker镜像位于Docker Hub的erudikaltd/scoold。强烈建议拉取发布版本镜像，如:1.42.0或:latest_stable，因为:latest标签可能不稳定。 :latest_stable标签始终指向最新发布版本。

Docker Run命令

在当前目录准备好application.conf配置文件，运行以下命令：

bash
docker run -ti -p 8000:8000 --rm -v $(pwd)/application.conf:/scoold/application.conf \
  -e JAVA_OPTS="-Dconfig.file=/scoold/application.conf" erudikaltd/scoold:latest_stable

Scoold Pro Docker Run命令

Scoold Pro镜像位于私有仓库，购买Pro许可证后可获取访问权限。运行命令需添加上传卷：

bash
docker run -ti -p 8000:8000 --rm -v $(pwd)/application.conf:/scoold-pro/application.conf \
  -v scoold-uploads:/scoold-pro/uploads -e JAVA_OPTS="-Dconfig.file=/scoold-pro/application.conf" \
  374874639893.dkr.ecr.eu-west-1.amazonaws.com/scoold-pro:latest_stable

环境变量

• JAVA_OPTS: Java系统属性，如-Dpara.port=8000
• BOOT_SLEEP: 启动延迟（秒数）

Docker Compose配置

使用docker-compose可一键启动Para + Scoold堆栈。创建新目录，复制docker-compose.yml（Scoold Pro的https://raw.githubusercontent.com/Erudika/scoold-pro/master/docker-compose.yml%EF%BC%89%EF%BC%8C%E5%B9%B6%E5%88%9B%E5%BB%BA%E4%BB%A5%E4%B8%8B%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6%EF%BC%9A

1. para-application.conf（Para配置示例）：

ini
para.env = "production"
para.dao = "H2DAO"

2. scoold-application.conf（Scoold配置示例）：

ini
para.env = "production"
para.app_name = "Scoold"
para.endpoint = "http://para:8080"
para.access_key = "app:scoold"
para.secret_key = "..."

启动命令：

bash
docker-compose up

初始化Para并创建Scoold应用后，更新scoold-application.conf，使用Ctrl+C停止容器，重新运行docker-compose up即可。

Kubernetes部署

helm/文件夹中包含Helm chart。编辑helm/scoold/values.yaml后，使用以下命令部署：

bash
cd helm; helm install ./scoold

更多信息请参考helm/README.md。

数据迁移

通过Scoold的备份和恢复功能可迁移数据：在源安装的管理页面下载备份ZIP文件，在目标安装的管理页面导入该文件。重要：所有数据将被覆盖。