Config.ini and gconfig.ini Files

There are two configuration files that are maintained by the server. Most entries in these files are maintained by site administrators with the browser interface for Configuration. However, a system administrator can also maintain these files manually with a text editor, then restart the server for changes to take effect.

The file config.ini resides in the main installation path of the CirrusPrint server. It controls the settings specific to that server machine. Here is a table of settings in that file:

[settings]
data=data	This points to the path where shared data resides. On different machines in a cluster, this can be a common mounted path that all machines share. Copy files from one machine to seed the data to be shared. The initial location is a subdirectory path "data" in the CirrusPrint install location.

[httpd]
port=27082	This is the http (unencrypted) port number for the browser interface
allow=127.0.0.1 10.0.0.0/8 172.16.0.0/12 192.168.0.0/16	This limits access to the http port
sslport=27083	This is the https (encrypted) port for the browser interface
sslcertfile=	A SSL/TLS certificate can be specified here as a path. If not set, an internal self-signed certificate is used.
sslkeyfile=	The private key file associated with the certificate is specified here as a path.
sslallow=	This limits access to the https port
mintls=1.2	This is the minimum TLS level accepted by the https port.

[smtpd]
smtpport=27085	This is the port the local SMTP server listens on. This is an optional feature of CirrusPrint, enabling emailing directly to the server. In most cases, this port should be 25, but if you control the output email configuration of document production, it can be any port your emailing application can send to. This is a receiving-only server, so do not use this SMTP server for general purpose email sending. Note CirrusPrint also supports IMAP-based document handling, enabling it to pull documents from a dedicated mailbox on any mail service you control.

The file gconfig.ini resides in the data path pointed to by the config.ini data=path setting. It contains settings for a whole site, in other words, all the machines that share a data path.

[settings]
debug=0	If set to 1, this adds more data to the log file that may be helpful for support
maxsize=25m	Files larger than this are rejected. This both protects the server from resource exhaustion and job recipients from huge unexpected print jobs. Use k, m, g suffixes for kilobytes, megabytes, and gigabytes. Gigabyte limits are not recommended.
minpix=1000	When evaluating email attachments, images with either x or y dimension pixels are considered non-deliverable files, such as logos in html email content.
portrange=10000-10999	When auto-assigning inbound source ports, use this range as a global default. Companies (tenants) can also be configured with their own ranges.
url=	This is the external url used to access the server. This is used when sending deployment or MFA links.
tracelog=0	If set to 1, adds job-level trace logging and makes copies of work files in the data/tracefiles path. Not recommended except under guidance from support, and should be reset to 0 when no longer needed. The same setting is also supported in the system client's config.ini file and should be kept in sync there as well. Logging is then also added to the client log, and received work files copied to the client's data/tracefiles path. Note there is no automatic purging of data/tracefiles. Delete those files manually.
password=0\|1\|2	Password enforcement for site users and locations. If set to 0, the default, passwords are at the descretion of the admininstrator. If 1, moderate password strength is enforced when user or location records are saved. If 2, strong password strength is enforced. Moderate passwords are at least 8 assorted characters including uppercase, lowercase, digit, and special characters (!@#$%^&*()-+=,.:;/). Strong passwords are at least 14 assorted characters.

[duration]
session=12h	The length of a browser login session. Use s, m, h, d suffixes for second, minute, hour, and day values.
deadfile=1h	A dead file is one in an inbound source path that is never considered complete, and should be removed. Examples would be a partial PDF file, or a file that doesn't meet wildcard specifications.
jobhist=1d	When jobs are complete, they remain on file for job monitoring purposes, but should be removed relatively promptly to lower machine resource needs.
jobdead=30d	Any job that is never picked up or delivered expires after this amount of time.
logage=7d	Log files, found in the data/logs path, are retained for this length of time.
mfa=15m	MFA codes expire after this amount of time.
passrec=15m	Password recovery codes expire after this amount of time.
verify=24h	Email verification links expire after this amount of time.
deploy=2h	Location client deployment links expire after this amount of time.
Other settings in this section should not be modified without guidance from support

[logs]
http=0	Set to 1 to increase logging of http requests
service=0	Set to 1 to increase general service logging
api=1	Set to 1 to log api errors, 2 to log all api requests

[email]	* This section should be maintained with the Configuration tool Note companies (tenants) have their own email settings as well
from=	When the server sends emails, this is the From address that is used.
server=	The SMTP server used for sending emails.
login=	The login to the SMTP server to send emails
enc_password=	An encrypted version of the password. Use the browser interface Configuration window to maintain this.
notify=	An email address to send notifications to
enc_sgkey=	An encrypted version of a SendGrid API key, used in preference to SMTP if supplied. Use the browser interface to maintain this.
mintls=1.2	The minimum TLS level the SMTP server accepts.
[httpd]
sslcertfile=	A global SSL/TLS certificate can be specified here as a path. This applies to all servers using the shared data path.
sslkeyfile=	The private key file associated with the certificate is specified here as a path. This applies to all servers using the shared data path.