From 16209950dedb464adbd55ce031de22d2f76cc8b8 Mon Sep 17 00:00:00 2001 From: dameyerdave Date: Tue, 4 Jun 2024 12:45:49 +0200 Subject: [PATCH] [DOC] update documentation --- .vscode/settings.json | 2 +- README.md | 18 ++++++++++++++---- 2 files changed, 15 insertions(+), 5 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index a96fb50..7b8e01c 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -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, diff --git a/README.md b/README.md index 8111d9d..41fd6b5 100644 --- a/README.md +++ b/README.md @@ -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 @@ -68,6 +66,7 @@ services: volumes: - ./.acint:/do env_file: .env + restart: unless-stopped ``` ### `.env` @@ -75,7 +74,6 @@ services: ```bash ... SMNRP_UPSTREAMS=acint!acint:80 -SMNRP_UPSTREAM_PROTOCOL=http SMNRP_LOCATIONS=/acint/!http://acint/ ... ACINT_ALLOWED_ACTIONS=.deploy @@ -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 -``` \ No newline at end of file +``` + +### 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": "", "token": "" }' \ +https:///acint/ +```