Merge pull request #1706 from wallabag/v2-install-doc

Documentation for wallabag installation

diff --git a/docs/en/index.rst b/docs/en/index.rst
index 85c764dabf6bb7d11a831a8f2bac887cacfbacef..17e375d2db71eef98eb45e7dad6a80699ee1984d 100644 (file)
--- a/docs/en/index.rst
+++ b/docs/en/index.rst
@@ -23,6 +23,7 @@ The main documentation for this application is organized into a couple sections:
    :maxdepth: 2
    :caption: User documentation
 
+   user/installation
    user/create_account
    user/login
    user/configuration

diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst
new file mode 100644 (file)
index 0000000..760fd4d
--- /dev/null
+++ b/docs/en/user/installation.rst
@@ -0,0 +1,145 @@
+Install wallabag
+================
+
+Requirements
+------------
+
+wallabag is compatible with php >= 5.5
+
+You'll need the following extensions for wallabag to work. Some of these may already activated in your version of php, so you may not have to install all corresponding packages.
+
+- php-session
+- php-ctype
+- php-dom
+- pĥp-hash
+- php-simplexml
+- php-json
+- php-gd
+- php-mbstring
+- php-xml
+- php-tidy
+- php-iconv
+- php-curl
+- php-gettext
+- php-tokenizer
+
+wallabag uses PDO to connect to database, so you'll need one of:
+
+- php-pdo_mysql
+- php-pdo_sqlite
+- php-pdo_pgsql
+
+and it's corresponding database server.
+
+Installation
+------------
+
+wallabag uses a big number of libraries in order to function. These libraries must be installed with a tool called Composer. You need to install it if you don't already have.
+
+Install Composer:
+
+::
+
+    curl -s http://getcomposer.org/installer | php
+
+You can find specific instructions here : __ https://getcomposer.org/doc/00-intro.md
+
+To install wallabag itself, you must run these two commands:
+
+::
+
+    SYMFONY_ENV=prod composer create-project wallabag/wallabag wallabag "2.0.*@alpha" --no-dev
+    php bin/console wallabag:install --env=prod
+
+To start php's build-in server and test if everything did install correctly, you can do:
+
+::
+
+    php bin/console server:run --env=prod
+
+And access wallabag at http://yourserverip:8000
+
+Installing on Apache
+--------------------
+
+Assuming you install wallabag in the /var/www/wallabag folder and that you want to use php as an Apache module, here's a vhost for wallabag:
+
+::
+
+    <VirtualHost *:80>
+        ServerName domain.tld
+        ServerAlias www.domain.tld
+
+        DocumentRoot /var/www/wallabag/web
+        <Directory /var/www/wallabag/web>
+            AllowOverride None
+            Order Allow,Deny
+            Allow from All
+
+            <IfModule mod_rewrite.c>
+                Options -MultiViews
+                RewriteEngine On
+                RewriteCond %{REQUEST_FILENAME} !-f
+                RewriteRule ^(.*)$ app.php [QSA,L]
+            </IfModule>
+        </Directory>
+
+        # uncomment the following lines if you install assets as symlinks
+        # or run into problems when compiling LESS/Sass/CoffeScript assets
+        # <Directory /var/www/wallabag>
+        #     Options FollowSymlinks
+        # </Directory>
+
+        # optionally disable the RewriteEngine for the asset directories
+        # which will allow apache to simply reply with a 404 when files are
+        # not found instead of passing the request into the full symfony stack
+        <Directory /var/www/wallabag/web/bundles>
+            <IfModule mod_rewrite.c>
+                RewriteEngine Off
+            </IfModule>
+        </Directory>
+        ErrorLog /var/log/apache2/wallabag_error.log
+        CustomLog /var/log/apache2/wallabag_access.log combined
+    </VirtualHost>
+
+After reloading or restarting Apache, you should now be able to access wallabag at http://domain.tld.
+
+Installing on Nginx
+-------------------
+
+Assuming you install wallabag in the /var/www/wallabag folder, here's the recipe for wallabag :
+
+::
+
+    server {
+        server_name domain.tld www.domain.tld;
+        root /var/www/wallabag/web;
+
+        location / {
+            # try to serve file directly, fallback to app.php
+            try_files $uri /app.php$is_args$args;
+        }
+        location ~ ^/app\.php(/|$) {
+            fastcgi_pass unix:/var/run/php5-fpm.sock;
+            fastcgi_split_path_info ^(.+\.php)(/.*)$;
+            include fastcgi_params;
+            # When you are using symlinks to link the document root to the
+            # current version of your application, you should pass the real
+            # application path instead of the path to the symlink to PHP
+            # FPM.
+            # Otherwise, PHP's OPcache may not properly detect changes to
+            # your PHP files (see https://github.com/zendtech/ZendOptimizerPlus/issues/126
+            # for more information).
+            fastcgi_param  SCRIPT_FILENAME  $realpath_root$fastcgi_script_name;
+            fastcgi_param DOCUMENT_ROOT $realpath_root;
+            # Prevents URIs that include the front controller. This will 404:
+            # http://domain.tld/app.php/some-path
+            # Remove the internal directive to allow URIs like this
+            internal;
+        }
+
+        error_log /var/log/nginx/wallabag_error.log;
+        access_log /var/log/nginx/wallabag_access.log;
+    }
+
+After reloading or restarting nginx, you should now be able to access wallabag at http://domain.tld.

diff --git a/docs/fr/index.rst b/docs/fr/index.rst
index d4ff7296aeb3eff54389734c6ae8fec502b118f4..a47b8a62399f13701b9f0307fa3cd057224c367a 100644 (file)
--- a/docs/fr/index.rst
+++ b/docs/fr/index.rst
@@ -24,6 +24,7 @@ La documentation principale de cette application est découpée en plusieurs sec
    :maxdepth: 2
    :caption: Documentation utilisateur
 
+   user/installation
    user/create_account
    user/login
    user/configuration

diff --git a/docs/fr/user/installation.rst b/docs/fr/user/installation.rst
new file mode 100644 (file)
index 0000000..f19ad6f
--- /dev/null
+++ b/docs/fr/user/installation.rst
@@ -0,0 +1,143 @@
+Install wallabag
+================
+
+Pré-requis
+------------
+
+wallabag est compatible avec php >= 5.5
+
+Vous aurez besoin des extensions suivantes pour que wallabag fonctionne. Il est possible que certaines de ces extensions soient déjà activées dans votre version de php, donc vous n'avez pas forcément besoin d'installer tous les paquets correspondants.
+
+- php-session
+- php-ctype
+- php-dom
+- pĥp-hash
+- php-simplexml
+- php-json
+- php-gd
+- php-mbstring
+- php-xml
+- php-tidy
+- php-iconv
+- php-curl
+- php-gettext
+- php-tokenizer
+
+wallabag utilise PDO afin de se connecter à une base de données, donc vous aurez besoin d'une extension et d'un système de bases de données parmi :
+
+- php-pdo_mysql
+- php-pdo_sqlite
+- php-pdo_pgsql
+
+Installation
+------------
+
+wallabag utilise un grand nombre de bibliothèques pour fonctionner. Ces bibliothèques doivent être installées à l'aide d'un outil nommé Composer. Vous devez l'installer si ce n'est déjà fait.
+
+Installation de Composer :
+
+::
+
+    curl -s http://getcomposer.org/installer | php
+
+Vous pouvez trouver des instructions spécifiques ici (en anglais) : __ https://getcomposer.org/doc/00-intro.md
+
+Pour installer wallabag, vous devez exécuter ces deux commandes :
+
+::
+
+    SYMFONY_ENV=prod composer create-project wallabag/wallabag wallabag "2.0.*@alpha" --no-dev
+    php bin/console wallabag:install --env=prod
+
+Pour démarrer le serveur interne à php et vérifier que tout s'est installé correctement, vous pouvez exécuter :
+
+::
+
+    php bin/console server:run --env=prod
+
+Et accéder wallabag à l'adresse http://lipdevotreserveur:8000
+
+Installation avec Apache
+------------------------
+
+En imaginant que vous vouliez installer wallabag dans le dossier /var/www/wallabag et que vous utilisiez php comme un module Apache, voici un vhost pour wallabag :
+
+::
+
+    <VirtualHost *:80>
+        ServerName domain.tld
+        ServerAlias www.domain.tld
+
+        DocumentRoot /var/www/wallabag/web
+        <Directory /var/www/wallabag/web>
+            AllowOverride None
+            Order Allow,Deny
+            Allow from All
+
+            <IfModule mod_rewrite.c>
+                Options -MultiViews
+                RewriteEngine On
+                RewriteCond %{REQUEST_FILENAME} !-f
+                RewriteRule ^(.*)$ app.php [QSA,L]
+            </IfModule>
+        </Directory>
+
+        # uncomment the following lines if you install assets as symlinks
+        # or run into problems when compiling LESS/Sass/CoffeScript assets
+        # <Directory /var/www/wallabag>
+        #     Options FollowSymlinks
+        # </Directory>
+
+        # optionally disable the RewriteEngine for the asset directories
+        # which will allow apache to simply reply with a 404 when files are
+        # not found instead of passing the request into the full symfony stack
+        <Directory /var/www/wallabag/web/bundles>
+            <IfModule mod_rewrite.c>
+                RewriteEngine Off
+            </IfModule>
+        </Directory>
+        ErrorLog /var/log/apache2/wallabag_error.log
+        CustomLog /var/log/apache2/wallabag_access.log combined
+    </VirtualHost>
+
+Après que vous ayez rechargé/redémarré Apache, vous devriez pouvoir avoir accès à wallabag à l'adresse http://domain.tld.
+
+Installation avec Nginx
+-----------------------
+
+En imaginant que vous vouliez installer wallabag dans le dossier /var/www/wallabag, voici un fichier de configuration Nginx pour wallabag :
+
+::
+
+    server {
+        server_name domain.tld www.domain.tld;
+        root /var/www/wallabag/web;
+
+        location / {
+            # try to serve file directly, fallback to app.php
+            try_files $uri /app.php$is_args$args;
+        }
+        location ~ ^/app\.php(/|$) {
+            fastcgi_pass unix:/var/run/php5-fpm.sock;
+            fastcgi_split_path_info ^(.+\.php)(/.*)$;
+            include fastcgi_params;
+            # When you are using symlinks to link the document root to the
+            # current version of your application, you should pass the real
+            # application path instead of the path to the symlink to PHP
+            # FPM.
+            # Otherwise, PHP's OPcache may not properly detect changes to
+            # your PHP files (see https://github.com/zendtech/ZendOptimizerPlus/issues/126
+            # for more information).
+            fastcgi_param  SCRIPT_FILENAME  $realpath_root$fastcgi_script_name;
+            fastcgi_param DOCUMENT_ROOT $realpath_root;
+            # Prevents URIs that include the front controller. This will 404:
+            # http://domain.tld/app.php/some-path
+            # Remove the internal directive to allow URIs like this
+            internal;
+        }
+
+        error_log /var/log/nginx/wallabag_error.log;
+        access_log /var/log/nginx/wallabag_access.log;
+    }
+
+Après que vous ayez rechargé/redémarré Nginx, vous devriez pouvoir avoir accès à wallabag à l'adresse http://domain.tld.