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…

What is this?UVdesk Community is a free, open-source helpdesk platform: a ticketing system for customer support built on the Symfony framework and backbone.js, covering tickets, mailboxes, a knowledge base and an extensible bundle system.
Is this a hosted service like Zendesk, or do I run it on my own server?You host it yourself — it's a PHP web application you deploy on your own Apache or NGINX server with MySQL, not a hosted SaaS. A pre-configured Amazon Machine Image is also available on the AWS Marketplace if you'd rather launch it in the cloud.
How do I install it — Composer, an archive, Docker?Create the project with Composer (composer create-project uvdesk/community-skeleton) or download the pre-packaged release zip, then open it in your browser and follow the web installer wizard. Docker, Vagrant and AWS AMI setups are documented too.
What do I need on my server before installing?PHP 8.1 with the IMAP and Mailparse extensions, MySQL 5.7.23+, Composer 2+, Apache or NGINX and about 4 GB of RAM. Ubuntu 16.04+ and Windows 7+ (WAMP/XAMPP) are supported, with setup guides for CentOS and Mac as well.
Is it usable out of the box, or is this a starter kit I have to build on?It works out of the box — the standard distribution ships the core, extension, automation, mailbox and support-center bundles plus a web installer. But this repo is a skeleton: the intent is to build and customize your own helpdesk on top of it.
Are there limits on agents or tickets as my support team grows?No artificial caps: unlimited agents, groups, teams, customers and tickets, with per-agent privileges to control who can do what — so it scales from a small shop to a large support department.
Can customer emails become tickets automatically?Yes — the mailbox component converts incoming emails into tickets inside UVdesk, and there's no limit on how many mailbox/email integrations you set up.
Does it include a self-service knowledge base?Yes: a knowledge base and FAQ system organized by articles, categories, and folders, plus a customizable support center portal where customers interact with the support staff.
Can I automate repetitive support work?The automation bundle adds workflows and prepared responses; on top of that you get saved replies for frequent questions, spam blocking, ticket forwarding and standard automated workflows.
Where do agents and customers sign in?By default agents log in at /en/member/login and customers at /en/customer/login on your helpdesk domain, unless you change those prefixes.
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