# XConf

**Repository Path**: xupaul/XConf

## Basic Information

- **Project Name**: XConf
- **Description**: 基于Golang的，分布式配置中心
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://github.com/micro-in-cn/XConf
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2020-09-30
- **Last Updated**: 2025-01-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# XConf 分布式配置中心

[![Github Actions](https://github.com/micro-in-cn/XConf/workflows/CI/badge.svg)](https://github.com/micro-in-cn/XConf/actions)
[![Go Report Card](https://goreportcard.com/badge/github.com/micro-in-cn/XConf)](https://goreportcard.com/report/github.com/micro-in-cn/XConf)
[![GoDoc](https://godoc.org/github.com/micro-in-cn/XConf?status.svg)](https://godoc.org/github.com/micro-in-cn/XConf)
[![LICENSE](https://img.shields.io/badge/LICENSE-MIT-blue)](https://github.com/micro-in-cn/XConf/blob/master/LICENSE)
[![Code Size](https://img.shields.io/github/languages/code-size/micro-in-cn/XConf.svg?style=flat)](https://img.shields.io/github/languages/code-size/micro-in-cn/XConf.svg?style=flat)

`XConf` 基于 go-micro 构建的分布式配置中心，提供配置的管理与发布、实时推送.

## 使用本项目的公司

- [CHUR Networks](https://www.churnetworks.com/)

## 特点

- 修改实时推送
- 高效读取配置
- 支持界面管理、配置导入导出
- 支持服务器agent进程，程序无感知接入
- 安装部署方便，简单

## 服务架构

![image](doc/design.png)

- App
  - Cluster 集群 （A区，B区，C区）
    - Namespace 空间（可理解为一个个配置文件：db.json，db.toml）
      - Value 配置内容

## 目录结构

```text
.
├── LICENSE
├── README.md
├── admin-api   // 配置管理 api 服务
├── agent-api   // 配置获取，推送服务
├── client      // micro config 客户端插件
├── config-srv  // 配置管理服务
├── dashboard   // 前端UI
├── doc
├── go.mod
├── go.sum
├── micro       // micro api 网关
└── proto
```

## 前端 UI

线上 demo - http://xconf.mogutou.xyz/admin/ui

![image](doc/app.png)

![image](doc/cluster.png)

![image](doc/namespace.png)

![image](doc/rollback.png)

## 快速开始

- 依赖
    
    MySQL XConf 底层存储使用 mysql 数据库

    ```sql
    CREATE DATABASE xconf
    ```
    
    > root:12345@(127.0.0.1:3306)/xconf?charset=utf8&parseTime=true&loc=Local

-  docker 快速启动 all in one
    
    > 所有服务打包到一个容器中，仅仅作为快速预览使用，不可作为生产使用。
    
    ```shell script
    docker pull xuxu123/xconf-all:latest
    ```
    
    ```shell script
    docker run --name xconf -it --rm -p 8080:8080 -e BROADCAST=broker -e DATABASE_URL="root:12345@(IP地址:3306)/xconf?charset=utf8&parseTime=true&loc=Local" xuxu123/xconf-all
    ```
    
    UI： http://127.0.0.1:8080/admin/ui

- agent

    agent 负责实时获取指定 应用/集群 下的所有配置文件到指定文件夹中

    ```text
    NAME:
       agent - XConf agent client

    USAGE:
       main [global options] command [command options] [arguments...]

    VERSION:
       0.0.1

    COMMANDS:
         help, h  Shows a list of commands or help for one command

    GLOBAL OPTIONS:
       --url value, -u value      base url (default: "127.0.0.1:8080") [$XCONF_BASE_URL]
       --app value, -a value      app name [$XCONF_APP_NAME]
       --cluster value, -c value  cluster name [$XCONF_CLUSTER_NAME]
       --dir value, -d value      directory (default: "/tmp") [$XCONF_DIR]
       --help, -h                 show help
       --version, -v              print the version

    ```

    ```shell script
    docker run --name agent -v /tmp/docker-xconf:/tmp  -d  xuxu123/agent  -u http://xconf.mogutou.xyz -a test -c dev -d /tmp
    ```

## 客户端

- Golang  [pkg/client/example](pkg/client/example/main.go)
    
    ```shell script
    git clone https://github.com/micro-in-cn/XConf.git
    cd XConf/pkg/client/example
    go run main.go 
    ```

    客户端支持读取配置，实时获取配置更新（页面上"发布"操作才能触发配置推送，"保存"操作仅是保存配置）
    
## 部署与构建

- [docker compose 部署](https://github.com/micro-in-cn/XConf/tree/master/deployments/docker-compose)

- [源码运行](https://github.com/micro-in-cn/XConf/tree/master/doc/build.md)

## 感谢

XConf 参考了 Apollo 在业界成熟的设计方案。