source: trunk/LATMOS-Accounts/man/man5/latmos-accounts.ini.pod @ 1013

Last change on this file since 1013 was 1013, checked in by nanardon, 12 years ago
  • move/rename pod files to improve readability
File size: 2.7 KB
Line 
1# $Id: latmos-accounts.ini.5.pod 3186 2010-09-01 08:10:38Z nanardon $
2
3=head1 NAME
4
5latmos-accounts.ini - Main configuration file for latmos-account.
6
7=head1 DEFAULT LOCATION
8
9F</etc/latmos-accounts/latmos-accounts.ini>
10
11=head1 DESCRIPTION
12
13This config is an C<ini> like file split into section. Each section describe a
14base except sections describe bellow.
15
16=head1 [_default_] SECTION
17
18This section contains global configuration variables
19
20=head2 VARIABLES
21
22=head3 base
23
24The top level base to use by default to modify informations. The base must
25exists as a section in the configuration
26
27=head3 sync
28
29The default synchronisation to run. The synchronisation must exists as a section
30in configuration.
31
32=head3 state_dir
33
34The directory where data files will be stored
35
36=head3 smtp
37
38The SMTP server to use to send mails
39
40=head3 mailFrom
41
42The identity to use in FROM field when sending mail
43
44=head3 acls
45
46The configuration file to use as ACL list
47
48=head3 allowed_values
49
50The configuration file containing attributes restriction
51
52=head3 expire_summary_to
53
54When set, this email address will receive a summary about account expiring soon
55
56=head2 [_defattr_] SECTION
57
58Contains value assigned at object creation if the value is not specified.
59Each variable is in form C<object.attributes>.
60
61=head3 user.homebase
62
63This value is used a base directory for UNIX user home. The login is append to
64end of the value (preceded by a C</>).
65
66
67=head2 [_network_]
68
69This section is used by buildnet tools, to generate network config file (DNS
70zone and dhcp).
71
72=head3 template_dir
73
74The directory containing template files
75
76=head3 output_dir
77
78The directory containing results files
79
80=head3 pre
81
82A command to execute before processing all zones
83
84=head3 post
85
86A command to run after procession all zones
87
88=head2 post_zone
89
90A command which will be run after each zone build
91
92=head2 maillog
93
94If set, must contains an email address where error will be sent in batch mode.
95
96=head2 BASES SECTIONS
97
98TODO
99
100=head2 SYNCHRO SECTIONS
101
102Each synchronisation definition is identified by a section, the section name is
103prefixed by C<sync:>.
104
105=head3 from
106
107The base to use as source
108
109=head3 to
110
111The bases to synchronize, multiples bases can be specified
112
113=head3 pre
114
115A script to run before processing, if it failed, the synchronisation is not
116performed
117
118=head3 post
119
120A script to run after processing, if it failed, the synchronisation is not
121recorded as done.
122
123=head3 unexported
124
125When set, unexported object are synchronised, usefull for base supporting this
126feature (SQL only at time)
127
128=head1 SEE ALSO
129
130la-allowed-values.ini(5),
131la-sync-list.ini(5)
132
133=head1 AUTHOR
134
135Olivier Thauvin <olivier.thauvin@latmos.ipsl.fr>
136
137=head1 COPYRIGHT
138
139(c) LATMOS - IPSL - CNRS
140
Note: See TracBrowser for help on using the repository browser.