Changes between Initial Version and Version 1 of CoreConfiguration

05/04/10 15:07:22 (10 years ago)



  • CoreConfiguration

    v1 v1  
     1Officeshots has many different configuration settings. This page attempts to document them all. 
     3== Core configuration == 
     5 debug:: 
     6   This should be set to 0 for production use. 
     7 Routing.admin:: 
     8   This must be set to "admin". Officeshots uses CakePHP admin routing. 
     9 Config.language:: 
     10   The default language used by Officeshots. These are three letter language codes. 
     11 Email.admin:: 
     12   The administrator's e-mail address. Also used as the From: address in system e-mails like registration confimations. 
     13 Auth.allowAnonymous:: 
     14   Set to true to allow anonymous users to submit requests to Officeshots 
     15 Auth.allowRegister:: 
     16   Set to true to allow new member registrations 
     17 Auth.limitRegister:: 
     18   Set to false to allow anyone to register for an account. You can also set it to the full path of a text file that contains a whitelist of e-mail addresses (one per line). 
     19 Request.limitAnonymous:: 
     20   The maximum number of requests per day for an anonymous user (based on IP address) 
     21 Request.limitRegistered:: 
     22   The maximum number of requests per day for registered users (based on user ID) 
     23 Request.expire:: 
     24   The number of seconds before a request expires 
     25 Request.meta_refresh:: 
     26   The number of seconds between automatic refreshes of a request page 
     27 Job.locktime 
     28   The number of seconds that a job is locked after it has been sent to a FactoryClient. If a factory does not respond with a result within this time, the job may be given to a different factory. 
     29 Factory.polltime:: 
     30   How often factories should poll the central server, in seconds. If a factory does not show any activity for this time period, it will be marked inactive and it's applications will not be shown on the front page. 
     31 Factory.stabletime:: 
     32   How long (in seconds) it takes for an active factory to become stable. Test suite documents are only given to stable factories. This to prevent accidentally overloading an in-development or volatile factory with thousands of documents. 
     33 Clamd:: 
     34   Set to false to disable scanning uploaded files with ClamAV. Or set it to an array to activate it. 
     36   The host where ClamAV is running as a service 
     37 Clamd.port:: 
     38   The TCP port that ClamAV is listening on 
     39 Clamd.timeout:: 
     40   A timeout in seconds. If ClamAV does not respond within this time, Officeshots will assume that scanning has failed. The document will not be processed. 
     41 Validator:: 
     42   An array of ODF validators that should be used to test ODF documents. To disable ODF validators, simply remove them. 
     43 Validator.Cyclone:: 
     44   Configuration for the Cyclone3 ODF validator. The value should be a full path to the locally installed {{{}}} 
     45 Validator.Officeotron:: 
     46   Complete URL to the remote Office-o-tron ODF validator webservice 
     47 Validator.ODFToolkit:: 
     48   Complete URL to the remote ODF toolkit validator webservice 
     49 Anonymiser.path:: 
     50   Full path to the locally installed script from iTools. 
     51 Testsuite.user_id:: 
     52   User ID of the user where all testsuite jobs and galleries should be assigned to 
     53 Testsuite.group_id:: 
     54   ID of the user group that all testsuite galleries should be assigned to. All users of this group can edit the testsuite gallery descriptions. 
     55 Gallery.abbreviate:: 
     56   If there are more than this many files in a gallery, it will be shown in abbreviated form (i.e. no individual results, just a tree of requests). This greatly reduces load on the server. 
     57 Cron:: 
     58   An array of cron jobs. These cron jobs are executed by the Officeshots background daemon, not by the system cron. Officeshots does not need a system cron. These jobs are executed at the specified interval (in seconds) ''and'' whenever the background daemon (re)starts. 
     59 Cron.testsuite_refresh:: 
     60   The gallery pages for test suites are cached for performance reasons. Test suites can get very large, very quickly. This cron job is responsible for refreshing the caches. 
     61 Cron.expire_requests:: 
     62   This cron job marks requests as "expired" when they have been running for too long (see also Request.expire above) 
     63 Cron.testsuite_jobs:: 
     64   This cron job makes a list of all stable, active factories and makes sure that there are jobs for these in the test suites. Any missing jobs will be created. Existing jobs will never be removed. 
     66== Beanstalkd configuration == 
     68The main Officeshots website communicates with the background daemon using the Beanstalkd workqueue manager. Beanstalkd should already be running on your server. The client configuration goes in the {{{BeanStalkManager::config}} array. The default settings are adequate fro Officeshots. You should only need to change the "servers" setting. Only change the other settings if you know what you are doing! 
     70 servers:: 
     71   An array of Beanstalkd servers in the form of {{{<ip-address:port>}}}. One server is normally enough. Officeshots is capable of running distributed (one central server with many background daemons on different machines) so it is possible to use multiple beanstalkd servers. 
     72 select:: 
     73   How to select between different Beanstalkd servers. "random wait" is good for just one Beanstalkd server. Other options are "sequential wait", "random peek" and "sequential peek". Note that using one of the "peek" variants may consume a lot of CPU power because Officeshots will be hopping from one Benastalkd server to the next, until it finds some work. See also "peek_usleep" below. 
     74 connection_timeout:: 
     75   In seconds. 
     76 peek_usleep: How long to sleep (in microseconds) between subsequent peeks on different Beanstalkd servers. 
     77 connection_retries:: 
     78   How often to reconnect to Beanstalkd 
     79 default_tube: 
     80   Which tube (or channel) to post the Officeshots messages on. If you run multiple instances of Officeshots on the same server (i.e. a production version and a development version) then they should all speak on different tubes. 
     81 auto_unyaml:: 
     82   Should be set to false.