65 lines
1.4 KiB
Markdown
65 lines
1.4 KiB
Markdown
# CreativeX Service Deployment Guide
|
|
|
|
This guide explains how to deploy the CreativeX Scoring Service as a background systemd service.
|
|
|
|
## Prerequisites
|
|
|
|
- The application must be installed in `/opt/ferrero-opentext/Python-Version`.
|
|
- The virtual environment must be at `/opt/ferrero-opentext/Python-Version/venv`.
|
|
- The user running the service is assumed to be `daveporter` (adjust if necessary).
|
|
|
|
## 1. Install the Service
|
|
|
|
Copy the service file to the systemd directory:
|
|
|
|
```bash
|
|
sudo cp scripts/creativex-service.service /etc/systemd/system/
|
|
```
|
|
|
|
## 2. Reload Systemd
|
|
|
|
Reload the systemd daemon to recognize the new service:
|
|
|
|
```bash
|
|
sudo systemctl daemon-reload
|
|
```
|
|
|
|
## 3. Enable and Start
|
|
|
|
Enable the service to start on boot, and start it immediately:
|
|
|
|
```bash
|
|
sudo systemctl enable creativex-service
|
|
sudo systemctl start creativex-service
|
|
```
|
|
|
|
## 4. Verify Status
|
|
|
|
Check if the service is running correctly:
|
|
|
|
```bash
|
|
sudo systemctl status creativex-service
|
|
```
|
|
|
|
You should see `Active: active (running)`.
|
|
|
|
## 5. View Logs
|
|
|
|
You can view the service logs in two ways:
|
|
|
|
**Option A: Systemd Journal**
|
|
```bash
|
|
sudo journalctl -u creativex-service -f
|
|
```
|
|
|
|
**Option B: Application Logs**
|
|
```bash
|
|
tail -f logs/creativex_service.log
|
|
```
|
|
|
|
## Troubleshooting
|
|
|
|
If the service fails to start:
|
|
1. Check permissions on the `scripts` directory.
|
|
2. Verify the paths in `/etc/systemd/system/creativex-service.service`.
|
|
3. Ensure the virtual environment python executable works.
|