diff options
| author | Daniil Baturin <daniil@vyos.io> | 2021-07-21 12:13:23 +0000 |
|---|---|---|
| committer | Daniil Baturin <daniil@vyos.io> | 2021-07-21 12:13:23 +0000 |
| commit | 6a62545ace0836d6650a468e7cf4556a4bdcec3b (patch) | |
| tree | 1fd5e90b85344d7ee5094f3750cce5c73ebf5443 | |
| parent | ca24573251477448e2ddff55f5b32873558799f0 (diff) | |
| download | uncron-6a62545ace0836d6650a468e7cf4556a4bdcec3b.tar.gz uncron-6a62545ace0836d6650a468e7cf4556a4bdcec3b.zip | |
Document the build procedure.
| -rw-r--r-- | README.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..b09b013 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# uncron + +Uncron is a simple job queue service that reds 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 ocamlfind lwt lwt_ppx logs containers + +# Build uncron +cd src/ +make +``` + +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`. |