zhamao-robot/zhamao-framework
1
0
Fork 0
mirror of https://github.com/zhamao-robot/zhamao-framework.git synced 2026-07-22 16:15:34 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update basic-config.md

Browse Source 
-Better display
This commit is contained in:
YiwanGi
2021-02-21 11:28:01 +08:00
committed by GitHub
parent 9ace85e604
commit 67e42cfe3e
1 changed files with 13 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/guide/basic-config.md
View File

@@ -4,7 +4,7 @@
!!! error "警告" !!! error "警告"
因为炸毛框架的全局配置中含有数据库名称和密码以及 access_token 等敏感字段，在使用版本控制软件过程中请不要将将敏感信息写入配置文件并提交至开源仓库！ 因为炸毛框架的全局配置中含有数据库名称和密码以及 access_token 等敏感字段，在使用版本控制软件过程中请不要将敏感信息写入配置文件并提交至开源仓库！
## 全局配置文件 global.php ## 全局配置文件 global.php
@@ -47,12 +47,18 @@
| 配置名称 | 说明 | 默认值 | | 配置名称 | 说明 | 默认值 |
| -------------------------- | ----------------------------------------------- | ---------------------------- | | -------------------------- | ----------------------------------------------- | ---------------------------- |
| `size` | 最多可以缓存的 k-v 条目数（必须是 2 的 n 次方） | 1024 | | `size` | 最多可以缓存的 k-v 条目数（必须是 2 的 n 次方） | 512 |
| `max_strlen` | 作为 value 字符串的最大长度 | 16384 | | `max_strlen` | 作为 value 字符串的最大长度 | 32768 |
| `hash_conflict_proportion` | Hash冲突率（越大越好，但是需要的内存更多） | 0.6 | | `hash_conflict_proportion` | Hash冲突率（越大越好，但是需要的内存更多） | 0.6 |
| `persistence_path` | 持久化的键值对的存储路径 | `zm_data` 下的 `_cache.json` | | `persistence_path` | 持久化的键值对的存储路径 | `zm_data` 下的 `_cache.json` |
| `auto_save_interval` | 持久化的键值对自动保存时间间隔（秒） | 900 | | `auto_save_interval` | 持久化的键值对自动保存时间间隔（秒） | 900 |
### 子表 worker_cache
| 配置名称 | 说明 | 默认值 |
| -------- | --------------------------- | ------ |
| `worker` | 跨进程缓存的存储工作进程 id | 0 |
### 子表 **sql_config** ### 子表 **sql_config**
| 配置名称 | 说明 | 默认值 | | 配置名称 | 说明 | 默认值 |
@@ -83,19 +89,13 @@
| `document_root` | 静态文件的根目录 | `{WORKING_DIR}/resources/html` | | `document_root` | 静态文件的根目录 | `{WORKING_DIR}/resources/html` |
| `document_index` | 默认索引的文件名列表 | `["index.html"]` | | `document_index` | 默认索引的文件名列表 | `["index.html"]` |
### 子表 worker_cache
| 配置名称 | 说明 | 默认值 |
| -------- | --------------------------- | ------ |
| `worker` | 跨进程缓存的存储工作进程 id | 0 |
## 多环境下的配置文件 ## 多环境下的配置文件
炸毛框架的配置文件模块支持不同环境下的配置文件，主要结构为 `global.{环境}.php`。在一般情况下，炸毛框架默认从教程引导方式根据指令 `vendor/bin/start server` 启动的框架是不带环境控制的。这章将讲述如何根据不同的环境（production / development / staging）来编写配置文件。 炸毛框架的配置文件模块支持不同环境下的配置文件，主要结构为 `global.{环境}.php`。在一般情况下，炸毛框架默认从教程引导方式根据指令 `vendor/bin/start server` 启动的框架是不带环境控制的。这章将讲述如何根据不同的环境（development / staging / production）来编写配置文件。
### 使用环境参数 ### 使用环境参数
在启动框架时，额外增加参数 `--env` 可以指定当前的环境，从而使用不同的配置文件。现在框架支持以下几种环境： `production`，`staging`，`development`。 在启动框架时，额外增加参数 `--env` 可以指定当前的环境，从而使用不同的配置文件。现在框架支持以下几种环境： `development`，`staging`，`production`。
```bash ```bash
vendor/bin/start server --env=development vendor/bin/start server --env=development
@@ -103,7 +103,7 @@ vendor/bin/start server --env=development
### 不同环境配置文件 ### 不同环境配置文件
由于框架默认只带有 `global.php` 文件，所以假设你现在需要区分开发环境和生产环境的配置，将 `global.php` 文件复制或改名为 `global.development.php` 或 `global.production.php` 即可。 由于框架默认只带有 `global.php` 文件，所以假设你现在需要区分开发环境和生产环境的配置，将 `global.php` 文件复制并重命名为 `global.development.php` 或 `global.production.php` 即可。
### 优先级 ### 优先级