af62fa478f
- Add complete database setup script (setup_complete_database.py) - Add quick deployment script (quick_deploy.sh) - Add comprehensive documentation (DATABASE_SETUP_README.md) - Move individual db scripts to backup_db_scripts folder - Update external_server.conf with correct database settings - Clean up obsolete documentation files - Streamline deployment process to single command Features: - One-script database creation for all tables and triggers - Automated permissions and roles setup - Complete verification and error handling - Production-ready deployment workflow - Maintains backward compatibility with individual scripts
133 lines
4.1 KiB
Markdown
133 lines
4.1 KiB
Markdown
# Quick Database Setup for Trasabilitate Application
|
|
|
|
This script provides a complete one-step database setup for quick deployment of the Trasabilitate application.
|
|
|
|
## Prerequisites
|
|
|
|
Before running the setup script, ensure:
|
|
|
|
1. **MariaDB is installed and running**
|
|
2. **Database and user are created**:
|
|
```sql
|
|
CREATE DATABASE trasabilitate;
|
|
CREATE USER 'trasabilitate'@'localhost' IDENTIFIED BY 'Initial01!';
|
|
GRANT ALL PRIVILEGES ON trasabilitate.* TO 'trasabilitate'@'localhost';
|
|
FLUSH PRIVILEGES;
|
|
```
|
|
3. **Python virtual environment is activated**:
|
|
```bash
|
|
source ../recticel/bin/activate
|
|
```
|
|
4. **Python dependencies are installed**:
|
|
```bash
|
|
pip install -r requirements.txt
|
|
```
|
|
|
|
## Usage
|
|
|
|
### Quick Setup (Recommended)
|
|
```bash
|
|
cd /srv/quality_recticel/py_app
|
|
source ../recticel/bin/activate
|
|
python3 app/db_create_scripts/setup_complete_database.py
|
|
```
|
|
|
|
### What the script creates:
|
|
|
|
#### MariaDB Tables:
|
|
- `scan1_orders` - Quality scanning data for process 1
|
|
- `scanfg_orders` - Quality scanning data for finished goods
|
|
- `order_for_labels` - Label printing orders
|
|
- `warehouse_locations` - Warehouse location management
|
|
- `permissions` - System permissions
|
|
- `role_permissions` - Role-permission mappings
|
|
- `role_hierarchy` - User role hierarchy
|
|
- `permission_audit_log` - Permission change audit trail
|
|
|
|
#### Database Triggers:
|
|
- Auto-increment approved/rejected quantities based on quality codes
|
|
- Triggers for both scan1_orders and scanfg_orders tables
|
|
|
|
#### SQLite Tables:
|
|
- `users` - User authentication (in instance/users.db)
|
|
- `roles` - User roles (in instance/users.db)
|
|
|
|
#### Configuration:
|
|
- Updates `instance/external_server.conf` with correct database settings
|
|
- Creates default superadmin user (username: `superadmin`, password: `superadmin123`)
|
|
|
|
#### Permission System:
|
|
- 7 user roles (superadmin, admin, manager, quality_manager, warehouse_manager, quality_worker, warehouse_worker)
|
|
- 25+ granular permissions for different application areas
|
|
- Complete role hierarchy with inheritance
|
|
|
|
## After Setup
|
|
|
|
1. **Start the application**:
|
|
```bash
|
|
python3 run.py
|
|
```
|
|
|
|
2. **Access the application**:
|
|
- Local: http://127.0.0.1:8781
|
|
- Network: http://192.168.0.205:8781
|
|
|
|
3. **Login with superadmin**:
|
|
- Username: `superadmin`
|
|
- Password: `superadmin123`
|
|
|
|
## Troubleshooting
|
|
|
|
### Common Issues:
|
|
|
|
1. **Database connection failed**:
|
|
- Check if MariaDB is running: `sudo systemctl status mariadb`
|
|
- Verify database exists: `sudo mysql -e "SHOW DATABASES;"`
|
|
- Check user privileges: `sudo mysql -e "SHOW GRANTS FOR 'trasabilitate'@'localhost';"`
|
|
|
|
2. **Import errors**:
|
|
- Ensure virtual environment is activated
|
|
- Install missing dependencies: `pip install -r requirements.txt`
|
|
|
|
3. **Permission denied**:
|
|
- Make script executable: `chmod +x app/db_create_scripts/setup_complete_database.py`
|
|
- Check file ownership: `ls -la app/db_create_scripts/`
|
|
|
|
### Manual Database Recreation:
|
|
|
|
If you need to completely reset the database:
|
|
|
|
```bash
|
|
# Drop and recreate database
|
|
sudo mysql -e "DROP DATABASE IF EXISTS trasabilitate; CREATE DATABASE trasabilitate; GRANT ALL PRIVILEGES ON trasabilitate.* TO 'trasabilitate'@'localhost'; FLUSH PRIVILEGES;"
|
|
|
|
# Remove SQLite database
|
|
rm -f instance/users.db
|
|
|
|
# Run setup script
|
|
python3 app/db_create_scripts/setup_complete_database.py
|
|
```
|
|
|
|
## Script Features
|
|
|
|
- ✅ **Comprehensive**: Creates all necessary database structure
|
|
- ✅ **Safe**: Uses `IF NOT EXISTS` clauses to prevent conflicts
|
|
- ✅ **Verified**: Includes verification step to confirm setup
|
|
- ✅ **Informative**: Detailed output showing each step
|
|
- ✅ **Error handling**: Clear error messages and troubleshooting hints
|
|
- ✅ **Idempotent**: Can be run multiple times safely
|
|
|
|
## Development Notes
|
|
|
|
The script combines functionality from these individual scripts:
|
|
- `create_scan_1db.py`
|
|
- `create_scanfg_orders.py`
|
|
- `create_order_for_labels_table.py`
|
|
- `create_warehouse_locations_table.py`
|
|
- `create_permissions_tables.py`
|
|
- `create_roles_table.py`
|
|
- `create_triggers.py`
|
|
- `create_triggers_fg.py`
|
|
- `populate_permissions.py`
|
|
|
|
For development or debugging, you can still run individual scripts if needed. |