README - REI3, the open application platform
============================================
REI3 is an open (free to use and open source) business application platform.
It is designed to run on Linux or Windows servers, locally or in the cloud.

For more information, visit https://rei3.de

# System requirements
On Windows systems, Microsoft Visual C++ 2015 or later must be installed. It is
applied automatically when using the installer but also included in the
portable version for manual installation (vc_redist.x64.exe).

On Linux systems, a version of ImageMagick is needed for thumbnail creation
(sudo apt install imagemagick). REI3 will run without ImageMagick, if thumbnails
are not needed.

For more information, please refer to the online documentation.
Installers and other releases can be found at: https://rei3.de/en/downloads
The full admin documentation is available at:  https://rei3.de/en/docs/admin

# Starting the REI3 portable version on Windows
After downloading the portable version as a zip file, extract it to a location
of your choice and run it. The REI3 server application will be launched and your
default browser opened to REI3´s start page. You are now good to go.

# Installing REI3 on Windows
To install REI3 on Windows systems, REI3 offers a graphical installer.
Two deployment models exist:
* Stand-alone: REI3 is installed with its own, integrated database system.
  Following the installer is sufficient to complete the setup process.
* Dedicated: REI3 is installed to run on a pre-existing PostgreSQL database.
  * The database must be encoded as UTF8 and full permissions are required.
  * Database connection details must be added in REI3´s configuration file
    ('config.json').

In either deployment model, REI3 is managed via the Windows service manager.

# Installing REI3 on Linux
* Download the REI3 release package for Linux.
* Extract the release package to a directory of your choice (/opt/rei3).
* Make the r3 file executable (chmod u+x r3).
* Copy the template config file (cp config_template.json config.json).
* Add connection details to an empty, UTF8 encoded PostgreSQL database to the
  config file. The database user needs full permissions for this database.
* Optional: Install ImageMagick & Ghostscript for thumbnail generation
  (sudo apt install imagemagick ghostscript).
* Optional: Install PostgreSQL client tools for integrated backup features
  (sudo apt install postgresql-client).
* Register REI3 with your service manager (sudo ./r3 -install).
* Start the REI3 service (sudo systemctl start rei3).

# Default login
The default login is username:admin, password:admin.

# Accessing the Builder
Included in all versions of REI3 is the graphical application build utility, or
'Builder'. The Builder can create new or change existing applications; it can
also easily delete all data from an instance. Do not use the Builder in
production environments.

The Builder can be enabled after activating the maintenance mode. With the
Builder enabled, its icon will appear at the upper-left corner of the main menu.

For more details, please visit the Builder documentation:
https://rei3.de/en/docs/builder

# Creating a new admin user
In case of lost access, a new admin user can be created from the command line.
First, make sure that REI3 is not running. Then, start REI3 with the parameter
'-newadmin', such as: 'r3 -newadmin newusername:password'

This will generate a new user with administrative permissions. The user name
must not exist beforehand. After the user has been created, start REI3 normally
and login with the new user.