# KunYuan

**Repository Path**: cstcloud-cnic/kunyuan

## Basic Information

- **Project Name**: KunYuan
- **Description**: 坤元，fork from中坤
- **Primary Language**: Python
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 3
- **Created**: 2024-10-25
- **Last Updated**: 2026-01-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 关于KunYuan


## 环境搭建(CentOS10)
### 1 安装python和Git
请自行安装python2.11或3.12和Git。
使用Git拉取代码： 
```
git clone https://gitee.com/cstcloud-cnic/kunyuan.git
```
### 2 安装python运行环境
#### （1） 使用python虚拟环境
使用pip命令安装pipenv。  
```
pip3 install pipenv
```
在代码工程根目录下，即文件Pipfile同目录下运行命令：  
```
pipenv install
```
#### （2） 使用系统python环境
在代码工程根目录下，即文件requirements.txt同目录下运行命令：  
```pip3 install -r requirements.txt```

### 3 安全敏感信息配置文件
安全信息配置demo文件security_demo.py修改文件名为security.py，根据自己情况完成配置。

### 4 数据库安装
请自行安装mysql、Mariadb或TiDB数据库，根据自己的情况修改security.py文件中数据库的配置项。 
  ```
DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.mysql',  # mysql数据库引擎
        # 'ENGINE': 'django_tidb',    # TiDB数据库
        'NAME': 'xxx',  # 数据的库名，事先要创建之
        'HOST': '127.0.0.1',  # 主机
        'PORT': '3306',  # 数据库使用的端口
        'USER': 'xxx',  # 数据库用户名
        'PASSWORD': 'xxx',  # 密码
        'OPTIONS': {
            'init_command': "SET sql_mode='STRICT_TRANS_TABLES'",
            'charset': 'utf8mb4'
        }
    },
}
```   
### 5 运行服务
如果使用python虚拟环境，先激活python虚拟环境  
```
pipenv shell
```    
数据库迁移,在项目根目录下运行如下命令完成数据库迁移。  
```
python3 manage.py migrate
```
运行web服务  
```
python3 manage.py runserver 0:80
```   
如果一切正常，打开浏览器输入url(主机IP, 如：127.0.0.1)即可查看站点;


### 生成环境部署
部署方式不是唯一的，下面推荐一种方式，Python3.9+、Nginx、uwsgi。

* 项目代码必须放在路径/home/uwsgi/下，项目根目录下00_shell目录中有uwsgi的配置文件和几个sh脚本可以方便控制uwsgi启动关闭；
* 也可以使用systemctl管理服务，执行一下脚本config_systemctl.sh，会配置好kunyuan.service服务；
```
systemctl start/stop/reload kunyuan.service
```

* 有些接口需要获取客户端的ip地址，所以nginx需要配置标头X-Forwarded-For
```
X-Forwarded-For 可能伪造，需要在服务一级代理防范处理
比如nginx：
uwsgi_param X-Forwarded-For $remote_addr;     不能使用 $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-For $remote_addr;     不能使用 $proxy_add_x_forwarded_for;
```

* 服务有一些定时任务使用systemd实现，可以使用timertask命令管理，具体使用可以查看scripts/readme.md文件
```
python3 manage.py timertask [subcommand] [timer]
```