From: pcarana Date: Tue, 1 Sep 2020 21:38:52 +0000 (-0500) Subject: Update docs to include 'docker pull' option, related to #17 X-Git-Tag: v1.4.1~2 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=a48bd789a1af218b13f1217bdae57fc38eec6d9b;p=thirdparty%2FFORT-validator.git Update docs to include 'docker pull' option, related to #17 --- diff --git a/docker/README.md b/docker/README.md index d9c36fa4..7eaf54b1 100644 --- a/docker/README.md +++ b/docker/README.md @@ -6,12 +6,16 @@ Special thanks to [ximon18](https://github.com/ximon18) for its [contribution](h **This image doesn't include TAL (Trust Anchor Locator) files.** They must be obtained somewhere else (here's [an example](https://github.com/NICMx/FORT-validator/tree/master/examples/tal)). -## Build +To pull the official docker image, run: -Just run a simple: +``` +docker pull nicmx/fort-validator:latest +``` + +If you want to build the image yourself, run the following command from this source folder: ``` -docker build -t fort:latest . +docker build -t fort-validator:latest . ``` ## Usage @@ -28,18 +32,18 @@ By default, the container uses a configuration file located (inside the containe Here's a basic usage example to run FORT validator mostly with default values (runs as RTR server by default, bound to port 323): ``` -docker run --name fort -v host/path/to/tals:/etc/fort/tal:ro -p 323:323 -d fort +docker run --name fort-validator -v host/path/to/tals:/etc/fort/tal:ro -p 323:323 -d fort-validator ``` At this example: -- `host/path/to/tals` is the path a the host machine where the TALs are located (`-v` mounts the content at the container, the last value `:ro` is to use it as read only). Inside the container, by default `fort` will seek the TALs at `/etc/fort/tal`. +- `host/path/to/tals` is the path a the host machine where the TALs are located (`-v` mounts the content at the container, the last value `:ro` is to use it as read only). Inside the container, by default `fort-validator` will seek the TALs at `/etc/fort/tal`. - The host port `323` is mapped to the container port `323`, which is the default value where the RTR server will be bound to (see [`--server.port`](https://nicmx.github.io/FORT-validator/usage.html#--serverport)). - `-d` runs the container in daemon mode. When using `-d` to run the service in the background the logs can be tailed like so: ``` -docker logs -f fort +docker logs -f fort-validator ``` ## Examples @@ -49,39 +53,39 @@ The container can receive more configuration arguments, useful to set more [Prog 1. Store the local cache at the host machine (using the path `path/to/cache`) and run as RTR server: ``` -docker run --name fort -v path/to/tals:/etc/fort/tal:ro \ +docker run --name fort-validator -v path/to/tals:/etc/fort/tal:ro \ -v path/to/cache:/var/local/fort \ - -p 323:323 -d fort + -p 323:323 -d fort-validator ``` 2. Use your own config file: ``` -docker run --name fort -v path/to/config/file:/etc/fort/fort.conf:ro -p 323:323 -d fort +docker run --name fort-validator -v path/to/config/file:/etc/fort/fort.conf:ro -p 323:323 -d fort-validator ``` 3. Use your own command arguments: ``` -docker run --name fort -v path/to/tals:/etc/fort/tal:ro -p 323:323 -ti fort [args] +docker run --name fort-validator -v path/to/tals:/etc/fort/tal:ro -p 323:323 -ti fort-validator [args] ``` 3.1. Using the [`--help`](https://nicmx.github.io/FORT-validator/usage.html#--help) argument: ``` -docker run --name fort --rm -ti fort -- -help +docker run --name fort-validator --rm -ti fort-validator -- -help ``` 3.2. Running once and printing the resulting valid ROAs to standard output: ``` -docker run --name fort --rm -v path/to/tals:/etc/fort/tal:ro \ - -ti fort --tal /etc/fort/tal --mode standalone --output.roa - +docker run --name fort-validator --rm -v path/to/tals:/etc/fort/tal:ro \ + -ti fort-validator --tal /etc/fort/tal --mode standalone --output.roa - ``` 3.3. Using a SLURM file (located at `path/to/slurm/my.slurm`): ``` -docker run --name fort -rm -v path/to/tals:/etc/fort/tal:ro -v path/to/slurm:/tmp:ro \ - -p 323:323 -ti fort --slurm /tmp/my.slurm +docker run --name fort-validator -rm -v path/to/tals:/etc/fort/tal:ro -v path/to/slurm:/tmp:ro \ + -p 323:323 -ti fort-validator --slurm /tmp/my.slurm ``` diff --git a/docs/installation.md b/docs/installation.md index 51f81282..bd7aff31 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -403,18 +403,24 @@ sudo make install ## Option 4: Running from a Docker container -There's also the option to run FORT validator from a Docker container. The Dockerfile to build the image is located at the official Github repository: [FORT-validator/docker](https://github.com/NICMx/FORT-validator/tree/master/docker). +There's also the option to run FORT validator from a Docker container. The image can be pulled from [Docker Hub](https://hub.docker.com/r/nicmx/fort-validator) or built from the official Github repository: [FORT-validator/docker](https://github.com/NICMx/FORT-validator/tree/master/docker). -Once you have the Dockerfile, just run (from the same directory where the Dockerfile is): +To pull the image from the official repository, run: {% highlight bash %} -docker build -t fort:latest . +docker pull nicmx/fort-validator:latest +{% endhighlight %} + +Or to build from the source Dockerfile, just run (from the same directory where the Dockerfile is): + +{% highlight bash %} +docker build -t fort-validator:latest . {% endhighlight %} A basic example to run the container using the default values, reading from a local TAL directory (i.e. `host/path/to/tals`), and binding to the local port `8323`: {% highlight bash %} -docker run --name fort -v host/path/to/tals:/etc/fort/tal:ro -p 323:323 -d fort +docker run --name fort-validator -v host/path/to/tals:/etc/fort/tal:ro -p 8323:323 -d fort-validator {% endhighlight %} Read more about the Docker container at the Github repository [FORT-validator/docker](https://github.com/NICMx/FORT-validator/tree/master/docker). \ No newline at end of file