Installation Guide

Before You Begin

What You'll Need

• Valid Purchase Code - Your Envato purchase code from CodeCanyon
• Web Server - Apache 2.4+ or Nginx 1.18+ with PHP 8.2+
• Database - MySQL 8.0+ with an empty database created
• FTP/SFTP Access - To upload files to your server
• SSL Certificate - Recommended for secure connections (required for payment gateways)

Prepare Your Database

Before installation, create an empty MySQL database and note down the following credentials:

• Database Host (usually localhost or 127.0.0.1)
• Database Port (usually 3306)
• Database Name
• Database Username
• Database Password

-- Create database (run in MySQL/phpMyAdmin)
CREATE DATABASE cointrail_db CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;

-- Create user (optional but recommended)
CREATE USER 'cointrail_user'@'localhost' IDENTIFIED BY 'your_secure_password';
GRANT ALL PRIVILEGES ON cointrail_db.* TO 'cointrail_user'@'localhost';
FLUSH PRIVILEGES;

Web Installer

The web installer is the easiest way to install CoinTrail. Follow these steps:

# Via SSH
chmod -R 755 storage bootstrap/cache public
chown -R www-data:www-data storage bootstrap/cache public

https://yourdomain.com/install

https://yourdomain.com/admin

Post-Installation Setup

After installation, complete these important setup steps:

1. Configure Cron Jobs

CoinTrail requires a cron job to run scheduled tasks (price updates, news fetching, etc.):

* * * * * cd /path-to-your-project && php artisan schedule:run >> /dev/null 2>&1

See the Cron Jobs Guide for detailed configuration.

2. Configure Payment Gateways

Go to Admin Panel → Payment Gateways to configure your payment processors:

• Enable desired gateways (Stripe, PayPal, etc.)
• Enter API credentials
• Set sandbox/live mode

See the Payment Gateways Guide for detailed setup.

3. Configure API Settings

Go to Admin Panel → Settings → API Settings to configure:

• CoinGecko API key (optional for higher rate limits)
• Price update intervals
• Tiered update settings

4. Configure Email

Go to Admin Panel → Settings → Email Settings to configure SMTP:

• SMTP host, port, and encryption
• Authentication credentials
• From address and name

See the Email Configuration Guide for detailed setup.

5. Set Up SSL Certificate

Most hosting providers offer free SSL via Let's Encrypt. After enabling SSL, update your .env file:

APP_URL=https://yourdomain.com
FORCE_HTTPS=true

6. Configure Site Settings

Go to Admin Panel → Settings → General Settings to customize:

• Site Name & Logo - Upload your logo and set site name
• Favicon - Upload a favicon for browser tabs
• Default Currency - Set your preferred fiat currency (USD, EUR, GBP, etc.)
• Timezone - Set your server timezone for accurate timestamps
• Date/Time Format - Customize how dates are displayed

7. Configure Social Login (Optional)

Enable social authentication for easier user registration:

• Google OAuth - Create credentials at Google Cloud Console
• Facebook Login - Set up at Facebook Developers
• GitHub OAuth - Configure at GitHub Developer Settings

See the Social Login Setup Guide for detailed instructions.

8. Set Up reCAPTCHA

Protect your forms from spam and bots:

1. Get your keys from Google reCAPTCHA Admin
2. Go to Admin Panel → Settings → Security Settings
3. Enter your Site Key and Secret Key
4. Enable reCAPTCHA for registration, login, and contact forms

See the reCAPTCHA Setup Guide for detailed instructions.

9. Configure Subscription Plans

Set up your monetization strategy at Admin Panel → Subscriptions → Plans:

• Create Plans - Define Free, Basic, Pro, and Enterprise tiers
• Set Pricing - Monthly and yearly pricing options
• Feature Limits - Portfolio coins, alerts, API calls per plan
• Trial Period - Optional free trial for premium plans

See the Subscription Management Guide for detailed setup.

10. Initialize Cryptocurrency Data

Populate your database with cryptocurrency data:

1. Go to Admin Panel → Crypto Data → Sync Settings
2. Click "Sync All Coins" to fetch cryptocurrency data from CoinGecko
3. This may take a few minutes depending on your rate limits
4. Enable Auto-Sync to keep data updated automatically

11. Set Up Queue Worker (Production)

For better performance, run background jobs asynchronously:

[program:cointrail-worker]
process_name=%(program_name)s_%(process_num)02d
command=php /path-to-your-project/artisan queue:work --sleep=3 --tries=3
autostart=true
autorestart=true
numprocs=1
user=www-data
redirect_stderr=true
stdout_logfile=/path-to-your-project/storage/logs/worker.log

Alternatively, add a cron job for queue processing:

* * * * * cd /path-to-your-project && php artisan queue:work --stop-when-empty >> /dev/null 2>&1

12. Verify File Permissions

Ensure proper permissions for security and functionality:

# Set directory permissions
find /path-to-your-project -type d -exec chmod 755 {} \;

# Set file permissions
find /path-to-your-project -type f -exec chmod 644 {} \;

# Writable directories
chmod -R 775 /path-to-your-project/storage
chmod -R 775 /path-to-your-project/bootstrap/cache
chmod -R 775 /path-to-your-project/public/uploads

13. Production Optimization

Optimize your installation for production performance:

# Cache configuration
php artisan config:cache

# Cache routes
php artisan route:cache

# Cache views
php artisan view:cache

# Optimize autoloader
composer install --optimize-autoloader --no-dev

14. Set Up Backups

Protect your data with regular backups:

• Database Backups - Schedule daily MySQL dumps
• File Backups - Back up .env, storage/, and public/uploads/
• Automated Backups - Use your hosting provider's backup feature or a service like spatie/laravel-backup

0 2 * * * mysqldump -u username -p'password' database_name > /path/to/backups/db_$(date +\%Y\%m\%d).sql

Common Issues

cd public
ln -s ../storage/app/public storage