Patrick Cool
18 years ago
parent
901e9ca780
commit
abd5973f26
@ -0,0 +1,333 @@ |
|||||||
|
***************************************** |
||||||
|
Dokeos 1.8 INSTALLATION |
||||||
|
***************************************** |
||||||
|
Thank you for downloading Dokeos! This text will guide you through the |
||||||
|
basics of installing Dokeos 1.8. Please read this fully |
||||||
|
before proceeding with the installation. |
||||||
|
|
||||||
|
This is only a short installation guide. We are writing a manual with more |
||||||
|
info on installation, but this was not ready at the time of writing. When |
||||||
|
ready, this manual will be accessible through the Dokeos documentation |
||||||
|
page: |
||||||
|
http://www.dokeos.com/documentation.php |
||||||
|
You can also read the work in progress manual on our web writing area: |
||||||
|
http://www.dokeos.com/wiki/index.php/Manual |
||||||
|
|
||||||
|
Contents |
||||||
|
|
||||||
|
1. Requirements |
||||||
|
2. Installing a new version of Dokeos |
||||||
|
3. Upgrading from a previous version of Dokeos |
||||||
|
4. Troubleshooting |
||||||
|
5. Administration section |
||||||
|
6. Ldap (optional) |
||||||
|
|
||||||
|
================= |
||||||
|
1. Requirements |
||||||
|
================= |
||||||
|
|
||||||
|
Dokeos is a web application which requires some other software to function: |
||||||
|
a web server, PHP, and the MySQL database server. These software packages |
||||||
|
have to be installed on the computer where you will install Dokeos. |
||||||
|
|
||||||
|
You can install all these software packages separately, which often gives |
||||||
|
the best results. However, beginning users who want to test Dokeos can use |
||||||
|
a combination package that installs all these software packages in one |
||||||
|
simple install. If you want to use a combination package, we recommend |
||||||
|
Wamp (you also need the PHP4 add-on for WAMP) or XAMP. |
||||||
|
WAMP5 website: http://www.wampserver.com/en/index.php |
||||||
|
WAMP PHP4 add-on: http://www.wampserver.com/en/add-ons.php |
||||||
|
XAMP: http://www.apachefriends.org/en/index.html |
||||||
|
|
||||||
|
1.1. A web server |
||||||
|
|
||||||
|
The Apache web server is recommended, and Dokeos is configured to use some |
||||||
|
Apache security enhancements if possible. However, other web servers will |
||||||
|
work too. For best security results, you need to have the Apache module |
||||||
|
mod_rewrite activated. The mod_rewrite rules for Dokeos are read from a |
||||||
|
.htaccess file in the courses folder, so Apache needs to allow this |
||||||
|
(AllowOverride FileInfo in httpd.conf). |
||||||
|
|
||||||
|
Download Apache web server: |
||||||
|
http://httpd.apache.org/download.cgi |
||||||
|
|
||||||
|
1.2. PHP |
||||||
|
|
||||||
|
You need PHP version 4.3.2 or later (4.x versions), configured with the |
||||||
|
following modules : mysql, zlib, preg, xml. PHP versions 5 or later are not |
||||||
|
supported by Dokes yet. You need the ldap module too if you want to use ldap |
||||||
|
with Dokeos. Most of the PHP4 compiled distributions are provided with these |
||||||
|
modules. Their presence is also checked by the Dokeos install script. |
||||||
|
|
||||||
|
Download PHP: |
||||||
|
http://www.php.net/downloads.php |
||||||
|
|
||||||
|
Some users could meet problems if their PHP setting doesn't fit these ones: |
||||||
|
|
||||||
|
short_open_tag = On |
||||||
|
safe_mode = Off |
||||||
|
magic_quotes_gpc = On |
||||||
|
magic_quotes_runtime = Off |
||||||
|
|
||||||
|
Past Dokeos versions required register_globals to be set to On. This is no |
||||||
|
longer necessary, this can be set to Off and Dokeos will work fine. |
||||||
|
|
||||||
|
BSD users: |
||||||
|
these php libraries have to be included during php installation: |
||||||
|
- php-mysql The mysql shared extension for php |
||||||
|
- php-pcre The pcre shared extension for php |
||||||
|
- php-session The session shared extension for php |
||||||
|
- php-zlib The zlib shared extension for php |
||||||
|
- (optional) php-ldap if you want to be able to use LDAP authentication |
||||||
|
|
||||||
|
|
||||||
|
1.3. The MySQL database server |
||||||
|
|
||||||
|
And a login/password allowing to administrate and create at least one |
||||||
|
database. By default, Dokeos will create a new database for each course |
||||||
|
created. It means your host should allow you to create and administrate |
||||||
|
several databases. If you want to use Dokeos on a 'single database host' |
||||||
|
you have to select this option during the installation. |
||||||
|
|
||||||
|
Download MySQL server: |
||||||
|
http://dev.mysql.com/downloads/ |
||||||
|
|
||||||
|
Note: |
||||||
|
It seems the backticks characters (`) inserted inside most of the Dokeos SQL |
||||||
|
queries since version 1.3 don't work with MySQL versions before 3.23.6. |
||||||
|
|
||||||
|
1.4. Permissions |
||||||
|
Furthermore, you need web Write access to web directory where Dokeos has |
||||||
|
been moved or unzipped to. On a Windows machine locally, this is not a |
||||||
|
problem. Remotely, you need to be allowed to CHMOD through FTP, telnet or |
||||||
|
any means. |
||||||
|
|
||||||
|
======================================= |
||||||
|
2. Installing a new version of Dokeos |
||||||
|
======================================= |
||||||
|
|
||||||
|
2.1. Download the Dokeos 1.8 install package (.zip for Windows users |
||||||
|
or .tar.gz for all others) from the Dokeos download page: |
||||||
|
http://www.dokeos.com/download.php |
||||||
|
|
||||||
|
2.2. Unzip or untar the downloaded install package. Most current operating |
||||||
|
systems can do this with a built-in graphical application, if this doesn't |
||||||
|
work you can open a commandline, go to the download directory and type |
||||||
|
tar -zxvf dokeos-1.8.tar.gz |
||||||
|
|
||||||
|
2.3. Move by any means (FTP, SCP, local file copy) the contents of the |
||||||
|
Dokeos install package to your website on your webserver (whether webroot |
||||||
|
or subdirectory). Your webserver can also be your local computer. Be sure |
||||||
|
to copy all the folders (archive, home, claroline, courses) as well as all |
||||||
|
the .php files. |
||||||
|
|
||||||
|
For Windows users: If you use e.g easyphp locally (http://www.easyphp.org), |
||||||
|
just drag and drop the contents of the Dokeos install package into |
||||||
|
C:\Program Files\easyphp\www\ |
||||||
|
|
||||||
|
2.4. The following files need to be readable and writeable for everyone: |
||||||
|
|
||||||
|
dokeos/main/inc/conf/claro_main.conf.php (if present) |
||||||
|
dokeos/home/*.html |
||||||
|
|
||||||
|
On Linux, Mac OS X and BSD operating systems you can use the CHMOD 666 |
||||||
|
command for this. In Windows, you may need to check the properties of |
||||||
|
the folders. |
||||||
|
|
||||||
|
NOTE: |
||||||
|
Do not modify the home_*.html files directly. Instead, choose "Configure |
||||||
|
the homepage" in the Dokeos administration section. |
||||||
|
|
||||||
|
2.5. The following directories need to be readable, writeable and executable |
||||||
|
for everyone: |
||||||
|
|
||||||
|
dokeos/main/inc/conf/ |
||||||
|
dokeos/main/garbage/ |
||||||
|
dokeos/main/upload/ |
||||||
|
dokeos/archive/ |
||||||
|
dokeos/courses/ |
||||||
|
dokeos/home/ |
||||||
|
|
||||||
|
On Linux, Mac OS X and BSD operating systems you can use the CHMOD 777 |
||||||
|
command for this. In Windows, you may need to check the properties of |
||||||
|
the folders. |
||||||
|
|
||||||
|
2.6. Open a web browser and go to |
||||||
|
http://www.yourserver.org/yoursite/dokeos/index.php |
||||||
|
|
||||||
|
For Windows users locally, with e.g easyphp or another combination package, |
||||||
|
open http://localhost/dokeos/index.php |
||||||
|
|
||||||
|
2.7. Click on the install button and follow instructions. Windows: with |
||||||
|
combination packages like easyphp, out of the box, login and password for |
||||||
|
MySQL should probably remain empty. |
||||||
|
|
||||||
|
2.8. Security after installation |
||||||
|
|
||||||
|
Protect your configuration file |
||||||
|
make sure no one can overwrite it. You can find the config file in (dokeos |
||||||
|
folder)/main/inc/conf/claro_main.conf.php. Make it read-only |
||||||
|
(windows/xwindows: right-click the file to edit the properties. |
||||||
|
linux/bsd/macosx: use the chmod 444 command). |
||||||
|
|
||||||
|
Protect your installation folder |
||||||
|
if the (dokeos folder)/main/install folder is still accessible, |
||||||
|
someone could install over your existing version (you could lose your data |
||||||
|
that way). Move the folder somewhere out of the web directories so it is |
||||||
|
not accessible, change its name, or edit its properties so no one can read |
||||||
|
or execute it. |
||||||
|
|
||||||
|
=============================================== |
||||||
|
3. Upgrading from a previous version of Dokeos |
||||||
|
=============================================== |
||||||
|
|
||||||
|
Before upgrading we heavily recommend you do a full backup of the previous Claroline or Dokeos directories and databases. If you are unsure how to achieve this please ask your hosting provider for advice. |
||||||
|
|
||||||
|
3.1. Download the Dokeos 1.8 install package (.zip for Windows users |
||||||
|
or .tar.gz for all others) from the Dokeos download page: |
||||||
|
http://www.dokeos.com/download.php |
||||||
|
|
||||||
|
3.2. Unzip or untar the downloaded install package. Most current operating systems can do this with a built-in graphical application, if this doesn't work you can open a commandline, go to the download directory and type tar -zxvf dokeos-1.6.beta.tar.gz |
||||||
|
|
||||||
|
3.3. Move the Dokeos directory to a different path from the previous version |
||||||
|
|
||||||
|
WARNING: |
||||||
|
Do not delete the previous Dokeos installation directory before installing the new one. When the update is successfully finished, you can remove the old path. |
||||||
|
|
||||||
|
TIP: |
||||||
|
If you want Dokeos 1.8 to be installed in the same directory as the previous version : |
||||||
|
|
||||||
|
move the old directory to a new location (e.g. move dokeos/ to dokeos_old/) |
||||||
|
uncompress Dokeos 1.8 to the old version directory (e.g. uncompress Dokeos 1.6 to dokeos/) |
||||||
|
go to next step |
||||||
|
|
||||||
|
3.4. The following files need to be readable and writeable for everyone: |
||||||
|
|
||||||
|
dokeos/main/inc/conf/claro_main.conf.php (if present) |
||||||
|
dokeos/home/*.html |
||||||
|
|
||||||
|
On Linux, Mac OS X and BSD operating systems you can use the CHMOD 666 command for this. In Windows, you may need to check the properties of the folders. |
||||||
|
|
||||||
|
NOTE: |
||||||
|
Do not modify the home_*.html files directly. Instead, choose "Configure the homepage" in the Dokeos administration section. |
||||||
|
|
||||||
|
3.5. The following directories need to be readable, writeable and executable for everyone: |
||||||
|
|
||||||
|
dokeos/main/inc/conf/ |
||||||
|
dokeos/main/garbage/ |
||||||
|
dokeos/main/upload/ |
||||||
|
dokeos/archive/ |
||||||
|
dokeos/courses/ |
||||||
|
dokeos/home/ |
||||||
|
|
||||||
|
On Linux, Mac OS X and BSD operating systems you can use the CHMOD 777 command for this. In Windows, you may need to check the properties of the folders. |
||||||
|
3.6. Open a web browser and go to http://www.yourserver.org/yoursite/dokeos/index.php Windows locally, with e.g easyphp or another combination package, open: http://localhost/dokeos/index.php |
||||||
|
|
||||||
|
3.7. Click on the install button, then click on "Update from Dokeos 1.5 | 1.5.4 | 1.5.5" and follow the instructions. |
||||||
|
|
||||||
|
3.8. This part is optional! |
||||||
|
Since after version 1.5.5, the following tables in the dokeos_main database can be removed when upgrading from a 1.5.5 version or lower, provided that you don't use them for a customisation of your Dokeos system: |
||||||
|
|
||||||
|
`todo` |
||||||
|
`pma_bookmark` |
||||||
|
`pma_column_comments` |
||||||
|
`pma_pdf_pages` |
||||||
|
`pma_relation` |
||||||
|
`pma_table_coords` |
||||||
|
`pma_table_info` |
||||||
|
These tables can be removed by connecting to the database as the Dokeos user and executing this query: DROP TABLE dokeos_main.my_table; where dokeos_main is the main dokeos database name and my_table is each of the preceding tables (repeat query for each) |
||||||
|
|
||||||
|
A clean-up of the useless fields has also influenced some code: The main_db.cours.cours_id has been removed, as all references to that field throughout the official Dokeos code. The course code (literal) is used instead. Please update your custom code if any. |
||||||
|
|
||||||
|
Under the same circumstances as tables removal, the following fields can be removed if not used by your code, using a query similar to: ALTER TABLE database.table drop column abc where database is the database name (dokeos_main? or code of a course) table is the table name (cours?) abc is the name of the field to drop You can thus drop the following fields: |
||||||
|
`_dokeos_main_`.`cours`.`versionDb` |
||||||
|
`_dokeos_main_`.`cours`.`versionClaro` |
||||||
|
`_dokeos_main_`.`cours`.`cahier_charges` |
||||||
|
`_dokeos_main_`.`faculte`.`bc` |
||||||
|
# the table `faculte` has been renamed to `course_category` since 1.6 |
||||||
|
`_cours_`.`announcement`.`code_cours` |
||||||
|
`_cours_`.`course_description`.`upDate` |
||||||
|
|
||||||
|
=========================== |
||||||
|
4. Troubleshooting |
||||||
|
=========================== |
||||||
|
|
||||||
|
In the future we will also provide instructions on how to do a "manual" |
||||||
|
install of Dokeos, by creating the database tables yourself. If you have |
||||||
|
any problems, go to the Dokeos website and ask a question on our support |
||||||
|
forum. Please read the previous messages first to see if there is already |
||||||
|
an answer to your question. We also maintain a list of Frequently Asked |
||||||
|
Questions (FAQ). |
||||||
|
|
||||||
|
Dokeos website: http://www.dokeos.com/ |
||||||
|
Support forum: http://www.dokeos.com/forum/ |
||||||
|
Frequently Asked Questions: http://www.dokeos.com/wiki/index.php/FAQ |
||||||
|
|
||||||
|
=========================== |
||||||
|
5. Administration section |
||||||
|
=========================== |
||||||
|
|
||||||
|
To access the Dokeos administration section, open browser, go to your Dokeos adress and log in with the admin user. Then you will see a "Platform admin section" link in the header of the web page. |
||||||
|
|
||||||
|
=========================== |
||||||
|
6. LDAP |
||||||
|
=========================== |
||||||
|
|
||||||
|
This part is optional, only organisations with an LDAP server will need to read this. |
||||||
|
An LDAP module is already provided in Dokeos, but it has to be configured to make it work. |
||||||
|
|
||||||
|
6.0. Compiling |
||||||
|
Linux servers: It's possible that you have to recompile php with ldap support. |
||||||
|
Newer distributions also allow downloading rpms for additional packages. |
||||||
|
|
||||||
|
6.1. Activating |
||||||
|
In main/inc/conf/claro_main.conf.php, around line 90, you see |
||||||
|
//for new login module |
||||||
|
//uncomment these to activate ldap |
||||||
|
//$extAuthSource['ldap']['login'] = "./main/auth/ldap/login.php"; |
||||||
|
//$extAuthSource['ldap']['newUser'] = "./main/auth/ldap/newUser.php"; |
||||||
|
|
||||||
|
remove the // from the last two lines to activate LDAP. |
||||||
|
|
||||||
|
6.2. Settings |
||||||
|
Ask the LDAP server admin for the settings: |
||||||
|
- ldap server name |
||||||
|
- ldap server port (usually 389) |
||||||
|
- ldap dc |
||||||
|
You must enter these in |
||||||
|
main/auth/ldap/ldap_var.inc.php |
||||||
|
|
||||||
|
//parameters for LDAP module |
||||||
|
$usesLDAP = TRUE; |
||||||
|
$usesCurriculum = FALSE; |
||||||
|
$ldaphost = "myldapserver.com"; // your ldap server |
||||||
|
$ldapport = 389; // your ldap server's port number |
||||||
|
$ldapDc = "dc=xx, dc=yy, dc=zz"; //domain |
||||||
|
|
||||||
|
6.3. Teacher/student status |
||||||
|
If you wish, you can give teacher/student status to dokeos users according to settings in the ldap server. |
||||||
|
This is not a standard field however, so you'll have to change some code. |
||||||
|
main/auth/ldap/ldap_var.inc.php |
||||||
|
around line 189, function putUserInfoInClaroline ($login, $infoArray) |
||||||
|
if (<your criterium>) |
||||||
|
{ |
||||||
|
$statut = STUDENT; |
||||||
|
} |
||||||
|
else |
||||||
|
{ |
||||||
|
$statut = COURSEMANAGER; |
||||||
|
} |
||||||
|
|
||||||
|
If this seems too difficult, the simplest solution is to just put |
||||||
|
$statut = STUDENT; |
||||||
|
and give course manager rights through the admin panel. |
||||||
|
|
||||||
|
6.4. Some LDAP servers do not support anonymous use of the directory services. |
||||||
|
In this case, you need code that binds with a name and password - this code has already been provided, |
||||||
|
just ask on a forum or email for this. |
||||||
|
|
||||||
|
========================================================================== |
||||||
|
Contact address: Dokeos, 44 rue des palais, B-1030 Brussels, Belgium |
||||||
|
Mail: info@dokeos.com |
||||||
|
May 2005 |
||||||
|
================================== END =================================== |
||||||
@ -0,0 +1,412 @@ |
|||||||
|
<html> |
||||||
|
<head> |
||||||
|
<title>Dokeos 1.8 installation guide</title> |
||||||
|
<link rel="stylesheet" href="./main/css/default.css" type="text/css" media="screen,projection" /> |
||||||
|
<link rel="shortcut icon" href="./favicon.ico" type="image/x-icon" /> |
||||||
|
</head> |
||||||
|
<body> |
||||||
|
|
||||||
|
<div id="header1"> |
||||||
|
<h1>Dokeos 1.8 installation guide</h1> |
||||||
|
</div> |
||||||
|
|
||||||
|
<div id="outerframe"> |
||||||
|
<div id="main"> |
||||||
|
|
||||||
|
<p> |
||||||
|
Thank you for downloading Dokeos! |
||||||
|
This text will guide you through the basics of installing Dokeos 1.8. |
||||||
|
Please read this fully before proceeding with the installation. |
||||||
|
</p> |
||||||
|
|
||||||
|
<p> |
||||||
|
The installation guide is also available in other languages, please see <a href="documentation/index.html">this overview page</a> for a list. The Dokeos website will notify when new translations are available. |
||||||
|
</p> |
||||||
|
<p> |
||||||
|
This is only a short installation guide. We are writing a manual with more info on installation, but this was not ready at the time of writing. When ready, this manual will be accessible through the <a href="http://www.dokeos.com/documentation.php">Dokeos documentation page</a>. You can read the work in progress manual on our <a href="http://www.dokeos.com/wiki/index.php/Manual">web writing area</a>. We also maintain a list of <a href="http://www.dokeos.com/wiki/index.php/FAQ">Frequently Asked Questions (FAQ)</a>. |
||||||
|
</p> |
||||||
|
|
||||||
|
<p> |
||||||
|
<b>Contents</b> |
||||||
|
<ol> |
||||||
|
<li><a href="#requirements">Requirements</a></li> |
||||||
|
<li><a href="#install_new_version">Installing a new version of Dokeos</a></li> |
||||||
|
<li><a href="#upgrade_previous_version">Upgrading from a previous version of Dokeos</a></li> |
||||||
|
<li><a href="#troubleshooting">Troubleshooting</a></li> |
||||||
|
<li><a href="#admin_section">Administration section</a></li> |
||||||
|
<li><a href="#ldap">Ldap (optional)</a></li> |
||||||
|
</ol> |
||||||
|
</p> |
||||||
|
|
||||||
|
<h2><a name="requirements">1. Requirements</a></h2> |
||||||
|
<p>Dokeos is a web application which requires some other software to function:</p> |
||||||
|
<ul> |
||||||
|
<li>A web server - we recommend <strong>Apache</strong></li> |
||||||
|
<li><strong>PHP</strong></li> |
||||||
|
<li>The <strong>MySQL</strong> database server</li> |
||||||
|
</ul> |
||||||
|
<p> |
||||||
|
These software packages have to be installed on the computer where you will install Dokeos. |
||||||
|
<br/> |
||||||
|
You can install all these software packages separately, which often gives the best results. However, beginning users who want to test Dokeos can use a <i>combination package</i> that installs all these software packages in one simple install. If you want to use a combination package, we recommend Wamp (Download at <a href="http://www.wampserver.com/en/index.php">the WAMP5 website</a>, you also need the <a href="http://www.wampserver.com/en/add-ons.php">PHP4 add-on</a>) or <a href="http://www.apachefriends.org/en/index.html">XAMP</a>. |
||||||
|
</p> |
||||||
|
|
||||||
|
<h3>1.1. A web server</h3> |
||||||
|
<p> |
||||||
|
The Apache web server is recommended, and Dokeos is configured to use some Apache security enhancements if possible. However, other web servers will work too. For best security results, you need to have the Apache module mod_rewrite activated. The mod_rewrite rules for Dokeos are read from a .htaccess file in the courses folder, so Apache needs to allow this (AllowOverride FileInfo in httpd.conf). |
||||||
|
<br/><br/> |
||||||
|
<a href="http://httpd.apache.org/download.cgi">Download Apache web server</a><br/> |
||||||
|
<a href="http://httpd.apache.org/docs-project/">Apache web server manual</a> |
||||||
|
</p> |
||||||
|
|
||||||
|
<h3>1.2. PHP</h3> |
||||||
|
<p> |
||||||
|
You need PHP version 4.3.2 or later (4.x versions), configured with the following modules : mysql, zlib, preg, xml. PHP versions 5 or later are not supported by Dokes yet. |
||||||
|
You need the ldap module too if you want to use ldap with Dokeos. |
||||||
|
Most of the PHP4 compiled distributions are provided with these modules. |
||||||
|
Anyway, their presence is checked by the Dokeos install script. |
||||||
|
<br/><br/> |
||||||
|
<a href="http://www.php.net/downloads.php">Download PHP</a><br/> |
||||||
|
<a href="http://www.php.net/docs.php">PHP manual</a> |
||||||
|
</p> |
||||||
|
|
||||||
|
<p> |
||||||
|
Some users could meet problems if their PHP setting doesn't fit |
||||||
|
these ones:</p> |
||||||
|
<ul> |
||||||
|
<li>short_open_tag = On</li> |
||||||
|
<li>safe_mode = Off</li> |
||||||
|
<li>magic_quotes_gpc = On</li> |
||||||
|
<li>magic_quotes_runtime = Off</li> |
||||||
|
</ul> |
||||||
|
<p> |
||||||
|
Past Dokeos versions required register_globals to be set to On. This is |
||||||
|
no longer necessary, this can be set to Off and Dokeos will work fine. |
||||||
|
</p> |
||||||
|
|
||||||
|
<p><strong>BSD users:</strong> these php libraries have to be included during php installation:</p> |
||||||
|
<ul> |
||||||
|
<li>php-mysql The mysql shared extension for php</li> |
||||||
|
<li>php-pcre The pcre shared extension for php</li> |
||||||
|
<li>php-session The session shared extension for php</li> |
||||||
|
<li>php-zlib The zlib shared extension for php</li> |
||||||
|
<li>php-xml</li> |
||||||
|
<li>(optional) php-ldap if you want to be able to use LDAP authentication</li> |
||||||
|
</ul> |
||||||
|
|
||||||
|
<h3>1.3. The MySQL database server</h3> |
||||||
|
<p> |
||||||
|
You will need a login and password allowing to administrate |
||||||
|
and create at least one database. By default, Dokeos will create a new |
||||||
|
database for each course created. It means your host should allow you to |
||||||
|
create and administrate several databases. You can also install DOkeos using only one database, in that case you have to select this option during the |
||||||
|
installation. |
||||||
|
<br/><br/> |
||||||
|
<a href="http://dev.mysql.com/downloads/">Download MySQL server</a><br/> |
||||||
|
<a href="http://dev.mysql.com/doc/mysql/en/index.html">MySQL server manual</a> |
||||||
|
</p> |
||||||
|
|
||||||
|
<p> |
||||||
|
<b>Note:</b><br/> |
||||||
|
It seems the backticks characters (`) inserted inside most of |
||||||
|
the Dokeos SQL queries since version 1.3 don't work with MySQL |
||||||
|
versions before 3.23.6. |
||||||
|
</p> |
||||||
|
|
||||||
|
<h3>1.4. Permissions</h3> |
||||||
|
<p> |
||||||
|
Furthermore, you need web Write access to web directory where Dokeos has been moved |
||||||
|
or unzipped to. On a Windows machine locally, this |
||||||
|
is not a problem. Remotely, you need to be allowed to CHMOD |
||||||
|
through FTP, telnet or any means. |
||||||
|
</p> |
||||||
|
|
||||||
|
<hr> |
||||||
|
<h2><a name="install_new_version">2. Installing a new version of Dokeos</a></h2> |
||||||
|
|
||||||
|
<p> |
||||||
|
2.1. Download the Dokeos 1.8 install package (.zip for Windows users or .tar.gz for all others) from the <a href="http://www.dokeos.com/download.php">Dokeos download page</a>. |
||||||
|
</p> |
||||||
|
|
||||||
|
<p> |
||||||
|
2.2. Unzip or untar the downloaded install package. |
||||||
|
Most current operating systems |
||||||
|
can do this with a built-in graphical application, if this doesn't work |
||||||
|
you can open a commandline, go to the download directory and type |
||||||
|
tar -zxvf dokeos-community-1.8.tar.gz |
||||||
|
</p> |
||||||
|
|
||||||
|
<p> |
||||||
|
2.3. Move by any means (FTP, SCP, local file copy) the contents of the |
||||||
|
Dokeos install package to your website on your webserver (whether webroot or subdirectory). Your webserver can also be your local computer. Be sure to copy all the folders (archive, home, claroline, courses) as well as all the .php files. |
||||||
|
</p> |
||||||
|
|
||||||
|
<p> |
||||||
|
For Windows users who install Dokeos locally: if you use an Apache/PHP/MySQL combination package, just drag and drop the contents of the Dokeos install package into the web directory of the combination package:</p> |
||||||
|
<ul> |
||||||
|
<li><strong>EasyPHP</strong> - C:\Program Files\easyphp\www\</li> |
||||||
|
<li><strong>WAMP</strong> - C:\Program Files\wamp\www\ |
||||||
|
<li><strong>XAMP</strong> - C:\Program Files\xamp\www\</li> |
||||||
|
</ul> |
||||||
|
|
||||||
|
<p> |
||||||
|
2.4. The following directories need to be readable, writeable and executable for everyone: |
||||||
|
</p> |
||||||
|
<ul> |
||||||
|
<li>dokeos/main/inc/conf/</li> |
||||||
|
<li>dokeos/main/garbage/</li> |
||||||
|
<li>dokeos/main/upload/</li> |
||||||
|
<li>dokeos/archive/</li> |
||||||
|
<li>dokeos/courses/</li> |
||||||
|
<li>dokeos/home/</li> |
||||||
|
</ul> |
||||||
|
<p> |
||||||
|
On Linux, Mac OS X and BSD operating systems you can use the CHMOD 777 command for this. |
||||||
|
In Windows, you may need to check the properties of the folders (by right-clicking on them). |
||||||
|
</p> |
||||||
|
|
||||||
|
<p> |
||||||
|
2.5. The following files need to be readable and writeable for everyone: |
||||||
|
</p> |
||||||
|
<ul> |
||||||
|
<li>dokeos/main/inc/conf/claro_main.conf.php (if present)</li> |
||||||
|
<li>dokeos/home/*.html</li> |
||||||
|
</ul> |
||||||
|
<p> |
||||||
|
On Linux, Mac OS X and BSD operating systems you can use the CHMOD 666 command for this. |
||||||
|
In Windows, you may need to check the properties of the files and folders (by right-clicking on them). |
||||||
|
</p> |
||||||
|
|
||||||
|
<p> |
||||||
|
<b>NOTE:</b><br/> |
||||||
|
Do not modify the home_*.html files directly. Instead, |
||||||
|
choose "Configure the homepage" in the Dokeos administration section. |
||||||
|
</p> |
||||||
|
|
||||||
|
<p> |
||||||
|
2.6. Open a web browser and go to |
||||||
|
http://www.yourserver.org/yoursite/dokeos/index.php |
||||||
|
|
||||||
|
If you install Dokeos locally (not on a server) open: |
||||||
|
http://localhost/dokeos/index.php |
||||||
|
</p> |
||||||
|
<p> |
||||||
|
2.7. Click on the install button and follow instructions. |
||||||
|
|
||||||
|
Windows: with combination packages like easyphp, out of the box, login and password |
||||||
|
for MySQL should probably remain empty. |
||||||
|
</p> |
||||||
|
<p> |
||||||
|
<strong>2.8. Configuration and security after installation</strong> |
||||||
|
</p> |
||||||
|
|
||||||
|
<ul> |
||||||
|
<li><strong>Protect your configuration file: </strong> |
||||||
|
make sure no one can overwrite it. You can find the config file in <em>(dokeos folder)</em>/main/inc/conf/claro_main.conf.php. Make it read-only (windows/xwindows: right-click the file to edit the properties. linux/bsd/macosx: use the chmod 444 command). The config file is created by Apache so you may need to be root user to change its permissions.</li> |
||||||
|
<li><strong>Protect your installation folder: </strong> |
||||||
|
if the <em>(dokeos folder)</em>/main/install folder is still accessible, someone could install over your existing version (you could lose your data that way). Move the folder somewhere out of the web directories so it is not accessible, change its name, or edit its properties so no one can read or execute it.</li> |
||||||
|
<li><strong>For better security: </strong> |
||||||
|
making the files world-writable will help you install, and solves many issues for people without much admin experience. However, it's better security to make the owner of the apache process (often called apache or www-data) also owner of all the dokeos files and folders. Ths way, these files need only be readable and writable by the Apache process owner, not by the entire world.</li> |
||||||
|
<li><strong>Configure your Dokeos installation: </strong> |
||||||
|
in the administration section of Dokeos, you can use the Dokeos Config Settings to adjust the behavior of your installation.</li> |
||||||
|
<li><strong>Configure Dokeos mail: </strong> |
||||||
|
most of Dokeos uses the mail settings from the php.ini file. However, the announcements tool uses phpMailer (another free software project) and the settings for this tool can be adjusted in <em>(dokeos folder)</em>/main/inc/conf/mail.conf.php.</li> |
||||||
|
</ul> |
||||||
|
|
||||||
|
<hr> |
||||||
|
<h2><a name="upgrade_previous_version">3. Upgrading from a previous version of Dokeos</a></h2> |
||||||
|
|
||||||
|
<p> |
||||||
|
Before upgrading we heavily recommend you do a full backup of the previous |
||||||
|
Dokeos directories and databases. If you are unsure how to achieve this |
||||||
|
please ask your hosting provider for advice.<br/></p> |
||||||
|
|
||||||
|
<p> |
||||||
|
<em>If you upgrade from Dokeos 1.8</em>, you can simply copy the new files of 2.0.1 over |
||||||
|
the files of the older version. You should not copy over the home, courses or archive folders, otherwise you might lose data. If you accidentally copy over those folders, you can simply replace them with the folders from your backup.<br/> |
||||||
|
|
||||||
|
<em>If you upgrade from a lower version of Dokeos (1.6.x)</em>, |
||||||
|
you'll have to use the built-in upgrade facility, as described below. |
||||||
|
</p> |
||||||
|
|
||||||
|
<p> |
||||||
|
3.1. Download the Dokeos 1.8 install package (.zip for Windows users or .tar.gz for all others) from the <a href="http://www.dokeos.com/download.php">Dokeos download page</a>. |
||||||
|
</p> |
||||||
|
|
||||||
|
<p> |
||||||
|
3.2. Unzip or untar the downloaded install package. |
||||||
|
Most current operating systems |
||||||
|
can do this with a built-in graphical application, if this doesn't work |
||||||
|
you can open a commandline, go to the download directory and type |
||||||
|
tar -zxvf dokeos-community-1.8.tar.gz |
||||||
|
</p> |
||||||
|
|
||||||
|
<p> |
||||||
|
3.3. Move the Dokeos directory to a different path from the previous version |
||||||
|
</p> |
||||||
|
<p> |
||||||
|
<b>WARNING:</b><br/> |
||||||
|
Do not delete the previous Dokeos installation directory before installing |
||||||
|
the new one. When the update is successfully finished, you can remove |
||||||
|
the old path. |
||||||
|
</p> |
||||||
|
<p> |
||||||
|
<b>TIP:</b><br/> |
||||||
|
If you want Dokeos 1.8 to be installed in the same directory as |
||||||
|
the previous version : |
||||||
|
|
||||||
|
<ul> |
||||||
|
<li>move the old directory to a new location (e.g. move dokeos/ to dokeos_old/)</li> |
||||||
|
<li>uncompress Dokeos 1.8 to the old version directory (e.g. uncompress Dokeos 2.0.1 to dokeos/)</li> |
||||||
|
<li>go to next step</li> |
||||||
|
</ul> |
||||||
|
</p> |
||||||
|
|
||||||
|
<p> |
||||||
|
3.4. The following files need to be readable and writeable for everyone: |
||||||
|
|
||||||
|
<ul> |
||||||
|
<li>dokeos/main/inc/conf/claro_main.conf.php (if present)</li> |
||||||
|
<li>dokeos/home/*.html</li> |
||||||
|
</ul> |
||||||
|
|
||||||
|
On Linux, Mac OS X and BSD operating systems you can use the CHMOD 666 command for this. |
||||||
|
In Windows, you may need to check the properties of the folders. |
||||||
|
</p> |
||||||
|
|
||||||
|
<p> |
||||||
|
<b>NOTE:</b><br/> |
||||||
|
Do not modify the home_*.html files directly. Instead, |
||||||
|
choose "Configure the homepage" in the Dokeos administration section. |
||||||
|
</p> |
||||||
|
|
||||||
|
<p> |
||||||
|
3.5. The following directories need to be readable, writeable and executable for everyone: |
||||||
|
|
||||||
|
<ul> |
||||||
|
<li>dokeos/main/inc/conf/</li> |
||||||
|
<li>dokeos/main/garbage/</li> |
||||||
|
<li>dokeos/main/upload/</li> |
||||||
|
<li>dokeos/archive/</li> |
||||||
|
<li>dokeos/courses/</li> |
||||||
|
<li>dokeos/home/</li> |
||||||
|
</ul> |
||||||
|
|
||||||
|
On Linux, Mac OS X and BSD operating systems you can use the CHMOD 777 command for this. |
||||||
|
In Windows, you may need to check the properties of the folders. |
||||||
|
</p> |
||||||
|
|
||||||
|
<p> |
||||||
|
3.6. Open a web browser and go to |
||||||
|
http://www.yourserver.org/yoursite/dokeos/index.php |
||||||
|
|
||||||
|
Windows locally, with e.g easyphp or another combination package, open: |
||||||
|
http://localhost/dokeos/index.php |
||||||
|
</p> |
||||||
|
|
||||||
|
<p> |
||||||
|
3.7. Click on the install button, then click on "Update from Dokeos 1.6, 1.6.1, 1.6.2, 1.6.3" and follow the instructions. |
||||||
|
</p> |
||||||
|
|
||||||
|
<h2><a name="troubleshooting">4. Troubleshooting</a></h2> |
||||||
|
<p> |
||||||
|
In the future we will also provide instructions on how to do a "manual" install |
||||||
|
of Dokeos, by creating the database tables yourself. |
||||||
|
|
||||||
|
If you have any problems, go to the <a href="http://www.dokeos.com">Dokeos website</a> and ask a question on our |
||||||
|
<a href="http://www.dokeos.com/forum/">support forum</a>. Please read the previous messages first to see if there is |
||||||
|
already an answer to your question. We also maintain a list of |
||||||
|
<a href="http://www.dokeos.com/wiki/index.php/FAQ">Frequently Asked Questions</a>. |
||||||
|
</p> |
||||||
|
|
||||||
|
<h2><a name="admin_section">5. Administration section</a></h2> |
||||||
|
<p> |
||||||
|
To access the Dokeos administration section, open browser, |
||||||
|
go to your Dokeos adress and log in with the admin user. |
||||||
|
Then you will see a "Platform admin section" link in the header of the web page. |
||||||
|
</p> |
||||||
|
|
||||||
|
<h2><a name="ldap">6. LDAP</a></h2> |
||||||
|
<p> |
||||||
|
<i>This part is optional, only organisations with an LDAP server will need to read this.</i><br/> |
||||||
|
An LDAP module is already provided in Dokeos, but it has to be configured to make it work. |
||||||
|
</p> |
||||||
|
|
||||||
|
<p> |
||||||
|
<b>Compiling</b><br/> |
||||||
|
Linux servers: It's possible that you have to recompile php with ldap support. |
||||||
|
Newer distributions also allow downloading rpms for additional packages. |
||||||
|
</p> |
||||||
|
|
||||||
|
<p> |
||||||
|
<b>Activating LDAP in Dokeos</b><br/> |
||||||
|
In (dokeos folder)/main/inc/conf/claro_main.conf.php, around line 90, you see<br/> |
||||||
|
//for new login module<br/> |
||||||
|
//uncomment these to activate ldap<br/> |
||||||
|
//$extAuthSource['ldap']['login'] = "./main/auth/ldap/login.php";<br/> |
||||||
|
//$extAuthSource['ldap']['newUser'] = "./main/auth/ldap/newUser.php";<br/> |
||||||
|
<br/> |
||||||
|
remove the // from the last two lines to activate LDAP.<br/> |
||||||
|
</p> |
||||||
|
|
||||||
|
<p> |
||||||
|
<b>Settings</b><br/> |
||||||
|
Ask the LDAP server admin for the settings: |
||||||
|
<ul> |
||||||
|
<li>ldap server name</li> |
||||||
|
<li>ldap server port (usually 389)</li> |
||||||
|
<li>ldap dc</li> |
||||||
|
</ul> |
||||||
|
You must enter these in |
||||||
|
(dokeos folder)/main/auth/ldap/ldap_var.inc.php |
||||||
|
<br/> |
||||||
|
//parameters for LDAP module<br/> |
||||||
|
$usesLDAP = TRUE;<br/> |
||||||
|
$usesCurriculum = FALSE;<br/> |
||||||
|
$ldaphost = "myldapserver.com"; // your ldap server<br/> |
||||||
|
$ldapport = 389; // your ldap server's port number<br/> |
||||||
|
$ldapDc = "dc=xx, dc=yy, dc=zz"; //domain<br/> |
||||||
|
</p> |
||||||
|
|
||||||
|
<p> |
||||||
|
<b>Teacher/student status</b><br/> |
||||||
|
If you wish, you can give teacher/student status to dokeos users according to settings in the ldap server. |
||||||
|
This is not a standard field however, so you'll have to change some code. |
||||||
|
main/auth/ldap/ldap_var.inc.php |
||||||
|
around line 189, function putUserInfoInClaroline ($login, $infoArray) |
||||||
|
</p> |
||||||
|
|
||||||
|
<p> |
||||||
|
if (<i>your criterium</i>)<br/> |
||||||
|
{<br/> |
||||||
|
$statut = STUDENT;<br/> |
||||||
|
}<br/> |
||||||
|
else<br/> |
||||||
|
{<br/> |
||||||
|
$statut = COURSEMANAGER;<br/> |
||||||
|
}<br/> |
||||||
|
</p> |
||||||
|
|
||||||
|
<p> |
||||||
|
If this seems too difficult, the simplest solution is to just put |
||||||
|
$statut = STUDENT; and give course manager rights through the administration section. |
||||||
|
</p> |
||||||
|
|
||||||
|
<p> |
||||||
|
<b>Protected LDAP servers</b><br/> |
||||||
|
Some LDAP servers do not support anonymous use of the directory services |
||||||
|
In this case, you need code that binds with a name and password - this code has already been provided, |
||||||
|
just ask on a forum or email for this. |
||||||
|
</p> |
||||||
|
|
||||||
|
<p> |
||||||
|
<hr> |
||||||
|
Contact address: Dokeos, 44 rue des palais, B-1030 Brussels, Belgium<br/> |
||||||
|
Mail: info@dokeos.com |
||||||
|
<hr> |
||||||
|
</p> |
||||||
|
|
||||||
|
</div> |
||||||
|
</div> |
||||||
|
|
||||||
|
</body></html> |
||||||
@ -0,0 +1,340 @@ |
|||||||
|
GNU GENERAL PUBLIC LICENSE |
||||||
|
Version 2, June 1991 |
||||||
|
|
||||||
|
Copyright (C) 1989, 1991 Free Software Foundation, Inc. |
||||||
|
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
||||||
|
Everyone is permitted to copy and distribute verbatim copies |
||||||
|
of this license document, but changing it is not allowed. |
||||||
|
|
||||||
|
Preamble |
||||||
|
|
||||||
|
The licenses for most software are designed to take away your |
||||||
|
freedom to share and change it. By contrast, the GNU General Public |
||||||
|
License is intended to guarantee your freedom to share and change free |
||||||
|
software--to make sure the software is free for all its users. This |
||||||
|
General Public License applies to most of the Free Software |
||||||
|
Foundation's software and to any other program whose authors commit to |
||||||
|
using it. (Some other Free Software Foundation software is covered by |
||||||
|
the GNU Library General Public License instead.) You can apply it to |
||||||
|
your programs, too. |
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not |
||||||
|
price. Our General Public Licenses are designed to make sure that you |
||||||
|
have the freedom to distribute copies of free software (and charge for |
||||||
|
this service if you wish), that you receive source code or can get it |
||||||
|
if you want it, that you can change the software or use pieces of it |
||||||
|
in new free programs; and that you know you can do these things. |
||||||
|
|
||||||
|
To protect your rights, we need to make restrictions that forbid |
||||||
|
anyone to deny you these rights or to ask you to surrender the rights. |
||||||
|
These restrictions translate to certain responsibilities for you if you |
||||||
|
distribute copies of the software, or if you modify it. |
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether |
||||||
|
gratis or for a fee, you must give the recipients all the rights that |
||||||
|
you have. You must make sure that they, too, receive or can get the |
||||||
|
source code. And you must show them these terms so they know their |
||||||
|
rights. |
||||||
|
|
||||||
|
We protect your rights with two steps: (1) copyright the software, and |
||||||
|
(2) offer you this license which gives you legal permission to copy, |
||||||
|
distribute and/or modify the software. |
||||||
|
|
||||||
|
Also, for each author's protection and ours, we want to make certain |
||||||
|
that everyone understands that there is no warranty for this free |
||||||
|
software. If the software is modified by someone else and passed on, we |
||||||
|
want its recipients to know that what they have is not the original, so |
||||||
|
that any problems introduced by others will not reflect on the original |
||||||
|
authors' reputations. |
||||||
|
|
||||||
|
Finally, any free program is threatened constantly by software |
||||||
|
patents. We wish to avoid the danger that redistributors of a free |
||||||
|
program will individually obtain patent licenses, in effect making the |
||||||
|
program proprietary. To prevent this, we have made it clear that any |
||||||
|
patent must be licensed for everyone's free use or not licensed at all. |
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and |
||||||
|
modification follow. |
||||||
|
|
||||||
|
GNU GENERAL PUBLIC LICENSE |
||||||
|
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION |
||||||
|
|
||||||
|
0. This License applies to any program or other work which contains |
||||||
|
a notice placed by the copyright holder saying it may be distributed |
||||||
|
under the terms of this General Public License. The "Program", below, |
||||||
|
refers to any such program or work, and a "work based on the Program" |
||||||
|
means either the Program or any derivative work under copyright law: |
||||||
|
that is to say, a work containing the Program or a portion of it, |
||||||
|
either verbatim or with modifications and/or translated into another |
||||||
|
language. (Hereinafter, translation is included without limitation in |
||||||
|
the term "modification".) Each licensee is addressed as "you". |
||||||
|
|
||||||
|
Activities other than copying, distribution and modification are not |
||||||
|
covered by this License; they are outside its scope. The act of |
||||||
|
running the Program is not restricted, and the output from the Program |
||||||
|
is covered only if its contents constitute a work based on the |
||||||
|
Program (independent of having been made by running the Program). |
||||||
|
Whether that is true depends on what the Program does. |
||||||
|
|
||||||
|
1. You may copy and distribute verbatim copies of the Program's |
||||||
|
source code as you receive it, in any medium, provided that you |
||||||
|
conspicuously and appropriately publish on each copy an appropriate |
||||||
|
copyright notice and disclaimer of warranty; keep intact all the |
||||||
|
notices that refer to this License and to the absence of any warranty; |
||||||
|
and give any other recipients of the Program a copy of this License |
||||||
|
along with the Program. |
||||||
|
|
||||||
|
You may charge a fee for the physical act of transferring a copy, and |
||||||
|
you may at your option offer warranty protection in exchange for a fee. |
||||||
|
|
||||||
|
2. You may modify your copy or copies of the Program or any portion |
||||||
|
of it, thus forming a work based on the Program, and copy and |
||||||
|
distribute such modifications or work under the terms of Section 1 |
||||||
|
above, provided that you also meet all of these conditions: |
||||||
|
|
||||||
|
a) You must cause the modified files to carry prominent notices |
||||||
|
stating that you changed the files and the date of any change. |
||||||
|
|
||||||
|
b) You must cause any work that you distribute or publish, that in |
||||||
|
whole or in part contains or is derived from the Program or any |
||||||
|
part thereof, to be licensed as a whole at no charge to all third |
||||||
|
parties under the terms of this License. |
||||||
|
|
||||||
|
c) If the modified program normally reads commands interactively |
||||||
|
when run, you must cause it, when started running for such |
||||||
|
interactive use in the most ordinary way, to print or display an |
||||||
|
announcement including an appropriate copyright notice and a |
||||||
|
notice that there is no warranty (or else, saying that you provide |
||||||
|
a warranty) and that users may redistribute the program under |
||||||
|
these conditions, and telling the user how to view a copy of this |
||||||
|
License. (Exception: if the Program itself is interactive but |
||||||
|
does not normally print such an announcement, your work based on |
||||||
|
the Program is not required to print an announcement.) |
||||||
|
|
||||||
|
These requirements apply to the modified work as a whole. If |
||||||
|
identifiable sections of that work are not derived from the Program, |
||||||
|
and can be reasonably considered independent and separate works in |
||||||
|
themselves, then this License, and its terms, do not apply to those |
||||||
|
sections when you distribute them as separate works. But when you |
||||||
|
distribute the same sections as part of a whole which is a work based |
||||||
|
on the Program, the distribution of the whole must be on the terms of |
||||||
|
this License, whose permissions for other licensees extend to the |
||||||
|
entire whole, and thus to each and every part regardless of who wrote it. |
||||||
|
|
||||||
|
Thus, it is not the intent of this section to claim rights or contest |
||||||
|
your rights to work written entirely by you; rather, the intent is to |
||||||
|
exercise the right to control the distribution of derivative or |
||||||
|
collective works based on the Program. |
||||||
|
|
||||||
|
In addition, mere aggregation of another work not based on the Program |
||||||
|
with the Program (or with a work based on the Program) on a volume of |
||||||
|
a storage or distribution medium does not bring the other work under |
||||||
|
the scope of this License. |
||||||
|
|
||||||
|
3. You may copy and distribute the Program (or a work based on it, |
||||||
|
under Section 2) in object code or executable form under the terms of |
||||||
|
Sections 1 and 2 above provided that you also do one of the following: |
||||||
|
|
||||||
|
a) Accompany it with the complete corresponding machine-readable |
||||||
|
source code, which must be distributed under the terms of Sections |
||||||
|
1 and 2 above on a medium customarily used for software interchange; or, |
||||||
|
|
||||||
|
b) Accompany it with a written offer, valid for at least three |
||||||
|
years, to give any third party, for a charge no more than your |
||||||
|
cost of physically performing source distribution, a complete |
||||||
|
machine-readable copy of the corresponding source code, to be |
||||||
|
distributed under the terms of Sections 1 and 2 above on a medium |
||||||
|
customarily used for software interchange; or, |
||||||
|
|
||||||
|
c) Accompany it with the information you received as to the offer |
||||||
|
to distribute corresponding source code. (This alternative is |
||||||
|
allowed only for noncommercial distribution and only if you |
||||||
|
received the program in object code or executable form with such |
||||||
|
an offer, in accord with Subsection b above.) |
||||||
|
|
||||||
|
The source code for a work means the preferred form of the work for |
||||||
|
making modifications to it. For an executable work, complete source |
||||||
|
code means all the source code for all modules it contains, plus any |
||||||
|
associated interface definition files, plus the scripts used to |
||||||
|
control compilation and installation of the executable. However, as a |
||||||
|
special exception, the source code distributed need not include |
||||||
|
anything that is normally distributed (in either source or binary |
||||||
|
form) with the major components (compiler, kernel, and so on) of the |
||||||
|
operating system on which the executable runs, unless that component |
||||||
|
itself accompanies the executable. |
||||||
|
|
||||||
|
If distribution of executable or object code is made by offering |
||||||
|
access to copy from a designated place, then offering equivalent |
||||||
|
access to copy the source code from the same place counts as |
||||||
|
distribution of the source code, even though third parties are not |
||||||
|
compelled to copy the source along with the object code. |
||||||
|
|
||||||
|
4. You may not copy, modify, sublicense, or distribute the Program |
||||||
|
except as expressly provided under this License. Any attempt |
||||||
|
otherwise to copy, modify, sublicense or distribute the Program is |
||||||
|
void, and will automatically terminate your rights under this License. |
||||||
|
However, parties who have received copies, or rights, from you under |
||||||
|
this License will not have their licenses terminated so long as such |
||||||
|
parties remain in full compliance. |
||||||
|
|
||||||
|
5. You are not required to accept this License, since you have not |
||||||
|
signed it. However, nothing else grants you permission to modify or |
||||||
|
distribute the Program or its derivative works. These actions are |
||||||
|
prohibited by law if you do not accept this License. Therefore, by |
||||||
|
modifying or distributing the Program (or any work based on the |
||||||
|
Program), you indicate your acceptance of this License to do so, and |
||||||
|
all its terms and conditions for copying, distributing or modifying |
||||||
|
the Program or works based on it. |
||||||
|
|
||||||
|
6. Each time you redistribute the Program (or any work based on the |
||||||
|
Program), the recipient automatically receives a license from the |
||||||
|
original licensor to copy, distribute or modify the Program subject to |
||||||
|
these terms and conditions. You may not impose any further |
||||||
|
restrictions on the recipients' exercise of the rights granted herein. |
||||||
|
You are not responsible for enforcing compliance by third parties to |
||||||
|
this License. |
||||||
|
|
||||||
|
7. If, as a consequence of a court judgment or allegation of patent |
||||||
|
infringement or for any other reason (not limited to patent issues), |
||||||
|
conditions are imposed on you (whether by court order, agreement or |
||||||
|
otherwise) that contradict the conditions of this License, they do not |
||||||
|
excuse you from the conditions of this License. If you cannot |
||||||
|
distribute so as to satisfy simultaneously your obligations under this |
||||||
|
License and any other pertinent obligations, then as a consequence you |
||||||
|
may not distribute the Program at all. For example, if a patent |
||||||
|
license would not permit royalty-free redistribution of the Program by |
||||||
|
all those who receive copies directly or indirectly through you, then |
||||||
|
the only way you could satisfy both it and this License would be to |
||||||
|
refrain entirely from distribution of the Program. |
||||||
|
|
||||||
|
If any portion of this section is held invalid or unenforceable under |
||||||
|
any particular circumstance, the balance of the section is intended to |
||||||
|
apply and the section as a whole is intended to apply in other |
||||||
|
circumstances. |
||||||
|
|
||||||
|
It is not the purpose of this section to induce you to infringe any |
||||||
|
patents or other property right claims or to contest validity of any |
||||||
|
such claims; this section has the sole purpose of protecting the |
||||||
|
integrity of the free software distribution system, which is |
||||||
|
implemented by public license practices. Many people have made |
||||||
|
generous contributions to the wide range of software distributed |
||||||
|
through that system in reliance on consistent application of that |
||||||
|
system; it is up to the author/donor to decide if he or she is willing |
||||||
|
to distribute software through any other system and a licensee cannot |
||||||
|
impose that choice. |
||||||
|
|
||||||
|
This section is intended to make thoroughly clear what is believed to |
||||||
|
be a consequence of the rest of this License. |
||||||
|
|
||||||
|
8. If the distribution and/or use of the Program is restricted in |
||||||
|
certain countries either by patents or by copyrighted interfaces, the |
||||||
|
original copyright holder who places the Program under this License |
||||||
|
may add an explicit geographical distribution limitation excluding |
||||||
|
those countries, so that distribution is permitted only in or among |
||||||
|
countries not thus excluded. In such case, this License incorporates |
||||||
|
the limitation as if written in the body of this License. |
||||||
|
|
||||||
|
9. The Free Software Foundation may publish revised and/or new versions |
||||||
|
of the General Public License from time to time. Such new versions will |
||||||
|
be similar in spirit to the present version, but may differ in detail to |
||||||
|
address new problems or concerns. |
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the Program |
||||||
|
specifies a version number of this License which applies to it and "any |
||||||
|
later version", you have the option of following the terms and conditions |
||||||
|
either of that version or of any later version published by the Free |
||||||
|
Software Foundation. If the Program does not specify a version number of |
||||||
|
this License, you may choose any version ever published by the Free Software |
||||||
|
Foundation. |
||||||
|
|
||||||
|
10. If you wish to incorporate parts of the Program into other free |
||||||
|
programs whose distribution conditions are different, write to the author |
||||||
|
to ask for permission. For software which is copyrighted by the Free |
||||||
|
Software Foundation, write to the Free Software Foundation; we sometimes |
||||||
|
make exceptions for this. Our decision will be guided by the two goals |
||||||
|
of preserving the free status of all derivatives of our free software and |
||||||
|
of promoting the sharing and reuse of software generally. |
||||||
|
|
||||||
|
NO WARRANTY |
||||||
|
|
||||||
|
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY |
||||||
|
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN |
||||||
|
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES |
||||||
|
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED |
||||||
|
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF |
||||||
|
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS |
||||||
|
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE |
||||||
|
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, |
||||||
|
REPAIR OR CORRECTION. |
||||||
|
|
||||||
|
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING |
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR |
||||||
|
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, |
||||||
|
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING |
||||||
|
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED |
||||||
|
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY |
||||||
|
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER |
||||||
|
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE |
||||||
|
POSSIBILITY OF SUCH DAMAGES. |
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS |
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs |
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest |
||||||
|
possible use to the public, the best way to achieve this is to make it |
||||||
|
free software which everyone can redistribute and change under these terms. |
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest |
||||||
|
to attach them to the start of each source file to most effectively |
||||||
|
convey the exclusion of warranty; and each file should have at least |
||||||
|
the "copyright" line and a pointer to where the full notice is found. |
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.> |
||||||
|
Copyright (C) <year> <name of author> |
||||||
|
|
||||||
|
This program is free software; you can redistribute it and/or modify |
||||||
|
it under the terms of the GNU General Public License as published by |
||||||
|
the Free Software Foundation; either version 2 of the License, or |
||||||
|
(at your option) any later version. |
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful, |
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||||
|
GNU General Public License for more details. |
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License |
||||||
|
along with this program; if not, write to the Free Software |
||||||
|
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
||||||
|
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail. |
||||||
|
|
||||||
|
If the program is interactive, make it output a short notice like this |
||||||
|
when it starts in an interactive mode: |
||||||
|
|
||||||
|
Gnomovision version 69, Copyright (C) year name of author |
||||||
|
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. |
||||||
|
This is free software, and you are welcome to redistribute it |
||||||
|
under certain conditions; type `show c' for details. |
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate |
||||||
|
parts of the General Public License. Of course, the commands you use may |
||||||
|
be called something other than `show w' and `show c'; they could even be |
||||||
|
mouse-clicks or menu items--whatever suits your program. |
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or your |
||||||
|
school, if any, to sign a "copyright disclaimer" for the program, if |
||||||
|
necessary. Here is a sample; alter the names: |
||||||
|
|
||||||
|
Yoyodyne, Inc., hereby disclaims all copyright interest in the program |
||||||
|
`Gnomovision' (which makes passes at compilers) written by James Hacker. |
||||||
|
|
||||||
|
<signature of Ty Coon>, 1 April 1989 |
||||||
|
Ty Coon, President of Vice |
||||||
|
|
||||||
|
This General Public License does not permit incorporating your program into |
||||||
|
proprietary programs. If your program is a subroutine library, you may |
||||||
|
consider it more useful to permit linking proprietary applications with the |
||||||
|
library. If this is what you want to do, use the GNU Library General |
||||||
|
Public License instead of this License. |
||||||
Loading…
Reference in new issue