Installation Process

⌘K
  2. Home
  4. Docs
  6. Helpnest – Ai Based...
  8. Instruction
  10. Installation Process

Installation Process

Prerequisites Checklist

Database Requirements

  • Database Engine: PostgreSQL 16 or higher (required)
  • Extension: pgvector (must be installed and enabled)

⚠️ MySQL is NOT supported
This application relies on pgvector for AI embeddings and vector search.
This application is designed exclusively for PostgreSQL with pgvector.
MySQL cannot be used to set up or run this application under any circumstances.
Installation and configuration will fail if MySQL is used.

Before starting, ensure your cPanel hosting meets these requirements:

  • ✅ PHP Version: 8.2 or higher
  • ✅ PostgreSQL: Version 16 or higher
  • ✅ pgvector Extension: Must be enabled
  • ✅ Required PHP Extensions:
    • BCMath, Ctype, Fileinfo, JSON, Mbstring, OpenSSL, PDO, PDO_PGSQL, PGSQL, Tokenizer, XML, GD
  • ✅ Composer: Available via SSH/Terminal
  • ✅ Tesseract OCR: Installed on server
  • ✅ Poppler Utils: Installed on server

Step 1: Download & Extract Files

  1. Download the file from CodeCanyon
  2. Extract the ZIP file on your PC
  3. You’ll find two folders:
    • Documentation
    • Installable File
  4. Inside the Installable File, locate the main ZIP file for upload

Step 2: Create PostgreSQL Database

2.1 Access PostgreSQL Database Manager

  1. Login to cPanel
  2. Navigate to Databases section
  3. Click on PostgreSQL Databases

2.2 Create New Database

  1. Under Create New Database, enter database name: e.g., ai_support
  2. Click Create Database
  3. Note down the full database name

2.3 Create Database User

  1. Scroll to the PostgreSQL Users section
  2. Enter username: e.g., ai_user
  3. Generate a strong password (click Password Generator)
  4. Click Create User
    • IMPORTANT: Save these credentials:
    • Database Name: [your_database_name]
    • User: [your_database_username]
    • Password: [your_generated_password]

2.4 Add User to Database

  1. Scroll to Add User To Database
  2. Select your user and database
  3. Click Add
  4. Check ALL PRIVILEGES
  5. Click Make Changes

2.5 Enable pgvector Extension

  1. Login via Terminal/SSH or use phpPgAdmin in cPanel
  2. Run these commands: -- Connect to database\c your_database_username-- Enable pgvector extensionCREATE EXTENSION IF NOT EXISTS vector;-- Verify installation\dx

Step 3: Upload Files to Server

3.1 Using File Manager

  1. Open cPanel File Manager
  2. Navigate to public_html (or your desired directory)
  3. Click Upload
  4. Select the installable ZIP file
  5. Wait for the upload to complete

3.2 Using FTP (Alternative)

  1. Use FileZilla or any FTP client
  2. Connect using cPanel FTP credentials
  3. Navigate to public_html
  4. Upload the ZIP file

Step 4: Extract Files

  1. In File Manager, locate the uploaded ZIP file
  2. Right-click → Extract
  3. Extract to the current directory or a specific folder
  4. After extraction, you should see folders like:
    • core/app/, bootstrap/, config/, database/, public/, resources/, etc.

Step 5: Set Permissions

5.1 Set File Permissions

Right-click on these files/folders and set permissions:

Folders (755):
- storage/
- bootstrap/cache/

5.2 Quick Permission Commands (via Terminal)

cd public_html/your-project
chmod -R 755 storage bootstrap/cache

Step 6: Run Web-Based Installer

6.1 Access Installation Wizard

  1. Open your browser
  2. Visit: https://yourdomain.com
  3. The installation wizard should automatically load

6.2 License Verification

  1. Enter your Envato Username
  2. Enter your Purchase Code (found in the license file from CodeCanyon)
  3. Click Verify, Next

6.3 Server Requirements Check

  • The System will check all PHP extensions
  • Green checkmarks = Requirements met ✅
  • Red cross = Missing requirement ❌
  • If red items appear, contact your hosting provider
  • Click Next when all green

6.4 Folder Permissions Check

  • System verifies folder permissions
  • Ensure all folders show green status
  • Click Next to continue

6.5 Database Configuration

  1. Enter database details from Step 2.3:
    • Database Host: localhost
    • Database Port: 5432
    • Database Name:[your_database_name]
    • Database User:[your_database_user]
    • Database Password: [your password]
  2. Click Install Now

6.6 Installation Complete

  • Wait for the database import
  • You should see the “Installation Complete” message
  • Click Go to Dashboard or Visit Site

Step 7: Installation Complete!

🎉 Congratulations! Your Project installation is now complete.

Step 8: Post-Installation Configuration

8.1 Generate Chatbot Secret Key

Before using the app, you need to generate a secret key for the chatbot:

php artisan chatbot:generate-secret-key

Note: This secret key is critical. Keep it safe. If it is lost, all previously added domains for embedding the chatbot will need to be re-added with a new secret.

8.2 Configure OCR Settings

  1. Login to the Admin Panel
  2. Navigate to Settings → Chatbot and AI Settings
  3. Find OCR and Tiktoken Settings section
  4. Enter Tesseract path (ask your hosting provider): Common paths:/usr/bin/tesseract/usr/local/bin/tesseract

8.3 Setup Cron Jobs

  1. In cPanel, go to Cron Jobs
  2. Add these cron jobs:

Queue Worker (Recommended)

* * * * * cd /home/username/public_html/your-project/core/ && php artisan queue:work --queue=ai_chat_processing,default --once >> /dev/null 2>&1

Step 9: Verify Installation

  1. Visit your domain: https://yourdomain.com
  2. Test user registration and login
  3. Check the admin panel access

Troubleshooting

Issue: Installation page not loading

Solution: Check .htaccess file and folder permissions

Issue: Database connection error

Solution: Verify database credentials in .env file

Issue: 500 Internal Server Error

Solution:

  • Check storage folder permissions (755)
  • Enable debug mode temporarily: APP_DEBUG=true in .env
  • Check Laravel logs: storage/logs/

Issue: pgvector not available

Solution: Contact your hosting provider to install the PostgreSQL pgvector extension

Issue: Queue jobs are not processing

Solution: Ensure cron jobs are set up correctly

Support

If you encounter issues during installation:

  • Check the documentation for additional guides
  • Contact the support team

Installation Complete! 🎉

Was this article helpful to you? No Yes

How can we help?