# System Requirements
On Premise Only
This document is intended for on premise customers who are setting up their infrastructure locally.
Cloud Hosting
For Cloud installations, different resource scenarios and guidelines apply. Please contact our sales team for more information.
The 4ALLPORTAL is a client-server based web application. The server(s) which run the 4ALLPORTAL provide graphical user interfaces and send data to users and other servers.
Below you will find the requirements for setting up a 4ALLPORTAL:
# Basic Installation Requirements
- Linux: A 4ALLPORTAL must be run on a Linux server.
- Docker: The choice of Linux distribution depends on the ability to run Docker. The 4ALLPORTAL is configured and run in a Docker container. Installing any packages other than Docker on the host is not required. The Docker host can be deployed on either virtual machines or physical servers.
- SSL: A 4ALLPORTAL system for production requires SSL (HTTPS).
- Domain: The 4ALLPORTAL does not support a domain name containing an underscore
_.
Please see our installation guide here.
# Availability of 4ALLPORTAL Services
The following services must always be available for your 4ALLPORTAL:
- Registry (https://registry.4allportal.net): Required for the
docker-imagethat installs the Core Engine and all Core Engine updates. - Repository Server (https://repository.4allportal.net): Required to install and update additional 4Apps.
- In-App Support (https://api.4allportal.cloud): Required to access our in-app support platform.
# Database
The 4ALLPORTAL requires a separate database. We currently support the following:
CoreEngine up to latest 3.x version
- MySQL 5.7.x, MySQL 8.0.31 or later (the latter requires Core version 3.10.38)
- Microsoft SQL Server (MS SQL) 2014, 2016, 2017 and 2019
- MariaDB 10.4 or later (10.11 recommended)
CoreEngine up to latest 4.x version
- MySQL 8.0.31 or later
- Microsoft SQL Server (MS SQL) 2019 and 2022
- MariaDB 10.6 or later (10.11 recommended)
Required permissions for Microsoft SQL Server
The 4ALLPORTAL database user requires the permission to create and alter databases (role: dbcreator). Additionally, the database requires the extension Fulltext Search.
Integrated Security with MS SQL
Please note: "integrated security" with MS SQL is not possible.
# Database Performance
- SSD: We highly recommend an installation of your database on a separate SSD-storage or a separate server-instance (minimum SSD speed, i.e. 300 MB/s reading/writing). This ensures an optimal performance of your system.
- Optimization:
- We recommend optimizing your database with a tool like MySQL Tuner (opens new window).
- For large systems with lots of custom configurations, it might be useful to tackle performance issues with a tool like Use The Index, Luke (opens new window).
- Large
innodb_buffer_pool_size(e.g., more than 8G) require lots of memory but often improve the performance.
- Fast hardware: Depending on your amount of assets and depending on your amount of index files used, more CPU/RAM is required to process the requests quickly.
# Mail Server
The 4ALLPORTAL requires access to an SMTP-Server, which is used for e-mail notifications to users, e.g. about assigned tasks or available download packages, as well as for the internal user management: When creating new users, passwords can only be assigned by users themselves, not by the administrator. Users will receive a welcome e-mail with a link for the assignment of their personal password (this will not apply when using an authentication provider like LDAP, SAML etc.).
# Mail Server Configuration
Before starting the 4ALLPORTAL, the mail server credentials must be added to the configuration file docker-compose.yml in its "environment" section (more information).
Please note: If your system is set up by 4ALLPORTAL GmbH, please pass the necessary information about your mail server to 4ALLPORTAL GmbH in advance.
For the docker-compose, the following information is required:
- mail host
- mail port
- security, e.g. SSL encryption
- username and password of the mail server
- e-mail sender address
- e-mail sender name, e.g. "4ALLPORTAL"
- no authorization is also possible
Mail server changes: If you want to make changes (e.g., new mail server credentials) or use a new one, make sure to configure it in the docker-compose.yml immediately. Otherwise, e-mail notifications from the 4ALLPORTAL may not be sent properly.
In the GUI, you can check your recent docker configuration in admin snap-in General system configurations/System settings/General settings.
# File System
The file system needs to be mounted into a directory on the operating system.
The way the storage is connected has a significant effect on the import speed for new and changed assets. Direct connections are preferable to network storage systems.
# /cefs Performance
All asset derivatives are stored in file system directory /4allportal/data/cefs after their creation in the tmp directory. From the cefs folder, they are provided for the frontend.
Please note: The faster the /cefs and the /tmp directories are, the faster conversions, downloads, and jobs run.
# Inode Support
You can make use of inodes to support moving files within the mount. Inodes are unique identifiers for files of your file system, that are independent of file content, file name and file path.
Please note: Your storage system has to support inodes if anything other that the 4allportal makes changes on the file system. Adding new files does not require inode support.
# System Resources
Please note: The resource requirements apply for On Premise installations only.
For Cloud installations, different scenarios and guidelines apply. Please contact our sales team for more information.
The system resources you require for your 4ALLPORTAL have to be sized depending on the expected amount of data and parallel users:
- number of managed assets (pictures, videos, documents, etc.)
- renewal rate of assets per day
- growth rate of assets per day
- parallel users
- size of the assets in the file system (the conversion of very large assets require more resources)
Required CPU: By rule of thumb, the requirement for CPUs grow with the number of parallel users.
Required RAM: By rule of thumb, multiply your RAM by 1.3 to determine the required resources for your tmp directory.
For many users or expected complex queries, more CPU/RAM are beneficial.
Please check and compare your individual prerequisites with one of our four resource recommendations (Small, Medium, Large, X-Large).
Please note: The resources suggested are required entirely for the 4ALLPORTAL. Please consider this if you use the same system for database hosting or a shared database system.
# Small
# Your Prerequisites:
| from | to | |
|---|---|---|
| managed assets | 1 | 100.000 |
| changed / new assets per day | 1 | 800 |
| parallel users | 1 | 10 |
| asset size in file system (GB) | 1 | 750 |
# Resource Recommendation:
| minimum | recommended | |
|---|---|---|
| CPU cores / threads | 2 | 4 |
| RAM (per server, GB) | 6 | 12 |
| combined servers | 1 | 1 |
| storage connection | direct: SAS, iSCSI, Fibre channel network share: NFS, SMB |
Please note: If you will have a lot of conversions of very large assets, you may require more resources.
# Medium
# Your Prerequisites:
| from | to | |
|---|---|---|
| managed assets | 100.000 | 500.000 |
| changed / new assets per day | 50 | 1.200 |
| parallel users | 5 | 20 |
| asset size in file system (TB) | 1 | 5 |
# Resource Recommendation:
| minimum | recommended | |
|---|---|---|
| CPU cores / threads | 8 | 16 |
| RAM (per server, GB) | 6 | 12 |
| combined servers | 1 | 1 |
| storage connection | direct: SAS, iSCSI, Fibre channel network share: NFS, SMB |
# Large
# Your Prerequisites:
| from | to | |
|---|---|---|
| managed assets | 500.000 | 2.000.000 |
| changed / new assets per day | 100 | 4.000 |
| parallel users | 10 | 30 |
| asset size in file system (TB) | 2 | 15 |
# Resource Recommendation:
| minimum | recommended | |
|---|---|---|
| CPU cores / threads | 8 | 16 |
| RAM (per server, GB) | 16 | 32 |
| combined servers | 2 | 5 |
| storage connection | direct: SAS, iSCSI, Fibre channel network share: SMB |
We recommend a clustered system.
# X-Large
# Your Prerequisites:
| from | to | |
|---|---|---|
| managed assets | 2.000.000 | 10.000.000 |
| changed / new assets per day | 400 | 10.000 |
| parallel users | 20 | 100 |
| asset size in file system (TB) | 5 | 100 |
# Resource Recommendation:
| from | recommended | |
|---|---|---|
| CPU cores / threads | 8 | 32 |
| RAM (per server, GB) | 16 | 32 |
| combined servers | 3 | 8 |
| storage connection | direct: SAS, iSCSI, Fibre channel network share: SMB |
We recommend a clustered system.
If your parameters are not covered in one of these scenarios, please contact us for individual advice.
# Operating System and Browser Requirements
# Operating System and CPU Support
Currently, we only support Linux configurations with:
- a 64bit - x86-64 or ARM CPU
- Kernel version 3.10 or later
- support for KVM virtualization
- generally: support for Docker
# /tmp Performance
In the /tmp directory, all asset derivatives are generated. It should be accordingly performant and needs to be larger than 5GB (minimum). With 5GB, a maximum of 5GB could be processed and provided in parallel. By rule of thumb, multiply your RAM by 1.3 to determine the required resources for your /tmp directory.
After creation, asset derivatives are stored in and made available for the frontend in the file system's /cefs directory.
# Desktop App Operating System
4App Desktop App offers native file access and improved features like drag and drop to the desktop for enhanced usability (more details (opens new window)).
If you want to work with our 4App Desktop App, you require:
- Windows x86 and x64 (all versions supported by Microsoft)
- Mac x64 and Apple Silicon (all versions supported by Apple)
# Supported Web Browsers
Please use one of the following browsers to work with the 4ALLPORTAL:
- Google Chrome (latest or prior version)
- Mozilla Firefox (latest or prior version + ESR)
- Safari (latest or prior version)
- Microsoft Edge (chromium based, latest or prior version)
- Opera (latest or prior version)
- Vivaldi (latest or prior version)
Note: Please keep your browser up-to-date to make sure all features work properly.