chamilo
/
chamilo-lms
mirror of https://github.com/chamilo/chamilo-lms/tree/1.11.x
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Rewrite README file for vChamilo plugin

Browse Source
pull/2487/head
Yannick Warnier 9 years ago
parent a884ebd587
commit 7dc4f90ab5
1 changed files with 64 additions and 41 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 105
      plugin/vchamilo/README.md

105
plugin/vchamilo/README.md
Unescape View File

@ -1,40 +1,50 @@
Virtual Chamilo
===================
Authors : Valery Fremaux (valery.fremaux@gmail.com), Julio Montoya
Authors : Valery Fremaux (valery.fremaux@gmail.com), Julio Montoya, Angel Quiroz, Yannick Warnier
Virtual chamilo is a feature that allows running several chamilo instances sharing the same
code base.
Virtual Chamilo (or vChamilo) is a feature that allows you to easily run several chamilo instances
sharing the same code base, with separate documents and databases, acting mostly like containers
sharing the same libraries.
With vChamilo, your first Chamilo portal acts as a container (or "controller"), and a seed
(or image) for the Chamilo instances you will install afterwards. This first image should be
created automatically when configuring the plugin, but if it isn't, the plugin will tell you
so and ask to generate one through the interface.
Once the plugin is fully setup, you will be able to create new Chamilo instances in a
matter of minutes (or seconds on powerful servers).
Changelog
=========
Version 1.4
*Version 1.5*
Improved usability and added validations. No DB update required.
*Version 1.4*
Database upgrade needed:
ALTER TABLE vchamilo ADD COLUMN password_encryption VARCHAR(255);
ALTER TABLE vchamilo ADD COLUMN password_encryption VARCHAR(255);
Version 1.3
*Version 1.3*
Add vchamilo import
Added vchamilo import
Version features
===================
This is a yet prototypal version that is not full featured in back-office tools.
At the moment, the setup of virtual clones still is a technical operation and has no
middle-office GUI. Development is in progress to offer a sufficient medium-level
administrability of the process.
This is still a beta version and it is not fully featured with back-office tools.
As such, you will be able to create, edit, copy, delete and even upgrade instances, but a certain
amount of manual work will still be required at the web server level to get your instances running.
How to setup
===================
You need :
To set this plugin up, you will need to:
1. Install the vchamilo package into the <chamiloroot>/plugin directory
2. Install the plugin in Chamilo administration
3. Insert the virtualization hook into the Chamilo master configuration file:
1. Insert the virtualization hook into the Chamilo master configuration file and enable multi-urls:
```
<chamiloroot>/app/config/configuration.php
@ -46,38 +56,51 @@ Insert the hook at the end of the file.
include_once $_configuration['root_sys'].'plugin/vchamilo/lib/Virtual.php';
Virtual::hookConfiguration($_configuration);
```
What you need for a virtual node is:
-------------
- a blank database copy of chamilo
- a dedicated course directory, that needs being accessible from chamilo installation root (directly, or using symlinks). the name
of this directory is free, as it will be mapped into the vchamilo record.
- a dedicated home page directory, that is located into <chamiloroot>/home directory and is named
as the chamilo instance domain name.
- a vchamilo record into the vchamilo table of the master installation. (the master installation is the install that refers to
the effective "configuration.php" information.
- an appropriate multiroot home root setup in the local chamilo instance
Prerequisites for VChamilo working nice
-------------
Multiple URL access must be enabled:
And add (or uncomment) the line to enable multi-url:
```
# in <chamiloroot>/main/inc/config/configuration.php
$_configuration['multiple_access_urls'] = true;
```
At this point, make sure there is no caching mechanism maintaining the previous configuration
version before you continue. Enabling the multi-url option should have the immediate effect
of adding a multi-url management link at the bottom of the "Platform" block in the
administration main page.
Take a moment to update the configuration of the default host in the multi-url configuration page
to the real hostname of your main (controller) portal.
2. Change the permissions on the <chamiloroot>/plugin/vchamilo/templates/ directory as it will
be necessary for the plugin to create files and directories there
3. Create a common directory to be used for all Chamilo-related files.
We recommend using <chamiloroot>/var/ for that. Inside that directory, create the following 4
directories: cache/, courses/, home/ and upload/ and give permissions to the web user to write
into them (exactly the same way you did it for the app/ directory when installing Chamilo)
4. Enable and configure the plugin in the Chamilo administration's plugins list
(if in doubt, use the suggested values). Please note that the proxy configuration part is
totally optional and is not maintained by the Chamilo team at this point.
5. Enable additional virtual hosts in your Apache config (unless you use subdirectories). All virtual hosts should point to the same DocumentRoot as the initial Chamilo installation.
6. For each virtual host or subdirectory, you will need to configure specific redirection rules (remember, this is still at beta-level):
In the administration, you will need configure an adequate home root definition for the instance finding
the dedicated home directory. You just need editing the http://localhost default host, and give the real domain
name you are using.
```
RewriteEngine On
RewriteRule /app/upload/(.*)$ http://[vchamilo-instance-domain]/[selected-common-dir]/upload/[vchamilo-instance-dir]/$1 [QSA,L]
```
In the example above, you would need to replace everything that is currently within brackets, with
the specific details of each instance. For example:
```
RewriteRule /app/upload/(.*)$ http://beeznest.chamilo.net/var/upload/beeznest-chamilo-net/$1 [QSA,L]
```
Although your vChamilo instances *will* work basically without this rewrite rule, you will end
up observing issues of files not appearing while uploading files on the instance.
Note that the domain of the instance, in the last part of the path, will be transformed
from dot-separated domain (beeznest.chamilo.net) to dash-separated-domain (beeznest-chamilo-net).
Check you have the <chamilo>/home/<instancedomain> clone of the standard home directory.
7. Finally, go to the "Instances manager" and create new instances. Once an instance
Important note about file system permissions
-------------
Vchamilos will use several side-directories apart from the standard installation (dedicated courses,
dedicated home page). Check you set the adequate filesystem permissions (usually let the server write
in there) for them.
vChamilo instances *need* a central directory where to store all their files. You should create
that directory (as mentioned in point 3 above) and make sure it has the right permissions.
The plugin/vchamilo/templates/ directory also needs to be writeable by the web server.

Write Preview
Loading…
Cancel
Save