summaryrefslogtreecommitdiff
path: root/README.md
blob: fb731214b73bb2a8a162e0a52dc1f33071edf734 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
# uncron

Uncron is a simple job queue service that reads command from a UNIX domain socket
and executes them sequentially.

Its goal is to serve as an intermediate layer for tools that don't implement locking
and thus aren't safe to run in parallel.

## Installation

You need to install [OPAM](opam.ocaml.org/), the [OCaml](https://ocaml.org) package manager first.

Follow its [installation instructions](https://opam.ocaml.org/doc/Install.html).
OPAM is capable of installing the OCaml compiler itself and it will be 

```
# Initialize the opam environment and install the latest stable compiler
opam init

# Install dependencies
opam install lwt logs containers

# Build uncron
dune build

```

Then you can copy the `uncron` executable to somewehre in the `$PATH`.
On Linux, you can also use the systemd unit file from `data/uncron.service`.