Documentation: Flowy Installation

Please support us to improve our service. We would like to use statistics anonymously.

We do not pass on your data! You can find more information in our privacy policy.

Decline

< Back to documentation

Flowy Installation

The following steps need to be executed:

  1. Set-up a PostgreSQL database for Flowy metadata; see database setup section for details
  2. Install Java runtime and write down the installation path
  3. Install fonts (if needed): see font installation section for details
  4. Install wkhtmltopdf
  5. Install Python, PIP and Jep:
apt-get install python3 python3-dev
apt-get install python3-pip
export JAVA_HOME=/path/to/java
pip3 install jep
  1. Install tesseract-ocr (if OCR steps will be used)
apt-get install google-perftools
pip3 install yep
apt-get install tesseract-ocr
  1. Create application user; it is recommended to use different ones for admin respective processing
  2. Create folders for Flowy:
mkdir -p /opt/flowy/admin/bin
mkdir /opt/flowy/admin/conf
mkdir /opt/flowy/admin/log
mkdir -p /opt/flowy/processing/bin
mkdir /opt/flowy/processing/conf
mkdir /opt/flowy/processing/log
  1. Change ownership of admin folder to the admin application user (respective for processing to the according user)
  2. Place flowy-admin.yml into /opt/flowy/admin/conf; example files as well as possible settings are available on the configuration page
  3. Place flowy-processing.yml into /opt/flowy/processing/conf; details are document in the same place as for the previous point
  4. Set up logback.xml in both conf folders (example files are available on the configuration page)
  5. Place flowy-admin.jar into the according bin folder
  6. Place flowy-processing.jar into the according bin folder
  7. Configure Flowy services as described on the startup page
  8. Start Flowy services
  9. Log in: by default the user admin@getflowy.io with the password admin is created

Gefahr

Please immediately change the password for this user.

  1. Enter correct SMTP settings for 'DEFAULT SMTP' credential: this is a mandatory step, as every newly signed up user receives a login token by email
  2. Adjust 'DEFAULT FRONTEND' frontend setting and update there the values of the following fields:
  • Set Password Url
  • Base Url Rest
  • Default Locale
  1. Setup a new user with either 'SUPER_USER' and/or 'USER_CREATOR' roles
  2. Check the configured email address and enter an initial password
  3. Log in using the newly set up user and disable the default admin@getflowy.io user

Database setup

Enclosed an short script which creates a new database and user (on Postgres 15):

CREATE DATABASE "mydatabasename" ENCODING 'UTF8';
CREATE USER mydatabaseuser WITH ENCRYPTED password 'mysecuredatabasepassword';
GRANT ALL PRIVILEGES ON DATABASE "mydatabasename" TO mydatabaseuser;
\c "mydatabasename"
GRANT ALL ON SCHEMA public TO mydatabaseuser;

Font installation

For the correct usage of Flowy, fonts libraries have to be installed, depending on the Java that you have selected. In most cases, this step can be skipped on macOS and Windows. For all other systems, we recommend the freely available software library FreeType.

FreeType can be installed using the following statements.

Debian/Ubuntu/Mint

apt-get install libfreetype6 fontconfig fonts-dejavu

RHEL/CentOS/Fedora

yum install freetype fontconfig dejavu-sans-fonts

SLES/OpenSUSE

zypper install libfreetype6 fontconfig dejavu-fonts