Skip to content

ryanwclark/docker-cachet

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

docker-cachet

Build Status Docker Pulls Docker Stars

Introduction

This will build a container for Cachet - An open source status page.

  • 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

Table of Contents

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 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 MariaDB container

Installation

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

docker pull ryanwclark/cachet

Quick Start

The first boot can take from 2 minutes - 5 minutes depending on your CPU to setup the proper schemas.

Login to the web server and enter in your admin email address, admin password and start configuring the system!

Configuration

Data-Volumes

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

Directory Description
/www/logs Nginx and PHP Log files
/assets/custom (Optional) Copy source code over existing source code in /www/html upon container start. Use exact file/folder structure
/assets/custom-scripts (Optional) If you want to execute custom scripting, place scripts here with extension .sh
/www/html (Optional) If you want to expose the cachet sourcecode and enable Self Updating, expose this volume
*OR
/data Hold onto your persistent sessions and cache between container restarts

Environment Variables

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

Still under construction, automatic installing is not fully working

Parameter Description default
ADMIN_EMAIL Administrator Email Address - Needed for logging in admin@example.com
ADMIN_PASS Administrator Password - Needed for Logging in cachet
ADMIN_USER Admin username admin
APPLICATION_NAME Change default application name - Default cachet cachet
APP_DEBUG Debug Mode for Application FALSE
DB_HOST Host or container name of MariaDB Server e.g. cachet-db
DB_NAME MariaDB Database name e.g. cachet
DB_PASS MariaDB Password for above Database e.g. password
DB_PORT MariaDB Port - Default 3306 3306
DB_USER MariaDB Username for above Database e.g. cachet
DRIVER_CACHE Cache Driver apc
DRIVER_QUEUE Queue Driver database
DRIVER_SESSION Session Driver apc
ENABLE_BEACON Send details to cachethq.io about installation FALSE
ENABLE_DEBUG_BAR Debug Bar FALSE
ENABLE_EMOJI Enable Github Emojis FALSE
MAIL_FROM_NAME From Name for above address Cachet
MAIL_FROM Mail From address noreply@example.com
SETUP_TYPE Automatically edit configuration after first bootup AUTO MANUAL
SITE_URL The url your site listens on example https://cachet.example.com

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. cachet) bash

References

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published