Commit 02f22b91 authored by Benjamin Sonntag's avatar Benjamin Sonntag

removing flags + readme translation + removing old docs

parent d7f9155d
* text=auto !eol
/BUILD -text
/COPYING -text
/HACKING -text
/README -text
/TODO -text
/README.en -text
/README.fr -text
aide/bin/build.sh -text
aide/bin/frames.dsl -text
aide/brouteur.sgml -text
......@@ -305,13 +303,6 @@ etc/alternc/templates/postfix/sasl/smtpd.conf -text
etc/alternc/templates/proftpd.conf -text
etc/alternc/templates/squirrelmail/apache.conf -text
etc/alternc/templates/welcome.msg -text
flags/de_DE.png -text
flags/en_UK.png -text
flags/en_US.png -text
flags/es_ES.png -text
flags/es_VE.png -text
flags/fr_CA.png -text
flags/fr_FR.png -text
install/alternc.install -text
install/body_checks -text
install/domaines.template -text
......
Build instructions
==================
1- get the source
# cvs co alternc
2- get the dependencies
You probably need at least dpkg-dev, dehelper and optionally fakeroot, to
build the package as non-root.
3- build the package
Should be as simple as calling dpkg-buildpackage now. The package will
be in ../alternc_<version>_<arch>.deb
You can verify the validity of the package using:
lintian -i ../*.deb
Warning: this will print out a lot of messages, since the package is
really not clean right now.
Modularisation d'AlternC
========================
- Chaque classe a un nom en lettres (pas trop long).
- Chaque classe fournit :
* Un fichier m_<classname>.php contenant la déclaration de la classe php
* Une classe qui s'appelle "m_<classname>"
* La variable globale instanciant la classe est $<classname>, elle est créée automatiquement par config_real.php
* Un fichier .pot dans locales/<classname>.po (et eventuellement <classname>_manual.po pour les entrees non détectées par gettext
* Les messages d'erreur sont du type "err_<classname>_<errno>" ou <errno> est un entier positif. 0 pour "OK"
* Une classe PEUT présenter un fichier "menu_<classname>.php" dans admin/
- Une classe peut présenter les fonctions particulières suivantes :
* alternc_add_domain($domain) qui est appellée quand un domaine est créé sur le compte membre courant
* alternc_del_domain($domain) qui est appellée quand un domaine est supprimé sur le compte membre courant
* alternc_add_member($uid) quand un membre est créé
* alternc_del_member($uid) quand un membre est détruit
* alternc_quota_check($uid) pour recalculer le quota utilisé par un membre
* alternc_quota_names() qui retourne une chaine ou un tableau avec le(s) noms des quota(s) gérés par cette classe.
si elle ne les contient pas, ces fonctions ne seront pas appellées...
AlternC est fourni en standard avec les classes :
- domain (installation domaines / dns / mx)
- ftp (maintenance des comptes ftp)
- mail (maintenance des emails pop/alias)
- quota (gestion globale des quotas de service et de disques)
- bro (navigateur dans le système de fichier)
- admin (panneau administrateur)
- mem (connexion et préférences membre)
- mysql (maintenance de bdd mysql)
- err (gestion des erreurs)
- sta2 (demande de sortie de logs bruts apache)
- hta (protection de dossiers web par htaccess/htpasswd)
Les modules additionnels dispo :
- alternc-webinstaller (cette classe particulière permet l'intégration facile d'outils (dmanager, spip, forum, chat ...) )
- alternc-mailman (gestion de listes sous mailman)
- alternc-sympa (gestion de listes sous sympa)
- alternc-webalizer (gestion de stats webalizer)
- procmail_builder (plugin spécial pour squirrelmail)
Donc, pour s'installer, une classe a besoin de :
- Créer les éventuelles structures de données nécessaires (mysql)
- Copier le fichier m_<classname> dans bureau/class/
- Copier l'eventuel fichier menu_<classname>.php
- Copier les éventuels autres fichiers dans bureau/admin, bureau/locales/* ...
Quotas
------
Le système de quota est simple : la classe peut appeler
$quota->inc dec ...
pour le membre donné, sur le nom de quota utilisé par celle-ci,
(utiliser <classname> est conseillé ;)
Quand un nouveau membre est créé, la valeur par défaut choisi par
l'admin lui est associé, et cette valeur vaut 0 par défaut.
Autres
------
Il est conseillé que chaque classe non standard fournisse un dossier
dans /bureau/admin/ dans lequel elle stocke les pages web
correspondantes, ceci afin de ne pas alourdir le dossier bureau/admin...
Ajout à l'API :
- La variable globale "$classes" contient un tableau avec le nom des
classes disponibles (nom court sans m_ =>mail, quota, err...)
Hooks ou "events" AlternC
=========================
Liste des fonctions "events" appellées lorsqu'un évènement particulier a lieu
sur un compte, tel que l'ajout d'un domaine, la suppression d'un domaine etc.
- Ces fonctions commencent TOUJOURS par "alternc_"
- SEULES ces fonctions ont le droit d'utiliser le prefixe alternc_ dans les
classes
- Les fonctions ne peuvent apparaitre que dans les classes d'AlternC, ayant
pour nom m_<nom du module>
- Chaque fonction est prototypée ci-dessous et son évènement est expliqué en
détail
alternc_del_domain($dom)
fonction appellée lorsqu'un domaine est effacé d'un compte AlternC.
$dom est le nom de domaine concerné.
alternc_add_domain($dom)
fonction appellée lorsqu'un domaine est installé sur un compte AlternC.
$dom est le nom de domaine concerné.
alternc_quota_check($id)
fonction appellée afin de recalculer le quota d'un membre pour le service correspondant.
$id est le numéro unique du membre concerné.
alternc_add_member($id)
fonction appellée lorsqu'un compte membre est créé sur le serveur AlternC.
$id est le numéro unique du membre concerné, qui a déjà été créé dans les tables principales.
alternc_del_member($id)
fonction appellée lorsqu'un compte membre est supprimé sur le serveur AlternC.
$id est le numéro unique du membre concerné, qui sera détruit après l'appel.
alternc_add_mx_domain($dom)
fonction appellée lorsqu'un domaine déjà hébergé mais n'ayant pas le mx pointant vers nous voit son mx
pointer vers nous. Pour les classes sensible au mail, cela équivaut bien souvent à add_domain
alternc_del_mx_domain($dom)
fonction appellée lorsqu'un domaine déjà hébergé et ayant son mx pointant vers nous voit son mx
nous quitter. Pour les classes sensible au mail, cela équivaut bien souvent à del_domain
alternc_description()
retourne la chaine ou la liste de chaine de description du module, traduit par gettext.
permet de savoir à quoi sert un module ou les éléments d'un module.
AlternC: Hosting software suite
=================================================
Introduction
------------
AlternC is a software suite helping system administrators in handling
Web Services management. It should be easy to install, based only on
OpenSource softwares. AlternC is GPL licensed.
This software consist of an automatic install and configuration system,
a web control panel to manage hosted users and their web services such
as domains, email accounts, ftp accounts, web statistics ...
Technically, AlternC is based on Debian GNU/Linux distribution, 'Sarge'
version, and it depends on other softwares such as Apache, Postfix,
Mailman ... It also contains an API documentation so that users can
easily customize their web desktop.
This project native tongue is French. However, the packages are
available at least in French and English. They may also be available in
other languages (Some Spanish or German translation is in the pipe...)
depending on YOUR help on this part of the project.
Some part of the documentation are only available in french for now, but
will certainly be translated in a near future.
AlternC was initially developped by system administrators at Lautre.Net,
then other guys came and helped us, such as Globenet, Netaktiv,
Neuronnexion or Koumbit.
Install
------------
For now, AlternC can be installed as a Debian package. This package
depends on other softs used by AlternC. Just add those lines to your
/etc/apt/sources.list file :
deb http://debian.alternc.org debian/
deb-src http://debian.alternc.org debian/
then apt-get install alternc
You may download and install additionnal plugins after installing AlternC.
Let's go to the developper page for more information.
https://dev.alternc.org/trac/alternc/
......@@ -28,7 +28,7 @@ multilingue devrait arriver un jour ...
AlternC est développé par les administrateurs système de l'Autre Net,
les membres de l'Autre Net, ainsi que d'autres structures / développeurs
parmis lesquels Globenet.
parmis lesquels Globenet, Neuronnexion ou Koumbit.
Installation
------------
......@@ -40,3 +40,14 @@ suivantes dans votre fichier /etc/apt/sources.list
deb http://debian.alternc.org debian/
deb-src http://debian.alternc.org debian/
lancez ensuite
aptitude update
aptitude install alternc
Note: vous pouvez aussi installer les modules additionnels d'AlternC par
la suite. Pour plus d'information, rendez-vous sur le serveur de
développement à l'adresse :
https://dev.alternc.org/trac/alternc/
See http://dev.alternc.org/trac/alternc/roadmap to get up to date information
about what's left to do for AlternC.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment