Fledge 开源项目安装与使用教程
1. 项目目录结构及介绍
Fledge 项目的目录结构如下:
fledge/
├── contrib/
├── data/
├── dco-signoffs/
├── docs/
├── examples/
│ └── node-red/
├── extras/
├── python/
├── scripts/
├── tests-manual/
│ └── C/
│ └── services/
│ └── core/
├── tests/
├── .gitignore
├── readthedocs.yaml
├── ADOPTERS.MD
├── CMakeLists.txt
├── CONTRIBUTING.md
├── GOVERNANCE.MD
├── LICENSE
├── Makefile
├── README.rst
├── SECURITY.MD
├── VERSION
├── doxy.config
├── mkversion
└── requirements.sh
目录介绍
- contrib/: 包含项目的贡献者相关文件。
- data/: 存放项目的数据文件。
- dco-signoffs/: 包含开发者证书相关文件。
- docs/: 存放项目的文档文件。
- examples/node-red/: 包含 Node-RED 相关的示例代码。
- extras/: 存放额外的资源文件。
- python/: 包含 Python 代码文件。
- scripts/: 存放项目的脚本文件。
- tests-manual/C/services/core/: 包含手动测试相关的 C 代码文件。
- tests/: 存放自动化测试代码。
- .gitignore: Git 忽略文件配置。
- readthedocs.yaml: ReadTheDocs 配置文件。
- ADOPTERS.MD: 项目采用者列表。
- CMakeLists.txt: CMake 构建配置文件。
- CONTRIBUTING.md: 贡献指南。
- GOVERNANCE.MD: 项目治理文档。
- LICENSE: 项目许可证文件。
- Makefile: 项目构建文件。
- README.rst: 项目介绍文档。
- SECURITY.MD: 安全相关文档。
- VERSION: 项目版本文件。
- doxy.config: Doxygen 配置文件。
- mkversion: 版本生成脚本。
- requirements.sh: 项目依赖安装脚本。
2. 项目启动文件介绍
Fledge 项目的启动文件主要位于 scripts/
目录下。以下是主要的启动文件:
- scripts/fledge: 这是 Fledge 的核心启动脚本。通过运行
./scripts/fledge start
可以启动 Fledge 服务。
启动步骤
- 进入项目根目录。
- 运行启动脚本:
./scripts/fledge start
3. 项目配置文件介绍
Fledge 项目的配置文件主要位于 data/
目录下。以下是主要的配置文件:
- data/fledge.json: 这是 Fledge 的主配置文件,包含了服务的各种配置选项,如数据库连接、日志级别等。
配置文件示例
{
"database": {
"host": "localhost",
"port": 3306,
"username": "fledge",
"password": "fledge"
},
"logging": {
"level": "INFO"
}
}
配置文件修改
- 打开
data/fledge.json
文件。 - 根据需要修改配置项。
- 保存文件并重启 Fledge 服务以应用更改。
通过以上步骤,您可以成功安装、启动并配置 Fledge 项目。