1 | # $Id: latmos-accounts.ini.5.pod 3186 2010-09-01 08:10:38Z nanardon $ |
---|
2 | |
---|
3 | =head1 NAME |
---|
4 | |
---|
5 | latmos-accounts.ini - Main configuration file for latmos-account. |
---|
6 | |
---|
7 | =head1 DEFAULT LOCATION |
---|
8 | |
---|
9 | F</etc/latmos-accounts/latmos-accounts.ini> |
---|
10 | |
---|
11 | =head1 DESCRIPTION |
---|
12 | |
---|
13 | This config is an C<ini> like file split into section. Each section describe a |
---|
14 | base except sections describe bellow. |
---|
15 | |
---|
16 | =head1 [_default_] SECTION |
---|
17 | |
---|
18 | This section contains global configuration variables |
---|
19 | |
---|
20 | =head2 VARIABLES |
---|
21 | |
---|
22 | =head3 base |
---|
23 | |
---|
24 | The top level base to use by default to modify informations. The base must |
---|
25 | exists as a section in the configuration |
---|
26 | |
---|
27 | =head3 sync |
---|
28 | |
---|
29 | The default synchronisation to run. The synchronisation must exists as a section |
---|
30 | in configuration. |
---|
31 | |
---|
32 | =head3 state_dir |
---|
33 | |
---|
34 | The directory where data files will be stored |
---|
35 | |
---|
36 | =head3 smtp |
---|
37 | |
---|
38 | The SMTP server to use to send mails |
---|
39 | |
---|
40 | =head3 mailFrom |
---|
41 | |
---|
42 | The identity to use in FROM field when sending mail |
---|
43 | |
---|
44 | =head3 expire_summary_to |
---|
45 | |
---|
46 | When set, this email address will receive a summary about account expiring soon |
---|
47 | |
---|
48 | =head3 mailSubject |
---|
49 | |
---|
50 | This parameter is dedicate to set the company or institute name. It is used to |
---|
51 | build the subject of mail send by application. |
---|
52 | |
---|
53 | =head3 crypt_method |
---|
54 | |
---|
55 | Specify the C<crypt()> algorythm to use to encrypt password when the work is |
---|
56 | done on application side. Can be DES, MD5, SHA-256 or SHA-512, default to MD5. |
---|
57 | |
---|
58 | Can be specified per base. |
---|
59 | |
---|
60 | =head3 cracklib_dictionnary |
---|
61 | |
---|
62 | The path to a specific dictionnary formated for cracklib library |
---|
63 | |
---|
64 | =head2 [_defattr_] SECTION |
---|
65 | |
---|
66 | Contains value assigned at object creation if the value is not specified. |
---|
67 | Each variable is in form C<object.attributes>. |
---|
68 | |
---|
69 | Some value can be specify for more complex auto completion: |
---|
70 | |
---|
71 | =head3 user.homebase |
---|
72 | |
---|
73 | This value is used a base directory for UNIX user home. The login is append to |
---|
74 | end of the value (preceded by a C</>). |
---|
75 | |
---|
76 | =head3 user.maildomain |
---|
77 | |
---|
78 | If exists set the mail attribute in form C<sn.givenName@maildomain>. |
---|
79 | |
---|
80 | =head2 [_network_] |
---|
81 | |
---|
82 | This section is used by buildnet tools, to generate network config file (DNS |
---|
83 | zone and dhcp). |
---|
84 | |
---|
85 | =head3 template_dir |
---|
86 | |
---|
87 | The directory containing template files |
---|
88 | |
---|
89 | =head3 output_dir |
---|
90 | |
---|
91 | The directory containing results files |
---|
92 | |
---|
93 | =head3 pre |
---|
94 | |
---|
95 | A command to execute before processing all zones |
---|
96 | |
---|
97 | =head3 post |
---|
98 | |
---|
99 | A command to run after procession all zones |
---|
100 | |
---|
101 | =head2 post_zone |
---|
102 | |
---|
103 | A command which will be run after each zone build |
---|
104 | |
---|
105 | =head2 maillog |
---|
106 | |
---|
107 | If set, must contains an email address where error will be sent in batch mode. |
---|
108 | |
---|
109 | =head2 checkzone |
---|
110 | |
---|
111 | If set generated DNS zones will be first written in a temporary files and |
---|
112 | checked by C<checkzone> utility. |
---|
113 | |
---|
114 | If the test fail the zone is not generated and temporary file not removed for |
---|
115 | analysis. |
---|
116 | |
---|
117 | =head2 named-checkzone |
---|
118 | |
---|
119 | The binary location of named-checkzone, default is C</usr/sbin/named-checkzone>. |
---|
120 | |
---|
121 | =head2 BASES SECTIONS |
---|
122 | |
---|
123 | TODO |
---|
124 | |
---|
125 | =head2 SYNCHRO SECTIONS |
---|
126 | |
---|
127 | Each synchronisation definition is identified by a section, the section name is |
---|
128 | prefixed by C<sync:>. |
---|
129 | |
---|
130 | =head3 from |
---|
131 | |
---|
132 | The base to use as source |
---|
133 | |
---|
134 | =head3 to |
---|
135 | |
---|
136 | The bases to synchronize, multiples bases can be specified |
---|
137 | |
---|
138 | =head3 pre |
---|
139 | |
---|
140 | A script to run before processing, if it failed, the synchronisation is not |
---|
141 | performed |
---|
142 | |
---|
143 | =head3 post |
---|
144 | |
---|
145 | A script to run after processing, if it failed, the synchronisation is not |
---|
146 | recorded as done. |
---|
147 | |
---|
148 | =head3 unexported |
---|
149 | |
---|
150 | When set, unexported object are synchronised, usefull for base supporting this |
---|
151 | feature (SQL only at time) |
---|
152 | |
---|
153 | =head3 noDelete |
---|
154 | |
---|
155 | Setting this parameter will make the syncronisation not deleting object in |
---|
156 | destination bases. |
---|
157 | |
---|
158 | Setting the C<noDelete.BASE> where C<BASE> is the name of an synchronized base |
---|
159 | will make this synchronisation not deleting any object into this base, |
---|
160 | |
---|
161 | Setting the C<noDelete.BASE.OTYPE> will make the synchronisation not deleting |
---|
162 | object type C<OTYPE> no delete into the base named C<BASE>. |
---|
163 | |
---|
164 | Example: |
---|
165 | |
---|
166 | noDelete.MyLdap.user = yes |
---|
167 | |
---|
168 | =head3 filtering object propagation |
---|
169 | |
---|
170 | It is possible to filter the objects you want to propagate into peer base. |
---|
171 | |
---|
172 | The filter to apply must be set into the parameter named |
---|
173 | C<filter.BASENAME.OTYPE>, where C<BASENAME> is the name of the destination |
---|
174 | base and C<OTYPE> the object type to filter. |
---|
175 | |
---|
176 | For example to push into C<ldap> base only user being into group C<unix>: |
---|
177 | |
---|
178 | filter.ldap.user = memberOf=unix |
---|
179 | |
---|
180 | |
---|
181 | =head3 Deleting filtered object |
---|
182 | |
---|
183 | By default filtered object will not be deleted to the destination base, neither |
---|
184 | touched. |
---|
185 | |
---|
186 | Setting option in form C<deletefiltered.BASENAME.OTYPE> to true will allow |
---|
187 | deletion. This option has effects only if filtering objects is enabled. |
---|
188 | |
---|
189 | =head1 SEE ALSO |
---|
190 | |
---|
191 | la-allowed-values.ini(5), |
---|
192 | la-sync-list.ini(5) |
---|
193 | |
---|
194 | =head1 AUTHOR |
---|
195 | |
---|
196 | Olivier Thauvin <olivier.thauvin@latmos.ipsl.fr> |
---|
197 | |
---|
198 | =head1 COPYRIGHT |
---|
199 | |
---|
200 | (c) LATMOS - IPSL - CNRS |
---|
201 | |
---|