Gollum est hébergé sur la machine Smeagol.

Au ResEl, nous avons notre version un peu forké, pour corriger des problèmes d'UTF-8, le code source est versionné sur Gitlab : ResEl/gollum-forks.

Le wiki est disponible sur le dépôt ResEl/general.wiki et est synchronisé avec le dépôt sur Smeagol dans /home/wiki/general.wiki.

Description

Gollum est un service simple de Wiki, synchronisé via Git, et pouvant traiter divers langage de Markup, dont Markdown ou Org-mode. Il s'agit du service par défaut utilisé par les wikis Gitlab et Github, mais il peut aussi être autohébergé seul, comme fait au ResEl.

Motivations

Avant, le ResEl à utilisé trac puis redmine comme solution complète de gestion de projet. Mais il a été décidé, suite au passage à Gitlab comme solution de gestion de projet, de séparer les outils de gestion de projet et le wiki.

Mise en place

Gollum est un programme développé en Ruby, qui se compose de trois partie, le frontend Gollum, le backend Gollum-lib et l'interface avec git rugged-adapter.

Gollum a été mis en place sur Smeagol, il pousse une plateforme web https://wiki.resel.fr, pointant sur le reverse publique Situs.

Pour résoudre quelques problèmes dans Gollum (notamment d'UTF-8), le code a été légèrement patchée par le ResEl, le code est disponible sur le dépôt associé, plus d'informations sur le README.

Utilisation

A priori, vous avez réussi à vous connecter et naviguer jusqu'à cette page, Bravo clap !

Rédaction des articles

Pour rédiger un article, vous pouvez simplement cliquer sur le lien vers un article inexistant, ou cliquer sur le bouton New. Pour éditer, le bouton Edit.

La rédaction peut se faire selon différent langage de markup, le recommandé étant Markdown, lisez le tuto.

Quelques conseils
  • Pour un service et la machine qui l'héberge :
    Tout ce qui touche au serice va sur la page service, tout ce qui touche à la machine va sur la page machine. On évite de mélanger des infos. Il faut bien comprendre qu'une machine peut être supprimé, et le service réinstallé sur une autre. Donc sur la page de la machine on ne traite que des infos du service vraiment en rapport avec la machine.
    Quelques pages modèles : Gollum/Smeagol, Sites Clubs/Golf

Configuration

warning La configuration fait l'objet d'un versionnage sur le dépôt git.

On peut modifier le service avec cette configuration, les détails sont sur la doc de Gollum. Il y a deux fichiers, custom.css et custom.js qui permettent d'injecter du css et du js pour améliorer l'aspect du site.

Pour soucis de préserver un versionnage propre du code, modifier la configuration sur le dépôt.

Aller voir les détails de mise en place de Gollum sur Sméagol pour voir comment est installé le service et comment puller des modifications.

Lien utiles

Listes de lien utiles, dans l'ordre :

Historique

  • Mise en place initiale par Théo Jacquin en 2017