docs(README): mention fail-with-body in curl

This commit is contained in:
2026-05-03 19:01:37 +02:00
parent 91ea4cee23
commit a65c3dd944
+10 -1
View File
@@ -115,18 +115,21 @@ PUT /{page}/
# create archive from 'dist' dir and upload it to /my-project/
tar -czC dist -f dist.tar.gz .
curl -X PUT \
--fail-with-body \
-H 'X-Token: <TOKEN>' \
--data-binary "@dist.tar.gz" \
https://stapler-host/my-project/
# same thing but one-liner
tar -czC dist . | curl -X PUT \
--fail-with-body \
-H 'X-Token: <TOKEN>' \
--data-binary @- \
https://stapler-host/my-project/
# make stapler server identify myproject.example.com and /my-project/
tar -czC dist . | curl -X PUT \
--fail-with-body \
--data-binary @- \
-H 'X-Token: <TOKEN>' \
-H 'X-Host: myproject.example.com' \
@@ -134,6 +137,7 @@ tar -czC dist . | curl -X PUT \
# make stapler server identifiers myproject.example.com only
tar -czC dist . | curl -X PUT \
--fail-with-body \
--data-binary @- \
-H 'X-Token: <TOKEN>' \
-H 'X-Host-Only: myproject.example.com' \
@@ -141,6 +145,7 @@ tar -czC dist . | curl -X PUT \
# make a SPA site at /my-project/index.html
tar -czC dist . | curl -X PUT \
--fail-with-body \
--data-binary @- \
-H 'X-Token: <TOKEN>' \
-H 'X-SPA: index.html' \
@@ -163,12 +168,14 @@ PUT /{page}/
```bash
# create /my-project/ that redirects to https://github.com/my-project
curl -X PUT \
--fail-with-body \
-H 'X-Token: <TOKEN>' \
-H 'X-Redirect: https://github.com/my-project' \
https://stapler-host/my-project/
# simple redirect from root host to www
curl -X PUT \
--fail-with-body \
-H 'X-Token: <TOKEN>' \
-H 'X-Proxy: https://www.my-website.com' \
-H 'X-Host: my-website.com' \
@@ -188,6 +195,7 @@ PUT /{page}/
```bash
# create /my-website/ that proxies to http://host.containers.internal:8000
curl -X PUT \
--fail-with-body \
-H 'X-Token: <TOKEN>' \
-H 'X-Proxy: http://host.containers.internal:8000' \
https://stapler-host/my-project/
@@ -203,6 +211,7 @@ DELETE /{page}/
```bash
# delete /my-project/
curl -X DELETE \
--fail-with-body \
-H 'X-Token: <TOKEN>' \
https://stapler-host/my-project/
```
@@ -229,7 +238,7 @@ curl -X DELETE \
run: tar -czC dist -f dist.tar.gz .
- name: Deploy to Stapler server
run: |
curl -X PUT --data-binary "@dist.tar.gz" \
curl -X PUT --fail-with-body --data-binary "@dist.tar.gz" \
-H 'X-Token: ${{ secrets.STAPLER_TOKEN }}' \
-H 'X-Host: ${{ vars.TARGET_HOST }}' \
${{ vars.STAPLER_URL }}