source: trunk/LATMOS-Accounts/man/man8/latmos-accounts.pod @ 1041

Last change on this file since 1041 was 1029, checked in by nanardon, 12 years ago

Env. LA_CONFIG define configuration directory

  • Property svn:keywords set to Id
File size: 3.3 KB
Line 
1# $Id$
2
3=head1 NAME
4
5    Link::Accounts - A multiple accounts base management and synchronisation
6    system
7
8=head1 GENERALITY
9
10=head2 HISTORY
11
12Link::Accounts is born with the need to have same set of groups and users in
13multiples accounts bases:
14
15=over 4
16
17=item OpenLDAP
18
19Standard ldap base w/o any change on basis schema
20
21=item Active Directory
22
23The domain management system for windows. Active Directory is a solution
24including LDAP, Kerberos, Smb protocol and a graphic interface to configure it.
25
26=item Unix file
27
28Standard users base under Unix system, also used for C<NIS>/C<YP> system.
29
30=back
31
32=head2 WORKFLOW
33
34Link::Accounts is made of three components:
35
36=over 4
37
38=item L</Bases>
39
40=item L</Objects>
41
42=item L</Attributes>
43
44=back
45
46=head3 Bases
47
48=head3 Objects
49
50=head3 Attributes
51
52=head1 CONFIGURATION
53
54All configuration files listed bellow must be stored in the same directory.
55
56By default this directory is F</etc/latmos-accounts>.
57
58It can be overload by setting envirronment variable C<LA_CONFIG>.
59
60=head2 Configuration files list
61
62=over 4
63
64=item latmos-accounts.ini
65
66Bases and synchronisations definitions.
67
68See L<latmos-accounts.ini>
69
70=item la-allowed-values.ini
71
72Attributes values allowed.
73
74See L<la-allowed-values.ini>
75
76=item la-sync-manager.ini
77
78The setup of L<la-sync-manager>, the daemon in charge of pushing values from
79primary base to others.
80
81See L<la-sync-manager.ini>
82
83=item la-acls.ini
84
85Access list configuration, used by Web application
86
87See L<la-acls.ini>
88
89=item la-sync-list.ini
90
91Configuration of mailing synchronisation module
92
93See L<la-sync-list.ini>
94
95=back
96
97=head1 TOOLS LIST
98
99The tools listed bellow are availlable to administrate the C<Link::Accounts>
100system.
101
102They are low level tools and are designed to be used system administrator, not
103end user (unlike the web interface).
104
105=head2 Configuration Tools
106
107=over 4
108
109=item la-config
110
111Display configuration information.
112
113L<la-config>
114
115=item la-attributes
116
117Display supported object and attributes.
118
119L<la-attributes>
120
121=item la-log-test
122
123Send message using log functions (for testing purpose)
124
125L<la-log-test>
126
127=item la-acls
128
129Check validity of ACL file (eg L<la-acls.ini>).
130
131See: L<la-acls>
132
133=item la-qacls
134
135Test ACLs permission for given user over given object.
136
137See: L<la-qacls>
138
139=back
140
141=head2 Base Content Tools
142
143=over 4
144
145=item la-cli
146
147Interactive command line interface, include online help, completion, etc...
148
149See L<la-cli>
150
151=item la-create
152
153Create an object into main base.
154
155See L<la-create>
156
157=item la-delete
158
159Delete an object from main base
160
161See L<la-delete>
162
163=item la-edit
164
165Modify object into main base.
166
167See L<la-edit>
168
169
170=item L<la-expired-reminder>
171
172=item L<la-find-expired>
173
174=item L<la-freeip>
175
176=item L<la-graph.pl>
177
178=item L<la-group>
179
180=item L<la-guser>
181
182=item la-passwd
183
184Change the password of users.
185
186L<la-passwd>
187
188=item L<la-query>
189
190=item L<la-rename>
191
192=item L<la-rename-host>
193
194=item L<la-rev>
195
196=item L<la-search>
197
198=item L<la-sync>
199
200=item L<la-sync-manager>
201
202=item L<la-sync-process>
203
204=item L<la-warn-expire>
205
206=item L<la-sql-edit-form>
207
208=item L<la-test-mail>
209
210=back
211
212=head2 SQL Base Tools
213
214=over 4
215
216=item L<la-sql-list-request>
217
218=item L<la-sql-loadatt>
219
220=item L<la-sql-regatt>
221
222=item L<la-sql-sanity>
223
224=item L<la-sql-upgrade.in>
225
226=item L<la-sql-valid-request>
227
228=item L<la-sql-crypt-passwd>
229
230=item L<la-sql-exchange-ip>
231
232=back
233
234=head1 BUGS
235
236=head1 AUTHOR
237
238Olivier Thauvin <olivier.thauvin@latmos.ipsl.fr>
Note: See TracBrowser for help on using the repository browser.