Skip to content

Commit

Permalink
[DOC] update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
dameyerdave committed Jun 4, 2024
1 parent 77cb6a7 commit 1620995
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 5 deletions.
2 changes: 1 addition & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"editor.defaultFormatter": "ms-python.black-formatter",
"editor.formatOnSave": true,
"editor.codeActionsOnSave": {
"source.organizeImports": false
"source.organizeImports": "never"
}
},
"python.terminal.activateEnvironment": false,
Expand Down
18 changes: 14 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,9 @@ The following example `docker-compose` and `.env` shows how to run `acint` besid
### `docker-compose.yml`

```yaml
version: "3.9"
volumes:
web_root:
smnrp-data:

services:
ws:
image: ethnexus/smnrp
Expand All @@ -68,14 +66,14 @@ services:
volumes:
- ./.acint:/do
env_file: .env
restart: unless-stopped
```
### `.env`

```bash
...
SMNRP_UPSTREAMS=acint!acint:80
SMNRP_UPSTREAM_PROTOCOL=http
SMNRP_LOCATIONS=/acint/!http://acint/
...
ACINT_ALLOWED_ACTIONS=.deploy
Expand Down Expand Up @@ -146,4 +144,16 @@ The following entry can be added to the repository's owners crontab:

```crontab
* * * * * (sudo /path/to/project/scripts/redeployIfNeeded.sh 2>&1) >> /path/to/project/logs/redeploy.log
```
```

### Test `acint`

You can use `curl` to test it:

```bash
curl -i \
-H "Accept: application/json" \
-H "Content-Type:application/json" \
-X POST --data '{ "action": "<ACINT_ACTION>", "token": "<ACINT_TOKEN>" }' \
https://<host>/acint/
```

0 comments on commit 1620995

Please sign in to comment.