Applipress documentation 1.0 Help

Applipress docker-compose.yml file

Applipress is launched using the following docker-compose.yml file:

version: '3.8' services: # # Please, first run the setup script to initialize the environment variables # applipress: image: nomendi6/applipress_demo:latest environment: - _JAVA_OPTIONS=-Xmx512m -Xms256m # Java memory configuration options - LOGGING_LEVEL_COM_NOMENDI6_APPLIPRESS=DEBUG # Log level for the Applipress application - APPLIPRESS_CONFIG_HOME=/config # Directory path where Applipress configurations are mapped - TRANSLATIONS_HOME=/.auto-translate # Directory path where translation configurations are mapped - APPLIPRESS_INSIGHT=yes # Enables the sending of anonymous usage statistics # - APPLIPRESS_USERNAME=${APPLIPRESS_USERNAME} # Username for Applipress # - APPLIPRESS_GROUPNAME=${APPLIPRESS_GROUPNAME} # Group name for Applipress - APPLIPRESS_USER_UID=${APPLIPRESS_USER_UID} # User UID for Applipress - APPLIPRESS_USER_GID=${APPLIPRESS_USER_GID} # User GID for Applipress # - GIT_USER_EMAIL="[email protected]" # Email for Git # - GIT_USER_NAME="Applipress" # Name for Git ports: - 127.0.0.1:18080:8080 # Maps the application's port 8080 to the host's port 18080 volumes: - ./config/applipress:/config # Maps the local Applipress configuration directory to the Docker container's /config directory - ./config/auto-translate:/.auto-translate # Maps the local translation configuration directory to the Docker container's /.auto-translate directory (optional, Google or Azure API keys can be defined here) - ./projects:/projects # Maps the local projects directory to the Docker container's /projects directory - this path can be changed to a different local directory as needed networks: - applipress_default # Adds a default network networks: applipress_default: driver: bridge

Parameters in docker-compose.yml

  • APPLIPRESS_CONFIG_HOME - The directory path inside the docker container where Applipress configurations are mapped.

  • TRANSLATIONS_HOME - The directory path inside the docker container where translation configurations are mapped.

  • APPLIPRESS_INSIGHT - Enables the sending of anonymous usage statistics. Valid values are yes and no.

  • APPLIPRESS_USERNAME - The username that is used for generating source.

  • APPLIPRESS_USER_UID - User UID for Applipress, default is 1000.

  • APPLIPRESS_GROUPNAME - Group name for Applipress.

  • APPLIPRESS_USER_GID - User GID, default is 1000.

  • GIT_USER_EMAIL - The email for the git user that will be used by Applipress. Default is [email protected].

  • GIT_USER_NAME - The name for the git user used by Applipress. Default is Applipress.

  • _JAVA_OPTIONS - Java memory configuration options for Applipress.

  • LOGGING_LEVEL_COM_NOMENDI6_APPLIPRESS - Log level for the Applipress. This is visible in the Applipress docker container logs.

Port mapping and network accessibility

  • By default, Applipress is accessible at port 18080 on the local machine and is not available from the network. If you wish the application to be network-accessible, remove the 127.0.0.1 part from the port mapping. Be cautious as this version does not require user authentication.

Directory mapping

The application maps the following directories to the container directories:

  • ./config/applipress - Maps the local Applipress configuration directory to the Docker container's /config directory.

  • ./config/auto-translate:/.auto-translate - Maps the local translation configuration directory to the Docker container's /.auto-translate directory (optional, Google or Azure API keys can be defined here).

  • ./projects:/projects - Maps the local projects directory to the Docker container's /projects directory. This is the directory where new projects will be created, and you can map it to any directory where you typically store your projects.

Last modified: 18 March 2024