Code Monkey home page Code Monkey logo

cronicle-docker's Introduction

Cronicle Docker container

โ— Maintainance of this repository has been moved to bluet/docker-cronicle-docker and this repository will be archived soon. Please use the new repository for any issues, pull requests or other contributions.

Docker container for a Cronicle single-server master node

Usage

Example docker-compose configuration:

services:
  app:
    image: foorschtbar/cronicle:latest
    hostname: cronicle
    container_name: cronicle-app
    volumes:
      - ./data/data:/opt/cronicle/data
      - ./data/plugins:/opt/cronicle/plugins:ro
    environment:
      - CRONICLE_base_app_url=http://localhost:3012
      - CRONICLE_smtp_hostname=mailserver
      - CRONICLE_smtp_hostname=25
      - CRONICLE_email_from=<changeme>
    restart: unless-stopped

The web UI will be available at: http://localhost:3012

NOTE: please replace the hostname localhost, this is only for testing purposes! If you rename the hostname also consider setting the environmental variable CRONICLE_base_app_url. e.g docker run --name cronicle --hostname cronicle-host -p 3012:3012 -e CRONICLE_base_app_url='http://cronicle-host:3012' foorschtbar/cronicle-docker

Volumes

Cronicle process runs under the cronicle user with ID 1001 and GUID 1001`. If you are using Docker bind mounts set permissions accordingly.

Path Description
/opt/cronicle/data Volume for data
/opt/cronicle/logs Volume for logs
/opt/cronicle/plugins Volume for plugins

Configuration

Environmental variables

Cronicle supports a special environment variable syntax, which can specify command-line options as well as override any configuration settings. The variable name syntax is CRONICLE_key where key is one of several command-line options (see table below) or a JSON configuration property path.

For overriding configuration properties by environment variable, you can specify any top-level JSON key from config.json, or a path to a nested property using double-underscore (__) as a path separator. For boolean properties, you can specify 1 for true and 0 for false. Here is an example of some of the possibilities available.

Environmental variable Description Default value
CRONICLE_base_app_url A fully-qualified URL to Cronicle on your server, including the port if non-standard. This is used for self-referencing URLs. http://localhost:3012
CRONICLE_smtp_hostname The hostname of your SMTP server, for sending mail. localhost
CRONICLE_smtp_port The port number to use when communicating with the SMTP server. 25
CRONICLE_email_from The e-mail address to use as the "From" address when sending out notifications. Most SMTP servers require this to be a valid address to accept mail. 1

All configuration options are documented in the Cronicle Configuration Guide.

Web UI credentials

The default credentials for the web interface are: admin / admin

Reference

https://github.com/jhuckaby/Cronicle

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.