Added a new authentication module to connect to a First Class server!
[moodle.git] / auth / fc / Readme.txt
1 Moodle - FirstClass authentication module\r
2 -----------------------------------------\r
3 This module uses the FirstClass Flexible Provisining Protocol (FPP) to communicate between the FirstClass server\r
4 and the Moodle host. \r
5 \r
6 Installation\r
7 ------------\r
8 \r
9 1. Enable FPP on the FirstClass server\r
10 FPP is not doumented in the FirstClass documentation and is not enable by default.\r
11 To enable the protocol you need to edit the file \FCPO\Server\Netinfo. Open the file and insert the\r
12 following lines.  \r
13 \r
14 // TCP port for Flexible Provisioning Protocol (FPP).\r
15 TCPFPPPORT = 3333\r
16 \r
17 \r
18 2. Create an account on the FirstClass server with privilege "Subadministrator".\r
19 Using the FPP protocoll this module logs in to the FirstClass server and issuess batch admin commands.\r
20 Batch admin command can only be issued in the context of a user with subadministrative privileges.\r
21 \r
22 Default account name is "fcMoodle".\r
23 \r
24 \r
25 3. Check that the FPP protocoll is working by running a Telnet session. If everyting is working you\r
26 should get a "+0" answer from the server. \r
27 \r
28 > telnet yourhost.domain.com 3333\r
29 +0\r
30 \r
31 Check that the "fcMoodle" is working by entering the following sequens of commands:\r
32 \r
33 > telnet yourhost.domain.com 3333\r
34 +0\r
35 fcMoodle\r
36 +0\r
37 \r
38 the_password_you_gave_fcmoodle\r
39 +0\r
40 \r
41 Get user some_user_id 1201\r
42 \r
43 1201 0 some_user_id\r
44 +0\r
45 \r
46 \r
47 \r
48 4. On the Moodle host go to the directory where you have installed Moodle.\r
49 Open the folder "auth", where all other authentication modules are installed,\r
50  and create a new directory with the name "fc". \r
51 \r
52 Copy the files "config.html", "fcFPP.php" and "lib.php" to the "auth" directory.\r
53 \r
54 Now you need to add som strings to the language file. This distribution contains\r
55 string for the English (en) and Swedish (sv) translation.\r
56 \r
57 Open the file "auth.php" in the folder "lang/sv" and paste the text from the file\r
58 "auth.php - sv.txt" at the end of the file above the line "?>"\r
59 \r
60 Open the file "auth.php" in the folder "lang/en" and paste the text from the file\r
61 "auth.php - en.txt" at the end of the file above the line "?>"\r
62 \r
63 \r
64 \r
65 \r
66 \r
67 \r
68 \r
69 \r
70 \r
71 \r