Installation - parpalak/s2 GitHub Wiki

Server Requirements

  • Web server
  • PHP 8.2 or higher.
  • One of supported databases:
    • MySQL (tested on MariaDB 10.5 and higher, MySQL 8.0 and higher),
    • PostgreSQL (tested on 14),
    • SQLite (tested on 3.37).

Installation steps

  1. Use the following commands to get the latest development version of S2
git clone https://github.com/parpalak/s2.git
cd s2

composer install # for local development and running tests
# or
composer install --no-dev -o # for production
  1. Upload the s2 directory contents to your server in the target website directory.
  2. Set write permissions (typically chmod 0777) for the _cache and _pictures folders. If issues arise, contact your hosting provider's support.
  3. Open your site's URL in a browser and follow the installation script instructions.

During installation, you'll need to:

  • Configure the database connection (enter the database name, username, and password).
  • Create an admin account (choose a username and password).
  • Set the site's base URL (enter the full URL without a trailing slash, e.g.,
    • https://example.com
    • https://example.com/s2
    • https://www.example.com
    • https://www.example.com/s2).

Pro tip: Configure your web server to redirect www subdomains to the main domain (e.g., www.example.com → example.com or vice versa) and http version to https. This prevents many obscure issues.

Upgrading

  1. Back up all engine files and the database to avoid data loss and enable rollbacks if needed.
  2. Disable all extensions in the control panel.
  3. Overwrite old core and extension files with the new versions.
  4. Update extensions in the control panel.
  5. Re-enable all extensions.