1
0
mirror of https://github.com/freescout-helpdesk/freescout.git synced 2024-11-24 11:22:42 +01:00
freescout/README.md

122 lines
4.6 KiB
Markdown
Raw Normal View History

2018-10-23 14:55:39 +02:00
# Free Self-Hosted Zendesk & Help Scout Alternative
2018-06-22 19:44:21 +02:00
2018-09-07 15:08:34 +02:00
<div align="center">
2018-07-20 16:48:32 +02:00
<img src="https://raw.githubusercontent.com/freescout-helpdesk/freescout/master/public/img/logo-300.png" width="180" height="180" />
2018-09-07 15:08:34 +02:00
<br/><br/>
2018-07-20 16:48:32 +02:00
2018-08-02 18:17:13 +02:00
[![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)
2019-05-08 08:14:04 +02:00
[![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)
2018-07-24 08:26:34 +02:00
2018-09-07 15:08:34 +02:00
</div>
2019-07-12 11:52:11 +02:00
**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.
2018-07-17 02:50:39 +02:00
2018-11-30 12:27:34 +01:00
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, design, logos, icons, CSS, JS, HTML files are copyrighted; idea cannot be copyrighted).
2018-09-19 10:00:59 +02:00
2018-09-20 09:08:02 +02:00
![FreeScout](https://freescout-helpdesk.github.io/img/screenshots/screenshot.png)
2018-06-22 19:44:21 +02:00
2018-07-15 01:46:01 +02:00
## Table of Contents
* [Features](#features)
2019-07-04 15:05:57 +02:00
* [Demo](#demo)
2019-11-09 08:17:58 +01:00
* [Mobile Apps](#mobile-apps)
2019-04-26 06:23:59 +02:00
* [Modules](#modules)
2018-07-15 01:46:01 +02:00
* [Requirements](#requirements)
2018-09-23 07:02:40 +02:00
* [News & Updates](#news--updates)
2018-11-04 07:33:26 +01:00
* [Installation](#installation)
2018-09-23 07:02:40 +02:00
* [Contributing](#contributing)
2018-07-15 01:46:01 +02:00
* [Screenshots](#screenshots)
2018-06-22 19:44:21 +02:00
## Features
2019-09-05 10:21:59 +02:00
* No limitations on the number of users, tickets, etc.
2018-08-27 10:08:20 +02:00
* 100% Mobile-friendly.
2019-06-05 13:15:41 +02:00
* Multilingual (English, French, Italian, Portuguese).
2019-06-18 10:48:34 +02:00
* Seamless email integration.
* Web installer & updater.
2018-06-22 19:44:21 +02:00
* Starred conversations.
2019-07-02 18:46:34 +02:00
* Forwarding conversations.
2019-07-22 16:05:52 +02:00
* Phone conversations.
* Sending new conversations to multiple recipients at once.
2018-10-22 15:49:27 +02:00
* Push notifications.
* Auto reply.
* Notes.
2018-07-16 12:09:15 +02:00
* Pasting screenshots from the clipboard into the reply area.
2019-04-26 06:23:59 +02:00
* Configuring notifications on a per user basis.
2018-10-22 15:49:27 +02:00
* Open tracking.
2019-07-22 16:05:52 +02:00
* Editing threads.
2019-04-26 06:23:59 +02:00
* Search.
Need anything else? Suggest features [here](https://feedback.userreport.com/25a3cb5f-e4bd-4470-b6f3-79fcfaa8e90f/#ideas/popular).
2018-10-22 15:49:27 +02:00
2019-07-04 15:05:57 +02:00
## Demo
[Live demo](https://demo.freescout.net)
2019-11-09 08:17:58 +01:00
## Mobile Apps
2019-11-09 10:51:46 +01:00
<a href="https://freescout.net/android-app/" target="_blank"><img alt="Android App" src="https://freescout-helpdesk.github.io/img/apps/android.png" width="200px" /></a>
2019-11-09 08:17:58 +01:00
2019-04-26 06:23:59 +02:00
## Modules
2019-06-20 12:43:10 +02:00
[Available modules](https://freescout.net/modules/)
2018-06-22 19:44:21 +02:00
## Requirements
2018-09-10 11:50:53 +02:00
FreeScout is a pure PHP/MySQL application, so it can be easily deployed even on a shared hosting.
2018-07-18 13:23:17 +02:00
* Nginx / Apache / IIS
2018-07-25 16:09:20 +02:00
* PHP 7.0+
2018-11-13 08:15:48 +01:00
* MySQL 5.0+ / MariaDB 5.0+ / PostgreSQL
2018-06-22 19:44:21 +02:00
2018-09-19 10:00:59 +02:00
## News & Updates
2018-07-18 01:43:59 +02:00
2018-09-19 10:00:59 +02:00
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)
2018-07-18 01:43:59 +02:00
2018-11-04 07:33:26 +01:00
## Installation
2018-06-22 19:44:21 +02:00
2018-07-16 12:58:44 +02:00
[Installation Guide](https://github.com/freescout-helpdesk/freescout/wiki/Installation-Guide)
2018-06-22 19:44:21 +02:00
2019-07-26 08:01:03 +02:00
Images & one-click installs:
2019-06-18 10:48:34 +02:00
2019-06-18 10:57:06 +02:00
* [Docker Image](http://freescout.net/docker/)
2019-07-25 13:05:39 +02:00
* [Softaculous](http://www.softaculous.com/apps/customersupport/FreeScout) (cPanel, Plesk, ISPmanager, H-Sphere, DirectAdmin, InterWorx)
2019-06-18 10:57:06 +02:00
* [Fantastico](http://ff3.netenberg.com/visitors/scripts/freescout/view) (cPanel, DirectAdmin, ISP Manager, ISP Config)
2019-06-18 10:48:34 +02:00
2018-09-23 07:02:40 +02:00
## Contributing
2018-07-18 01:43:59 +02:00
2018-11-04 07:33:26 +01:00
* [Development Guide](https://github.com/freescout-helpdesk/freescout/wiki/Development-Guide)
2019-06-21 08:02:23 +02:00
* [Todo list](https://github.com/freescout-helpdesk/freescout/labels/help%20wanted)
2018-09-26 16:31:21 +02:00
* [Translate](https://github.com/freescout-helpdesk/freescout/wiki/Translate)
2018-09-23 07:02:40 +02:00
* [Support project by leaving a feedback](https://github.com/freescout-helpdesk/freescout/wiki#support-project)
2018-07-18 01:43:59 +02:00
2018-06-22 19:44:21 +02:00
## Screenshots
2018-09-20 07:49:09 +02:00
Dashboard:
2018-07-06 05:53:48 +02:00
2018-09-20 07:49:09 +02:00
![Dashboard](https://freescout-helpdesk.github.io/img/screenshots/dashboard.png)
2018-07-16 09:58:40 +02:00
2018-07-20 08:19:25 +02:00
Conversation:
![Conversation](https://freescout-helpdesk.github.io/img/screenshots/conversation.png)
2018-09-20 07:49:09 +02:00
2018-07-08 09:39:12 +02:00
Mailbox connection settings page:
2018-09-20 07:49:09 +02:00
![Mailbox connection settings page](https://freescout-helpdesk.github.io/img/screenshots/mailbox-connection.png)
2018-10-31 08:17:39 +01:00
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)
2018-09-20 07:49:09 +02:00
Login page:
2018-10-15 08:12:05 +02:00
![Login page](https://freescout-helpdesk.github.io/img/screenshots/freescout-login.png)