Documentation
Sushee configuration
Edit /sushee.conf.php to configure your freshly installed Sushee.
All configuration directives are modified like this :
$GLOBALS['paramName'] = value;
General
- admin_email : configures the email adress of the person whom the feedbacks will be sent to.
- keyringsSender : configures the email adress indicated in the emails sent with the users'access codes.
- NectilMasterURL : configures the web adress which is used to access nectil root (which contains OS,Public, Kernel, Files).
- NectilMasterURL2 : configures a second url that can be used to access Nectil. If you want more, use commas to separate them and put them all in this variable.
- xmlVisible : authorizes, or not, the vision of XML datas when xml=true is set in the url of the pages. To disable : $GLOBALS['xmlVisible']='false';
- MySQLFullTextMinLength : the min length of the MySQL Fulltext index. See the matchagainst operator. Under this value, Sushee will fallback on a LIKE operator. The default value is 4 (the default value of MySQL). You will have to configure MySQL to use this operator.
- VirtualMinResidents : sushee doesnt create the residents by itself but just the database. It lets VirtualMin create the folders and files.
Security
- CookieHttpOnly : cookies are only accessible through http and not Javascript (to avoid XSS attacks vulnerability)
- CookieSecure : for SSL secured websites, configures the cookies to be secured too.
Mailing
- MaxEmailPacket : configures the number of emails sent every quarter.
- MailingMinInterval : configures the minimum interval (in minutes) between two mailing sending (the specific interval for the Kernel can be updated in the resident ID=1).
-
PopServer : indicates the adress of your pop server.
A pop account is necessary to catch the emails that come back because the recipient email adress is erroneous (or the recipient mailbox is over quota). - PopUsername : indicates the name of the pop account.
- PopMailAddress : indicates the real email adress if popusername is not an email adresse but only a login to access the Pop account.
- PopPassword : indicates the password of the pop account.
- phpExecutable : indicates the path to the PHP executable. Necessary to execute scheduled tasks (like mailings, cache respawning) every quarter and every night.
Various
- ImageMagickPath : indicates the path to the ImageMagick(graphic library) executables (convert, composite). Ex: /usr/bin/
- javaExecutable : indicates the path to the java executable. Necessary if you want to generate PDF with Nectil. Ex: /usr/bin/java
- javaMaxMemory : indicates the maximum amount of memory the java process can use (in Mb). Ex: 512
- xsltproc : indicates the path to the libxslt executable. This is only necessary if you do not use sablotron and if xsltproc is in an unusual directory. In the windows version, xsltproc is included and doesn't need to be configured.
Cache & Temporary files
Default value is one month. You can tweak these values if your server Hard Disk is almost full and that directories /Files/cache, /Files/pdf/ or /Files/tmp contain too many files.
- TempMaxAge : indicates how long temporary files are kept on the server HD. Temporary files include dynamic images, text generations, csv exports. TempMaxAge is expressed in seconds. Ex: 1 day is 86400 seconds.
- CacheMaxAge : indicates how long cache files should be kept on the server. Cache files include cached NQL requests, HTML resulting from XSL transformation (a XSL transformation is automatically cached and is not redone if template has not changed). CacheMaxAge is expressed in seconds.
- PDFMaxAge : indicates how long dynamically generated PDF files (stickers, exports) are kept on the server. PDFMaxAge is expressed in seconds.
- ConfirmMaxAge : indicates how long NQL waiting for confirmation should be kept on the server. ConfirmMaxAge is expressed in seconds.
Image transformation
Configures the maximum dimensions of the pictures transformed dynamically (image transformations can be quite heavy). It does not impact transformation performed inside the Officity environment as there are no limits on these operations.
- TranformationMaxWidth : indicates the maximum width a picture can reach and still be transformed. This value is expressed in pixels and is by default 1600 px.
- TranformationMaxHeight : indicates the maximum height a picture can reach and still be transformed. This value is expressed in pixels and is by default 1600 px.
- TranformationMaxSize : indicates the maximum size - in Kb - a picture can reach and be transformed. This value is 512 Kb by default.
Logs
Configures the behaviour of Sushee logging
- LogMaxSize : the maximum size of the files in /Files/logdevs/ (query.log, response.log, debug.log, errors.log) in bytes. The default value is 1048576 (1Mb) by default.