From 5cc7b21eb2f006130bfb0c94241774457f4d1d29 Mon Sep 17 00:00:00 2001 From: Serge Guzik Date: Sun, 17 Feb 2019 13:34:46 +0200 Subject: [PATCH] docs: Make separate docker README --- INSTALL.md | 15 +++------------ Dockerfile => docker/Dockerfile | 0 docker/README.md | 18 ++++++++++++++++++ 3 files changed, 21 insertions(+), 12 deletions(-) rename Dockerfile => docker/Dockerfile (100%) create mode 100644 docker/README.md diff --git a/INSTALL.md b/INSTALL.md index b9ed4e2..4296992 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -22,23 +22,14 @@ Previous command can be also used to upgrade to the latest version. ## Docker -``` -$ docker run --rm -it \ - -e "WARP4J_CACHE=/cache" \ - --volume :/cache \ - --volume :/workdir \ - --user $(id -u):$(id -g) \ - guziks/warp4j -``` - -Change according to your requirements, but volume with working directory is mandatory. +See docker hub [page](https://hub.docker.com/r/guziks/warp4j). ## Moor -To simplify the command above make a launcher with [moor](https://github.com/guziks/moor): +Instead of direct `docker run` command you can make a launcher with [moor](https://github.com/guziks/moor): ``` -$ moor guziks/warp4j warp4j +$ moor guziks/warp4j:stable warp4j ``` Then use as an ordinary command. diff --git a/Dockerfile b/docker/Dockerfile similarity index 100% rename from Dockerfile rename to docker/Dockerfile diff --git a/docker/README.md b/docker/README.md new file mode 100644 index 0000000..3d7b19c --- /dev/null +++ b/docker/README.md @@ -0,0 +1,18 @@ +# Warp4j + +Turn JAR (java archive) into self-contained executable in a single command. + +See project [page](https://github.com/guziks/warp4j) for more information. + +## Usage + +``` +$ docker run --rm -it \ + -e "WARP4J_CACHE=/cache" \ + --volume :/cache \ + --volume :/workdir \ + --user $(id -u):$(id -g) \ + guziks/warp4j:stable +``` + +Change according to your requirements, but volume with working directory is mandatory.