freescout/README.md

# Free Self-Hosted Zendesk & Help Scout Alternative

<div align="center">

<img src="https://raw.githubusercontent.com/freescout-helpdesk/freescout/master/public/img/logo-300.png" width="180" height="180" />
<br/><br/>

[![PHP version](https://freescout-helpdesk.github.io/img/badges/PHP-7.0%2B-blue.svg)](https://github.com/freescout-helpdesk/freescout#requirements) [![Laravel version](https://freescout-helpdesk.github.io/img/badges/Laravel-5.5-blue.svg)](https://github.com/freescout-helpdesk/freescout#requirements) 
[![Build Status](https://freescout-helpdesk.github.io/img/badges/travis.svg)](https://freescout-helpdesk.github.io/img/badges/travis.svg) [![HitCount](http://hits.dwyl.io/freescout-helpdesk/freescout.svg)](http://hits.dwyl.io/freescout-helpdesk/freescout)

</div>

**FreeScout** is the super lightweight free open source help desk and shared inbox written in PHP7 (Laravel 5.5 framework) – self hosted clone of HelpScout. Now you can enjoy [free Zendesk & Help Scout](https://freescout.net) without giving up privacy or locking yourself into a service you don't control.

FreeScout has been developed from scratch and is not using any copyrighted Help Scout materials to comply with GitHub's [DMCA Policy](https://help.github.com/articles/dmca-takedown-policy/) (trademark, logos, icons, CSS, JS, HTML files are copyrighted; idea, look and feel cannot be copyrighted).

![FreeScout](https://freescout-helpdesk.github.io/img/screenshots/screenshot.png)

## Table of Contents
   * [Features](#features)
   * [Requirements](#requirements)
   * [News & Updates](#news--updates)
   * [Installation](#installation)
   * [Modules](#modules)
   * [Contributing](#contributing)
   * [Screenshots](#screenshots)

## Features

![FreeScout](https://raw.githubusercontent.com/freescout-helpdesk/freescout/master/public/img/banner.png)

  * 100% Mobile-friendly.
  * Multilingual.
  * Starred conversations.
  * Push notifications.
  * Auto reply.
  * Notes.
  * Pasting screenshots from the clipboard into the reply area.
  * Dragging images into the reply area.
  * Open tracking.
  * Search.
  * Edit/hide threads.

Need anything else? Suggest features [here](https://feedback.userreport.com/25a3cb5f-e4bd-4470-b6f3-79fcfaa8e90f/#ideas/popular)

## Requirements

FreeScout is a pure PHP/MySQL application, so it can be easily deployed even on a shared hosting.

  * Nginx / Apache / IIS
  * PHP 7.0+
  * MySQL 5.0+ / MariaDB 5.0+ / PostgreSQL

## News & Updates

If you would like to be notified about new releases, news and updates you can subscribe [here](https://feedburner.google.com/fb/a/mailverify?uri=freescout)

## Installation

[Installation Guide](https://github.com/freescout-helpdesk/freescout/wiki/Installation-Guide)

## Modules

FreeScout [Modules](https://github.com/freescout-helpdesk/freescout/wiki/FreeScout-Modules)

## Contributing

* [Development Guide](https://github.com/freescout-helpdesk/freescout/wiki/Development-Guide)
* [Todo list](https://github.com/freescout-helpdesk/freescout/projects/1)
* [Translate](https://github.com/freescout-helpdesk/freescout/wiki/Translate)
* [Support project by leaving a feedback](https://github.com/freescout-helpdesk/freescout/wiki#support-project)

## Screenshots

Dashboard:

![Dashboard](https://freescout-helpdesk.github.io/img/screenshots/dashboard.png)

Conversation:

![Conversation](https://freescout-helpdesk.github.io/img/screenshots/conversation.png)


Mailbox connection settings page:

![Mailbox connection settings page](https://freescout-helpdesk.github.io/img/screenshots/mailbox-connection.png)

Notifications:

![Notifications](https://freescout-helpdesk.github.io/img/screenshots/notifications.png)

Push notification:

![Push notification](https://freescout-helpdesk.github.io/img/screenshots/push.png)

Web installer:

![Web installer](https://freescout-helpdesk.github.io/img/screenshots/installer.png)

Login page:

![Login page](https://freescout-helpdesk.github.io/img/screenshots/freescout-login.png)