Installation
Get Pivor running in minutes with Docker or manual installation.
Requirements
PHP
8.2+
Composer
2.0+
Node.js
18+
Database
SQLite / MySQL / PostgreSQL
Docker
RecommendedOne command to get up and running. Best for quick start and production.
Get started
Local Development
Manual setupFull control over your environment. Best for development and customization.
Get started
Docker Installation
1
Clone the Repository
git clone git@github.com:Lexaro-Software/pivor.git
cd pivor
2
Start Pivor
docker compose up -d
Database, migrations, and seeding are handled automatically
3
Access Pivor
Open your browser and navigate to:
http://localhost:8080
What the container handles automatically
Creates SQLite database
Runs migrations and seeds data
Generates APP_KEY if not set
Caches config for performance
Local Development Installation
1
Clone the Repository
git clone git@github.com:Lexaro-Software/pivor.git
cd pivor
2
Install Dependencies
# PHP dependencies
composer install
# Node dependencies
npm install
3
Setup Environment
cp .env.example .env
php artisan key:generate
4
Create Database & Seed
php artisan migrate --seed
5
Build Assets & Start Server
npm run build
php artisan serve
Access at
http://localhost:8000
Default Login Credentials
Default Credentials
Email
admin@pivor.dev
Password
password
Change these credentials immediately after first login!
Production Deployment
Production Checklist
Web Server
Use Nginx or Apache (not artisan serve)
Debug Mode
Set
APP_DEBUG=falseDatabase
MySQL or PostgreSQL for better performance
Caching
Configure Redis for sessions and cache
Queue Worker
For email sync and background jobs
HTTPS
Enable with a valid SSL certificate
Queue Worker with Supervisor
For production, use Supervisor to manage the queue worker:
[program:pivor-worker]
process_name=%(program_name)s_%(process_num)02d
command=php /path/to/pivor/artisan queue:work --sleep=3 --tries=3 --max-time=3600
autostart=true
autorestart=true
stopasgroup=true
killasgroup=true
user=www-data
numprocs=1
redirect_stderr=true
stdout_logfile=/path/to/pivor/storage/logs/worker.logUpdating Pivor
1
Pull Latest Changes
git pull origin main
2
Update Dependencies & Migrate
composer install --no-dev
npm install
php artisan migrate
3
Rebuild & Cache
npm run build
php artisan config:cache
php artisan route:cache
php artisan view:cache