Add example scripts / README example

Signed-off-by: Knut Ahlers <knut@ahlers.me>
This commit is contained in:
Knut Ahlers 2020-10-02 01:11:58 +02:00
parent 89916ea9b5
commit 06c38a3a97
Signed by: luzifer
GPG key ID: DC2729FDD34BE99E
4 changed files with 28 additions and 1 deletions

1
.gitignore vendored
View file

@ -1 +0,0 @@
scripts

View file

@ -9,3 +9,19 @@
`local-functions` is intended as the opposite of Cloud-Functions: Run scripts on the local machine through HTTP calls.
**Be aware:** This will expose scripts in a certain folder on your machine. This might cause trouble for you! So you really should only expose the server on **localhost** and ensure nobody else is able to access the API.
## Examples
```console
# curl -d '{"test": "foo"}' -H 'Content-Type: application/json' -X POST localhost:3000/echo
PWD=/home/luzifer/workspaces/private/go/src/github.com/Luzifer/local-functions
ACCEPT=*/*
SHLVL=1
CONTENT_TYPE=application/json
METHOD=POST
_=/usr/bin/env
=====
{"test": "foo"}
```

8
scripts/echo Executable file
View file

@ -0,0 +1,8 @@
#!/bin/bash
set -euo pipefail
env
echo -e "\n=====\n"
cat -s

4
scripts/test Executable file
View file

@ -0,0 +1,4 @@
#!/bin/bash
set -euo pipefail
echo "Test success"