Everything you need to get started with Novumdesk
Welcome to Novumdesk! This guide will help you get up and running quickly.
Novumdesk is a modern helpdesk platform designed to streamline customer support operations. It helps you manage tickets, collaborate with your team, and provide exceptional customer service.
Novumdesk offers two deployment options:
For cloud deployment, simply sign up at cloud.novumdesk.io and start using Novumdesk immediately.
Requirements:
# Clone the repository
git clone https://github.com/novumdesk/novumdesk.git
cd novumdesk
# Install dependencies
composer install
npm install
# Configure environment
cp .env.example .env
php artisan key:generate
# Run migrations
php artisan migrate
# Start the server
php artisan serve
Configure your application using the .env file:
APP_NAME=Novumdesk
APP_ENV=production
APP_URL=https://your-domain.com
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=novumdesk
DB_USERNAME=your_username
DB_PASSWORD=your_password
Learn how to create, manage, and resolve support tickets effectively.
Tickets can be created through the web interface, email, API, or automatically from integrated channels.
Connect Novumdesk with your favorite tools and services.
Connect your email accounts
Get notifications in Slack
Sync tickets with Jira
Automate workflows
Create intelligent AI chatbots powered by Ollama models, trained on your product documents for accurate customer support.
First, install and run Ollama on your server:
# Install Ollama
curl -fsSL https://ollama.com/install.sh | sh
# Start Ollama server
ollama serve
# Pull a model (e.g., llama3)
ollama pull llama3
Upload your product documentation (PDF, DOCX, TXT, MD) to train the AI:
POST /api/v1/documents
Content-Type: multipart/form-data
file: product_manual.pdf
title: "Product Manual"
category: "product"
train_ai: true
Create a chatbot with Ollama model and link it to your product documents:
POST /api/v1/chatbots
{
"name": "Product Support Bot",
"model": "llama3",
"ollama_endpoint": "http://localhost:11434",
"product_documents": ["doc_1", "doc_2"]
}
Train your chatbot on product documents using RAG (Retrieval Augmented Generation):
POST /api/v1/documents/train
{
"document_ids": ["doc_1", "doc_2"],
"chatbot_id": "chatbot_123",
"model": "llama3",
"training_type": "rag"
}
Send messages to your trained chatbot:
POST /api/v1/chat/message
{
"message": "What are your product features?",
"chatbot_id": "chatbot_123"
}
Example Code: Check out our example implementations in Python and Node.js for complete integration examples.
Novumdesk provides a comprehensive REST API for programmatic access. For detailed API documentation, visit our API Reference page.
# Example API call
curl -X GET https://your-instance.com/api/v1/tickets \
-H "Authorization: Bearer YOUR_API_TOKEN"