System Configuration

From DotProjectWiki

Jump to: navigation, search

SYSTEM ADMIN MANUAL LINKS

This section of the site refers to the System Admin > System Configuration options only.

As of 2.x Release, most configuration options where moved from the config.php file into this user interface. The only configuration information that is now included in the config.php file is the database connection information. Please do not attempt to configure dotProject 2.x or greater via that file, you should use this user interface instead.

For other information on configuring your dotProject installation please refer to Configuration.

Each of the options also includes brief online help (via the ? against each option). In short, available configuration elements are:

Contents

1 Host Locale

This option indicates the localisation or language setting for your site (NOT THE GANT CHART LOCALE - See jpGraph Locale below.

2 Overallocation Checking

This is a work in progress WHICH SHOULD NOT BE USED It is the basis of a system that will allow Project Managers to establish the maximum % of time that a resource can be allocated to a particular task for a particular period of time.

3 Currency Symbol

Whilst we currently have locale support built in there is still an extra facility for setting Currency Symbol. Localisation of the currency-symbol. For the EURO sign symbol set to '€' Check http://www.w3.org/TR/html401/sgml/entities.html for information about html special characters.

4 Default User Interface Style

As set in the User Preferences area, however, you will need to type the name of the default in here. If you need a prompt - check the dropdown in the User preferences and repeat that name here.

5 Company Name

The company name setting is used to stipulate what will appear in the top name of the login box on your site.

6 Page Title

Stipulate what will appear on the top line of the browser - before the browser name.

7 Site Domain

The domain set here is used to generate an email address if an incomplete address has been entered in the user's record.

8 Email Prefix

This setting is used to stipulate the subject line prefix for all email that dotProject sends out.

9 Admin Username / admin_user_title

This setting is used to nominate which of your dotProject user accounts is the administration account.

10 Minimum Username Length

Establish the minimum length of any user names for dotProject. This can NOT be longer than the length of the column in DB

11 Minimum Password Length

Establish the minimum length of any password entry in dotProject. This can NOT be longer than the length of the column in DB

12 Enable Gantt Charts

The option to enable or disable Gantt charts allows you to turn on the function or turn off the function, depending upon whether you wish to use Gantt charts on your site.

13 jpGraph Locale

Use this option to set a locale for jpGraph if it is required. jpGraph is the third party package that is used throughout dotProject to create graphics or charts (eg the Gantt chart). Leave blank if you experience problems.

14 Log Changes

This option allows you to nominate whether you wish to Log Changes in the history module automatically.

15 Check Task Dates

If this option is turned on the start and end dates will be required in all tasks before they can be added.

16 Translation Warning

Display a warning in the User Interface when a translated item is not found. (Used in conjunction with Translation Alert String)

17 Translation Alert String

The string appended to untranslated strings or unfound keys if Translation Warning is turned on.

18 Daily Working Hours

This setting establishes the standard number of hours in a working day for your installation, for example 8.0

19 Show Debug Messages

Set to true to display debug messages as well as log them. WARNING: Setting to true can cause dotproject to fail on warnings if the debug level is set greater than 1. Normally errors will be displayed so this should only be set to track warnings and debug messages if you do not have access to the PHP log files.

20 Allow Ticket Relinking

Having this option turned on will allow you to relink tickets to an arbitrary parent in Ticketsmith. Could be useful for email-generated tickets.

21 Show All Task Assignees

Set this option on if you wish to show all assignee names in the project task task list or off if you would prefer to see just the main assignee name and a count in brackets of the number of other assignees.

22 Edit Multiple Task Assignments

Turning this option on will allow you to edit task assignments and other options (per task block) in the main Task Module view. You will also need to turn this option on to allow updating of multiple tasks on the Todo / Today listings.

23 Restrict Project Colour Selection

Used in conjuction with the System Value Look up option "ProjectColors" you can use this setting to control the project colour selection options accessible by all users on this system. If you turn this option on then project creators will only be able to select from the colour options defined in the System Value Lookup outlined above. If you turn this option off then project creators will be able to access the default system presets and the full colour pallette.

24 Calendar Start Hour

Use this option to indicate the starting hour for your calendar day - integer value from 0 to 23

25 Calendar End Hour

The last hour of the working day - integer value from 0 to 23

26 Calendar Minute Increment

Minute increment setting for the Calendar Time Display

27 Calendar Working Days

Establish the required working days for your company in a comma separated list where 0 is Sunday. For example if you work Monday through to Friday your list would be 1,2,3,4,5. If you work Friday through to Sunday your list would be 5,6,0

28 Memory Limit for Gantt

Experiencing Errors with invisible / errors on Gantt Charts use this variable to temporarily expand your PHP Memory Limit for Gantt Chart drawing. Values of 64M, 128M etc. are common.

29 Restrict Task Time Editing

Turned on, this option will restrict the editing of task time settings to the task owner, the project owner or the system administration only.

30 Default Module

If you want to define your own start/default page set this. If the value is empty then the first listed module becomes the default view. Easiest way to set this is to choose the module that you want to have as your startup and copy the name of the module from the URL to this field, eg:

m=projects in the URL would equal projects in this field (DON'T Use the m=)

31 Default Submodule

If you want to define your own start/default page set this. Specifies a subview like shown in the url of dP. Easiest way to set this is to choose the module that you want to have as your startup and copy the name of the module from the URL to this field, eg:

m=tasks&a=todo (todo page)

Default module = tasks

Default submodule = todo

a=todo in the URL would equal todo in this field (DON'T Use the a=)

32 Default Tabbed Subview

If you want to define your own start/default page set this. Specifies a tabbed subview. 0=first tab, ...

33 Maximum File Size for Indexing

File Indexing for Searching: Large Files may cause timeout problems during exhausting indexing process. Specify an upper filesize limit for indexing in KiloBytes. Have in mind that files greater than the specified value are not indexed! A negative value defines the absence of a limit (index all files).

34 Debug Level

Turn this option on to display debug messages as well as log them. WARNING: Setting to true, if the debug level is greater than 1, can cause dotProject to fail on messages that are technically only Warnings and therefore can be ignored. Normally errors will be displayed so this should only be set to track warnings and debug messages if you do not have access to the PHP log files. Anything other than 0 will provide debugging information. Level 1 is probably the most reasonable compromise between normal operation and error tracking information. Set to 10 to get complete debugging information but be aware that this will generate large log files and/or debug listings very very quickly.

35 Default File Indexing Parser

Location for the Default File Indexing Parser, e.g. /usr/bin/strings

36 MS Word Indexing Parser

Location for the MS Word File Indexing Parser.

37 Html File Indexing Parser

Location for the Html File Indexing Parser, e.g. /usr/bin/strings

38 PDF Indexing Parser

Location for the PDF File Indexing Parser, e.g. /usr/bin/pdftotext

39 Preserve File Settings on CI

Keep file attributes during Check In. If this is on, you will not be able to change file type, project or task of a file during the check in.

40 Allow Editing of Previous Versions

Allow or disallow editing of previous versions of files in File Module

41 Show MiniCals in Day View

Include MiniCalendar Displays in the Day View.

42 Postnuke login also allows Standard Login

If PostNuke authentication is in effect, setting this also allows standard dotProject logins. If not set all logins must be performed via PostNuke.

43 tasks_ajax_list_title

Turn on / off ajax support on Task listings.

44 stf'n_title

tba

45 User Authentication Settings

Methods for authenticating (checking for valid) user login name / password combinations.

45.1 User Authentication Method

This option will list the authentication methods available (this will depend on the modules installed / options configured on your site). For more Details see User Authentication Methods

46 LDAP Settings

These options set up LDAP server access for dotProject to connect to.

46.1 LDAP Search User

The full DN of a user who has access to search your users directory

46.2 LDAP Host

The Name or IP address of the LDAP host to authenticate against, when using LDAP Authentication.

46.3 LDAP Port

Port Number to use to connect to LDAP authentication host.

46.4 LDAP Version

LDAP Version that the LDAP host understands. If unsure, leave at the default of 3.

46.5 LDAP Base DN

The Base Distinguished Name (DN) to use for LDAP queries.

46.6 LDAP User Filter

User Filter to use for determining matching users on LDAP queries. Check with your site administrator for details.

46.7 LDAP Search User Password

Password for the search user from your LDAP server

46.8 LDAP also allows standard login

Tick on to allow dotProject database only based users to login

47 Email Settings

This option is used to tell dotProject what it needs to know to connect to your email setup.

47.1 Email Transport

Select either PHP for standard PHP mail support or SMTP for direct SMTP support

47.2 SMTP Host

The fully qualified domain name (FQDN) or the IP address of the SMTP host to use for sending email

47.3 SMTP Port

The TCP port to connect to the SMTP host. If in doubt, leave it at the default of 25.

47.4 Host requires login

Some SMTP hosts require authentication, if yours does you will need to set this and provide a username and password. Tick to turn on and then use the next two settings (SMTP Username and Password) set up the required elements.

47.5 SMTP Username

The username to use when authenticating to your SMTP server

47.6 SMTP Password

The password to use when authenticating to the SMTP server

47.7 Queue Email for later sending

Check this to queue email for later sending. An entry will be made in the Event Queue. You will need to either set the Scan Event Queue option in Session Handling or create a cron job to call: wget -O- http://your.domain/dotproject/queuescanner.php

47.8 SMTP Server Timeout

The number of seconds to wait for a successful connection to the SMTP server

48 Session Handling Settings

User Sessions or login sessions are required to maintain ongoing connections with dotProject (if users are being logged out between pages, for example, then it could be that you don't have user sessions set up properly).

48.1 Session Handler

Which session handling to use, should be either 'php' for traditional PHP session management, or 'app' for the dotProject application to manage its own sessions via the database. Session Management: This extends the session handling of PHP to beyond browser-based sessions and stores the session information in the database. This allows for prolonged sessions with lower overheads.

48.2 Session Idle Time

The maximum time a session can have no activity before it is declared dead. Values are in seconds unless followed by a letter: h = hours, d = days, m = months, y = years. You can only have 1 character within a string, so 2d4h is NOT valid, but 28h is.

48.3 Session Maximum Lifetime

The maximum time a session can exist before it is trashed, regardless of how active it is.

48.4 Scan Event Queue on Session Garbage Collection

If using deferred email or any other event queue, setting this causes the session handler to check the queue when it garbage collects the session. This is an option to using an external program to call the queue scanner.

48.5 session_name_title

Name / ID of sessions for ease of identification - we'd suggest you use dotproject

49 Task Reminders

These options setup how / when task reminders are emailed.

49.1 Send Task Reminders

Tick on to send out task reminders - if off then no reminders will be sent to anyone. If set, an email will be sent to all assignees when a task is due and every day it is overdue until completed.

49.2 Number of days warning for due tasks

Setting this will determine how many days before a task is due the first reminder is set.

49.3 Maximum number of reminders to send

If a task is overdue for a large number of days, it may not be worth sending any more reminders. This value determines the total number of reminders that will be sent, including pre-due date warnings and overdue alerts.

50 Return to...

...back to System Administration

51 Footnotes

    Personal tools
    System Administration
    Conversion