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