coop-cloud/parasol-static-site
coop-cloud/parasol-static-site
3
2
Fork 0
Code Issues 6 Pull Requests Packages Projects Releases Wiki Activity

add Usage section to README

Browse Source
This commit is contained in:
basebuilder 2024-11-26 16:06:01 +01:00
parent fb4a3fad43
commit 9fd5fef3d2
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -127,6 +127,24 @@ COMPOSE_FILE="compose.yml:compose.auth.yml:compose.private.yml"
```
## Usage
To trigger the deploy webhook with normal HTTP request
```bash
curl -v -XPOST https://example.org/deploy
```
To trigger the deploy webhook with HTTP Auth enabled, add the header with:
```bash
curl -v XPOST -H "Authorization: Basic <insert password token>" https://hook.com/deploy
```
Assuming all is setup correctly, you should see the build triggered
when viewing `abra app log example.org` log output.
## Troubleshooting
This is a WIP, there are likely dragons and foot cannons. Ye be warned :dragon: :pirate_flag: :grimacing: