freescout-support/README.md

154 lines
6.2 KiB
Markdown
Raw Permalink Normal View History

2018-10-23 05:55:39 -07:00
# Free Self-Hosted Zendesk & Help Scout Alternative
2018-06-22 10:44:21 -07:00
2018-09-07 06:08:34 -07:00
<div align="center">
2024-06-18 00:46:15 -07:00
<img src="https://raw.githubusercontent.com/freescout-help-desk/freescout/master/public/img/logo-300.png" width="180" height="180" />
2018-09-07 06:08:34 -07:00
<br/><br/>
2018-07-20 07:48:32 -07:00
2025-04-01 23:59:04 -07:00
[![PHP version](https://freescout-helpdesk.github.io/img/badges/PHP-7.1%2B-blue.svg)](https://github.com/freescout-help-desk/freescout#requirements)
2018-07-23 23:26:34 -07:00
2018-09-07 06:08:34 -07:00
</div>
2023-06-25 06:07:21 -07:00
**FreeScout** is the super lightweight and powerful free open source help desk and shared inbox built with PHP (Laravel framework). 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.
2018-09-19 01:00:59 -07:00
2023-03-30 22:25:04 -07:00
If you want to support the project feel free to **star this repository**. It helps to increase the visibility of the project and let people know that it is valuable. Thanks for your support!
2018-09-20 00:08:02 -07:00
![FreeScout](https://freescout-helpdesk.github.io/img/screenshots/screenshot.png)
2018-06-22 10:44:21 -07:00
2018-07-14 16:46:01 -07:00
## Table of Contents
2019-07-04 06:05:57 -07:00
* [Demo](#demo)
2023-09-02 00:04:35 -07:00
* [Features](#features)
2019-11-08 23:17:58 -08:00
* [Mobile Apps](#mobile-apps)
2018-07-14 16:46:01 -07:00
* [Requirements](#requirements)
2018-11-03 23:33:26 -07:00
* [Installation](#installation)
2021-10-19 23:39:33 -07:00
* [Cloud Hosted](#cloud-hosted)
2021-02-03 05:56:34 -08:00
* [Modules](#modules)
* [Tools & Integrations](#tools--integrations)
* [News & Updates](#news--updates)
2018-09-22 22:02:40 -07:00
* [Contributing](#contributing)
2018-07-14 16:46:01 -07:00
* [Screenshots](#screenshots)
2023-09-02 00:04:35 -07:00
## Demo
**[Live Demo](https://demo.freescout.net)**
2018-06-22 10:44:21 -07:00
## Features
2021-10-21 05:50:53 -07:00
* No limitations on the number of users, tickets, mailboxes, etc.
2018-08-27 01:08:20 -07:00
* 100% Mobile-friendly.
2025-03-31 01:23:15 -07:00
* Multilingual: English, Chinese, Croatian, Czech, Danish, Dutch, Finnish, French, German, Hungarian, Italian, Japanese, Kazakh, Korean, Norwegian, Persian, Polish, Portuguese, Russian, Spanish, Slovak, Swedish, Turkish.
2019-06-18 01:48:34 -07:00
* Seamless email integration.
2023-03-09 23:03:46 +11:00
* Supports modern Microsoft Exchange authentication.
2024-03-07 10:43:17 -08:00
* Fully supports screen readers (for visually impaired).
2024-03-07 22:08:26 -08:00
* Built with strong focus on [security](https://freescout.net/security).
2019-06-18 01:48:34 -07:00
* Web installer & updater.
2018-06-22 10:44:21 -07:00
* Starred conversations.
2019-07-02 09:46:34 -07:00
* Forwarding conversations.
2020-09-27 23:02:15 -07:00
* Merging conversations.
2019-11-14 08:46:03 -08:00
* Moving conversations between mailboxes.
2019-07-22 07:05:52 -07:00
* Phone conversations.
* Sending new conversations to multiple recipients at once.
2022-01-29 05:57:28 -08:00
* Collision detection notice is shown when two agents open the same conversation.
2018-10-22 06:49:27 -07:00
* Push notifications.
2019-12-28 05:44:21 -08:00
* Following a conversation.
2018-10-22 06:49:27 -07:00
* Auto reply.
2021-10-21 05:50:53 -07:00
* Internal notes.
2022-12-16 09:36:20 -08:00
* Automatic refreshing of the conversations list without the need to reload the page.
2018-07-16 03:09:15 -07:00
* Pasting screenshots from the clipboard into the reply area.
2019-04-25 21:23:59 -07:00
* Configuring notifications on a per user basis.
2018-10-22 06:49:27 -07:00
* Open tracking.
2019-07-22 07:05:52 -07:00
* Editing threads.
2019-04-25 21:23:59 -07:00
* Search.
2023-11-21 23:18:19 -08:00
* And more…
2019-04-25 21:23:59 -07:00
2020-01-10 21:15:04 -08:00
Need anything else? Suggest features [here](https://freescout.net/request-feature/).
2018-10-22 06:49:27 -07:00
2019-11-08 23:17:58 -08:00
## Mobile Apps
2020-10-07 10:23:10 -07:00
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.
2020-10-06 02:28:13 -07:00
<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>
2019-11-08 23:17:58 -08:00
2024-12-06 09:23:44 -08:00
[MacOS Menu Bar App](https://github.com/jonalaniz/scouter)
2018-06-22 10:44:21 -07:00
## Requirements
2024-12-05 08:12:49 -08:00
FreeScout is a pure PHP/MySQL application, so it can be easily deployed even on a [shared hosting](https://github.com/freescout-help-desk/freescout/wiki/Choosing-a-Server).
2018-09-10 02:50:53 -07:00
2018-07-18 04:23:17 -07:00
* Nginx / Apache / IIS
2024-04-11 23:33:16 -07:00
* PHP 7.1 - 8.x
2018-11-12 23:15:48 -08:00
* MySQL 5.0+ / MariaDB 5.0+ / PostgreSQL
2018-06-22 10:44:21 -07:00
2024-06-11 22:18:50 -07:00
There are no minimum system requirements (CPU / RAM) FreeScout will run on any system.
2023-01-17 03:03:45 -08:00
2018-11-03 23:33:26 -07:00
## Installation
2018-06-22 10:44:21 -07:00
2024-06-18 00:46:15 -07:00
[Installation Guide](https://github.com/freescout-help-desk/freescout/wiki/Installation-Guide)
2018-06-22 10:44:21 -07:00
2021-02-03 06:01:20 -08:00
Images & one-click installs:
2021-02-03 05:59:06 -08:00
* [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)
2024-06-18 00:46:15 -07:00
* [Ubuntu](https://github.com/freescout-help-desk/freescout/wiki/Installation-Guide#interactive-installation-bash-script-ubuntu) (bash script)
2021-02-03 05:59:06 -08:00
2021-10-19 23:39:33 -07:00
## Cloud Hosted
2021-10-19 23:41:13 -07:00
[Cloud Hosted FreeScout](https://freescout.net/cloud-hosted/)
2021-10-19 23:39:33 -07:00
2021-02-03 05:56:34 -08:00
## Modules
* [Official Modules](https://freescout.net/modules/)
* [Community Modules](https://freescout.net/community-modules/)
2021-02-03 05:56:34 -08:00
## Tools & Integrations
* [API](https://api-docs.freescout.net/)
2021-02-12 06:18:06 -08:00
* [Migrate to FreeScout](http://freescout.net/migrate/) (from any help desk)
2022-01-20 07:31:58 -08:00
* [Zapier](https://freescout.net/zapier/)
2022-06-21 23:10:57 -07:00
* [Make](https://freescout.net/make-integration/) (Integromat)
2021-02-03 05:56:34 -08:00
## News & Updates
2022-12-01 22:32:46 -08:00
Don't miss news, updates and new modules!
2023-11-21 23:21:39 -08:00
[Email Newsletter](https://freescout.net/subscribe/) | [Facebook](https://freescout.net/facebook/) | [Twitter](https://freescout.net/twitter/) | [YouTube](https://freescout.net/youtube/) | [Telegram](https://freescout.net/telegram/) | [RSS](https://freescout.net/feed/)
2021-02-03 05:56:34 -08:00
2018-09-22 22:02:40 -07:00
## Contributing
2018-07-17 16:43:59 -07:00
2024-06-18 00:46:15 -07:00
* [Support the project by leaving a feedback](https://github.com/freescout-help-desk/freescout/issues/288)
* [Development Guide](https://github.com/freescout-help-desk/freescout/wiki/Development-Guide)
* [Todo list](https://github.com/freescout-help-desk/freescout/labels/help%20wanted)
* [Translate](https://github.com/freescout-help-desk/freescout/wiki/Translate)
2018-07-17 16:43:59 -07:00
2018-06-22 10:44:21 -07:00
## Screenshots
2018-09-19 22:49:09 -07:00
Dashboard:
2018-07-05 20:53:48 -07:00
2018-09-19 22:49:09 -07:00
![Dashboard](https://freescout-helpdesk.github.io/img/screenshots/dashboard.png)
2018-07-16 00:58:40 -07:00
2018-07-19 23:19:25 -07:00
Conversation:
![Conversation](https://freescout-helpdesk.github.io/img/screenshots/conversation.png)
2018-09-19 22:49:09 -07:00
2018-07-08 00:39:12 -07:00
Mailbox connection settings page:
2018-09-19 22:49:09 -07:00
![Mailbox connection settings page](https://freescout-helpdesk.github.io/img/screenshots/mailbox-connection.png)
2018-10-31 00:17:39 -07: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-19 22:49:09 -07:00
Login page:
2018-10-14 23:12:05 -07:00
![Login page](https://freescout-helpdesk.github.io/img/screenshots/freescout-login.png)