Skip to main content

Configuration of the ABRA Flexi Server

How to Configure a Custom Server for ABRA Flexi

Written by Petr Pech

Warning: The server configuration documentation is intended primarily for IT administrators. Elevated access rights, such as administrator privileges, may be required to edit the configuration file.

The configuration file flexibee-server.xml allows you to specify the services used (database server, SMTP server) and customize the behavior of the Flexi server running in your own installation (it cannot be used to configure Flexi running in the cloud).

The file location differs depending on the operating system (directory and file locations). You can find it here:

Operating System

Location

MS Windows

C:\Program Files\Common Files\WinStrom
or
C:\Program Files (x86)\Common Files\WinStrom

Linux

/etc/flexibee/flexibee-server.xml

Mac OS X

/Library/Application Support/FlexiBee/Data/flexibee-server.xml

The file is in XML format using the Java properties variant. Individual properties are listed within the properties element:

<?xml version="1.0"?><entry key="{vlastnost}">{hodnota}</entry>

For example, the entry:

<?xml version="1.0"?><entry key="forceHttps">redirect</entry>

specifies that the property forceHttps will be set to the value redirect.


Property Overview


Database server connection

host

The address of the database server hosting the Flexi installation databases.

Default value: localhost

port

The port used to connect to the database server.

Default value: 5433

user

The username used to log in to the database server.

Default value: dba

password

The password for logging in with the username specified in user.

Web interface and REST API

defaultPort

The port number on which the Flexi web interface and REST API will be available.

Default value: 5434

forceHttps

Possible values: redirect, no, yes

Default value: redirect

Determines the server's behavior when a request is made via the unsecured HTTP protocol.

  • redirect – The request will be redirected to the secure HTTPS protocol and processed.

  • no – The request submitted via HTTP will be fulfilled.

  • yes – The request submitted via HTTP will be rejected.


Server Behavior

sendErrors

Determines whether information about unexpected server errors should be sent to the developers.

Possible values: always, never

Default value: never

  • always – Error information is always sent.

  • never – Error information is never sent.

startKernel

Determines the startup method for the server's application kernel, which can be started either when the server starts or upon the first request.

Possible values: true, false

Default value: true

  • true – The application layer is started when the server starts.

  • false – The application layer is started only upon the first request.

autoUpgrade

Possible values: true, false

Default value: false

Determines how company databases are upgraded when an older database version is detected than required by the current application version. Please note that upgrading a company database may in some cases take several minutes, depending on the database size and the extent of the changes being applied.

  • true – When the server starts, all company databases will be checked and any outdated ones will be upgraded.

  • false – A company database will be upgraded only upon the first user access to that company.

developerDirectory

Default value: /etc/flexi/developer

enableHooks

Enables the WebHooks technology, i.e. user-defined HTTP requests triggered by changes made within a company. WebHooks must also be enabled in the license.

Possible values: true, false

Default value: true

Sending emails

The application allows you to send documents (e.g. issued invoices) by email, and documents can also be sent via the REST API. For this purpose, an SMTP server can be configured in the Flexi server configuration file:

smtp.host

The address of the SMTP server through which application emails will be sent.

Default value: localhost

smtp.defaultFromThe email address of the currently logged-in user is used for sending emails (if provided); otherwise, the value set in this property is used.

Default value: noreply@localhost

smtp.auth.user

The username for logging in to the SMTP server.

Default value: user

smtp.auth.password

The password for logging in with the username specified in smtp.auth.user.

Default value: password

smtp.encryption

The encryption method used for the connection to the SMTP server.

Possible values: never, starttls, tls, ssl

Default value: ssl

  • never – unencrypted connection

  • starttls – connection is established unencrypted with the option to switch to a secure connection if TLS is supported

  • tls – connection is established unencrypted with a requirement to switch to a TLS-secured connection

  • ssl – fully secured connection (required by Gmail)

smtp.port

Specifies the port for communication with the SMTP server. In most cases, this line can be left commented out.

Default value: 25

Did this answer your question?