Cherami Server 开源项目安装与使用指南

Cherami Server 开源项目安装与使用指南

cherami-server Distributed, scalable, durable, and highly available message queue system. This project is deprecated and not maintained. 项目地址: https://gitcode.com/gh_mirrors/ch/cherami-server

1. 项目目录结构及介绍

Cherami Server作为Uber曾经的核心分布式消息系统，其项目结构精心组织以支持高效的开发和维护。以下是项目的主要目录结构和各部分的简要说明：

cherami-server/
├── bin/                    # 编译后生成的可执行文件存放目录
├── cmd/                    # 应用的主命令入口，包含server等重要命令的执行文件
│   └── cherami-server      # 主程序启动文件所在目录
├── config/                 # 配置文件目录，包含基本配置(base.yaml)和特定环境配置(local.yaml)
│   ├── base.yaml           # 核心基础配置模板
│   └── local.yaml          # 本地运行时覆盖基础配置的文件
├── internal/               # 内部实现模块，封装了Cherami的具体逻辑实现
├── licenses/               # 许可证相关文件
├── pkg/                    # 包层级，包含了项目中的各种功能包
├── scripts/                # 脚本集合，用于数据库设置、测试等辅助操作
│   └── cherami-setup-schema # 初始化Cassandra数据库脚本
├── README.md               # 项目主读我文件
├── glide.lock              # Go依赖管理锁定文件
└── glide.yaml              # Go依赖管理配置文件

2. 项目的启动文件介绍

主要的启动文件位于cmd/cherami-server目录下。虽然直接的启动命令不是通过这个目录下的单个文件执行，但该目录定义了应用程序的入口点。启动Cherami Server通常涉及使用Makefile提供的目标来编译整个项目，之后通过控制台命令配合环境变量和配置文件来进行。

# 示例命令(非实际路径，需按实际情况调整)
make bins
CHERAMI_ENVIRONMENT=local ./bin/cherami-server start all

这表明，虽然没有直接的.exe或显式的启动脚本，但通过Makefile编译后的可执行文件结合环境变量设置和命令参数来启动服务。

3. 项目的配置文件介绍

Cherami Server的配置基于YAML格式的文件，主要有两个关键文件：

base.yaml

这是配置的基础版本，包含了服务默认的配置参数。这些参数适用于大多数标准部署情况，涵盖了从网络端口到存储设置的多个方面。

local.yaml

此文件被用来覆盖base.yaml中的某些配置，专为本地开发和测试环境定制。这允许开发者或运维人员调整配置，使其适应本地硬件或特殊测试要求，比如指向本地数据库实例或调整日志级别。

配置文件中的典型条目可能包括服务端口、数据库连接字符串、日志级别、以及是否启用调试模式等。修改这些配置时，需要考虑到对系统性能和安全的影响。

为了正确配置并启动Cherami Server，您应该阅读并理解这两个配置文件中的各个参数意义，并根据您的部署需求进行适当的调整。务必在更改配置后重新启动服务，以使改动生效。

cherami-server Distributed, scalable, durable, and highly available message queue system. This project is deprecated and not maintained. 项目地址: https://gitcode.com/gh_mirrors/ch/cherami-server