Commit 5a5cd024 authored by Didier Verna's avatar Didier Verna
Browse files

Rework the final part of the README file.

parent cc2fcca9
......@@ -94,51 +94,41 @@ tweak the behavior of Quickref.
## Docker images
You can build your own Quickref images by using the provided Dockerfiles (they
are located in the `docker` directory):
You can build your own Quickref Docker images by using the provided
Dockerfiles located in the `docker` directory. The project is split in 2
separate images:
`Dockerfile-buildenv` creates an image with all the dependencies needed to
buid the various Quicklisp libraries inside.
* `Dockerfile-buildenv` creates a Debian 8 image with all the dependencies
needed to buid the various Quicklisp libraries inside.
* `Dockerfile` builds on top of the `buildenv` image to set up a
`quickbuilder` user, pull the latest versions of Quickref and Declt, and
finally launch Quickref.
`Dockerfile` builds on top of the `buildenv` image and sets up a
`quickbuilder` user, pulls the latest versions of Quickref and Declt, and
finally launches Quickref.
With this 2-steps process, it is possible to rebuild the final Quickref image
with the latest Quicklisp without rebuilding the whole environment (including
the hundreds of dependencies installed from `apt`).
*Note:* The project is split into 2 separate images to allow rebuilding the
final quickref image with the `--no-cache` flag (to pull the latest version
from the git repo), without rebuilding the whole environment (including the
hundreds of dependencies installed from `apt`).
### Building the images
To create the image with the build environment, run:
The two Quickref Docker images are created by typing respectively (and in that
order):
```
docker build -t quickref/buildenv -f Dockerfile-buildenv .
```
To create the final Quickref image, run:
```
docker build -t quickref .
```
### Retrieving the website files from the image once Quickref finished running:
With `docker ps -a`, get the name/ID of your image.
### Extracting the website
The output should look like this: (with a different name/ID for you)
With `docker ps -a`, get the name/ID of your image. The output should look
like this (with a different name/ID for you):
```
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
2b67991057f4 quickref "bash" 6 seconds ago Exited (0) 2 seconds ago sleepy_morse
```
Then simply do:
Then, extract the website from the container just like with the official
image:
```
docker cp sleepy_morse:~/quickbuilder/quickref .
```
The entire `quickref/` folder will be copied, the `website` folder inside
contains all the necessary files, just copy them to the root of your webserver
of choice.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment