Getting Started

Install and configure your Spwig e-commerce platform.

Editions

Spwig is free and open source under AGPL-3.0-or-later. Just install it — no licence key needed for the Community edition. Optional Pro and Enterprise licence keys add hosted services (hosted email, higher rate limits, priority support, SSO) on top of the free core.

Community — Free

Full platform, POS, page builder, themes. AGPL-3.0. Self-host on your own infrastructure. No sign-up, no licence key, no fees.

Pro & Enterprise Licence Keys

Add Spwig-hosted email delivery, higher hosted-service rate limits, priority support, and SSO (Enterprise). Paid, launching alongside managed hosting.

System Requirements

Minimum

Resource	Requirement
OS	Ubuntu 22.04+, Debian 12+, or any Linux with Docker support
CPU	2 cores
RAM	4 GB
Disk	10 GB free
Access	Root / sudo

Recommended (for production)

Resource	Recommendation
CPU	4 cores
RAM	4 GB+
Disk	40 GB+ SSD
Network	Public IP with ports 80 and 443 open

Dependencies

The installer checks for and can auto-install:

Docker (20.10+) and Docker Compose (v2)
curl, openssl, tar, gzip (present on most systems)

Quick Start

curl -fsSL https://spwig.com/install.sh | sudo bash

That's it. The installer handles everything: Docker setup, database, SSL certificates, and service configuration.

If you have a setup token from your purchase:

curl -fsSL https://spwig.com/install.sh | sudo bash -s -- --token=YOUR_TOKEN

What Gets Installed

Spwig runs as a set of Docker containers on your server:

Service	Purpose
Shop	Django application server
PostgreSQL	Database
Redis	Caching and sessions
MinIO	Media file storage (S3-compatible)
Nginx	Reverse proxy with SSL
Celery	Background task workers
Translator	AI-powered content translation
Upgrader	Automatic component updates

Installation Options

Interactive (default)

The installer walks you through each step:

curl -fsSL https://spwig.com/install.sh | sudo bash

With Domain

curl -fsSL https://spwig.com/install.sh | sudo bash -s -- \
  --domain=shop.example.com \
  [email protected]

Fully Automated (no prompts)

curl -fsSL https://spwig.com/install.sh | sudo bash -s -- \
  --domain=shop.example.com \
  [email protected] \
  --non-interactive

Dry Run (preview without changes)

curl -fsSL https://spwig.com/install.sh | sudo bash -s -- --dry-run

Download and Inspect First

curl -fsSL https://spwig.com/install.sh -o install.sh
less install.sh          # review the script
sudo bash install.sh

CLI Reference

Option	Description
`--token=JWT`	Setup token from purchase email
`--domain=DOMAIN`	Domain name for your store
`--email=EMAIL`	Admin email (used for SSL and admin account)
`--no-domain`	Install without a domain (access via IP)
`--mode=MODE`	Force mode: standalone, sidecar, or local
`--port=PORT`	Override HTTP port (default: 80)
`--ssl-port=PORT`	Override HTTPS port (default: 443)
`--instance-id=ID`	Unique ID for multi-instance isolation
`--skip-ssl`	Skip SSL certificate setup
`--version=VER`	Install a specific Spwig version
`--dry-run`	Preview the installation plan
`--yes, -y`	Accept all prompts automatically
`--non-interactive`	No prompts at all (for automation)
`--help, -h`	Show help

Installation Modes

The installer auto-detects the best mode for your environment:

Standalone

Ports 80 and 443 are free. Spwig takes full control of web traffic with its own Nginx and SSL.

Sidecar

An existing web server (Nginx, Apache, Caddy) is detected. Spwig runs on alternate ports and provides a proxy config for your existing server.

Local

No public IP detected. Runs in development mode with DEBUG=true and a self-signed certificate at spwig.local.

After Installation

Default Credentials

Admin URL	`https://your-domain/admin/`
Username	`admin`
Password	Generated during setup

Important: The installer generates a unique password and displays it once at the end of installation. Make sure to save it before closing the terminal.

Setup Wizard

On first login, the Setup Wizard guides you through:

Store name and URL
Contact information
Currency and locale
Payment methods

Go Live

Your store starts in maintenance mode. Visitors see a "Coming Soon" page until you're ready:

cd /opt/spwig && ./go-live.sh

Add a Domain Later

Installed without a domain? Add one anytime:

cd /opt/spwig && ./configure-domain.sh

Cloud Marketplace

Deploy with a single click on supported platforms:

Akamai / Linode — Available on the Linode Marketplace
DigitalOcean — Available as a 1-Click App

Managing Your Installation

cd /opt/spwig

# View logs
docker compose logs -f shop

# Check service status
docker compose ps

# Restart all services
docker compose restart

# Stop everything
docker compose down

# Start everything
docker compose up -d

# Update to latest version
docker compose pull && docker compose up -d

Uninstall

cd /opt/spwig
docker compose down -v    # stop and remove containers + volumes
sudo rm -rf /opt/spwig    # remove installation directory

Warning: This permanently deletes all data including your database and media files. Back up first if needed.

Developer Program

Spwig itself is free (AGPL-3.0) — you already have full platform access from the moment you install it. The Spwig Developer Program adds early access to new features, integration guides, and a channel to build and publish for the marketplace.

API & webhook docs — build custom integrations, themes, and components
Marketplace publishing — ship your themes and providers to other merchants
Developer community — connect with other Spwig developers

Join the Developer Program →

Support

Documentation: docs.spwig.com
Community Forum: community.spwig.com
Email: [email protected]