installation_guide.html 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"><head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  4. <title>Dokeos 1.8.6.1 Installation Guide</title><link rel="stylesheet" href="default.css" type="text/css" media="screen,projection" />
  5. <link rel="shortcut icon" href="./favicon.ico" type="image/x-icon" />
  6. <style type="text/css">
  7. <!--
  8. page { width: 21cm; height: 29.7cm; margin: 2cm }
  9. pre { font-family: "Courier New", monospace }
  10. p { margin-bottom: 0.21cm }
  11. .code {margin: 1em 1em 1em 2em; padding: 0.5em; background-color: rgb(229, 229, 229); vertical-align: top; border: 1px solid #999999;}
  12. --></style></head>
  13. <body>
  14. <div id="header1">
  15. <h1>Dokeos 1.8.6.1 FREE : Installation Guide</h1>
  16. </div>
  17. <a href="index.html">Documentation</a> &gt; Installation Guide
  18. <div id="outerframe">
  19. <div id="main">
  20. <p></p>
  21. <p>Thank you for downloading Dokeos Babel FREE.</p>
  22. <ul>
  23. <li>Quick preview of <a href="http://www.dokeos.com/en/node/58">Dokeos features&nbsp;</a></li>
  24. <li>Test Dokeos on <a href="http://campus.dokeos.com">Free Campus</a></li>
  25. </ul>
  26. <p>This guide explains how to install Dokeos FREE. Please read this fully before proceeding with the installation.</p>Check <a href="http://www.dokeos.com/en/buy.php">Dokeos PRO</a> and <a href="http://www.dokeos.com/en/buy.php">Dokeos MEDICAL</a> for a complete learning suite with a Service Level Agreement. <br />
  27. <h2><b>Contents</b></h2>
  28. <ol>
  29. <li><a href="#1._Pre-requisites">Pre-requisites</a></li>
  30. <li><a href="#2._Installation_of_Dokeos_LMS">Installation of Dokeos LMS</a></li>
  31. <li><a href="#3._Upgrade_from_a_previous_version_of">Upgrade from a previous version of Dokeos</a></li>
  32. <li><a href="#4._Troubleshooting">Troubleshooting</a></li>
  33. <li><a href="#5._Administration_section">Administration section</a></li>
  34. <li><a href="#6._LDAP">LDAP&nbsp;</a></li>
  35. <li><a href="#7._Mathematical_formulas">Mathematical formulas with LaTeX</a></li>
  36. </ol>
  37. <br />
  38. <hr style="width: 100%; height: 2px;" />
  39. <h2><a name="1._Pre-requisites"></a>1. Pre-requisites</h2>
  40. Dokeos
  41. can be installed on Windows, Linux, Mac OS X and UNIX servers
  42. indifferently. However, we recommend the use of Linux server for
  43. optimal flexibility, remote control and scalability. <br />
  44. <br />
  45. Dokeos is mainly a LMS running <span style="font-weight: bold;">Apache</span>, <span style="font-weight: bold;">MySQL</span> and <span style="font-weight: bold;">PHP5</span> (the so called <span style="font-weight: bold;">AMP</span> trilogy). <br />
  46. <br />
  47. All these software are open source and freely available. <br />
  48. <br />
  49. To run Dokeos <span style="font-weight: bold;">LMS</span> on your server, you need to install WAMP, LAMP or MAMP:
  50. <ul>
  51. <li>To install <span style="font-weight: bold;">WAMP</span> (AMP on Windows), we recommend the <a href="http://www.apachefriends.org/en/xampp.html">XAMPP</a> .exe installer<a href="http://www.apachefriends.org/en/xampp.html"></a></li>
  52. <li>To install <span style="font-weight: bold;">LAMP</span>
  53. (AMP on Linux), use the Package manager of your favourite distribution (Synaptic, RPMFinder etc.).
  54. For instance, on a Ubuntu server,&nbsp;use Shell or Synaptic following the
  55. <a href="http://ubuntuguide.org/wiki/Ubuntu:Feisty#Apache_HTTP_Server">Ubuntuguide on Apache</a> and the following sections</li>
  56. <li>To install <span style="font-weight: bold;">MAMP</span> (AMP on Mac OS X), refer to the <a href="http://www.mamp.info/en/index.php">MAMP</a> dedicated website<a href="http://www.mamp.info/en/index.php"></a></li>
  57. </ul>
  58. <br />
  59. <h3><span style="font-weight: bold;">MySQL database server</span></h3>
  60. You will need a login and password allowing to administrate and create
  61. at least one database. By default, Dokeos will create a new database
  62. for each course created. It means your host should allow you to create
  63. and administrate several databases. You can also install Dokeos using
  64. only one database, in that case you have to select this option during
  65. the installation.<span style="font-weight: bold;"><br />
  66. </span>
  67. <hr style="width: 100%; height: 2px;" />
  68. <h2><a name="2._Installation_of_Dokeos_LMS"></a><span style="font-weight: bold;">2. Installation of Dokeos LMS</span></h2>
  69. <a href="http://www.dokeos.com/download.php"></a>
  70. <ul>
  71. <li><a href="http://www.dokeos.com/node/33">Download Dokeos LMS</a></li>
  72. <li>Unzip it</li>
  73. <li>Copy the dokeos directory in your Apache web directory. This can be
  74. <span style="font-weight: bold;">C:\xampp\htdocs\</span> on a Windows server or <span style="font-weight: bold;">/var/www/html/</span> on a Linux server</li>
  75. <li>Open your web browser (Internet Explorer, Firefox...) and type
  76. <span style="font-weight: bold;">http://localhost/dokeos/</span> if you install locally or
  77. <span style="font-weight: bold;">http://www.domain.com/dokeos/</span> if you install remotely</li>
  78. <li>Follow the web installation process. You can accept all default
  79. values. Consider changing the admin password to remember it.&nbsp;</li>
  80. </ul>
  81. <br />
  82. The following directories need to be readable, writeable and executable for everyone:
  83. <ul>
  84. <li>dokeos/main/inc/conf/</li>
  85. <li>dokeos/main/upload/users/</li>
  86. <li>dokeos/main/default_course_document/</li>
  87. <li>dokeos/archive/</li>
  88. <li>dokeos/courses/</li>
  89. <li>dokeos/home/</li>
  90. </ul>
  91. (where 'dokeos' is the directory in which you installed Dokeos)
  92. <p>On Linux, Mac OS X and BSD operating systems you can use the CHMOD
  93. 777 command for this (although we recommend you seek advice from an
  94. experienced system administrator).
  95. In Windows, you may need to check the properties of the folders (by
  96. right-clicking on them).</p>
  97. <p>
  98. 2.5. The following files need to be readable and writeable for the web browser,
  99. only during the installation process:</p>
  100. <ul>
  101. <li>dokeos/main/inc/conf/configuration.php (if present)</li>
  102. </ul>
  103. <p>On Linux, Mac OS X and BSD operating systems you can use the CHMOD
  104. 666 command for this (although we recommend you seek advice from an
  105. experienced system administrator).
  106. In Windows, you may need to check the properties of the files and
  107. folders (by right-clicking on them).</p>
  108. <p>
  109. <b>NOTES:</b><br />
  110. Do not modify the home_*.html files directly. Instead,
  111. choose "Configure the homepage" in the Dokeos administration section.</p>
  112. <p><span style="font-weight: bold;">Windows</span> : with combination packages like XAMPP, out of the box, login and password
  113. for MySQL should probably remain empty.</p>
  114. <p></p>
  115. <h3><strong> Configuration and security after installation</strong></h3>
  116. <ul>
  117. <li><strong>Protect your configuration file: </strong>
  118. make sure no one can overwrite it. You can find the config file in <em>(dokeos folder)</em>/main/inc/conf/configuration.php.
  119. Make it read-only (windows/xwindows: right-click the file to edit the
  120. properties. linux/bsd/macosx: use the chmod 444 command). The config
  121. file is created by Apache so you may need to be root user to change its
  122. permissions.</li>
  123. <li><strong>Protect your installation folder: </strong>
  124. if the <em>(dokeos folder)</em>/main/install
  125. folder is still accessible, someone could install over your existing
  126. version (you could lose your data that way). Move the folder somewhere
  127. out of the web directories so it is not accessible, change its name, or
  128. edit its properties so no one can read or execute it.</li>
  129. <li><strong>For better security: </strong>
  130. making the files world-writable will help you install, and solves many
  131. issues for people without much admin experience. However, it's better
  132. security to make the owner of the apache process (often called apache
  133. or www-data) also owner of all the dokeos files and folders. Ths way,
  134. these files need only be readable and writable by the Apache process
  135. owner, not by the entire world.</li>
  136. <li><strong>Configure your Dokeos installation: </strong>
  137. in the administration section of Dokeos, you can use the Dokeos Config Settings to adjust the behavior of your installation.</li>
  138. <li><strong>Configure Dokeos mail: </strong>
  139. most of Dokeos uses the mail settings from the php.ini file. However,
  140. the announcements tool uses phpMailer (another free software project)
  141. and the settings for this tool can be adjusted in <em>(dokeos folder)</em>/main/inc/conf/mail.conf.php.</li>
  142. </ul>
  143. <br />
  144. <h3>PHP configuration</h3>
  145. To get the best of Dokeos, you need to finetune PHP settings. Consider : <br />
  146. <ul>
  147. <li>Editing php.ini file (on windows can be located at <span style="font-weight: bold;">C:\xampp\php\php.ini</span>, on Ubuntu Linux : <span style="font-weight: bold;">/etc/php5/apache2/php.ini</span></li>
  148. <li>search the word "max" and increase values to optimise the server</li>
  149. <li>you may want to end up&nbsp;with the following values : </li>
  150. </ul>
  151. <div class="code">
  152. max_execution_time = 300&nbsp;&nbsp;&nbsp; ; Maximum execution time of each script, in seconds<br />
  153. max_input_time = 600 ; Maximum amount of time each script may spend parsing request data<br />
  154. memory_limit = 256M&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ; Maximum amount of memory a script may consume (128MB)<br />
  155. post_max_size = 64M<br />
  156. upload_max_filesize = 100M</div>
  157. <p>
  158. Some users could meet problems if their PHP settings don't fit
  159. these ones:</p>
  160. <ul>
  161. <li>short_open_tag = On</li>
  162. <li>safe_mode = Off</li>
  163. <li>magic_quotes_gpc = On</li>
  164. <li>magic_quotes_runtime = Off</li>
  165. </ul>
  166. <p>
  167. Past Dokeos versions required register_globals to be set to On. This is
  168. no longer necessary, this can be set to Off and Dokeos will work fine.</p>
  169. <p><strong>BSD users:</strong> these php libraries have to be included during php installation:</p>
  170. <ul>
  171. <li>php-mysql The mysql shared extension for php</li>
  172. <li>php-pcre The pcre shared extension for php</li>
  173. <li>php-session The session shared extension for php</li>
  174. <li>php-zlib The zlib shared extension for php</li>
  175. <li>(optional) php-ldap if you want to be able to use LDAP authentication</li>
  176. </ul>
  177. <p><a href="http://dev.mysql.com/doc/mysql/en/index.html"></a><br />
  178. </p>
  179. <hr />
  180. <h2><a name="3._Upgrade_from_a_previous_version_of"></a>3. Upgrade from a previous version of Dokeos</h2>
  181. Before upgrading we <b>heavily</b> recommend you do a full backup of the previous
  182. Dokeos directories and databases. If you are unsure how to achieve this
  183. please ask your hosting provider for advice.<br />
  184. <p></p>
  185. <h3>3.1 Upgrading from Dokeos 1.8.x</h3>
  186. <em>If you upgrade from Dokeos 1.8.x</em> :&nbsp;
  187. <ul>
  188. <li> check that you haven't left any customised stylesheet or image*</li>
  189. <li> download the Dokeos 1.8.6 Svalbard install package from the <a href="http://www.dokeos.com/en/node/33">Dokeos download page</a></li>
  190. <li> unzip the new files of Dokeos 1.8.6 over the files of the older version</li>
  191. <li> point your browser on your portal URL + main/install/</li>
  192. <li> choose your language and click&nbsp;<span style="font-style: italic;">Upgrade from 1.8.x</span></li>
  193. </ul>
  194. <br />
  195. <font size="-1">* Styles and images are located in the main/css or main/img
  196. directories. You can still recover them from your backup if you have made it.
  197. Any modified style or image that uses the default style/image name will be
  198. overwritten by the next step. To avoid loosing your customisations, always
  199. ensure you copy the styles/images under a new name and use and modify the
  200. copy, not the original. The original will always be overwritten by newer
  201. versions. In Dokeos 1.8.5, we have changed the name of several CSS themes.
  202. Backwards compatibility is ensured by the fact that an upgrade only adds the
  203. new themes, but you should try and use these new themes rather than sticking
  204. to the old ones which will be deprecated shortly (not maintained).</font>
  205. <br />
  206. <p></p>
  207. <h3>3.2 Upgrading from Dokeos 1.6.x</h3>
  208. <em>If you upgrade from a lower version of Dokeos (1.6.x)</em>, the first
  209. and most important thing to do is to *move* your current directory to another
  210. place.<br />
  211. An easy way to do that is to create a subdirectory called "old_version"
  212. in your current Dokeos directory and move everything in there using a
  213. simple "move" command (i.e. under Linux: mkdir old_version; mv *
  214. old_verion/), then make the old_version/ directory writeable by the web
  215. server so that courses/ and upload/ directories can be moved from the
  216. old to the new installation.<br />
  217. <br />
  218. The complete process is as follow:
  219. <ul>
  220. <li> move the current Dokeos directory contents to a subdirectory called
  221. <em>old_version</em> and make it writeable by the web server. This
  222. is important to allow the move of the courses/ and upload/ directories
  223. to the new install</li>
  224. <li> download the Dokeos 1.8.6 install package from the
  225. <a href="http://www.dokeos.com/en/node/33">Dokeos download page</a></li>
  226. <li> unzip the new files of Dokeos 1.8.6 in the main Dokeos directory. The
  227. new directory <em>main</em> should be located directly inside your
  228. Dokeos root folder</li>
  229. <li> point your browser on your portal URL</li>
  230. <li> choose your language and click&nbsp;<span style="font-style: italic;">Upgrade from 1.6.x</span> and confirm the
  231. current directory of the old version</li>
  232. </ul>
  233. <br />
  234. <em> NOTE: </em> The upgrade from 1.6.x to 1.8.x implies a revision of
  235. the customised graphics and styles. The new version uses a complete new
  236. set of icons and styles, which means the ones from version 1.6 cannot be
  237. simply reused. The good news is the version 1.8.x allows you to create
  238. your own style in a separate css folder, that you can then reuse through
  239. all the 1.8.x versions
  240. <br />
  241. <p></p>
  242. <p>
  243. <b>WARNING:</b><br />
  244. Do not delete the previous Dokeos installation directory before installing
  245. the new one. When the update is successfully finished, you can remove
  246. the old path.</p>
  247. <p>
  248. <b>NOTE:</b><br />
  249. Do not modify the home_*.html files directly. Instead,
  250. choose "Configure the homepage" in the Dokeos administration section.</p>
  251. <p></p>
  252. <h3>3.3 In both cases</h3>
  253. The following directories need to be readable, writeable and executable for the web server:
  254. <ul>
  255. <li>dokeos/main/inc/conf/</li>
  256. <li>dokeos/main/upload/users/</li>
  257. <li>dokeos/main/default_course_document/</li>
  258. <li>dokeos/archive/</li>
  259. <li>dokeos/courses/</li>
  260. <li>dokeos/home/</li>
  261. </ul>
  262. On Linux, Mac OS X and BSD operating systems you can quick-fix this using the
  263. CHMOD 777 command, but if you are unsure, we recommend you seek advice for
  264. your own OS on <a href="http://www.dokeos.com/en/node/66">our forum</a>.
  265. In Windows, you may need to check the properties of the folders.
  266. <p></p>
  267. <h3>3.4 Quick-upgrade from 1.6.x guide for Linux</h3>
  268. The following quick-upgrade guide assumes that:
  269. <ul>
  270. <li>the Dokeos database username (for MySQL) is "dokeos_db_user" and your login is "dokeos_user"</li>
  271. <li>the Dokeos installation is currently in /var/www/dokeos/ and it has 777 permissions</li>
  272. <li>your portal's URL is http://www.portalurl.com/</li>
  273. </ul>
  274. <br />
  275. On the command-line, type:
  276. <ul>
  277. <li>cd /tmp</li>
  278. <li>mysqldump -u dokeos_db_user -p --all-databases --result-file=/home/dokeos_user/dokeos_old.sql</li>
  279. <li>cp -ra /var/www/dokeos /home/dokeos_user/backup_dokeos</li>
  280. <li>mkdir /var/www/dokeos/old_version</li>
  281. <li>mv /var/www/dokeos/* /var/www/dokeos/old_version/</li>
  282. <li>chmod -R 0777 /var/www/dokeos/old_version/</li>
  283. <li>wget http://www.dokeos.com/download/dokeos-1.8.6.tar.gz</li>
  284. <li>tar zxvf dokeos-1.8.6.tar.gz</li>
  285. <li>sudo cp -ra dokeos-1.8.6/* /var/www/dokeos/</li>
  286. <li>rm dokeos-1.8.6.tar.gz</li>
  287. <li>sudo rm -r dokeos-1.8.6/</li>
  288. </ul>
  289. <br />
  290. Then:
  291. <ul>
  292. <li>Direct your browser to http://www.portalurl.com/main/install/</li>
  293. <li>Proceed with the installation</li>
  294. <li>Review the directories permissions</li>
  295. </ul>
  296. <p></p>
  297. <p></p>
  298. <hr style="width: 100%; height: 2px;" />
  299. <h2><a name="4._Troubleshooting"></a>4. Troubleshooting</h2>
  300. <p>If you have&nbsp;problems, go to the <a href="http://www.dokeos.com">Dokeos website</a> and ask a question on the
  301. <a href="http://www.dokeos.com/en/node/66">support forum</a>. Please read the previous messages first to see if there is
  302. already an answer to your question. We also maintain a list of
  303. <a href="http://www.dokeos.com/wiki/index.php/FAQ">Frequently Asked Questions</a>.</p>
  304. <h2></h2>
  305. <hr style="width: 100%; height: 2px;" />
  306. <h2><a name="5._Administration_section"></a>5. Administration section</h2>
  307. <p>To access the Dokeos administration section, open browser,
  308. go to your Dokeos adress and log in with the admin user.
  309. Then you will see a "Platform admin section" link in the header of the
  310. web page. There you can manage users, courses, sessions, portal look
  311. and feel, homepage content, course categories etc.&nbsp;</p>
  312. <p></p>
  313. <hr style="width: 100%; height: 2px;" />
  314. <h2><a name="6._LDAP"></a>6. LDAP</h2>
  315. <p>
  316. <i>This part is optional, only organisations with an LDAP server will need to read this.</i><br />
  317. An LDAP module is already provided in Dokeos, but it has to be configured to make it work.</p>
  318. <h3><b>Compiling</b></h3>
  319. <p>
  320. Linux servers: It's possible that you have to recompile php with ldap support.
  321. Newer distributions also allow downloading rpms for additional packages.</p>
  322. <h3><b>Activating LDAP in Dokeos</b></h3>
  323. <p>
  324. In (dokeos folder)/main/inc/conf/configuration.php, around line 90, you see<br />
  325. //for new login module<br />
  326. //uncomment these to activate ldap<br />
  327. //$extAuthSource['ldap']['login'] = "./main/auth/ldap/login.php";<br />
  328. //$extAuthSource['ldap']['newUser'] = "./main/auth/ldap/newUser.php";<br />
  329. <br />
  330. remove the // from the last two lines to activate LDAP.<br />
  331. </p>
  332. <h3><b>Settings</b></h3>
  333. <p>
  334. Ask the LDAP server admin for the settings:</p>
  335. <ul>
  336. <li>ldap server name</li>
  337. <li>ldap server port (usually 389)</li>
  338. <li>ldap dc</li>
  339. </ul>
  340. Since 1.8.5, you have to change the LDAP settings inside the "Portal
  341. administration" panel, under "Dokeos configuration settings", section
  342. "LDAP".
  343. <br />
  344. As an example, you should find the following kind of values:<br />
  345. LDAP main server's address: "myldapserver.com"; // your ldap server<br />
  346. LDAP main server's port: 389; // your ldap server's port number<br />
  347. LDAP domain: "dc=xx, dc=yy, dc=zz"; //domain<br />
  348. <br />
  349. <h3><b>Teacher/student status</b></h3>
  350. <p>
  351. By default, Dokeos will check if the "employeenumber" field has a value. If it has, then Dokeos will
  352. consider this user as being a teacher.<br />
  353. If you want to change this behaviour, you can edit main/auth/ldap/authldap.php, function ldap_put_user_info_locally(),
  354. and change the <em>if (empty($info_array[$tutor_field]))</em> condition to whatever suits you.<br />
  355. You can also remove this check by removing the condition and leaving only the <em>$status = STUDENT;</em> line.</p>
  356. <h3><b>Protected LDAP servers</b></h3>
  357. <p>
  358. Some LDAP servers do not support anonymous use of the directory services.<br />
  359. In this case, you should fill in the appropriate fields in the
  360. administration panel (e.g. "manager" and "mypassword") and Dokeos will
  361. try to authenticate using these, or fall back to anonymous mode before
  362. giving up.</p>
  363. <h3>LDAP import into sessions</h3>
  364. <p>There is a new set of scripts now that allow you to insert users
  365. from LDAP directly into a Dokeos session. This, however, relies on a
  366. set of static choices in the LDAP contact attributes.<br />
  367. The fields used intensively by the Dokeos module are:<br />
  368. </p>
  369. <ul>
  370. <li>uid, which is matched to the username in Dokeos</li>
  371. <li>userPassword, which is matched to the user password, although
  372. this part will only work for non-encrypted passwords for now, but it
  373. shouldn't be necessary if using the LDAP server as authentication</li>
  374. <li>ou should end with the year of the person registration or any
  375. criteria you will use to filter users, so that they can be retrieved on
  376. that criteria</li>
  377. <li>sn is used as the lastname field in Dokeos</li>
  378. <li>givenName is used as the firstname field in Dokeos</li>
  379. <li>mail is used as the email field in Dokeos</li>
  380. </ul>
  381. <hr style="width: 100%; height: 2px;" />
  382. <h2><a name="7._Mathematical_formulas"></a>7. Mathematical formulas with LaTeX</h2>
  383. <i>This part is optional, only organisations planning to use mathematical formulas inside the online editor might want to read this.</i><br /><br />
  384. You can enable mathematical equations writing inside the Dokeos online editor (FCKEditor) by applying the following steps:
  385. <ul>
  386. <li>1. Configure your Apache installation to add a cgi-bin directory that contains a symbolic link to the mimetex.cgi in
  387. <i>dokeos/main/inc/lib/mimetex/</i> (*see below, step 4)</li>
  388. <li>2. Reload your Apache configuration</li>
  389. <li>3. Edit the online editor's configuration file <i>dokeos/main/inc/lib/fckeditor/myconfig.php</i> and
  390. <ul>
  391. <li>3.1. Enable the mimetex plugin, find the line //$config['LoadPlugin'][] = 'mimetex'; and modify it to be:
  392. <b>$config['LoadPlugin'][] = 'mimetex';</b> (remove the double slash)</li>
  393. <li>3.2. The additional settings <b>$config['MimetexExecutableInstalled']</b> , <b>$config['MimetexExecutableDetectionMethod']</b>
  394. and <b>$config['MimetexExecutableDetectionTimeout']</b> are configured for best probability
  395. of automatic detection of the installed on the server file <i>mimetex.cgi</i> or <i>mimetex.exe</i>.
  396. In rare cases these options might need to be twicked, see the acccompanying comments abou
  397. these options within the file <i>myconfig.php</i></li>
  398. <li>3.3. Once the plugin has been activated, almost in all toolbars the corresponding button appears.
  399. If you need to edit some toolbars, see the configuration files (php) within the directory <i>dokeos/main/inc/lib/fckeditor/toolbars/</i> .
  400. Here is an example:
  401. <div class="code">$config['ToolbarSets']['Normal'] = array(<br />
  402. &nbsp;&nbsp;array('FitWindow','Bold','Image','Link','PasteWord','MP3',<b>'mimetex'</b>,'Table','Subscript','Superscript','ShowBlocks')<br />
  403. );</div>
  404. The item <b>'mimetex'</b> represents the button, you may add it to or remove it from any toolbar.<br /><br />
  405. </li>
  406. </ul>
  407. <li>4. To install mimetex executable file, make these changes:</li>
  408. <p>Add the corresponding cgi-bin directory to your Apache configuration could be done, in Apache 2, like this:
  409. </p>
  410. <div class="code">
  411. ScriptAlias /cgi-bin/ /var/www/cgi-bin/<br />
  412. &lt;Directory "/var/www/cgi-bin"&gt;<br />
  413. &nbsp;&nbsp;AllowOverride None<br />
  414. &nbsp;&nbsp;Options ExecCGI -MultiViews +SymLinksIfOwnerMatch<br />
  415. &nbsp;&nbsp;Order allow,deny<br />
  416. &nbsp;&nbsp;Allow from all<br />
  417. &lt;/Directory&gt;<br />
  418. </div>
  419. <p>Adding a symbolic link can be done, under Windows, by creating a
  420. shortcut to the mimetex.exe file from the cgi-bin directory, or under
  421. Linux by issuing the following command:
  422. </p>
  423. <div class="code">
  424. <p>ln -s /var/www/dokeos/main/inc/lib/mimetex/mimetex.cgi /var/www/cgi-bin/mimetex.cgi</p>
  425. </div>
  426. <p>If you are reluctant to modify your Apache configuration, alternately you may do at step 4 the following:
  427. copy mimetex.exe (for windows) or mimetex.cgi (for linux) from <i>dokeos/main/inc/lib/mimetex/</i> directory to your <i>cgi-bin/</i></p>
  428. <li>5. Make sure that the file mimetex.cgi (or mimetex.exe) has right to be executed by the web-server process. For example, on a Ubuntu Linux system you may write a command like the following:</li>
  429. <div class="code">
  430. <p>sudo chmod a+x mimetex.cgi</p>
  431. </div>
  432. </ul>
  433. <p>As a result of this procedure, a new button becomes available in your Dokeos online editor, that gives you possibility
  434. to insert mathematical formulas into your documents.<br />
  435. <br />
  436. <br />
  437. Contact address: Dokeos, Rue Victor Hugo, 201,&nbsp;B-1030 Brussels, Belgium<br />
  438. Mail: info@dokeos.com<br />
  439. Tel. +32 (0)2 669 69 55<br />
  440. <br />
  441. </p>
  442. <hr />
  443. </div>
  444. </div>
  445. <hr />
  446. <a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10-blue" alt="Valid XHTML 1.0 Transitional" style="margin: 1em; float: right;" height="31" width="88" /></a>
  447. <a href="http://jigsaw.w3.org/css-validator/">
  448. <img src="http://jigsaw.w3.org/css-validator/images/vcss-blue" style="margin: 1em; float: right;" alt="Valid CSS" />
  449. </a>
  450. </body></html>