Skip to content

Commit 2836cd0

Browse files
committed
Update readme
1 parent 706a15a commit 2836cd0

File tree

1 file changed

+33
-2
lines changed

1 file changed

+33
-2
lines changed

README.md

+33-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,33 @@
1-
# curl-timer
2-
Curl-timer is a very light Docker image that let you perform a curl in a configurable amount of time
1+
# Docker curl Timer
2+
You need a way to perform a curl inside a container every `TIMER` secs? And you don't want to use a cron job, because a Linux based image is too heavy for this work, right?
3+
Curl-Timer is your light solution.
4+
5+
Curl Timer is a very light Docker image that let you perform a curl in a configurable amount of time.
6+
7+
You can specify the `HTTP_VERB`, `URL`, `AUTH_TYPE` and `AUTH` you want to use.
8+
9+
Simply try it:
10+
11+
```
12+
docker run \
13+
-e HTTP_VERB='POST' \
14+
-e URL='https://example.com' \
15+
-e AUTH_TYPE='Basic' \
16+
-e AUTH='MyToken' \
17+
-e TIMER=600 \
18+
agiuliano/curl-timer
19+
```
20+
21+
22+
Or use it in your `docker-compose.yml` file:
23+
24+
```yaml
25+
timer:
26+
build: agiuliano/curl-timer
27+
environment:
28+
HTTP_VERB: POST
29+
URL: https://example.com
30+
AUTH_TYPE: Basic
31+
AUTH: MyToken
32+
TIMER: 600
33+
```

0 commit comments

Comments
 (0)