自建OurBoard.io服务器:完整部署指南与环境配置
自建OurBoard.io服务器完整部署指南与环境配置【免费下载链接】ourboardAn online whiteboard项目地址: https://gitcode.com/gh_mirrors/ou/ourboardOurBoard.io是一款功能强大的在线白板工具支持多人实时协作适用于团队头脑风暴、项目规划和创意设计等场景。本指南将详细介绍如何在自己的服务器上部署OurBoard.io让你拥有专属的协作白板平台。准备工作系统要求与环境依赖在开始部署前请确保你的服务器满足以下基本要求操作系统Linux推荐Ubuntu 20.04或更高版本Docker20.10.x或更高版本Docker Composev2.x或更高版本Node.js18.x推荐使用nvm管理版本Git用于克隆项目代码核心依赖检查通过以下命令验证Docker和Node.js是否已正确安装docker --version docker-compose --version node --version快速部署使用Docker Compose一键启动OurBoard项目提供了完整的Docker化配置通过docker-compose可以快速部署整个服务栈包括PostgreSQL数据库、Keycloak认证服务和应用服务器。1. 克隆项目代码git clone https://gitcode.com/gh_mirrors/ou/ourboard cd ourboard2. 启动服务栈项目根目录下的docker-compose.yaml文件定义了完整的服务配置包括PostgreSQL数据库端口13338Keycloak认证服务端口8080应用服务组件执行以下命令启动所有服务docker-compose up -d3. 验证服务状态检查所有容器是否正常运行docker-compose ps正常情况下你应该看到db、keycloak-db和keycloak三个容器处于up状态。手动部署分步构建与配置如果你需要更灵活的部署方式可以选择手动构建和配置各个组件。1. 安装依赖包项目使用Yarn作为包管理器根目录的package.json定义了工作区配置和脚本命令# 安装项目依赖 yarn install # 构建所有模块 yarn build2. 配置数据库OurBoard使用PostgreSQL存储数据数据库迁移脚本位于backend/migrations/目录。手动配置数据库步骤# 启动数据库使用Docker docker run -d -p 13338:5432 \ -e POSTGRES_USERr-board \ -e POSTGRES_PASSWORDsecret \ --name ourboard-db postgres:12 # 运行数据库迁移 cd backend tsx src/tools/wait-for-db.ts # 迁移脚本将自动执行3. 启动后端服务后端服务代码位于backend/src/目录主要入口文件为server.ts# 开发模式启动 yarn dev:backend # 生产模式启动 yarn start:backend4. 构建并启动前端前端代码位于frontend/src/目录使用esbuild构建# 构建前端资源 cd frontend yarn build # 开发模式启动带热重载 yarn watch关键配置环境变量与服务端口OurBoard的核心配置文件位于backend/src/config.ts你可以通过环境变量或配置文件调整服务参数。主要环境变量PORT后端服务端口默认3001DATABASE_URL数据库连接地址默认postgres://r-board:secretlocalhost:13338/r-boardKEYCLOAK_URLKeycloak认证服务地址默认http://localhost:8080端口映射说明根据docker-compose.yaml配置服务默认端口映射如下应用服务3001PostgreSQL数据库13338Keycloak认证8080常见问题故障排除与性能优化1. 数据库连接失败如果后端服务无法连接数据库请检查PostgreSQL容器是否正常运行数据库用户名和密码是否与docker-compose.yaml中的配置一致网络是否允许容器间通信2. 性能优化建议数据库优化定期执行compact-history.ts清理历史数据资源限制在docker-compose中为各服务设置合理的内存限制静态资源通过Nginx代理前端静态资源提高加载速度启动与访问验证部署结果完成部署后通过以下步骤验证服务是否正常运行访问应用打开浏览器访问http://服务器IP:3001Keycloak认证首次访问需通过Keycloak登录默认管理员账号admin/admin创建白板登录后创建新白板邀请团队成员测试实时协作功能图OurBoard平台登录界面使用Keycloak进行身份验证总结通过本指南你已成功部署了自建的OurBoard.io服务器。无论是使用Docker Compose一键部署还是手动构建配置都可以根据实际需求灵活调整。OurBoard的实时协作功能将极大提升团队效率而自建服务器则确保了数据安全和隐私保护。如需进一步定制可以查阅项目中的state-management.md了解状态管理机制或修改frontend/src/components/目录下的UI组件来自定义界面。【免费下载链接】ourboardAn online whiteboard项目地址: https://gitcode.com/gh_mirrors/ou/ourboard创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考