okfn/cachethq-docker

Name: cachethq-docker

Owner: Open Knowledge International

Description: A dockerized version of Cachet.

Forked from: CachetHQ/Docker

Created: 2017-09-05 13:04:55.0

Updated: 2017-09-05 13:05:14.0

Pushed: 2017-08-22 16:23:57.0

Homepage: https://cachethq.io/

Size: 212

Language: Shell

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

Cachet Docker Image

This is the official repository of the Docker image for Cachet.

Cachet is a beautiful and powerful open source status page system, a free replacement for services such as StatusPage.io, Status.io and others.

For full documentation, visit the Installing Cachet with Docker page.

Supporting Cachet

Cachet is a BSD-3-licensed open source project. If you'd like to support future development, check out the Cachet Patreon campaign.

Quickstart

  1. Clone this repository

    clone https://github.com/CachetHQ/Cachet.git
    
  2. Edit the docker-compose.yml file to specify your ENV variables.

  3. To build an image containing a specific Cachet release, set the cachet_ver ARG in the docker-compose.yml

    The master branch and cachethq/docker:latest Docker automated build are a work in progress / development version of the upstream https://github.com/CachetHQ/Cachet project. As such, master or latest should not be used in a production environment as it can change at anytime.

    We strongly recommend specifying a stable Cachet Release at build time as mentioned above.

  4. Build and run the image

    er-compose build
    er-compose up
    
  5. cachethq/docker runs on port 8000 by default. This is exposed on host port 80 when using docker-compose.

Docker Hub Automated build

cachethq/docker is available as a Docker Hub Trusted Build.

For a full list of Cachet versions released as Docker images please see the list of Docker hub tags.

Please use a tagged Cachet Docker image release or one of the tagged builds from https://hub.docker.com/r/cachethq/docker/tags/ with docker pull cachethq/docker:2.3.10.

Testing

Pull requests must pass the Bash Automated Testing System tests, which run on Travis CI via located in the test directory.

Use make test to manually run the tests.

Development of Cachet using this docker environment

  1. Clone the official repo of CachetHQ/Docker

    clone https://github.com/cachethq/Docker.git cachet-docker
    achet-docker
    tag -l
    checkout $LATEST_TAG
    
  2. Clone the official repo of CachetHQ/Cachet here and do composer install

    clone https://github.com/CachetHQ/Cachet.git
    
  3. Setup the Cachet project

    achet
    oser install
    ./conf/.env.docker ./.env
    .
    
  4. Edit the docker-compose.yml file

    ace
    d: .
    
    e: cachethq/docker
    
    ace
    ar/www
    
    Cachet/:/var/www/html/
    
  5. Build and run the docker compose

    er-compose up
    
  6. Open new terminal and run the following commands after getting container name via docker ps:

    er exec -i cachetdocker_cachet_1  php artisan key:generate
    er exec -i cachetdocker_cachet_1  php artisan app:install
    

This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.