Skip to content

Commit

Permalink
📗 Docker image usage documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
evrignaud committed May 21, 2016
1 parent 7810b6f commit ba130ec
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 3 deletions.
1 change: 1 addition & 0 deletions docker-hub.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,5 +36,6 @@ A complete documentation of Fim is available [here](http://evrignaud.github.io/f

### Run it:
If you don't have the Fim docker image locally it will pull the image first.
This script takes the same arguments as the `fim` one.

$ ./fim-docker -h
42 changes: 39 additions & 3 deletions src/main/asciidoc/how-can-you-use-fim.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,52 @@ include::changelog.adoc[]

== Run Fim using Docker

If you don't have Java and you don't want to install it, you can run Fim using a docker image.<br>
It will run only on Linux.
If you don't have Java and you don't want to install it (or you don't have the required version of Java), you can run Fim using a Docker image. +
All the environment required to run Fim is inside the Docker image. Just pull the image and run Fim.

[IMPORTANT]
====
The Docker image runs only on Linux
====

=== Using the latest published Docker image

Fim releases are published as Docker images on https://hub.docker.com/r/evrignaud/fim/[Docker Hub]. +
You can use them like this.

* Retrieve the `fim-docker` script:

[source, bash]
----
$ curl https://raw.githubusercontent.com/evrignaud/fim/master/fim-docker -o fim-docker
$ chmod a+rx fim-docker
----

* Run it: +
This script takes the same arguments as the `fim` one. +
If you don't have the Fim Docker image locally it will pull the image first.

[source, bash]
----
$ ./fim-docker -h
----

If you want to be sure the have the latest version of the Fim Docker image you can pull it manually:

[source, bash]
----
$ docker pull evrignaud/fim
----

=== Creating your own Docker Image

After having build Fim (<<how-can-you-use-fim.adoc#_build_fim,see below>>), type the following command:
[source, bash]
----
$ ./build-docker-image
----

Then you can use the provided `fim-docker` script that takes the same arguments as the `fim` one.
Then you can use the provided `fim-docker` script.

== Build Fim

Expand Down

0 comments on commit ba130ec

Please sign in to comment.