ONLYOFFICE Server 项目安装与使用教程
1. 项目目录结构及介绍
ONLYOFFICE Server 项目的目录结构如下:
/github/workflows
/Common
/DocService
/FileConverter
/Metrics
/SpellChecker
/branding
/license
/schema
/tests
/.gitignore
/travis.yml
/3rd-Party.txt
/CHANGELOG.md
/Gruntfile.js
/LICENSE.txt
/Makefile
/Readme.md
/npm-shrinkwrap.json
/package.json
目录介绍
- github/workflows: 包含 GitHub Actions 的工作流配置文件。
- Common: 包含项目的通用配置和工具。
- DocService: 文档服务的主要代码。
- FileConverter: 文件转换服务的代码。
- Metrics: 用于收集和展示项目指标的代码。
- SpellChecker: 拼写检查服务的代码。
- branding: 品牌相关的资源和配置。
- license: 许可证相关的文件。
- schema: 数据库模式和初始化脚本。
- tests: 项目的测试代码。
- .gitignore: Git 忽略文件配置。
- travis.yml: Travis CI 配置文件。
- 3rd-Party.txt: 第三方依赖列表。
- CHANGELOG.md: 项目变更日志。
- Gruntfile.js: Grunt 任务配置文件。
- LICENSE.txt: 项目许可证文件。
- Makefile: Makefile 配置文件。
- Readme.md: 项目自述文件。
- npm-shrinkwrap.json: npm 依赖锁定文件。
- package.json: npm 包配置文件。
2. 项目启动文件介绍
项目的启动文件主要是 run.bat
脚本,位于项目根目录下。该脚本用于启动 ONLYOFFICE Server 服务。
启动步骤
- 打开命令行:在 Windows 系统中打开命令行工具(cmd)。
- 切换到项目目录:使用
cd /d 安装目录
命令切换到 ONLYOFFICE Server 的安装目录。 - 运行启动脚本:执行
run.bat
脚本,启动服务。
cd /d 安装目录
run.bat
3. 项目配置文件介绍
ONLYOFFICE Server 的配置文件主要位于 Common/config
目录下。以下是主要的配置文件及其用途:
配置文件列表
- default.json: 通用的配置文件,适用于所有生产版本。
- production-windows.json: 适用于 Windows 平台生产版本的配置文件。
- production-linux.json: 适用于 Linux 平台生产版本的配置文件。
- development-windows.json: 适用于 Windows 平台开发版本的配置文件。
配置文件示例
{
"server": {
"port": 8080
},
"database": {
"type": "mysql",
"host": "localhost",
"port": 3306,
"username": "onlyoffice",
"password": "onlyoffice"
}
}
配置文件修改
如果需要临时修改配置文件,可以在 Common/config
目录下创建 local.json
文件,并在其中重新定义配置项。这样可以避免在更新仓库时丢失本地修改。
{
"server": {
"port": 8081
}
}
通过以上步骤,您可以成功安装、配置和启动 ONLYOFFICE Server 项目。
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考