Deployment Guide

Deploy your ScribeEngine app to production.

Production Checklist

Before deploying:

• Change secret_key in scribe.json to a random value
• Enable HTTPS (SSL/TLS)
• Set debug=False in Flask
• Use environment variables for secrets
• Set up monitoring/logging
• Configure backups

Using Production Server

ScribeEngine includes Waitress (production WSGI server):

scribe serve --host 0.0.0.0 --port 8000 --threads 8

Options:

• --host: IP address (0.0.0.0 = all interfaces)
• --port: Port number
• --threads: Worker threads

PostgreSQL Configuration

Edit scribe.json:

{
  "databases": {
    "default": {
      "type": "postgresql",
      "host": "localhost",
      "port": 5432,
      "user": "myapp_user",
      "password": "USE_ENV_VARIABLE",
      "database": "myapp_db"
    }
  },
  "SECRET_KEY": "USE_ENV_VARIABLE"
}

Don't commit secrets! Use environment variables.

Nginx Reverse Proxy

server {
    listen 80;
    server_name myapp.com;

    location / {
        proxy_pass http://127.0.0.1:8000;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
    }
}

Systemd Service

Create /etc/systemd/system/myapp.service:

[Unit]
Description=MyApp ScribeEngine
After=network.target

[Service]
Type=simple
User=www-data
WorkingDirectory=/var/www/myapp
ExecStart=/usr/local/bin/scribe serve --host 127.0.0.1 --port 8000
Restart=always

[Install]
WantedBy=multi-user.target

Enable:

sudo systemctl daemon-reload
sudo systemctl enable myapp
sudo systemctl start myapp

See other guides for development workflows.