Skip to content

setup docker for antora

Joseph Cayouette edited this page Dec 4, 2019 · 1 revision

Setup Docker for Antora

We use the latest Antora Docker Image from docker hub to simplify building a static development site from our sources.

Overview

This guide will help you install docker, configure docker and pull the community image for Antora for building documentation. You will perform the following tasks to build our documentation.

  1. Install Docker

  2. Enable the docker daemon

  3. Start the docker daemon

  4. Add your user to the docker group.

  5. Pull the latest Antora docker container

Installing Docker on OpenSUSE

  1. Install docker on your OpenSUSE Leap 42.3 / 15 / 15.1 system:

    sudo zypper in docker
  2. Start and enable the docker daemon:

    sudo systemctl enable docker
    sudo systemctl start docker
  3. Add your user to the docker group:

    sudo usermod -aG docker $USER
  4. To activate docker with your user, log out of your current user session and log back in.

  5. Test that docker works without sudo by typing the following in your terminal:

    docker images

    The following output should be displayed in your terminal:

    docker images

Docker is now setup on your system. In the next section you will learn how to build documentation using our custom container.

Pull the Latest Antora Image

  1. To pull in the latest Antora image enter the following into your terminal:

    docker pull antora/antora:latest
  2. Check that you have the image:

    docker images

    You should see something similar to the following output:

    docker pull

Now that Docker and Antora are setup lets get to building the docs!

Clone this wiki locally