community-skeleton README

The project's README from github.com/uvdesk/community-skeleton. As one markdown file: README.md.

Latest Stable Version Total Downloads Backers on Open Collective Sponsors on Open Collective connect on gitter discuss on uvdesk forum Checkout us on open source projects from India

➡️ Website | Documentation | Installation Guide | Forums | Community ⬅️

Arabic German English Spanish French Italian Danish Polish Turkish Chinese Brazil

Uvdesk community helpdesk project skeleton packaged along with the bare essential utilities and tools to build and customize your own helpdesk solutions.

Visit our official demo website to see it in action!

Check out UVdesk on Symfony Official Website – Symfony

Getting Started

About

Build on top of symfony and backbone.js, UVdesk Community is an open-source, service-oriented, and event-driven helpdesk system designed for easy customization and seamless client support. Its extensible architecture allows organizations to deliver efficient, tailored customer service with minimal effort.

The standard distribution includes a comprehensive set of helpdesk packages to support a wide range of use cases and operational needs.

Reach out to us at our official gitter chat or by joining forum for any queries, concerns and feature request discussions.

The development of the uvdesk community edition is led by the uvdesk team and backed by Webkul. Visit our website to learn more about the UVDesk Helpdesk System.

Features

Documentation

Visit docs.uvdesk.com to read our official documentation and learn more about the uvdesk community project.

We use Jekyll to develop and maintain our documentations. Consider contributing by submitting a pull request to our project's jeykll repository.

Requirements

Installation

The installation process is broken down into two distinct steps:

Setting up your helpdesk project

In this step, you'll download the Helpdesk project skeleton and install its dependencies.

You can either use Composer to download and install everything automatically, or download a pre-packaged archive that includes all dependencies. We recommend using Composer whenever possible for easier updates and better dependency management. However, if you're on a system with limited resources (e.g., shared hosting), the archive download may be more reliable.

Regardless of the method you choose, the configuration process for Helpdesk remains the same.

Composer

You can use composer to setup your project by simply running the following command from your terminal:

$ composer create-project uvdesk/community-skeleton helpdesk-project

Direct Download

Alternatively, you can also download the zip archive of the latest stable release and extract its content by running the following commands from your terminal:

$ wget "https://cdn.uvdesk.com/uvdesk/downloads/opensource/uvdesk-community-current-stable.zip" -P /var/www/
$ unzip -q /var/www/uvdesk-community-current-stable.zip -d /var/www/ \

Configuring your helpdesk project

After you've downloaded and installed all the project dependencies, you can configure your helpdesk installation using either of the following ways:

Using Terminal

$ php bin/console uvdesk:configure-helpdesk

Using Web Installer Wizard

Extract the contents of zip and execute the project in your browser in case of project zip download:
http(s)://localhost/community-skeleton/public
In case of created project using command, execute the project in your browser:
http(s)://localhost/helpdesk-project/public

or

http(s)://example.com/public

After opening your project in the web browser, you will be greeted by the web installer which will guide you in configuring your project.

Run project on localhost (dev mode)
php bin/console server:run

How to clear cache:

php bin/console c:c

☁️ Deploy UVdesk on the Cloud with Amazon AMI

Easily launch UVdesk on the cloud using our pre-configured Amazon Machine Image (AMI), available directly from the AWS Marketplace:

👉 Launch UVdesk on AWS

This AMI offers a quick and hassle-free way to set up UVdesk on a secure, scalable AWS environment. Perfect for both production deployments and testing purposes, with no need for manual configuration.

How to log in as admin/agent:

Below url is the default url for admin/agent login if you have not made any changes for /member prefix.

http(s)://example.com/en/member/login

How to log in as customer:

Below url is the default url for customer login if you have not made any changes for /customer prefix.

http(s)://example.com/en/customer/login

Docker Runtime

Dockerize your helpdesk project

Docker Persistent Container

Get started with Uvdesk now by using docker persistent container

Vagrant Virtual Environment

Get started with uvdesk now by using vagrant to setup virtual environment

Modules

Available Modules/Apps

Need something else ? email us at [email protected]

License

All libraries and bundles included in the UVDesk Community Edition are released under the OSL-3.0 license license.

Security Vulnerabilities

Please don't disclose any security vulnerabilities publicly. If you find any security vulnerability in our platform then please write us at [email protected].

Feedback

Feedback (Support Community project by raising feedback)

Contributions

This project is hosted on Open Collective and exists thanks to our contributors:

Backers

Thank you to all our backers! 🙏

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website.

community-skeleton (uvdesk/community-skeleton)

Searching Database…

这是什么?UVdesk Community 是一个免费开源的客服工单平台:基于 Symfony 框架和 backbone.js 构建的客户支持工单系统,涵盖工单、邮箱、知识库以及可扩展的 bundle 系统。
它是像 Zendesk 那样的托管服务,还是需要我自己部署到服务器上?需要自己部署——它是一个 PHP 网页应用,你要把它部署到自己的 Apache 或 NGINX 服务器上并搭配 MySQL,而不是托管式的 SaaS。如果你更想在云端运行,AWS Marketplace 上也提供了预配置好的 Amazon Machine Image。
怎么安装?用 Composer、压缩包还是 Docker?可以用 Composer 创建项目(composer create-project uvdesk/community-skeleton),也可以下载打包好的发行版 zip,然后在浏览器中打开并按照网页安装向导操作。Docker、Vagrant 和 AWS AMI 的安装方式也都有文档说明。
安装前我的服务器需要具备哪些条件?PHP 8.1(需启用 IMAP 和 Mailparse 扩展)、MySQL 5.7.23+、Composer 2+、Apache 或 NGINX,以及约 4 GB 内存。支持 Ubuntu 16.04+ 和 Windows 7+(WAMP/XAMPP),也提供 CentOS 和 Mac 的安装指南。
它是开箱即用的,还是一个需要我自行搭建的入门模板?它可以开箱即用——标准发行版包含核心、扩展、自动化、邮箱和客服中心等 bundle,外加一个网页安装器。不过这个仓库本质上是一个骨架:其设计初衷就是让你在它之上搭建和定制自己的客服系统。
随着客服团队扩大,客服人员或工单数量会有上限吗?没有人为主观限制:客服人员、分组、团队、客户和工单数量都不限,还能为每个客服人员单独设置权限来控制谁能做什么——所以从小作坊到大型客服部门都能用。
客户发来的邮件能自动变成工单吗?可以——邮箱组件会把收到的邮件自动转换成 UVdesk 里的工单,而且邮箱/邮件集成想配置多少个都没有限制。
它带自助服务知识库吗?有:提供按文章、分类和文件夹组织的知识库和 FAQ 系统,还有一个可定制的客服中心门户,客户可以在上面与客服人员互动。
重复性的客服工作能自动化吗?自动化 bundle 提供了工作流和预设回复;此外还有针对常见问题的保存回复、垃圾邮件拦截、工单转发以及标准自动工作流。
客服人员和客户在哪里登录?默认情况下,客服人员在客服域名下的 /en/member/login 登录,客户在 /en/customer/login 登录,除非你修改了这些路径前缀。
What are similar projects?chatwoot, Kooboo, SSPanel-UIM, MaxKB, unopim, caprover, temporal, matomo
Creator
uvdesk
Size
34.9 MB
Stars
19.6K
Age
7y
Commits · 90 Days