File System Layout

Overview

If installing Polarity Server onto a single server we recommend placing your PostgreSQL installation on a separate partition from your Operating System (OS) partition. In addition, we recommend placing your system audit logs (found by default in /var/logs/audit) into their own partition so that in the event application logs fill up your OS partition, the system audit logs can continue to be written.

In general, we recommend a mirrored (Raid 1) setup for your OS partition, and a Raid 10 (1+0) setup for your database partition. The size of the partitions and the types of disks used will depend on the number of simultaneous users you expect to be connected as well as the amount of data (tag, entities, and comments) that you expect to store directly in Polarity.

For the PostgreSQL partition we recommend sizing the disks so that the total disk space is equal to the required space for your data plus 30% for the overhead of Postgres logs, caches, and other database operations. In general, we recommend the use of SSD drives over spinning disks.

Important File System Locations

Log file locations

Software
Directory
Filename

Polarity Server

/app/polarity-server/logs

polarity-server.log

Polarity Integrations

/app/polarity-server/integrations/<integrationName>/logs

integration.log

Polarity Web

(see nginx logs)

NGINX

/var/log/nginx

access.log, error.log

Redis Caches & OS

/var/log

messages

PostgreSQL

/var/lib/pgsql/13/data/logs

Postgresql-<Day>.log

System Audit

/var/log/audit

audit.log

Important Default File System Locations

/app

Contains Polarity Software

/app/nginx

Contains Polarity nginx configurations

/app/polarity-web

Contains polarity-web files (served by nginx)

/app/polarity-server

Contains polarity server REST API and logs

/etc/nginx

Nginx configuration directory

/etc/pki/tls/certs/server.crt

SSL Public Certificate

/etc/pki/tls/private/server.key

SSL Certificate Private Key

/var/lib/pgsql/13/data

PostgreSQL configuration and database data

Default Mount Points

When installing Polarity software onto a single server we recommend putting the OS partition, PostgreSQL partition, and Polarity software partition on separate disks. The table below shows the default filesystem locations for the OS, PostgreSQL, and Polarity.

Name
Mount Point
FS
Min Size

OS partition

/

XFS

24 Gb

PostgreSQL

/var

XFS

80 Gb

Polarity

/app

XFS

40 Gb

When available, we would recommend mounting /, /var, and /app onto different disks.

Last updated