documentator 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e09f4c8c041881638c3bbd0d7076d2689863854
-  data.tar.gz: 1a34de1fc0c0a419d7b6b7666255f30a1a159220
+  metadata.gz: bb646a36cd36840293d199b18b7057c4aa2e6f91
+  data.tar.gz: 029d8d2b1cda5b1691263facf54d12b42b0d8236
 SHA512:
-  metadata.gz: ce479d595b8cf88a6d43103ae13cf2dee8603e9ca3147f8aa4ddd52fea7fc5e32f430c2f1f6b9f250f8f77bd6870cbe0565761302f5e0a2abedf2bdf56af938e
-  data.tar.gz: 5f3a96bf4de980b6dee781c6524a1480d817c98082f295f85bf7842f8fac2497f6219c3cc044087aaf502448412e1a653f267960ef901e4183958996ec3753c8
+  metadata.gz: e2cfba5891611382740343eee5f76cf4aa1d6565331075465ec3c30460fe1f698709f6075d7cf08ed7d8380ca9b7de4235d57701b78f7965c1188048df016add
+  data.tar.gz: b76beb09ad815d9c78334d7d3aba86bfb1bff0f973e5ddbcfa05c4092fbc67c0d8f2bcc98db175744187a2a60db6dc6b647fffb1c3eacea20fd10103f1af7c4e

data/README.md

@@ -11,7 +11,7 @@ With bundler, add it to your `Gemfile`:
 
 ``` ruby
 group :development do
-  gem "documentator", git: "git@github.com:AF83/documentator.git"
+  gem "documentator"
 end
 ```
 

data/lib/documentator/templates/en/redis.md

@@ -0,0 +1,34 @@
+# Redis
+
+[Redis](http://redis.io/) is an open source, BSD licensed, advanced key-value store. It is
+often referred to as a data structure server since keys can contain
+strings, hashes, lists, sets and sorted sets.
+
+## Install Redis
+
+### Debian
+
+As root:
+
+```shell
+aptitude install redis-server
+```
+
+## Configuration
+
+The configuration file is located at /etc/redis.redis.conf. The
+meaning of each configuration variable is documented in the file.
+
+## Usage
+
+### Redis shell
+
+The `redis-cli` command opens a command-line console to a Redis
+server. All the commands documented on the [Redis documentation
+page](http://redis.io/commands) are allowed.
+
+The `INFO` command displays the current state of the Redis server
+including the memory usage. The `MONITOR` command shows all the
+operations currently executed on the Redis server.
+
+

data/lib/documentator/templates/fr/elasticsearch.md

@@ -82,10 +82,10 @@ $ bin/plugin install karmi/elasticsearch-paramedic
 
 Ces plugins seront accessibles sur les URLs suivantes :
 
-* http://localhost:9200/_plugin/head/
-* http://localhost:9200/_plugin/inquisitor/
-* http://localhost:9200/_plugin/bigdesk/
-* http://localhost:9200/_plugin/paramedic/
+* http://localhost:9200/\_plugin/head/
+* http://localhost:9200/\_plugin/inquisitor/
+* http://localhost:9200/\_plugin/bigdesk/
+* http://localhost:9200/\_plugin/paramedic/
 
 
 

data/lib/documentator/templates/fr/grunt.md

@@ -4,7 +4,7 @@
 
 ## Installation
 
-Version recommandé: 0.4
+Version recommandée : 0.4
 Il est supposé que nodejs est installé dans une version supérieure à 0.8
 
 ``` shell

data/lib/documentator/templates/fr/neo4j.md

@@ -2,12 +2,12 @@
 
 [The Market Leader Property Graph Database](http://www.neo4j.org/)
 
-Une base de données graphe est un système de stockage supportant 
-la persistance des données sous forme de graphe (noeuds, relations) nativement. 
+Une base de données graphe est un système de stockage supportant
+la persistance des données sous forme de graphe (noeuds, relations) nativement.
 
 ## Installation
 
-Version recommandé stable en édition 'community': 1.8.2
+Version recommandée stable en édition 'community': 1.8.2
 
 * Debian
 
@@ -15,7 +15,7 @@ Version recommandé stable en édition 'community': 1.8.2
 # start root shell
 sudo -s
 # Import our signing key
-wget -O - http://debian.neo4j.org/neotechnology.gpg.key | apt-key add - 
+wget -O - http://debian.neo4j.org/neotechnology.gpg.key | apt-key add -
 # Create an Apt sources.list file
 echo 'deb http://debian.neo4j.org/repo stable/' > /etc/apt/sources.list.d/neo4j.list
 # Find out about the files in our repository
@@ -32,4 +32,3 @@ via Homebrew
 brew update && brew install neo4j
 neo4j start
 ```
-

data/lib/documentator/templates/fr/nodejs.md

@@ -0,0 +1,38 @@
+# Nodejs
+
+[Nodejs](http://nodejs.org/)
+
+## Installation
+
+Version recommandée : version majeur pair (ex 0.10.6)
+Installation sans droit administrateur.
+
+prérequis :
+
+ * GNU make >= 3.81
+ * python == 2.6 ou 2.7.
+
+``` shell
+git clone https://github.com/joyent/node.git
+cd node
+git checkout v0.10.6
+./configure --prefix=$HOME/.node && make -j 3 && make install
+export PATH=$PATH:$HOME/node/bin
+```
+
+ou utiliser les [binaires](http://nodejs.org/download/)
+
+``` shell
+wget http://nodejs.org/dist/v0.10.6/node-v0.10.6-linux-x64.tar.gz
+tar xzvf node-v0.10.6-linux-x64.tar.gz
+export PATH=$PATH:$HOME/node-v0.10.6-linux-x64/bin
+```
+
+Ajouter la derniere ligne à ~/.profile ou ~/.bash_profile ou ~/.bashrc ou ~/.zshenv
+
+## Utilisation
+
+``` shell
+npm --help
+node --help
+```

data/lib/documentator/templates/fr/postgresql.md

@@ -2,37 +2,93 @@
 
 ## Installation
 
+Les exemples ci-dessus prennent comme version de référence la version 9.1, [la
+version de PostgreSQL la plus récente qui soit disponible dans
+squeeze-backports](http://packages.debian.org/squeeze-backports/postgresql)
+
 ### Debian
 
-En tant que root:
+En tant que root :
 
 ``` bash
-aptitude install postgresql postgresql-server-dev-9.1 postgresql-client
+aptitude install postgresql postgresql-server-dev-9.1 postgresql-client postgresql-contrib-9.1
 libpq-dev
 ```
 
-Une fois postgresql installé, il faut créer un nouvel utilisateur:
+## Authentification sur une machine de développment
 
-``` bash
-su postgres
-createuser username
-exit
-```
+Pour une utilisation en dévelopment, il est généralement beaucoup plus simple
+de changer les paramètres d'authentification de PostgreSQL pour autoriser tout
+utilisateur local à se connecter à n'importe quelle base avec n'importe quel
+rôle (_user_).
 
-Puis éditer le fichier `/etc/postgresql/9.1/main/pg_hba.conf` pour autoriser les
-utilisateurs non-unix à s'authentifier.
+Pour cela, éditer le fichier `/etc/postgresql/9.?/main/pg_hba.conf` et changez
+les méthodes `peer` (accès autorisés pour tout utilisateur ayant un nom de
+compte Unix identique au rôle PG demandé) ou `md5` (password crypté) en `trust`
+(confiance absolue, aucune vérification de l'identité du user ou de son
+password)¹.
 
-Pour cela, il faut changer `peer` en `trust`:
+Cela donne donc, pour la section du fichier concernée :
 
 ```
 # TYPE  DATABASE        USER            ADDRESS                 METHOD
 
 # "local" is for Unix domain socket connections only
 local   all             all                                     trust
+# IPv4 local connections:
+host    all             all             127.0.0.1/32            trust
+# IPv6 local connections:
+host    all             all             ::1/128                 trust
 ```
 
-Finalement, redémarrer postgresql:
+**Ceci ne doit bien évidemment être fait que pour une utilisation sur une
+machine individuelle et JAMAIS sur un serveur un tant soit peu exposé.**
+
+Redémarrer PostgreSQL pour prendre en compte ce changement de configuration :
 
 ``` bash
 /etc/init.d/postgresql restart
 ```
+
+
+## Ajout d'un nouvel utilisateur (UTILISATEUR)
+
+Faire ² :
+
+```shell
+# su postgres -c "createuser --createdb --pwprompt UTILISATEUR"
+```
+
+Il faudra alors saisir le mot de passe que l'on désire pour l'utilisateur
+PosgreSQL `map`. Dans le cas d'une installation sur une machine de
+développment (ou de manière générale, non "sensible"), on peut préférer ne pas
+préciser de mot de passe. On lancera alors la commande sans le flag _pwprompt_ ² :
+
+```shell
+# su postgres -c "createuser --createdb UTILISATEUR"
+```
+
+## Gestion des extensions
+
+Pour pouvoir installer ou supprimer une extension, un utilisateur Postgres doit
+être doté des droits _superuser_.
+
+Comme il n'est cependant ni vraiment utile, ni raisonnable de donner ces droits
+à un utilisateur lambda, le plus simple est d'ajouter l'extension désirée à la
+base _template1_, qui sert de modèle pour toutes les bases créées. Toute
+nouvelle base de données créée héritera donc automatiquement de cette
+extension, via le schéma `pg_catalog`.
+
+Par exemple, si on veut rajouter l'extension
+[hstore](http://www.postgresql.org/docs/9.1/static/hstore.html), on peut faire
+(en tant que root)² :
+
+```shell
+# su postgres -c "psql -d template1 -c 'CREATE EXTENSION IF NOT EXISTS hstore'"
+```
+
+¹ Voir http://www.postgresql.org/docs/9.1/static/auth-methods.html pour plus
+de détails
+² Pour tous les exemples de commandes de type `su postgres -c "psql…`, on peut
+tout simplement faire un `psql -U postgres -c "…` si on a déjà mis en place une
+configuration de type "machine de développment" tel que décrite plus haut.

data/lib/documentator/templates/fr/redis.md

@@ -0,0 +1,32 @@
+# Redis
+
+[Redis](http://redis.io/) est une base de donnée "clé-valeur" améliorée. Elle est capable
+de stocker des structures de données évoluées comme des chaines, des
+dictionnaire, des listes, des ensembles et des ensembles ordonnés.
+
+## Installation
+
+### Debian
+
+En tant que root :
+
+```shell
+aptitude install redis-server
+```
+
+## Configuration
+
+Le fichier de configuration de Redis est /etc/redis/redis.conf. Les
+effets de chaque variables y sont documentés.
+
+## Utilisation
+
+### Le shell Redis
+
+La commande `redis-cli` permet de se connecter à un serveur
+Redis. Toutes les commandes listées sur la [documentation de
+Redis](http://redis.io/commands) peuvent être utilisées sur le shell.
+
+La commande `INFO` permet d'avoir un apercu de l'état du serveur Redis,
+notamment de la mémoire consommée. La commande `MONITOR` permet de
+moniter en temps réel les opérations exécuté sur le serveur.

data/lib/documentator/templates/fr/zeromq.md

@@ -16,7 +16,7 @@ aptitude install libzmq-dev
 Ou pour la branche 3.2:
 
 ``` bash
-aptitude install libzmq-dev
+aptitude install libzmq3-dev
 ```
 
 Et, c'est tout.

data/lib/documentator/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module Documentator
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: documentator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - chatgris
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-03 00:00:00.000000000 Z
+date: 2013-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: boson
@@ -44,6 +44,7 @@ files:
 - lib/documentator/bootstrap/Deploy.md
 - lib/documentator/bootstrap/Environments.md
 - lib/documentator/bootstrap/Gemfile
+- lib/documentator/templates/en/redis.md
 - lib/documentator/templates/en/ruby.md
 - lib/documentator/templates/fr/beanstalkd.md
 - lib/documentator/templates/fr/capistrano.md
@@ -51,7 +52,9 @@ files:
 - lib/documentator/templates/fr/grunt.md
 - lib/documentator/templates/fr/mongodb.md
 - lib/documentator/templates/fr/neo4j.md
+- lib/documentator/templates/fr/nodejs.md
 - lib/documentator/templates/fr/postgresql.md
+- lib/documentator/templates/fr/redis.md
 - lib/documentator/templates/fr/zeromq.md
 - lib/documentator/version.rb
 homepage: https://github.com/AF83/documentator