Installations
npm install @tiledesk/tiledesk-serverDeveloper
Developer Guide
Module System
CommonJS
Min. Node Version
16.17.0
Typescript Support
No
Node Version
16.17.0
NPM Version
8.15.0
Statistics
308 Stars
5,444 Commits
108 Forks
12 Watching
138 Branches
6 Contributors
Updated on 28 Nov 2024
Languages
JavaScript (92.79%)
HTML (7%)
Pug (0.17%)
Dockerfile (0.02%)
Shell (0.02%)
Total Downloads
Cumulative downloads
Total Downloads
231,435
Last day
-60.1%
65
Compared to previous day
Last week
-19.1%
330
Compared to previous week
Last month
-55.9%
1,266
Compared to previous month
Last year
238.8%
159,066
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
86
Dev Dependencies
7
🚀 Do you want to install Tiledesk on your server with just one click?
Use Docker Compose Tiledesk installation guide
Introduction
Tiledesk-server is the server engine of Tiledesk. Tiledesk is an Open Source Live Chat platform with integrated Chatbots written in NodeJs and Express. Build your own customer support with a multi-channel platform for Web, Android and iOS.
Designed to be open source since the beginning, we actively worked on it to create a totally new, first class customer service platform based on instant messaging.
What is Tiledesk today? It became the open source “conversational app development” platform that everyone needs 😌
You can use Tiledesk to increase sales for your website or for post-sales customer service. Every conversation can be automated using our first class native chatbot technology. You can also connect your own applications using our APIs or Webhooks. Moreover you can deploy entire visual applications inside a conversation. And your applications can converse with your chatbots or your end-users! We know this is cool 😎
Tiledesk is multichannel in a totally new way. You can write your chatbot scripts with images, buttons and other cool elements that your channels support. But you will configureyour chatbot replies only once. They will run on every channel, auto-adapting the responses to the target channel whatever it is, Whatsapp, Facebook Messenger, Telegram etc.
More info on Tiledesk website: https://www.tiledesk.com.
You can find technical documentation here: https://developer.tiledesk.com
Prerequisites for Installation
Run Tiledesk with Docker Compose
Do you want to install all the Tiledesk components on your server with just one click? Use Docker Compose Tiledesk installation guide
Running Tiledesk Server
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
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.
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.
Deploy on Heroku
Deploy with button:
Community? Questions? Support ?
If you need help or just want to hang out, come, say hi on our 
Discord server.
REST API
See the Tiledesk REST API here
Upgrading
To see how to upgrade tiledesk-server see here
Testing
Run unit test with npm test and integration test with npm run test:int
No vulnerabilities found.
Reason
30 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
packaging workflow detected
Details
- Info: Project packages its releases by way of GitHub Actions.: .github/workflows/docker-community-push-latest.yml:10
Reason
Found 0/30 approved changesets -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/docker-community-push-latest.yml:1
- Warn: no topLevel permission defined: .github/workflows/docker-community-worker-push-latest.yml:1
- Warn: no topLevel permission defined: .github/workflows/docker-image-en-tag-push.yml:1
- Warn: no topLevel permission defined: .github/workflows/docker-image-tag-community-tag-push.yml:1
- Warn: no topLevel permission defined: .github/workflows/docker-image-tag-worker-community-tag-push.yml:1
- Warn: no topLevel permission defined: .github/workflows/docker-push-en-push-latest.yml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
no SAST tool detected
Details
- Warn: no pull requests merged into dev branch
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docker-community-push-latest.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/Tiledesk/tiledesk-server/docker-community-push-latest.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker-community-push-latest.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/Tiledesk/tiledesk-server/docker-community-push-latest.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docker-community-worker-push-latest.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/Tiledesk/tiledesk-server/docker-community-worker-push-latest.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker-community-worker-push-latest.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/Tiledesk/tiledesk-server/docker-community-worker-push-latest.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docker-image-en-tag-push.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/Tiledesk/tiledesk-server/docker-image-en-tag-push.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker-image-en-tag-push.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/Tiledesk/tiledesk-server/docker-image-en-tag-push.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker-image-en-tag-push.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/Tiledesk/tiledesk-server/docker-image-en-tag-push.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker-image-en-tag-push.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/Tiledesk/tiledesk-server/docker-image-en-tag-push.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docker-image-tag-community-tag-push.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/Tiledesk/tiledesk-server/docker-image-tag-community-tag-push.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker-image-tag-community-tag-push.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/Tiledesk/tiledesk-server/docker-image-tag-community-tag-push.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docker-image-tag-worker-community-tag-push.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/Tiledesk/tiledesk-server/docker-image-tag-worker-community-tag-push.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker-image-tag-worker-community-tag-push.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/Tiledesk/tiledesk-server/docker-image-tag-worker-community-tag-push.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docker-push-en-push-latest.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/Tiledesk/tiledesk-server/docker-push-en-push-latest.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker-push-en-push-latest.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/Tiledesk/tiledesk-server/docker-push-en-push-latest.yml/master?enable=pin
- Warn: containerImage not pinned by hash: Dockerfile:1: pin your Docker image by updating node:16 to node:16@sha256:f77a1aef2da8d83e45ec990f45df50f1a286c5fe8bbfb8c6e4246c6389705c0b
- Warn: containerImage not pinned by hash: Dockerfile-en:1: pin your Docker image by updating node:16 to node:16@sha256:f77a1aef2da8d83e45ec990f45df50f1a286c5fe8bbfb8c6e4246c6389705c0b
- Warn: containerImage not pinned by hash: Dockerfile-jobs:1: pin your Docker image by updating node:16 to node:16@sha256:f77a1aef2da8d83e45ec990f45df50f1a286c5fe8bbfb8c6e4246c6389705c0b
- Warn: npmCommand not pinned by hash: Dockerfile:24
- Warn: npmCommand not pinned by hash: Dockerfile-en:24
- Warn: npmCommand not pinned by hash: Dockerfile-jobs:23
- Info: 0 out of 6 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 8 third-party GitHubAction dependencies pinned
- Info: 0 out of 3 containerImage dependencies pinned
- Info: 0 out of 3 npmCommand dependencies pinned
Reason
80 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-4g6q-77j7-vvjc
- Warn: Project is vulnerable to: GHSA-7v5v-9h63-cj86
- Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-257v-vj4p-3w2h
- Warn: Project is vulnerable to: GHSA-wm7h-9275-46v2
- Warn: Project is vulnerable to: GHSA-3wf4-68gx-mph8
- Warn: Project is vulnerable to: GHSA-4q6p-r6v2-jvc5
- Warn: Project is vulnerable to: GHSA-8cf7-32gw-wr33
- Warn: Project is vulnerable to: GHSA-hjrf-2m68-5959
- Warn: Project is vulnerable to: GHSA-qwph-4952-7xr6
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-qrpm-p2h7-hrv2
- Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
- Warn: Project is vulnerable to: GHSA-5rrq-pxf6-6jx5
- Warn: Project is vulnerable to: GHSA-8fr3-hfg3-gpgp
- Warn: Project is vulnerable to: GHSA-gf8q-jrpm-jvxq
- Warn: Project is vulnerable to: GHSA-2r2c-g63r-vccr
- Warn: Project is vulnerable to: GHSA-cfm4-qjh2-4765
- Warn: Project is vulnerable to: GHSA-x4jg-mjrx-434g
- Warn: Project is vulnerable to: GHSA-g954-5hwp-pp24
- Warn: Project is vulnerable to: GHSA-h755-8qp9-cq85
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-g78m-2chm-r7qv
- Warn: Project is vulnerable to: GHSA-4w2v-q235-vp99
- Warn: Project is vulnerable to: GHSA-cph5-m8f7-6c5x
- Warn: Project is vulnerable to: GHSA-wf5p-g6vw-rhxx
- Warn: Project is vulnerable to: GHSA-8hc4-vh64-cxmj
- Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
- Warn: Project is vulnerable to: GHSA-wxhq-pm8v-cw75
- Warn: Project is vulnerable to: GHSA-4vmm-mhcq-4x9j
- Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
- Warn: Project is vulnerable to: GHSA-xwcq-pm8m-c4vf
- Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h
- Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
- Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
- Warn: Project is vulnerable to: GHSA-x3cc-x39p-42qx
- Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q
- Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c
- Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
- Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
- Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
- Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
- Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
- Warn: Project is vulnerable to: GHSA-hhhv-q57g-882q
- Warn: Project is vulnerable to: GHSA-wgfq-7857-4jcc
- Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
- Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj
- Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf
- Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m / GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-vxvm-qww3-2fh7
- Warn: Project is vulnerable to: GHSA-9m93-w8w6-76hh
- Warn: Project is vulnerable to: GHSA-w9mr-4mfr-499f
- Warn: Project is vulnerable to: GHSA-9h6g-pr28-7cqp
- Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr
- Warn: Project is vulnerable to: GHSA-v923-w3x8-wh69
- Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
- Warn: Project is vulnerable to: GHSA-3965-hpx2-q597
- Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
- Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
- Warn: Project is vulnerable to: GHSA-gp95-ppv5-3jc5
- Warn: Project is vulnerable to: GHSA-54xq-cgqr-rpm3
- Warn: Project is vulnerable to: GHSA-34r7-q49f-h37c
- Warn: Project is vulnerable to: GHSA-c9f4-xj24-8jqx
- Warn: Project is vulnerable to: GHSA-9m6j-fcg5-2442
- Warn: Project is vulnerable to: GHSA-hh27-ffr2-f2jc
- Warn: Project is vulnerable to: GHSA-rqff-837h-mm52
- Warn: Project is vulnerable to: GHSA-8v38-pw62-9cw2
- Warn: Project is vulnerable to: GHSA-hgjh-723h-mx2j
- Warn: Project is vulnerable to: GHSA-jf5r-8hm2-f872
- Warn: Project is vulnerable to: GHSA-p5gc-c584-jj6v
- Warn: Project is vulnerable to: GHSA-whpj-8f3w-67p5
- Warn: Project is vulnerable to: GHSA-cchq-frgv-rjh5
- Warn: Project is vulnerable to: GHSA-g644-9gfx-q4q4
- Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
- Warn: Project is vulnerable to: GHSA-776f-qx25-q3cc
- Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp
Score
3.8
/10
Last Scanned on 2024-11-25
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More