Introduction

This installation manual guides you through the installation of the Write Back Extreme extension on Linux.

Skill level

To follow along, knowledge of installing a webserver on Linux is required.

Operating System

This manual is written for Linux Ubuntu LTS 20.04.

Scope

The following topics will be outside the scope of this manual:

  • Configuring the firewall
    • Webserver: 80/443
    • MySQL: 3306
    • MSSQL: 1433

Points of attention

  • Avoid using passwords containing a period “.” This will break connections and result in unexpected behaviour.

1. Preparation

For the purpose of this manual, you should use the bash terminal with sudo privileges:

Copy to Clipboard

Create the installation folder for the extension:

Copy to Clipboard

Make sure that we use the correct OS (Ubuntu or other LTS system):

Copy to Clipboard

Update dependency packages:

Copy to Clipboard

2. Installing a webserver

In order to use Write Back Extreme, you need to run a webserver. Our recommendation for a webserver is NGINX, due to its lightweight and static file performance. Alternatively, you can install Apache2 or others depending on the operating system. Select your preferred webserver below and follow te installation steps:

3. Installing PHP 7.4.15 or higher

To use Write Back Extreme you need to setup PHP correctly. We’d recommend installing PHP-FPM because it’s a standalone PHP instance. Other PHP instances require and run-only with Apache2. Check what version of PHP is currently installed:

Copy to Clipboard

Install PHP

Add the following settings to php.ini to be able to upload extension-upgrade files:

Copy to Clipboard

Restart PHP

Copy to Clipboard

4. Installing a repository database

The next step in installing Write Back Extreme is to install a database. As of this moment, we fully support 4 databases for system tables and schema creation. Other databases support schema-only. Supported databases are listed below. Follow the appropriate guide for the preferred system database. Afterwards you can install any of the database drivers for schema creation.

Repository Databases:

  • MySQL
  • SQL Server
  • PostgreSQL
  • SQLite

Points of attention

  • Avoid using passwords containing a period “.” This will break connections and result in unexpected behaviour.

5. Installing and configuring the Write Back Extreme extension

If you’ve prepared your environment with a webserver, PHP and a database, you are ready to install and configure the Write Back Extreme extension.

Point of attention

  • Avoid using passwords containing a period “.” This will break connections and result in unexpected behaviour.

5.1 Installation

First, unpack the zip file to /var/www/{write-back.company.com}/ 

Copy to Clipboard

5.2 Install Write Back Extreme

This video is for version 1.2 and higher

5.3 Set file permissions

Copy to Clipboard

5.4 Access backend

The system user (administrator = yes) you created in the “Configure application” step is used to access the backend via:

Copy to Clipboard

5.5 Download the .trex file

The .trex file can be downloaded from the backend to share it with users. Click on the username (top right) and click on “Download .trex”.

Write Back Extreme – Installation Manual (Linux) write back extreme installation linux

What’s next?

Congratulations! You’ve successfully installed and configured the Write Back Extreme extension in your environment. Now that you’re ready to go, check out the Write Back Extreme Product Guide for complete documentation on how to use the extension.

Upgrade guide 1.x to 1.2 (Linux)

This upgrade is specially made when upgrading from 1.x to 1.2 or higher. If you are on 1.2 and are upgrading 1.3 or higher, you can follow the same steps. But you only to backup / overwrite the wbe-core.phar and run the ./update script.

Make sure you are on PHP version 7.4.15 or higher!

These steps are exactly the same for Windows. But instead of running shell script you run Windows script. 

Steps:

  1. Backup current directory
  2. Extract new extension files in current directory
  3. Restore LICENSE, .env, storage folder and migrations folder
  4. Run Update script (if you are upgrading)
  5. Make sure that permissions are correct for the newly added files (see below)
  6. Done!

 

Update file permissions

Copy to Clipboard
Important for Snowflake users: It’s required to have a driver configuration `NoExecuteInSQLPrepare=true`. Snowflake default executes [prepare statements](https://docs.snowflake.com/en/release-notes/2020-08.html#odbc-driver-2-21-6-changes-to-the-handling-of-ddl-statements-in-sqlprepare-and-sqlexecute) but it’s not default ODBC behaviour.