tiredofit / docker-logchimp

Dockerized Logchimp Application

hub.docker.com/r/tiredofit/logchimp

Introduction

This will build a container for logchimp - An open source product evaluation tool

• This Container uses a customized Alpine base which includes s6 overlay enabled for PID 1 Init capabilities, zabbix-agent for individual container monitoring, Cron also installed along with other tools (bash,curl, less, logrotate, nano, vim) for easier management. It also supports sending to external SMTP servers..

Changelog

Authors

• Dave Conroy

Table of Contents

• Introduction
• Authors
• Table of Contents
• Prerequisites
• Installation
  • Quick Start
• Configuration
  • Data-Volumes
  • Environment Variables
  • Networking
• Maintenance
  • Shell Access
• References

Prerequisites

This image assumes that you are using a reverse proxy such as jwilder/nginx-proxy and optionally the Let's Encrypt Proxy Companion @ https://github.com/JrCs/docker-letsencrypt-nginx-proxy-companion or Traefik in order to serve your pages. However, it will run just fine on it's own if you map appropriate ports. See the examples folder for a docker-compose.yml that does not rely on a reverse proxy.

You will also need an external Postgresql container

Installation

Automated builds of the image are available on Docker Hub and is the recommended method of installation.

docker pull tiredofit/logchimp

Quick Start

• The quickest way to get started is using docker-compose. See the examples folder for a working docker-compose.yml that can be modified for development or production use.

• Set various environment variables to understand the capabilities of this image.

• Map persistent storage for access to configuration and data files for backup.

• Make networking ports available for public access if necessary

In reality all you wil need to do is populate the APP_KEY and DB_* environment variables to have a working solution.

Configuration

Data-Volumes

The following directories are used for configuration and can be mapped for persistent storage.

Directory	Description

Environment Variables

Along with the Environment Variables from the Base image and Web Image below is the complete list of available options that can be used to customize your installation.

Parameter	Description	Default
APP_KEY	Used for encryption/decryption of passwords. Do not change once set!
BACKEND_HOSTNAME	Backend Hostname	localhost
BACKEND_PORT	Backend Port	3000
BACKEND_PROTOCOL	Backend protocol http or https	http
DB_HOST	Host or container name of Postgresql Server e.g. logchimp-db
DB_NAME	Postgresql Database name e.g. logchimp
DB_PASS	Postgresql Password for above Database e.g. password
DB_PORT	Postgresql Server Port - Default 5432	5432
DB_USER	Postgresql Username for above Database e.g. logchimp
FRONTEND_PORT	Frontend Port	8080

Networking

The following ports are exposed.

Port	Description
80	HTTP

Maintenance

Shell Access

For debugging and maintenance purposes you may want access the containers shell.

docker exec -it (whatever your container name is e.g. logchimp-app) bash

References

• https://logchimp.codecarrot.net/docs/