Comment exporter la documentation pour une consultation Offline

La méthode donnée ci dessous, est la méthode que j'ai utilisé et qui m'a permis de créer en 2015, une archive complète de la documentation.
Données techniques au 01/10/2015

L'export a été fait sur un pc portable :

  • un processeur i7 4 cœurs
  • 8 Go de RAM
  • HDD 500 Go
  • Kubuntu 15.04 64 bit

L'exportation des 6500 pages a duré 41h.

la création du fichier zim : entre 5 et 10 min.

Installation du serveur web

Dans un premier temps, nous allons installer le serveur web qui va nous permettre de mettre en place une copie du site de la documentation. J'ai personnellement utilisé Apache, il est possible d'utiliser n'importe quel serveur web supportant php5.(pour plus d'information voir Serveur Web - LAMP)

apt-get install apache2 libapache2-mod-php5
Je n'ai pas installé Mysql, parce que le site de la documentation ne le nécessite pas.

Il faut configurer Apache et php afin d'éviter des problèmes d'exportation.

Attention

Certains paramètres sont vivement déconseillés sur des serveurs en production. Ils peuvent conduire à une saturation du serveur. La modification de ces paramètres est nécessaire, sinon l'exportation échoue. Éviter d'avoir plusieurs scripts ou plusieurs sites sur le même PC. Si nécessaire, pour les paramètres php, il est possible de passer par un fichier .user.ini à la racine du wiki(utile si plusieurs sites sont servi par le serveur Apache).

Editer le fichier /etc/apache2/apache.conf avec votre éditeur de texte favori.

ServerName localhost #Pour éviter l'alarme au démarrage d'Apache
Timeout 300 # On augmente de manière significative la durée passant de 30 secondes à 5 min
# A modifier si existant ou à rajouter voir la documentation de dokuwiki
<Directory /var/www/>
	Options Indexes FollowSymLinks
	AllowOverride None
	Require all granted
</Directory>

Maintenant, nous allons créer nos hotes virtuels :

  • Le premier est l’hôte qui hébergera le dokuwiki et que j'ai appelé www.doc-ubuntu-fr.loc
  • le deuxième pour les éléments statique et le template Ubuntu.
Actuellement, je ne suis pas parvenu à faire fonctionner le template Ubuntu. L'exportation s'est fait à partir du template (mise en page) de base de dokuwiki.
<VirtualHost *:80>
	ServerName www.doc-ubuntu-fr.loc

	ServerAdmin webmaster@localhost
	DocumentRoot /var/www/ubuntu-fr/ubuntu-fr-doc

	<Directory /var/www/ubuntu-fr/ubuntu-fr-doc>

		Options Indexes FollowSymlinks
		AllowOverride All
		order allow,deny
		allow from all
	</Directory>
	ErrorLog ${APACHE_LOG_DIR}/error.log
	CustomLog ${APACHE_LOG_DIR}/access.log combined
</VirtualHost>

<VirtualHost *:80>
	ServerName www.static-ubuntu-fr.loc
	
	ServerAdmin webmaster@localhost
	DocumentRoot /var/www/ubuntu-fr/ubuntu-fr-static

	ErrorLog ${APACHE_LOG_DIR}/error.log
	CustomLog ${APACHE_LOG_DIR}/access.log combined
</VirtualHost>

Modification des valeurs par défaut de php : Il suffit de modifier les valeurs si dessous

max_execution_time = 300 
max_input_time = 600
memory_limit = 512M 
default_socket_timeout = 600

Une fois terminée, il faut relancer le serveur Apache pour lui faire prendre en compte les modifications.

service apache restart

Installation du dokuwiki

  • Installation de bazaar : (pour plus d'information voir Bazaar)
apt-get install bzr
mkdir /var/www/ubuntu-fr/original
cd /var/www/ubuntu-fr/original
  • Récupération du site static
bzr branch lp:ubuntu-fr-static
  • Récupération du site documentation.
bzr branch lp:ubuntu-fr-doc
Nous récupérons les différents plug-ins déployés dans la documentation, mais nous allons repartir d'une installation neuve.
  • Récupération de dokuwiki ici.
A l'heure de l'écriture du tutoriel (octobre 2015), le wiki tourne sur la version 2014-05-05.
  • Décompressez l'archive du dokuwiki dans /var/www/ubuntu-fr/ubuntu-fr-doc
  • Dans un navigateur ouvrir la page www.doc-ubuntu-fr.loc/install.php et suivre le processus d’installation.
Il est important de créer un administrateur afin de pouvoir installer et utiliser le plug-in "SiteExport".
  • Copier les plug-ins et les données obtenues auprès des administrateurs
cp -R /var/www/orignal/ubuntu-fr-doc/lib/plugins /var/www/ubuntu-fr-doc/lib/plugins
cp -R [chemin ou se trouve les données]/data/ /var/www/ubuntu-fr-doc/data/
  • Installer le plugin dokuwiki **siteexport**, soit manuellement en le décompressant dans le dossier lib/plugins/ soit en utilisant l'interface d'administration de votre instance de dokuwiki.

Exporter le wiki

Toutes les opérations de cette section demande d'être logué en tant qu'administrateur sur le wiki.
  • Dans un navigateur se rendre : http://www.doc-ubuntu-fr.loc/doku.php?id=accueil
  • Se loguer en tant qu'administrateur
  • Cliquer sur le menu administrer
  • Cliquer sur Export du site dans la section Extensions
  • Renseigner les champs suivants :
    • Espace de nom parent à exporter : accueil
    • Type d'export : Tous les sous espaces de nom
    • Cocher : Export du corps uniquement
    • Décocher : Exporter les pages liées
    • Décocher : Export de tous les paramètres (exp: "do")
    • Cliquer dur le bouton démarrer
  • Attendre la fin de l'export. A la fin de l'export, le navigateur vous proposera de télécharger le fichier.
Au dessus du bouton démarrer se trouvent plusieurs liens dont le lien en téléchargement direct. Il peut être intéressant de le garder, surtout si le navigateur ne propose pas de télécharger le fichier. Il suffit alors de se rendre à l'adresse en question pour télécharger le fichier en question.

Créer le fichier

Commencer par récupérer le code de dokuwiki que nous utilisons et se créer une instance locale (ou sur un serveur distant).

Demander une copie de sauvegarde du dossier data aux administrateurs système (ou utiliser autre chose si c'est pour faire des tests, comme par exemple le dossier data fourni avec une dokuwiki normal).

Installer le plugin dokuwiki **siteexport**, soit manuellement en le décompressant dans le dossier lib/plugins/ soit en utilisant l'interface d'administration de votre instance de dokuwiki.

Se rendre dans l'interface d'administration, un nouvel élément Export du site devrait être là. C'est là dedans que tout se passe, réglages fin et lancement de l'export partiel ou total.

FIXME la suite


Contributeurs : Darkjam.

  • groupes/ubuntu-fr-doc/exporter_la_doc.txt
  • Dernière modification: Le 15/12/2015, 11:07
  • par darkjam