AlternC, Documentation Développeur

AlternC Development Team

tech@alternc.org

AlternC est un logiciel de gestion d'hébergeur de sites Internet, d'emails, de noms de domaines et de tout service web disponible pour le public. Ce logiciel utilise des programmes comme apache pour serveur web ou postfix pour le courrier électronique. Il fournit une suite logicielle écrite en php4 qui permet de gérer intégralement un serveur depuis une interface web, et permet d'allouer à chaque utilisateur un certain nombre de ressources sur le serveur.

AlternC fournit donc une interface web complète à destination des administrateurs système et des utilisateurs finaux hébergés. Cette interface est programmée en PHP

Ce logiciel est basé sur la distribution Debian (Woody (V3) à ce jour), et est disponible sous licence GPL. Chacun peut participer à l'évolution du projet, à la création de nouveaux paquets pour AlternC etc.

Table des matières

1. Introduction

Description du projet
Historique du projet

2. Choix Logiciels

La distribution debian

Les logiciels utilisés, détails

Apache-SSL (LE serveur Web)
MySQL (Serveur de données)
Php 4 (Scripts Dynamiques dans Apache)
Sympa (Gestionnaire de listes de diffusions)
HtDig (Moteur de Recherche)
MonHarc (Archiveur de listes de diffusions)
Postfix (Serveur SMTP + Distribution du mail)
Courier pop imap pops imaps (Serveurs de lecture de courrier)
ProcMail (Gestion de filtres de mails)
ProFTPd (Serveur FTP)
OpenLdap (Serveur Ldap)
KernelQuotas (Gestion des quotas disque)
libpam-ldap (Gestion de l'authentification dans LDAP)
libnss-ldap (Gestion de l'autorisation dans LDAP)
Bind 9 (Serveur DNS)

3. - ROADMAP - Liste des fonctionnalités figées, plan de développement.

Liste des choses à faire avant la version 1.0
Fonctionnalités d'AlternC en version 1.0
Fonctionnalités futures d'AlternC

4. Qui est derrière le projet AlternC ?

Qui est à l'origine du projet
L'Equipe de développeurs d'AlternC

5. CVS, Mode d'emploi

Qu'est ce que CVS ?
Utilisation de CVS sous linux
Utilisation de Tortoise CVS pour Windows
Liste des modules CVS d'AlternC
Accès au CVSWEB d'AlternC

6. Documentation développeur

Fonctionnement du bureau AlternC
Modules et classes php
La liste des classes, leur rôle

7. Les classes php, détails de l'implémentation

m_admin, Administration des hébergés

$ad->get($uid)
$ad->get_list()
$ad->add_mem($login, $pass, $nom, $prenom, $mail)
$ad->update_mem($uid, $mail, $nom, $prenom, $pass, $enabled)
$ad->del_mem($uid)
$ad->normal2su($uid)
$ad->su2normal($uid)
$ad->listtld()
$ad->addtld($tld,$mode)
$ad->edittld($tld,$mode)

m_domains, Installation et gestion des domaines hébergés

$do->enum_domains()
$do->del_domain($dom)
$do->add_domain($domain,$dns)
$do->whois($domain)
$do->get_domain_all($dom)
$do->get_sub_domain_all($dom,$sub)
$do->set_sub_domain($dom,$sub,$type,$action,$dest)
$do->del_sub_domain($dom,$sub)
$do->edit_domain($dom,$dns,$mx)

m_ftp, Gestion des comptes FTP hébergés

$ft->get_list()
$ft->get_ftp_details($id)
$ft->prefix_list()
$ft->select_prefix_list()
$ft->put_ftp_details($id,$prefixe,$login,$pass,$dir)
$ft->delete_ftp($id)
$ft->add_ftp($prefixe,$login,$pass,$dir)
$ft->is_ftp($dir)

m_mails, Gestion des comptes email pop et des alias mails des domaines hébergés.

$ma->enum_domains()
$ma->enum_doms_mails($dom)
$ma->get_mail_details($mail)
$ma->change_password($mail,$pass)
$ma->put_mail_details($mail,$pop,$pass,$alias)
$ma->add_mail($dom,$mail,$pop,$pass,$alias)
$ma->del_mail($mail)

m_error, Gestion des erreurs et des logs.

$er->clsidname
$er->raise($clsid,$error[,$param])
$er->errstr()
$er->log($clsid,$function[,$param])

m_quota, Gestion des quotas de service et quota disque.

$disk
$qlist
$qu->cancreate($ressource)
$qu->getquota([$ressource][,$uid])
$qu->setquota($ressource,$size[,$used][,$uid])
$qu->inc($ressource)
$qu->dec($ressource)
$qu->checkquota([$id])
$qu->delquotas($uid)
$qu->addquotas($uid)

m_ml, Gestion des listes de discussion / diffusion.

$ml->enum_ml()
$ml->get_ml_users($id,$offset)
$ml->size_list([$max_size])
$ml->get_ml_all_users($id)
$ml->count_users($id)
$ml->add_user($id,$mail[,$nom])
$ml->add_user_multiple($id,$liste)
$ml->edit_user ($id,$name,$mail,$old_mail)
$ml->del_user($id,$mail)
$ml->add_owner($mail,$id)
$ml->del_owner($suppr,$id)()
$ml->edit_ml($id,$sub,$unsub,$send,$reply,$mail,$addsubject,$max_size)
$ml->get_ml($id)
$ml->prefix_list()
$ml->select_prefix_list($current)
$ml->add_lst($domain,$login,$owner)
$ml->delete_lst($id)
$ml->get_template($id,$txt)
$ml->set_template($id,$txt,$message)
$ml->select_subscribe_mode($current)
$ml->select_unsubscribe_mode($current)
$ml->select_send_mode($current)
$ml->select_reply_to($current)
$ml->checkquota([$id])
$ml->del_dom($dom)
$ml->add_dom($dom)

8. Installation d'AlternC sur un serveur

Installation de Debian GNU/Linux

Installation d'AlternC 1ere Etape

Installation du serveur, Explications

Introduction
Le serveur AlternC
Fonctionnement général d'AlternC

Installation d'un serveur DNS secondaire.

Installation de SpamAssassin

Configuration d'AlternC : 'alternc.conf'

9. Le paquet Debian d'AlternC

Les paquets en dépendance directe

10. Liens utiles d'AlternC

11. SGML, mode d'emploi

Préambule
Les balises utilisées dans AlternC

Liste des exemples
11-1. Exemple de balise para
11-2. Exemple de balise chapter
11-3. Exemple de balise sect1
11-4. Exemple de balise note
11-5. Exemple de balise Orderedlist
11-6. Exemple de balise Literal
11-7. Exemple de balise Command
11-8. Exemple de balise link
11-9. Exemple de balise ulink
11-10. Exemple de balise graphic

		Suivant
		Introduction