SureBooking — FAQ

• PHP: 8.4 or higher
• MySQL: 5.7+ or 8.0+, MariaDB 10.3+
• RAM: Minimum 512 MB (1 GB+ recommended)
• Disk: 500 MB minimum
• PHP Extensions: curl, gd, imagick, json, zip, mbstring, xml, pdo, pdo_mysql, bcmath, tokenizer

See requirements.txt for the complete checklist.

docker-compose up -d
# Then open: http://localhost:9059/install

• PHP 8.4+ with all required extensions
• MySQL database access
• SSH access (recommended for queue workers)
• Ability to set up cron jobs

1. Open /install in your browser
2. Complete Steps 1–4 (requirements, permissions, database, site info)
3. On Step 5 — Admin Account, enter your desired admin name, email, and password
4. After installation completes, click Go to Admin Panel on the Finish screen and log in with those credentials

• Modify CSS/JS source files
• Customize the theme assets

1. Login to /admin
2. Go to Settings → Email Configuration
3. Enter SMTP details (host, port, username, password, encryption)
4. For Gmail: use an App Password, not your regular password
5. Use the built-in Send Test Email to verify

• Email notifications (appointment confirmations, status updates, password reset)
• Image optimization after upload
• Background report generation

1. Install Supervisor: sudo apt-get install supervisor
2. Copy config: cp supervisord.ini.example supervisord.ini
3. Edit paths in supervisord.ini (update command and stdout_logfile paths)
4. Deploy: sudo cp supervisord.ini /etc/supervisor/conf.d/surebooking-worker.conf
5. Start: sudo supervisorctl reread && sudo supervisorctl update

1. Install Redis on your server
2. Install the PHP Redis extension: php-redis
3. Update .env:

   CACHE_DRIVER=redis
   QUEUE_CONNECTION=redis
   REDIS_HOST=127.0.0.1
   REDIS_PORT=6379

4. Clear cache: php artisan cache:clear

1. Update APP_URL in .env
2. Clear config cache: php artisan config:clear
3. Clear app cache: php artisan cache:clear
4. Restart queue workers: sudo supervisorctl restart surebooking-worker:*

1. Install the relevant payment package
2. Go to Admin → Settings → Payment Methods
3. Enable and configure each gateway (API keys, webhook URLs, etc.)

1. Go to Admin → Service Booking → Appointments
2. Use filters (status, branch, date range) to find appointments
3. Click an appointment to view full details: customer, services, employee, payment
4. Use the Update Status button to transition: New → Accepted → Success / Cancel
5. Every status change is logged in the appointment history and triggers a customer email notification

1. Branches: Admin → Service Booking → Branches → Add New. Fill in name, address, phone, and working hours
2. Service Categories: Admin → Service Booking → Service Categories — organize services into groups
3. Services: Admin → Service Booking → Services → Add New. Set price, duration, and assign to branches
4. Employees: Admin → Service Booking → Employees — add staff, set working hours and service assignments per branch

• Create coupons at Admin → Service Booking → Coupons
• Set discount type: fixed amount or percentage (with optional max cap)
• Configure scope: all customers, specific customer, service category, service, or branch
• Set date window, per-user usage limit, total quantity cap, and minimum booking amount
• Customers enter the coupon code on the booking form before confirming
• Coupon is rolled back automatically if the appointment is cancelled

• Appointments: Admin → Appointments → Export button (respects current filters)
• Customers: Admin → Customers → Export
• Coupon usage: Admin → Coupons → Usage History → Export
• Redirect rules: Admin → Sync Links → Export

1. Select service(s): Customer picks one or more services from the frontend
2. Choose branch & employee: Select preferred location and staff member
3. Pick date & time: Real-time availability calendar shows open slots
4. Confirm: Review booking summary, optionally apply a coupon code, and submit
5. Notification: Confirmation email sent to customer; admin notified of new appointment
6. Admin workflow: Staff reviews (New → Accepted), delivers service (Accepted → Success)

• Go to Admin → Sync Links
• Add rules: Source URL (old path) → Target URL (new path)
• Choose redirect type: 301 (permanent, good for SEO) or 302 (temporary)
• Enable/disable individual rules
• Import from Excel for bulk setup; export to back up or audit

1. File permissions:

   chmod -R 755 storage bootstrap/cache

2. Check error logs:

   cat storage/logs/laravel.log

3. Ensure .env exists and has correct database credentials
4. Verify all required PHP extensions are installed: php -m | grep -E 'curl|gd|imagick|zip|mbstring'
5. Clear caches:

   php artisan optimize:clear

sudo supervisorctl status
# Should show: surebooking-worker:surebooking-worker_00   RUNNING

1. Reload config:

   sudo supervisorctl reread && sudo supervisorctl update

2. Start workers:

   sudo supervisorctl start surebooking-worker:*

php artisan queue:work --queue=high,default

php artisan queue:failed

1. Check permissions:

   chmod -R 755 public/uploads

2. Verify php-gd and php-imagick are installed: php -m | grep -E 'gd|imagick'
3. Check upload limits in php.ini:

   upload_max_filesize = 64M
   post_max_size = 64M
   memory_limit = 256M

1. Go to Admin → Settings → Email Configuration and check SMTP settings
2. Use the built-in Send Test Email button
3. For Gmail: use an App Password (Google Account → Security → App Passwords) with port 587 + TLS
4. Confirm queue worker is running (emails are sent via queue)
5. Check Laravel logs:

   tail -f storage/logs/laravel.log

6. Ensure SMTP ports 587/465 are open on your server firewall

php artisan optimize:clear

sudo supervisorctl restart surebooking-worker:*

1. Use Redis for cache and queues:

   CACHE_DRIVER=redis
   QUEUE_CONNECTION=redis

2. Enable PHP OPcache in php.ini
3. Increase queue workers: Edit numprocs in supervisord.ini to 2–4 for high traffic
4. Production mode: APP_ENV=production and APP_DEBUG=false
5. CDN: Serve static assets and uploaded images via CDN

• Small (<1,000 users): 1 CPU, 1 GB RAM, 10 GB SSD
• Medium (1,000–10,000 users): 2 CPUs, 2–4 GB RAM, Redis cache
• Large (10,000+ users): 4+ CPUs, 8 GB+ RAM, Redis, CDN, load balancer

1. Change the default password immediately after first login
2. Enable Two-Factor Authentication (2FA): Admin → Settings → Security
3. Set APP_DEBUG=false and APP_ENV=production in production
4. Use HTTPS with a valid SSL certificate
5. Set file permissions to 755 (not 777)
6. Never commit .env to version control
7. Keep the system updated regularly

1. Database:

   mysqldump -u surebooking_user -p surebooking_db > backup_$(date +%Y%m%d).sql

2. Files to backup:
   • .env — configuration
   • public/uploads/ — user uploaded media
   • storage/ — generated files and logs
3. Automate: Use cron jobs or a backup service
4. Off-site storage: Store backups on a separate server/cloud storage

1. Theme Config: Admin → Appearance → Theme Configuration — colors, fonts, layout options
2. Custom CSS: Admin → Appearance → Custom CSS — inject custom styles
3. Menu: Admin → Appearance → Menus — manage navigation menus
4. Logo/Favicon: Admin → Settings → General
5. Theme files: Edit blade templates in packages/theme/resources/views/ then rebuild assets with npm run production

• Add new fields to services, branches, or employees via a Laravel migration + model update
• Extend the booking form in the theme views under packages/theme/resources/views/
• Add custom admin fields using the existing FormBuilder patterns (see packages/service-booking/)

1. Go to Admin → Translations
2. Select the language to translate
3. Search for the text key you want to change
4. Enter the translation and save

• Appointments — list, detail, and status update (state-machine enforced)
• Branches — list and detail
• Services — list and detail (with service category)
• Customers — list and detail (search by name, email, phone)

1. Login to /admin
2. Go to Admin → API Clients
3. Click Add New, enter a name for the client (e.g., "Mobile App"), and save
4. Click Generate Token on the client detail page
5. Copy the token — it is displayed only once

Authorization: Bearer YOUR_API_TOKEN

{
  "success": true,
  "data": { ... },
  "message": "...",
  "meta": { "current_page": 1, "last_page": 3, "per_page": 15, "total": 42 }
}