Skip to content

Commit dd977f1

Browse files
committed
Added to-do section + some better explaining
Signed-off-by: rumd3x <edmurcardoso@gmail.com>
1 parent e06f199 commit dd977f1

File tree

1 file changed

+20
-10
lines changed

1 file changed

+20
-10
lines changed

README.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,22 +12,29 @@ The aim for this project is for dockerized environments. Containerized tasks ask
1212

1313
## Usage
1414

15-
You will probably want your tasks to persist after container recreation. So create a volume.
15+
You will probably want your tasks to persist after container recreation. So create a volume, and pass it as a mountpoint.
16+
1617
```sh
17-
$ docker volume create cronmanager-data
18+
docker volume create cronmanager-data
1819
```
1920

20-
Now run the image. You will also want the job manager to access your other containers, to manager them, so pass the `/var/run/docker.sock` as a volume too.
21+
You will also want the job manager to access your other containers, so it can manage them. For that, pass `/var/run/docker.sock` as a mountpoint.
22+
23+
This is a cronjob schedule related image, which is very time sensitive. So it is very important to get the your time settings right. Luckily this image supports the `TZ` environment var for setting the timezone, so no worries. Just make sure to get it right like in the example below.
24+
25+
The container exposes port `80` for using the web interface and the API, just forward that port to a port on your host. The web interface is located at `http://your.hostname:port/`. The API docs are below.
26+
27+
Now to run the image:
28+
2129
```sh
22-
$ docker run \
23-
-p 80:80 \
24-
-v cronmanager-data:/usr/src/app/.node-persist \
25-
-v /var/run/docker.sock:/var/run/docker.sock \
26-
edmur/cronjob-manager
30+
docker run \
31+
-p 80:80 \
32+
-v cronmanager-data:/usr/src/app/.node-persist \
33+
-v /var/run/docker.sock:/var/run/docker.sock \
34+
-e TZ="America/Sao_Paulo" \
35+
edmur/cronjob-manager
2736
```
2837

29-
The container exposes port `80` to the web interface and API, so forward that port to a port on your host.
30-
3138
## API
3239

3340
The web interface uses a REST API on the back-end that can also be called externally.
@@ -98,6 +105,9 @@ http://your-host/api/jobs/{id}
98105
| commandType | String | The command to execute on the container. |
99106
| active | Boolean | If the job is enabled or not. |
100107

108+
## To Do
109+
- Add current container time to web interface
110+
101111
## License
102112

103113
This project is open-source software licensed under the [MIT license](https://opensource.org/licenses/MIT).

0 commit comments

Comments
 (0)