[feat] add readme
This commit is contained in:
parent
6e1995364b
commit
f623c4f9c3
18
README.md
18
README.md
@ -1,2 +1,20 @@
|
||||
# auto-deploy-service
|
||||
|
||||
## Config struct
|
||||
|
||||
```yaml
|
||||
server:
|
||||
port: 10230 # server listen port
|
||||
listens:
|
||||
- http:
|
||||
method: get # http method only support get and post
|
||||
path: /test # http register path
|
||||
headers: # header check map[string]string
|
||||
x-validate-key: '123'
|
||||
script: /tmp/run.sh # script location required execute permission
|
||||
- http:
|
||||
method: post
|
||||
path: /test-post
|
||||
headers: {}
|
||||
script: /tmp/run.sh
|
||||
```
|
||||
|
Loading…
Reference in New Issue
Block a user