Installation using Docker

Factori script for Docker

The simplest way to use Factori via docker is via this script. Get it with:

wget -O factori

Then, make it executable with:

chmod +x factori

To call factori without a path prefix, move it to, e.g., $HOME/bin/ (assuming $HOME/bin/ appears in $PATH):

mv factori $HOME/bin/

Now try:


If you didn't pull any factori image yet and 0.5.3 is the latest release, you will get something like:

Warning: It seems that you didn't pull any factori image for the moment.
The tag of the latest release is 0.5.3. Consider downloading it with docker pull functori/factori:0.5.3.

Let's pull the indicated docker image:

docker pull functori/factori:0.5.3

Again, run:


Now, it should print something like:

Notice: using the latest pulled factori version 0.5.3.
Use 'factori --help' for help on commands

You are ready to use factori! You can move to SDK generation section.

Versions management with the script

The script above can be parameterized via a VERSION environnement variable. For instance, to use the docker image of the release 0.5.2, you can write:

VERSION=0.5.2 factori <CMD>

Of course, if you didn't pull version 0.5.2 yet, you'll be asked to do it or to pull the latest released version.

In addition to the tag of a released/pulled version, the value of VERSION environnement variable can be:

  • latest, to use the latest docker image release;
  • show-pulled, to show the list of pulled factori images;
  • show-latest-release, to show the tag of the latest factori release.

Note that the latest release that has been pulled is systematically used when factori is invoked with:

factori <CMD>

For advanced users, the REPOSITORY environment variable can be set to dev to use GitLab registry instead of docker hub as a source of images. In this case, one can use any unreleased image published there. In particular, VERISON=next can be used alongside REPOSITORY to target development versions of Factori.

Docker pull

If you don't want to use the script above, you have to pull the docker images yourself. For instance, you can get the image with the latest with:

docker pull functori/factori:latest

The list of released factori version is available via docker hub. If you would like to use a previous version, e.g. 0.3.1, you can run:

docker pull functori/factori:0.3.1

Then, you should be able to run factori as follows (probably with some extra arguments depending on the usage):

docker run functori/factori:latest