Tiledesk Server

by Tiledesk

GitHub Readme.md

npm version

Build Status

Introduction

Tiledesk-server is the server engine of Tiledesk. Tiledesk is an Open Source Live Chat platform with integrated ChatBot written in NodeJs and Express. Build your own customer support with a multi-channel platform for Web, Android and iOS. More info here https://www.tiledesk.com.

You can find more info here: https://developer.tiledesk.com

Prerequisites

Running Tiledesk Server

Run locally with npm

Steps to run with npm:

npm install -g @tiledesk/tiledesk-server mongodb-runner
mongodb-runner start
curl https://raw.githubusercontent.com/Tiledesk/tiledesk-server/master/.env.sample --output .env
nano .env #configure .env file properly
tiledesk-server  

If you want to load .env file from another path: DOTENV_PATH=/MY/ABSOLUTE/PATH/.env tiledesk-server

Note: If installation with -g fails due to permission problems (npm ERR! code 'EACCES'), please refer to this link.

Using Docker

Configure .env file

curl https://raw.githubusercontent.com/Tiledesk/tiledesk-server/master/.env.sample --output .env
nano .env #configure .env file properly

Running

If you want to run tiledesk and mongo with docker run :

docker run --name tiledesk-mongo -d mongo
docker run -p 3000:3000 --env DATABASE_URI="mongodb://mongo/tiledesk-server" --env-file .env --link tiledesk-mongo:mongo tiledesk/tiledesk-server

Otherwise if you want to run tiledesk only with docker run :

docker run -p 3000:3000 --env DATABASE_URI="mongodb://YOUR_MONGO_INSTALLATION_ENDPOINT/tiledesk-server" --env-file .env tiledesk/tiledesk-server

Install from source code

  • Clone this repo
  • Install dependencies with npm install
  • Configure the tiledesk .env file. You can see an example in the file .env.sample under the root folder. Rename it from .env.sample to .env and configure it properly.
  • Run the app with the command npm start or with nodemon if you want monitoring and auto reload. Install nodemon with npm install -g nodemon

Deploy on Heroku

Deploy with button:

Deploy

REST API

See the Tiledesk REST API here

Upgrading

To see how to upgrade tiledesk-server see here