Installation

Docker one-liner installation (recommended)

To install Sword, you need only Docker to be installed on your host.

You don't need to be familiar with Docker. Everything is taken care of for you. Just download and install it.

To create a new project, simply replace myproject by the name of your project and run:

docker run --rm --pull=always -t -e HOST_PWD="$PWD" \
    -v "$PWD":/app -v /var/run/docker.sock:/var/run/docker.sock \
    ghcr.io/phpsword/installer myproject

NOTE

The command line above will install a new project using the latest compatible version. If you want to install a project using a newer PHP version in beta support, use the tag corresponding to the PHP version you want to install:

docker run --rm --pull=always -t -e HOST_PWD="$PWD" \
    -v "$PWD":/app -v /var/run/docker.sock:/var/run/docker.sock \
    ghcr.io/phpsword/installer:php-8.3 myproject

Wait a couple of minutes. Done! Now visit https://myproject.localhost/ to access WordPress installation page.

NOTE

If port 443 is unavailable, the installation process will automatically assign a free port to your app.

You can now check the tutorial to understand the basics.

Windows / Linux / WSL / macOS manual installation

WARNING

The manual installation process is a bit complex and has not been tested.

Requirements to install Sword:

• PHP 8.1 or above, with bcmath, mysqli, exif and imagick extensions (redis too if you want to use redis)
• MySQL 8.0 or above
• Composer 2
• Symfony CLI executable
• Nginx

If for any reason you don't want to use Docker, try a manual install using these files as guide:

• The installer project build
• The installer install script
• The Nginx configuration configured to be behind Traefik reverse-proxy
• Environment variables