public/warp4j
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 3 Wiki Activity

docs: Make separate INSTALL document

Browse Source
This commit is contained in:
Serge Guzik 2019-02-16 21:12:03 +02:00
parent 85c9732271
commit a490e3f868
2 changed files with 47 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
INSTALL.md Normal file
View File

@ -0,0 +1,44 @@
# Install
Here are several more ways to install `warp4j`.
## Manual
First install [warp-packer](https://github.com/dgiagio/warp/releases) and ensure other common tools available: `awk`, `curl`, `file`, `grep`, `sed`, `sort`, `tar`, `unzip`, optional: `zip`. Then install `warp4j` like this:
```
$ LOCATION=/usr/local/bin \
LINK=https://raw.githubusercontent.com/guziks/warp4j/master/warp4j \
TEMP_LOCATION=/tmp/warp4j \
bash -c 'curl -fsSL -o $TEMP_LOCATION $LINK && \
sudo install -D \
--mode=755 \
--owner=root \
--group=root \
"$TEMP_LOCATION" "$LOCATION"'
```
Previous command can be also used to upgrade to the latest version.
## Docker
```
$ docker run --rm -it \
-e "WARP4J_CACHE=/cache" \
--volume <cache on host>:/cache \
--volume <jars on host>:/workdir \
--user $(id -u):$(id -g) \
guziks/warp4j <app.jar>
```
Change according to your requirements, but volume with working directory is mandatory.
## Moor
To simplify the command above make a launcher with [moor](https://github.com/guziks/moor):
```
$ moor guziks/warp4j warp4j
```
Then use as an ordinary command.

22
README.md
View File

@ -17,31 +17,15 @@ Just put both `warp4j` and `warp-packer` somewhere in your PATH and run `warp4j
## Install
### One-liner
Installs latest versions of both `warp4j` and `warp-packer`:
Curl one-liner installs latest versions of both `warp4j` and `warp-packer`:
```
$ bash -c "$(curl -fsSL https://raw.githubusercontent.com/guziks/warp4j/master/install)"
```
### Manual
This script will show missing dependencies (if there are any), they must be installed with your package manager.
First install [warp-packer](https://github.com/dgiagio/warp/releases) and ensure other common tools available: `awk`, `curl`, `file`, `grep`, `sed`, `sort`, `tar`, `unzip`, optional: `zip`. Then install `warp4j` like this:
```
$ LOCATION=/usr/local/bin \
LINK=https://raw.githubusercontent.com/guziks/warp4j/master/warp4j \
TEMP_LOCATION=/tmp/warp4j \
bash -c 'curl -fsSL -o $TEMP_LOCATION $LINK && \
sudo install -D \
--mode=755 \
--owner=root \
--group=root \
"$TEMP_LOCATION" "$LOCATION"'
```
Previous command can be also used to upgrade to the latest version.
See more install methods [here](INSTALL.md).
## Usage