winfylr:architecture
Table of Contents
Fylr for Windows - Architecture
Overview
The installer of Fylr for Windows not only installs Fylr itself but also all required additional services (e.g., database engine, search indexer) and tools (e.g., Image Magick, Libre Office, Inkscape, etc). The location of the installed tools and services must be kept to enable a seamless in-place update of the entire installation. The installer will delete and update services and tools as needed when installing an update for an existing installation.
Filesystem Structure
The installer uses the following file structure
| Fylr | |||
| \data | Directory for all customer data (database, index, assets, log files, backups, Fylr's tmp folder) | ||
| \assets | Default location for assets cataloged in Fylr (can be changed after the installation with the Location Manager) | ||
| \backup | Installer ships a batch script to create a database-backup while Fylr is running which writes into this directory | ||
| \logs | All installed services are configured to write their log-files into this directory. | ||
| \opensearch | Directory contains the live data of the indexing engine | ||
| \pgsql | Directory contains the live data of the database. | ||
| \tmp | tmp-Directory configured for Fylr itself | ||
| \licenses | Contains the license files for tools and services | ||
| \plugins | Contains the plugins as delivered by ProgrammFabrik | ||
| \services | Root directory for all core services of the Fylr installation. It also contains the scripts executed by the installer to register/unregister the services as Windows services, to prepare the database engine if starting from scratch, a backup script for the database which can be used for Windows Task Scheduler |
||
| \apache-tomcat | [Optional] Apache Tomcat to run Attention web-applications. Configured to be behind the Fylr reverse proxy. | ||
| \jdk | Java environment needed by Fylr itself and Apache Tomcat | ||
| \opensearch | Indexing engine used by Fylr | ||
| \pgsql | Database engine used by Fylr | ||
| \utils | Root directory for all 3rd-party applications needed by Fylr for asset processing. Do not change them as they are referenced from within the Fylr configuration. | ||
Fylr Configuration
The installer ships several configuration files:
| fylr.base.yml | The main configuration file for the Fylr service. This file contains most of the configuration needed for the tools and services installed by the installer. This file will be overwritten with the next installer run. Never do any changes in this file but in fylr.yml instead. |
| fylr.yml | The second main configuration file for the Fylr service which contains the customer specific configuration. This file is never overwritten by the installer. Do all the needed configuration changes within this file. |
| fylr.sample.yml | This is the fylr.yml the installer would have used for a new installation. Can be used to check the changes made to it for a new release. |
| fylr.default.yml | The fylr.default.yml as shipped by ProgrammFabrik. It's not used for the Fylr service configuration. This file will be overwritten with the next installer run. |
| fylr.example.yml | The fylr.example.yml as shipped by ProgrammFabrik. It's not used for the Fylr service configuration. This file will be overwritten with the next installer run. |
winfylr/architecture.txt · Last modified: by 127.0.0.1