1
0
mirror of https://github.com/freescout-helpdesk/freescout.git synced 2024-11-24 03:12:46 +01:00
freescout/README.md
2021-02-12 21:24:02 -08:00

134 lines
5.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 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 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 or Zendesk materials.
![FreeScout](https://freescout-helpdesk.github.io/img/screenshots/screenshot.png)
## Table of Contents
* [Features](#features)
* [Demo](#demo)
* [Mobile Apps](#mobile-apps)
* [Requirements](#requirements)
* [Installation](#installation)
* [Modules](#modules)
* [Tools & Integrations](#tools--integrations)
* [News & Updates](#news--updates)
* [Contributing](#contributing)
* [Screenshots](#screenshots)
## Features
* No limitations on the number of users, tickets, etc.
* 100% Mobile-friendly.
* Multilingual (English, French, Japanese, Italian, Polish, Portuguese, Russian, Dutch, German, Spanish, Swedish).
* Seamless email integration.
* Web installer & updater.
* Starred conversations.
* Forwarding conversations.
* Merging conversations.
* Moving conversations between mailboxes.
* Phone conversations.
* Sending new conversations to multiple recipients at once.
* Push notifications.
* Following a conversation.
* Auto reply.
* Notes.
* Pasting screenshots from the clipboard into the reply area.
* Configuring notifications on a per user basis.
* Open tracking.
* Editing threads.
* Search.
Need anything else? Suggest features [here](https://freescout.net/request-feature/).
## Demo
**[Live Demo](https://demo.freescout.net)**
## Mobile Apps
Mobile apps support the same functionality and modules as the web version of your FreeScout installation. Both support agents and administrators can use mobile apps.
<a href="https://freescout.net/android-app/" target="_blank" rel="nofollow"><img alt="Android App" src="https://freescout-helpdesk.github.io/img/apps/android.png" width="200px" /></a> <a href="https://freescout.net/ios-app/" target="_blank" rel="nofollow"><img alt="iOS App" src="https://freescout-helpdesk.github.io/img/apps/ios.png?v=1" width="200px" /></a>
## 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 - 7.4
* MySQL 5.0+ / MariaDB 5.0+ / PostgreSQL
## Installation
[Installation Guide](https://github.com/freescout-helpdesk/freescout/wiki/Installation-Guide)
Images & one-click installs:
* [Docker Image](http://freescout.net/docker/)
* [Softaculous](http://www.softaculous.com/apps/customersupport/FreeScout) (cPanel, Plesk, ISPmanager, H-Sphere, DirectAdmin, InterWorx)
* [Fantastico](http://ff3.netenberg.com/visitors/scripts/freescout/view) (cPanel, DirectAdmin, ISP Manager, ISP Config)
* [Cloudron](https://cloudron.io/store/net.freescout.cloudronapp.html)
* [Ubuntu](https://github.com/freescout-helpdesk/freescout/wiki/Installation-Guide#interactive-installation-bash-script-ubuntu) (bash script)
## Modules
[Available modules](https://freescout.net/modules/)
## Tools & Integrations
* [API](https://api-docs.freescout.net/)
* [Migrate to FreeScout](http://freescout.net/migrate/) (from any help desk)
* [Zapier Integration](https://freescout.net/zapier/)
## News & Updates
If you would like to be notified about important news and updates you can subscribe [here](https://feedburner.google.com/fb/a/mailverify?uri=freescout)
## Contributing
* [Support the project by leaving a feedback](https://github.com/freescout-helpdesk/freescout/issues/288)
* [Development Guide](https://github.com/freescout-helpdesk/freescout/wiki/Development-Guide)
* [Todo list](https://github.com/freescout-helpdesk/freescout/labels/help%20wanted)
* [Translate](https://github.com/freescout-helpdesk/freescout/wiki/Translate)
## 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)