Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tiredofit/docker-freescout
Dockerized web based help desk and shared inbox
https://github.com/tiredofit/docker-freescout
docker helpdesk laravel php-fpm
Last synced: 4 days ago
JSON representation
Dockerized web based help desk and shared inbox
- Host: GitHub
- URL: https://github.com/tiredofit/docker-freescout
- Owner: tiredofit
- License: mit
- Created: 2018-11-04T02:02:56.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-04-26T15:02:09.000Z (8 months ago)
- Last Synced: 2024-05-01T15:53:17.469Z (8 months ago)
- Topics: docker, helpdesk, laravel, php-fpm
- Language: Dockerfile
- Homepage:
- Size: 341 KB
- Stars: 196
- Watchers: 8
- Forks: 86
- Open Issues: 61
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# github.com/tiredofit/docker-freescout
[](https://github.com/tiredofit/docker-freescout/releases/latest)
[](https://github.com/tiredofit/docker-freescout/actions)
[](https://hub.docker.com/r/tiredofit/freescout/)
[](https://hub.docker.com/r/tiredofit/freescout/)
[](https://github.com/sponsors/tiredofit)
[](https://www.paypal.me/tiredofit)
* * *
## About
This will build a Docker Image for [FreeScout](https://freescout.net/) - An open source Helpscout / Zendesk alternative.
* Automatically installs and sets up installation upon first start
## Maintainer
- [Dave Conroy](https://github.com/tiredofit)
## Table of Contents
- [About](#about)
- [Maintainer](#maintainer)
- [Table of Contents](#table-of-contents)
- [Prerequisites and Assumptions](#prerequisites-and-assumptions)
- [Installation](#installation)
- [Build from Source](#build-from-source)
- [Prebuilt Images](#prebuilt-images)
- [Configuration](#configuration)
- [Quick Start](#quick-start)
- [Persistent Storage](#persistent-storage)
- [Environment Variables](#environment-variables)
- [Base Images used](#base-images-used)
- [Networking](#networking)
- [Maintenance](#maintenance)
- [Shell Access](#shell-access)
- [Support](#support)
- [Usage](#usage)
- [Bugfixes](#bugfixes)
- [Feature Requests](#feature-requests)
- [Updates](#updates)
- [License](#license)
- [References](#references)
## Prerequisites and Assumptions
* Assumes you are using some sort of SSL terminating reverse proxy such as:
* [Traefik](https://github.com/tiredofit/docker-traefik)
* [Nginx](https://github.com/jc21/nginx-proxy-manager)
* [Caddy](https://github.com/caddyserver/caddy)
* Requires access to a MySQL/MariaDB or Postgres Server
## Installation
### Build from Source
Clone this repository and build the image with `docker build -t (imagename) .`
### Prebuilt Images
Builds of the image are available on [Docker Hub](https://hub.docker.com/r/tiredofit/freescout)
```bash
docker pull docker.io/tiredofit/freescout:(imagetag)
```
Builds of the image are also available on the [Github Container Registry](https://github.com/tiredofit/docker-freescout/pkgs/container/docker-freescout)
```
docker pull ghcr.io/tiredofit/docker-freescout:(imagetag)
```
The following image tags are available along with their tagged release based on what's written in the [Changelog](CHANGELOG.md):
| Container OS | Tag |
| ------------ | --------- |
| Alpine | `:latest` |
## Configuration
### Quick Start
- The quickest way to get started is using [docker-compose](https://docs.docker.com/compose/). See the examples folder for a working [docker-compose.yml](examples/docker-compose.yml) that can be modified for development or production use.
- Set various [environment variables](#environment-variables) to understand the capabilities of this image.
- Map [persistent storage](#data-volumes) for access to configuration and data files for backup.
- Make [networking ports](#networking) available for public access if necessary
**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!
### Persistent Storage
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` |
| `/assets/modules` | (Optional) If you want to add additional modules outside of the source tree, add them here |
| `/www/html` | (Optional) If you want to expose the Freescout sourcecode and enable Self Updating, expose this volume |
| *OR* | |
| `/data` | Hold onto your persistent sessions and cache between container restarts |
### Environment Variables
#### Base Images used
This image relies on an [Alpine Linux](https://hub.docker.com/r/tiredofit/alpine) or [Debian Linux](https://hub.docker.com/r/tiredofit/debian) base image that relies on an [init system](https://github.com/just-containers/s6-overlay) for added capabilities. Outgoing SMTP capabilities are handlded via `msmtp`. Individual container performance monitoring is performed by [zabbix-agent](https://zabbix.org). Additional tools include: `bash`,`curl`,`less`,`logrotate`,`nano`.
Be sure to view the following repositories to understand all the customizable options:
| Image | Description |
| ------------------------------------------------------------- | -------------------------------------- |
| [OS Base](https://github.com/tiredofit/docker-alpine/) | Customized Image based on Alpine Linux |
| [Nginx](https://github.com/tiredofit/docker-nginx/) | Nginx webserver |
| [PHP-FPM](https://github.com/tiredofit/docker-nginx-php-fpm/) | PHP Interpreter |
| Parameter | Description | Default | `_FILE` |
| -------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------- | ------- |
| `ADMIN_EMAIL` | Administrator Email Address - Needed for logging in | | x |
| `ADMIN_FIRST_NAME` | Admin user First Name | `Admin` | x |
| `ADMIN_LAST_NAME` | Admin user First Name | `User` | x |
| `ADMIN_PASS` | Administrator Password - Needed for Logging in | | x |
| `APPLICATION_NAME` | Change default application name - Default `Freescout` | `freescout` | |
| `APP_PROXY` | Allow Application to use a proxy for fetching modules | | |
| `APP_TRUSTED_PROXIES` | Comma separated list of trusted proxies, i.e. `192.168.1.1,192.168.1.2,192.168.1.3` | | |
| `APP_SINCE_WITHOUT_QUOTES_ON_FETCHING` | Allow to disable quotes around SINCE date in IMAP search | `FALSE` | |
| `APP_X_FRAME_OPTIONS` | Allow to embed via iframes `TRUE` `FALSE` `DENY` `ALLOW FROM example.org` | `TRUE` | |
| `DB_TYPE` | Type of the Database. Currently supported are `mysql` and `pgsql` | `mysql` | |
| `DB_PGSQL_SSL_MODE` | Postgresql TLS Mode | `prefer` | |
| `DB_HOST` | Host or container name of the Databse Server e.g. `freescout-db` | | x |
| `DB_PORT` | Database Port e.g.`3306` for mysql, `5432` for postgres | `3306` | x |
| `DB_NAME` | Database name e.g. `freescout` | | x |
| `DB_USER` | Username for above Database e.g. `freescout` | | x |
| `DB_PASS` | Password for above Database e.g. `password` | | x |
| `DISPLAY_ERRORS` | Display Errors on Website | `FALSE` | |
| `ENABLE_AUTO_UPDATE` | If coming from an earlier version of image, automatically update it to latest Freescout release | `TRUE` | |
| `SETUP_TYPE` | Automatically edit configuration after first bootup `AUTO` or `MANUAL` | `AUTO` | |
| `SITE_URL` | The url your site listens on example `https://freescout.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.
``bash
docker exec -it (whatever your container name is) bash
``
## Support
These images were built to serve a specific need in a production environment and gradually have had more functionality added based on requests from the community.
### Usage
- The [Discussions board](../../discussions) is a great place for working with the community on tips and tricks of using this image.
- [Sponsor me](https://tiredofit.ca/sponsor) for personalized support
### Bugfixes
- Please, submit a [Bug Report](issues/new) if something isn't working as expected. I'll do my best to issue a fix in short order.
### Feature Requests
- Feel free to submit a feature request, however there is no guarantee that it will be added, or at what timeline.
- [Sponsor me](https://tiredofit.ca/sponsor) regarding development of features.
### Updates
- Best effort to track upstream changes, More priority if I am actively using the image in a production environment.
- [Sponsor me](https://tiredofit.ca/sponsor) for up to date releases.
## License
MIT. See [LICENSE](LICENSE) for more details.
## References
*
*