docs: 凭证外置到 ~/.docsys/config.json,说明首次配置方式
This commit is contained in:
@@ -10,6 +10,13 @@
|
|||||||
|
|
||||||
## 通用约定
|
## 通用约定
|
||||||
|
|
||||||
|
- 凭证配置(`scripts/docsys.py` 读取顺序:命令行参数 > `~/.docsys/config.json` > 环境变量 > 内置默认地址):
|
||||||
|
```json
|
||||||
|
// ~/.docsys/config.json
|
||||||
|
{"baseUrl": "http://172.1.4.31:8100/DocSystem", "user": "x@y.com", "password": "xxx"}
|
||||||
|
```
|
||||||
|
环境变量:`DOCSYS_BASE_URL` / `DOCSYS_USER` / `DOCSYS_PASSWORD`。
|
||||||
|
仓库默认库可用 `DOCSYS_DEFAULT_REPO` 覆盖。**凭证不要提交进代码库。**
|
||||||
- 全部接口为 `POST`,表单编码 `application/x-www-form-urlencoded; charset=UTF-8`
|
- 全部接口为 `POST`,表单编码 `application/x-www-form-urlencoded; charset=UTF-8`
|
||||||
(仅 `uploadDoc.do` 为 `multipart/form-data`)。
|
(仅 `uploadDoc.do` 为 `multipart/form-data`)。
|
||||||
- 必须带请求头 `X-Requested-With: XMLHttpRequest`。
|
- 必须带请求头 `X-Requested-With: XMLHttpRequest`。
|
||||||
|
|||||||
@@ -11,6 +11,21 @@ agent_created: true
|
|||||||
|
|
||||||
底层是一个零依赖的 Python CLI:只用标准库,不需要 pip 安装任何东西。
|
底层是一个零依赖的 Python CLI:只用标准库,不需要 pip 安装任何东西。
|
||||||
|
|
||||||
|
## 首次配置(凭证)
|
||||||
|
|
||||||
|
凭证不写在代码里,从 `~/.docsys/config.json` 或环境变量读取。首次使用先建这个文件:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"baseUrl": "http://172.1.4.31:8100/DocSystem",
|
||||||
|
"user": "your.name@company.com",
|
||||||
|
"password": "your-password"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
也可用环境变量 `DOCSYS_BASE_URL` / `DOCSYS_USER` / `DOCSYS_PASSWORD`,或命令行 `--base-url` / `--user` / `--password` 临时覆盖。
|
||||||
|
未配置时 CLI 会直接提示配置文件路径,不会用空账号去撞登录接口。
|
||||||
|
|
||||||
## 快速开始
|
## 快速开始
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|||||||
Reference in New Issue
Block a user