Introduction

Trudesk is Open Source Help Desk Software. Built with one goal in mind, to keep work loads organized and simple.

This documentation will assist Trudesk users with installation, configuration, and administration of theOpen Source Community Edition of Trudesk.

Let's discoverTrudesk in less than 5 minutes.

Features​

Trudesk has been active development since 2014. Many community requested features have been implemented. Here are just a few things Trudesk Community Edition has to offer. With many more features alreadyin-progress.

• 📝Tickets
  • Real time updates through websockets.
  • Organized through Teams, Groups, and Tags
• 💬Messaging
  • Chat between Agent and Customers/Users.
  • Real time online status of Users
• 📧Mail
  • Notification mail sent automatically
  • Generate tickets through polling an IMAP mailbox.
• 📢Annoucements
  • Site wide announcements
• ⚛️Developer Friendy
  • API access for third party developers to integrate with Trudesk.

Getting Started​

Trudesk is built withNodeJS,MongoDB, andElasticSearch which allows it to run in any cloud provider stack, VM, Docker, or bare metal.

Get started bydeploying an instance.

Deploying Instance​

Quickly deploy a new instance withUbuntu Server

What you'll need​

• Ubuntu Server 20.04 LTS
  • If installing MongoDB and ElasticSearch, a minium of2GB of memory and5GB of storage is required.

Deploy with Ubuntu Install Script​

Deploy Trudesk with a simple one-liner on a fresh install of Ubuntu 20.04 LTS

curl -L -s https://storage.trudesk.io/install/ubuntu-1.2.sh

Once complete you can access your deployment athttp://{ipaddress}:8118

Other Notes​

• In a production environment you should serveTrudesk overhttps. It is recommended to use annginx reverse proxy withssl in front of Trudesk.Please read theNginx Reverse Proxy documentation for more information.

Deploy with Docker-Compose​

Within the Github repo, a sampledocker-compose.yml file is included. We can quickly stand up a demo site with docker.

Downloaddocker-compose.yml from Github repo

wget https://raw.githubusercontent.com/polonel/trudesk/master/docker-compose.yml

Stand Up Docker Stack

docker-compose up

Three containers are deployed;MongoDB,ElasticSearch,Trudesk. Once all containers are online, access the Trudesk instance athttp://localhost:8118

Note: By default MongoDB and Elastic search ports are exposed to the host

What's Next​

Once you finished the install wizard you'll be prompted to login. From here the first steps to any fresh deployment is toconfigure Trudesk for use.Here are some recommended topics to get you started.

• Setup yourGeneral configuration.
• Get yourMailer up and running.
• Learn aboutDepartment, Teams, & Groups.
• Customize yourAppearance.

Something Not Right?​

If you find issues with the documentation or have suggestions on how to improve the documentation pleasefile an issue for us. The Community Edition of Trudesk is maintained by a very small team, so any additional support is welcomed with open arms.