Required configuration

• The Linux distribution used does not matter. However, to use the Docker container that contains the HFSQL server, it is necessary to be familiar with Docker and, in particular:
  • know how to install a new container from the Docker image of the HFSQL server,
  • manage at least one volume required for data persistence,
  • manage network configuration inside Docker.

Running the image (creation of the container)

• The name of the preset image is:
  
  "windev/hfsql:<FR/US><Version>"
• To persist data (e.g. if the image changes), you must:
  • Use a volume. The command to create a volume:
    
    "docker volume create <VolumeName>"
  • Mount the volume into the container on
    
    "/var/lib/hfsql"
• Example of command line:
  
  sudo docker run -d
  --restart unless-stopped
  --name HFSQL_DOCKER
  --volume <NomVolume>:/var/lib/hfsql
  --publish 4923:4900
  windev/hfsql:US230053b
  Here are the parameters of the command above:
  • "name": indicates the name of the container.
  • "volume": indicates the "binding" between the volume and the directory defined in the container. In the HFSQL server configuration, the database path will be seen as "var/lib/hfsql".
  • "publish": indicates the container access port (4923 in this example) and the redirection to the port inside the container (4900: HFSQL standard port).
    In this example, the server will be accessible on port 4923 of the docker server.
  • the name of the docker package and the HFSQL version (US230053b" in this example).

Notes (important)

• When the container is created, if there are no databases, you can define environment variables, for example, via the syntax:
  
  -e HFSQL_RANDOM_PASSWORD=yes
  
  You can use one of the following three variables (or nothing for the default "admin" mode):
  • HFSQL_PASSWORD: Password of the initial account.
  • HFSQL_PASSWORD_FILE: Path of the file that contains the password of the initial account.
  • HFSQL_RANDOM_PASSWORD: The password for the initial account is generated randomly
    It is displayed on the standard output and can be found in the logs with the command
    docker logs HFSQL_DOCKER
  You can also use the following variable (optional): HFSQL_USER: Name of the account (admin by default.)
• Reminder of basic Docker commands:
  • Stop a container:
    
    "docker stop <ID>"
  • Restart a container:
    
    "docker start <ID>"