Auxx Documentation

Configure your self-hosted Auxx.ai deployment with a custom domain, email, Shopify integration, AI providers, and more.

After the initial install, configure your deployment for production use.

Domain & SSL

Set your public URL in .env:

NEXT_PUBLIC_APP_URL=https://yourdomain.com

Then set up a reverse proxy to handle SSL termination and forward traffic to the web service.

Caddy (simplest — auto-HTTPS)

yourdomain.com {
  reverse_proxy localhost:3000
}

nginx

server {
  server_name yourdomain.com;
  location / {
    proxy_pass http://localhost:3000;
    proxy_set_header Host $host;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;
  }
}

SSL with nginx

Use Certbot or a similar tool to add Let's Encrypt SSL certificates to your nginx configuration.

Email sending

Configure outbound email by setting one of the following provider configurations in .env:

MAILGUN_API_KEY=your-api-key
MAILGUN_DOMAIN=mail.yourdomain.com

SES_REGION=us-east-1
SES_ACCESS_KEY_ID=your-access-key
SES_SECRET_ACCESS_KEY=your-secret-key

SMTP_HOST=smtp.yourdomain.com
SMTP_PORT=587
SMTP_USER=your-username
SMTP_PASS=your-password

Email receiving (IMAP)

Connect inboxes through the Auxx.ai UI at Settings > Integrations. See Connect your inbox for step-by-step instructions.

Shopify integration

Connect your Shopify store through Settings > Integrations in the Auxx.ai UI. See Connect Shopify for details.

AI providers

Configure one or more AI provider API keys in .env:

OPENAI_API_KEY=sk-...
ANTHROPIC_API_KEY=sk-ant-...

You can configure which models to use in the Auxx.ai UI at Settings > AI.

File storage

MinIO is included by default in the Docker Compose stack. To use an external S3-compatible service instead, update these variables in .env:

S3_ENDPOINT=https://s3.amazonaws.com
S3_ACCESS_KEY_ID=your-access-key
S3_SECRET_ACCESS_KEY=your-secret-key

Updating

Check the latest release on GitHub
Update VERSION in your .env file
Pull new images:
```
docker compose pull
```
Restart:
```
docker compose up -d
```

Backups

Database backup

docker compose exec postgres pg_dump -U postgres auxx-ai > backup.sql

Database restore

docker compose exec -T postgres psql -U postgres auxx-ai < backup.sql

Automate backups

Set up a cron job to run database backups regularly. For example, to back up daily at 2 AM:

0 2 * * * cd /path/to/auxx && docker compose exec -T postgres pg_dump -U postgres auxx-ai > backups/auxx-$(date +\%Y\%m\%d).sql

Setup & configuration