Giter Club home page Giter Club logo

docker-freescout's Introduction

hub.docker.com/r/tiredofit/freescout

Build Status Docker Pulls Docker Stars Docker Layers

Introduction

This will build a container for Freescout - An open source Helpscout / Zendesk alternative.

  • Automatically installs and sets up installation upon first start

This Container uses tiredofit/alpine:3.8 as a base.

Changelog

Authors

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 MySQL/MariaDB Container

Installation

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

docker pull tiredofit/freescout

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

Environment Variables

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

Parameter Description
ADMIN_EMAIL Administrator Email Address - Needed for logging in
ADMIN_FIRST_NAME Admin user First Name - Default Admin
ADMIN_LAST_NAME Admin user First Name - Default User
ADMIN_PASS Administrator Password - Needed for Logging in
DB_HOST Host or container name of MySQL Server e.g. freescout-db
DB_PORT MySQL Port - Default 3306
DB_NAME MySQL Database name e.g. asterisk
DB_USER MySQL Username for above Database e.g. asterisk
DB_PASS MySQL Password for above Database e.g. password
DISPLAY_ERRORS Display Errors on Website - Default FALSE
ENABLE_SSL_PROXY If using SSL reverse proxy force application to return https URLs TRUE or FALSE
SITE_URL The url your site listens on example https://freescout.example.com
TIMEZONE Timezone - Use Unix Style - Default America/Vancouver

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

References

docker-freescout's People

Contributors

silviot avatar tiredofit avatar

Watchers

 avatar

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.