Appearance

Post-Installation Setup ​

After successfully installing OmniSuite CMS, follow this guide to complete your initial configuration and get your site ready for use.

Table of Contents ​

  1. First Login
  2. Initial Configuration Checklist
  3. General Settings
  4. Email Configuration
  5. Payment Gateway Setup
  6. SSL/HTTPS Setup
  7. Cron Jobs Configuration
  8. Queue Worker Setup
  9. Cache Configuration
  10. File Storage Configuration
  11. Backup Setup
  12. Security Checklist

First Login ​

Accessing the Admin Panel ​

  1. Navigate to: http://yourdomain.com/login
  2. Enter your admin credentials:
    • Email: The email you used during installation
    • Password: The password you created
  3. Click Login

Dashboard Overview ​

After logging in, you'll see:

  • Dashboard: Overview of your site
  • Navigation Menu: Access to all modules
  • Quick Stats: Key metrics and information

Initial Configuration Checklist ​

Complete these steps in order:

  • [ ] Configure General Settings
  • [ ] Set up Email (SMTP)
  • [ ] Configure Payment Gateways (if needed)
  • [ ] Set up SSL/HTTPS
  • [ ] Configure Cron Jobs
  • [ ] Set up Queue Worker (if using queues)
  • [ ] Configure Cache
  • [ ] Set up File Storage
  • [ ] Configure Backups
  • [ ] Review Security Settings

General Settings ​

Accessing General Settings ​

  1. Go to Admin Panel → Settings → General
  2. Or navigate to: /admin/settings/general

Basic Configuration ​

App Name ​

  • Your site/company name
  • Used in emails, notifications, and site headers

Logo Upload ​

  1. Click Upload Logo
  2. Select your logo file (PNG, JPG, or SVG)
  3. Recommended size: 200x50px or similar
  4. Click Save

Favicon ​

  1. Upload a favicon (16x16 or 32x32 PNG)
  2. This appears in browser tabs

Default Language ​

  • Select your site's default language
  • Available languages depend on your installation

Timezone ​

  • Select your server's timezone
  • Important for scheduling and timestamps

Saving Changes ​

Click Save or Update button to apply changes.

See Also: General Settings Documentation

Email Configuration ​

Why Configure Email ​

Email is needed for:

  • User registration confirmations
  • Password resets
  • Order confirmations
  • Notifications
  • System alerts

Accessing Email Settings ​

  1. Go to Admin Panel → Settings → Email Settings
  2. Or during installation (Step 2)

SMTP Configuration ​

Mail Driver ​

Select: SMTP (recommended for production)

SMTP Settings ​

Host:

  • Gmail: smtp.gmail.com
  • Outlook: smtp-mail.outlook.com
  • Custom: Check with your email provider

Port:

  • 587: TLS (recommended)
  • 465: SSL
  • 25: Unencrypted (not recommended)

Username:

  • Your full email address

Password:

  • Your email password
  • For Gmail, use an "App Password" if 2FA is enabled

Encryption:

  • TLS: For port 587
  • SSL: For port 465

From Address:

  • Email address to send from
  • Usually your main email

From Name:

  • Name shown in email "From" field
  • Example: "Your Company Name"

Testing Email ​

  1. After configuring, click Send Test Email
  2. Enter a test email address
  3. Check if email is received
  4. If not received, check spam folder and verify settings

Common Email Providers ​

Gmail ​

Host: smtp.gmail.com
Port: 587
Encryption: TLS
Username: your-email@gmail.com
Password: App Password (if 2FA enabled)

Outlook/Hotmail ​

Host: smtp-mail.outlook.com
Port: 587
Encryption: TLS
Username: your-email@outlook.com
Password: Your password

cPanel Email ​

Host: mail.yourdomain.com
Port: 587
Encryption: TLS
Username: your-email@yourdomain.com
Password: Your email password

See Also: Email Settings Documentation

Payment Gateway Setup ​

Accessing Payment Settings ​

  1. Go to Admin Panel → Settings → Payment Gateways
  2. Or navigate to: /admin/settings/payments

Supported Gateways ​

  • Stripe
  • PayPal
  • Authorize.Net
  • Cash on Delivery
  • Free Products
  • Razorpay
  • Mollie
  • Square
  • Klarna

Configuring a Payment Gateway ​

Stripe Setup ​

  1. Get API Keys:

    • Sign up at stripe.com
    • Go to Developers → API Keys
    • Copy Publishable Key and Secret Key

  2. Enter in Admin Panel:

    • Publishable Key
    • Secret Key
    • Webhook Secret (for webhooks)

  3. Test Connection:

    • Click "Test Connection"
    • Verify connection is successful

PayPal Setup ​

  1. Get Credentials:

    • Sign up at paypal.com
    • Go to Developer Dashboard
    • Create App and get Client ID and Secret

  2. Enter in Admin Panel:

    • Client ID
    • Client Secret
    • Mode: Sandbox (testing) or Live (production)

  3. Configure Webhook:

    • Set webhook URL in PayPal dashboard
    • Enter webhook secret in admin panel

See Also: Payment Gateway Settings Documentation

SSL/HTTPS Setup ​

Why SSL is Important ​

  • Encrypts data transmission
  • Required for payment processing
  • Improves SEO rankings
  • Builds user trust

Using Let's Encrypt (Free SSL) ​

In cPanel ​

  1. Go to SSL/TLS Status
  2. Find your domain
  3. Click Run AutoSSL
  4. Wait for certificate installation
  5. Enable "Force HTTPS Redirect"

Manual Setup ​

  1. Install SSL certificate via your hosting provider
  2. Update .env file:
    APP_URL=https://yourdomain.com
  3. Clear cache:
    bash
    php artisan config:clear
php artisan cache:clear

Force HTTPS ​

After SSL is installed:

  1. Update .env:

    APP_URL=https://yourdomain.com

  2. Or configure in web server (Apache/Nginx)

Cron Jobs Configuration ​

Why Cron Jobs are Needed ​

Cron jobs run scheduled tasks:

  • Email queue processing
  • Scheduled posts
  • Cleanup tasks
  • Reports generation

Setting Up Cron Job ​

In cPanel ​

  1. Go to Cron Jobs
  2. Add new cron job:
    • Minute: *
    • Hour: *
    • Day: *
    • Month: *
    • Weekday: *
    • Command:
      bash
      php /home/username/public_html/artisan schedule:run >> /dev/null 2>&1
  3. Replace /home/username/public_html with your installation path
  4. Save cron job

Via SSH ​

Add to crontab:

bash
crontab -e

Add line:

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

Verifying Cron Job ​

  1. Check cron job is running
  2. Monitor scheduled tasks in admin panel
  3. Check logs for any errors

Queue Worker Setup ​

When Queue Worker is Needed ​

If your application uses queues for:

  • Email sending
  • Image processing
  • Background jobs
  • Notifications

Setting Up Queue Worker ​

Option 1: Cron Job (Simple) ​

Add to cron jobs:

bash
*/5 * * * * cd /path/to/your/app && php artisan queue:work --stop-when-empty

  1. Install Supervisor:

    bash
    sudo apt-get install supervisor

  2. Create config file: /etc/supervisor/conf.d/omnisuite-worker.conf

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

  3. Start supervisor:

    bash
    sudo supervisorctl reread
sudo supervisorctl update
sudo supervisorctl start omnisuite-worker:*

See Also: Your hosting provider's documentation for queue worker setup

Cache Configuration ​

Types of Cache ​

OmniSuite CMS uses caching for:

  • Configuration
  • Routes
  • Views
  • Application data

Clearing Cache ​

Via Admin Panel:

  1. Go to Settings → Module Settings
  2. Click Clear Cache

Via Command Line:

bash
php artisan cache:clear
php artisan config:clear
php artisan route:clear
php artisan view:clear

Cache Drivers ​

Configure in .env:

CACHE_DRIVER=file

Options:

  • file: Default, uses file system
  • redis: For better performance (requires Redis)
  • memcached: Alternative cache system

File Storage Configuration ​

Storage Locations ​

  • Public Storage: public/storage/ (publicly accessible)
  • Private Storage: storage/app/ (protected)

Setting Up Public Storage ​

Create symbolic link:

bash
php artisan storage:link

This links storage/app/public to public/storage

File Permissions ​

Ensure storage directories are writable:

bash
chmod -R 755 storage
chmod -R 755 bootstrap/cache

Backup Setup ​

Why Backups are Critical ​

  • Protect against data loss
  • Easy recovery from errors
  • Required before updates

Manual Backup ​

Database Backup ​

Via phpMyAdmin:

  1. Select your database
  2. Click Export
  3. Choose Quick or Custom
  4. Click Go

Via Command Line:

bash
mysqldump -u username -p database_name > backup.sql

File Backup ​

Via cPanel:

  1. Go to Backup
  2. Click Generate Full Backup
  3. Download when ready

Via FTP:

  • Download all files via FTP client

Automated Backups ​

Set up automated backups via:

  • cPanel Backup tool
  • Hosting provider's backup service
  • Third-party backup solutions

Recommended: Daily database backups, weekly full backups

Security Checklist ​

After installation, complete these security steps:

  • [ ] Change default admin password (if applicable)
  • [ ] Enable SSL/HTTPS
  • [ ] Set proper file permissions (755 for directories, 644 for files)
  • [ ] Remove installer access (installer is auto-locked)
  • [ ] Configure firewall (if available)
  • [ ] Set strong admin password
  • [ ] Enable two-factor authentication (if available)
  • [ ] Regular security updates
  • [ ] Monitor error logs
  • [ ] Set up regular backups

File Permissions Review ​

Ensure these permissions:

Directories: 755
Files: 644
.env: 600 (most secure) or 644
artisan: 755

Next Steps ​

After completing post-installation setup:

  1. Explore Modules:

    • Review available modules
    • Enable/disable as needed
    • Configure module settings

  2. Add Content:

    • Create pages
    • Add blog posts
    • Upload media files

  3. Customize Design:

    • Upload logo
    • Configure header/footer
    • Customize colors and styles

  4. Read Documentation:

Support ​

If you need help:

  1. Check Troubleshooting Guide
  2. Review error logs
  3. Contact your hosting provider
  4. Refer to application support channels

Last Updated: [Date will be updated during final review]

Released under the MIT License.

Copyright © 2024 OmniSuite CMS