1 = Administering imip-agent = 2 3 With imip-agent deployed, usage of the software should occur automatically. 4 However, evidence of its operation will only emerge when calendar-related 5 messages are exchanged between e-mail users. This will cause a few different 6 things to happen: 7 8 * Summary messages may be sent by the calendar system to mail recipients 9 10 * Replies to calendar-related messages may be received by the senders of 11 those messages 12 13 * Free/busy information will become available, either in responses to 14 requests sent over e-mail, or [[../FreeBusyPublishing|over the Web]] 15 16 In the background, imip-agent uses and updates information as described in the 17 [[../FilesystemUsage|filesystem usage guide]]. 18 19 == Initialising the System == 20 21 As described in the [[../GettingStarted|getting started guide]], the system is 22 initialised by running the initialisation script: 23 24 {{{ 25 tools/init.sh 26 }}} 27 28 == Creating Data Stores for Individual Users == 29 30 The [[../MailIntegration|mail system]] mechanisms are responsible for 31 determining whether a valid recipient has been specified in any given message, 32 and imip-agent does not attempt to validate such information again. Therefore, 33 when a message is received for a calendar user for whom no data store has been 34 initialised in the [[../FilesystemUsage|filesystem]], the software will 35 automatically create one. 36 37 Consequently, users for whom such data stores have been created will experience 38 the software using the default configuration, described in the 39 [[../Preferences|preferences guide]]. It is for this reason that the default 40 values in the [[../Configuration|configuration]] should be adjusted according 41 to the policies decided for the deployment of this software. 42 43 However, it is possible to create data stores for users in advance using the 44 `tools/init_user.sh` script as in the following example: 45 46 {{{ 47 tools/init_user.sh mailto:vincent.vole@example.com 48 }}} 49 50 Here, the user identity is given as a URI since this is how iCalendar references 51 participants in scheduling operations. The result of the above command should be 52 some new directories in the [[../FilesystemUsage|filesystem area]] dedicated to 53 calendar information storage. 54 55 === Initialising Resources === 56 57 Resources belong to a class of user whose preferences should be configured in 58 advance because their policies may differ on a case-by-case basis. For example, 59 some resources may benefit from employing the `permitted_times` setting so that 60 a granularity on event times may be imposed, meaning that such resources would 61 be "handed over" at regular intervals. 62 63 The `freebusy_offers` setting, together with the `scheduling_function` setting, 64 would allow different kinds of resources to "keep open" tentatively-suggested 65 periods for different lengths of time, allowing frequently-requested resources 66 to respond to scheduling requests in a timely fashion, whilst also allowing 67 other resources to give more time to event organisers to respond to their 68 counter-proposals. 69 70 === Adjusting Preferences === 71 72 Once initialised, the user preferences can be adjusted by adding files to the 73 `preferences` directory created by the above command. For example, if a user has 74 elected to not participate in the calendar system, a file called `participating` 75 can be added as follows: 76 77 {{{ 78 echo 'no' > '/var/lib/imip-agent/preferences/mailto:vincent.vole@example.com/participating' 79 }}} 80 81 Here, the default storage location has been given in the filename. 82 83 Normally, users should visit the [[../CalendarManager|management interface]] to 84 change their preferences, but modifications done by administrators are more 85 efficiently performed by directly interacting with the filesystem. For example, 86 an administrator might initialise the common names of users by scripting changes 87 to the `CN` file for each user, obtaining such names from some kind of database. 88 89 The permissions on any created files must be consistent with those defined when 90 configuring the [[../SystemUsers|system users]] for imip-agent. To reset file 91 permissions, use the appropriate tool script: 92 93 {{{ 94 tools/fix.sh 95 }}} 96 97 == Excluding Users Entirely == 98 99 Since the [[../AgentPrograms|agent programs]] are installed as part of the mail 100 handling workflow, even the configuration of non-participation in the calendar 101 system for users will still result in those users' messages being passed along 102 the workflow by imip-agent, which may result in a decrease in general mail 103 delivery performance. 104 105 To exclude users entirely, the routing configuration of the 106 [[../MailIntegration|MTA]] needs to be changed so that such users identities are 107 not recognised as calendar system participants, thus preventing their messages 108 from being routed via imip-agent. This is as simple as either not listing the 109 identity in [[../MailIntegration/Simple|lists of addresses]] or by adjusting 110 [[../MailIntegration/LDAP|queries yielding calendar users]].