aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorThomas Citharel <tcit@tcit.fr>2016-02-21 16:54:22 +0100
committerThomas Citharel <tcit@tcit.fr>2016-02-21 16:54:22 +0100
commit89d95cdd188a5f56fd7be0aff2b33b1e054eac11 (patch)
tree92c6c1a2fe13641384a24fae7e714e02aecffcfb
parente6ebb14f0fdbdb2b5b43102dd0adb67b17cef50c (diff)
downloadwallabag-89d95cdd188a5f56fd7be0aff2b33b1e054eac11.tar.gz
wallabag-89d95cdd188a5f56fd7be0aff2b33b1e054eac11.tar.zst
wallabag-89d95cdd188a5f56fd7be0aff2b33b1e054eac11.zip
improve installation documentation
-rw-r--r--docs/en/user/installation.rst126
-rw-r--r--docs/fr/user/installation.rst132
2 files changed, 250 insertions, 8 deletions
diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst
index 278f918f..c2c6cc55 100644
--- a/docs/en/user/installation.rst
+++ b/docs/en/user/installation.rst
@@ -4,20 +4,142 @@ Install wallabag
4Requirements 4Requirements
5------------ 5------------
6 6
7wallabag is compatible with php >= 5.5
8
9You'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.
10
11- php-session
12- php-ctype
13- php-dom
14- pĥp-hash
15- php-simplexml
16- php-json
17- php-gd
18- php-mbstring
19- php-xml
20- php-tidy
21- php-iconv
22- php-curl
23- php-gettext
24- php-tokenizer
25
26wallabag uses PDO to connect to database, so you'll need one of:
27
28- php-pdo_mysql
29- php-pdo_sqlite
30- php-pdo_pgsql
31
32and it's corresponding database server.
33
7Installation 34Installation
8------------ 35------------
9 36
37wallabag 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.
38
10Install Composer: 39Install Composer:
11 40
12:: 41::
13 42
14 curl -s http://getcomposer.org/installer | php 43 curl -s http://getcomposer.org/installer | php
15 44
16Next, on your web server, run this command: 45You can find specific instructions here : __ https://getcomposer.org/doc/00-intro.md
46
47To install wallabag itself, you must run these two commands:
17 48
18:: 49::
19 50
20 SYMFONY_ENV=prod composer create-project wallabag/wallabag wallabag "2.0.*@alpha" --no-dev 51 SYMFONY_ENV=prod composer create-project wallabag/wallabag wallabag "2.0.*@alpha" --no-dev
21 php bin/console wallabag:install --env=prod 52 php bin/console wallabag:install --env=prod
22 53
23Now you can access to http://yourwebsite/wallabag. 54To start php's build-in server and test if everything did install correctly, you can do:
55
56::
57
58 php bin/console server:run --env=prod
59
60And access wallabag at http://yourserverip:8000
61
62Installing on Apache
63--------------------
64
65Assuming 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:
66
67::
68
69 <VirtualHost *:80>
70 ServerName domain.tld
71 ServerAlias www.domain.tld
72
73 DocumentRoot /var/www/wallabag/web
74 <Directory /var/www/wallabag/web>
75 AllowOverride None
76 Order Allow,Deny
77 Allow from All
78
79 <IfModule mod_rewrite.c>
80 Options -MultiViews
81 RewriteEngine On
82 RewriteCond %{REQUEST_FILENAME} !-f
83 RewriteRule ^(.*)$ app.php [QSA,L]
84 </IfModule>
85 </Directory>
86
87 # uncomment the following lines if you install assets as symlinks
88 # or run into problems when compiling LESS/Sass/CoffeScript assets
89 # <Directory /var/www/wallabag>
90 # Options FollowSymlinks
91 # </Directory>
92
93 # optionally disable the RewriteEngine for the asset directories
94 # which will allow apache to simply reply with a 404 when files are
95 # not found instead of passing the request into the full symfony stack
96 <Directory /var/www/wallabag/web/bundles>
97 <IfModule mod_rewrite.c>
98 RewriteEngine Off
99 </IfModule>
100 </Directory>
101 ErrorLog /var/log/apache2/wallabag_error.log
102 CustomLog /var/log/apache2/wallabag_access.log combined
103 </VirtualHost>
104
105After reloading or restarting Apache, you should now be able to access wallabag at http://domain.tld.
106
107Installing on Nginx
108-------------------
109
110Assuming you install wallabag in the /var/www/wallabag folder, , here's the recipe for wallabag :
111
112::
113
114 server {
115 server_name domain.tld www.domain.tld;
116 root /var/www/wallabag/web;
117
118 location / {
119 # try to serve file directly, fallback to app.php
120 try_files $uri /app.php$is_args$args;
121 }
122 location ~ ^/app\.php(/|$) {
123 fastcgi_pass unix:/var/run/php5-fpm.sock;
124 fastcgi_split_path_info ^(.+\.php)(/.*)$;
125 include fastcgi_params;
126 # When you are using symlinks to link the document root to the
127 # current version of your application, you should pass the real
128 # application path instead of the path to the symlink to PHP
129 # FPM.
130 # Otherwise, PHP's OPcache may not properly detect changes to
131 # your PHP files (see https://github.com/zendtech/ZendOptimizerPlus/issues/126
132 # for more information).
133 fastcgi_param SCRIPT_FILENAME $realpath_root$fastcgi_script_name;
134 fastcgi_param DOCUMENT_ROOT $realpath_root;
135 # Prevents URIs that include the front controller. This will 404:
136 # http://domain.tld/app.php/some-path
137 # Remove the internal directive to allow URIs like this
138 internal;
139 }
140
141 error_log /var/log/nginx/wallabag_error.log;
142 access_log /var/log/nginx/wallabag_access.log;
143 }
144
145After reloading or restarting nginx, you should now be able to access wallabag at http://domain.tld.
diff --git a/docs/fr/user/installation.rst b/docs/fr/user/installation.rst
index fc550c2c..1d420a82 100644
--- a/docs/fr/user/installation.rst
+++ b/docs/fr/user/installation.rst
@@ -1,23 +1,143 @@
1Installer wallabag 1Install wallabag
2================== 2================
3 3
4Pré-requis 4Pré-requis
5---------- 5------------
6
7wallabag est compatible avec php >= 5.5
8
9Vous 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 packets correspondants.
10
11- php-session
12- php-ctype
13- php-dom
14- pĥp-hash
15- php-simplexml
16- php-json
17- php-gd
18- php-mbstring
19- php-xml
20- php-tidy
21- php-iconv
22- php-curl
23- php-gettext
24- php-tokenizer
25
26wallabag 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 :
27
28- php-pdo_mysql
29- php-pdo_sqlite
30- php-pdo_pgsql
6 31
7Installation 32Installation
8------------ 33------------
9 34
10Installez Composer: 35wallabag 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.
36
37Installation de Composer :
11 38
12:: 39::
13 40
14 curl -s http://getcomposer.org/installer | php 41 curl -s http://getcomposer.org/installer | php
15 42
16Ensuite, sur votre serveur web, exécutez cette commande : 43Vous pouvez trouver des instructions spécifiques ici (en anglais) : __ https://getcomposer.org/doc/00-intro.md
44
45Pour installer wallabag, vous devez excécuter ces deux commandes :
17 46
18:: 47::
19 48
20 SYMFONY_ENV=prod composer create-project wallabag/wallabag wallabag "2.0.*@alpha" --no-dev 49 SYMFONY_ENV=prod composer create-project wallabag/wallabag wallabag "2.0.*@alpha" --no-dev
21 php bin/console wallabag:install --env=prod 50 php bin/console wallabag:install --env=prod
22 51
23VOus pouvez maintenant accéder à wallabag ici http://votresiteweb/wallabag. 52Pour démarrer le serveur interne à php et vérifier que tout s'est installé correctement, vous pouvez exécuter :
53
54::
55
56 php bin/console server:run --env=prod
57
58Et accéder wallabag à l'adresse http://lipdevotreserveur:8000
59
60Installation avec Apache
61------------------------
62
63En 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 :
64
65::
66
67 <VirtualHost *:80>
68 ServerName domain.tld
69 ServerAlias www.domain.tld
70
71 DocumentRoot /var/www/wallabag/web
72 <Directory /var/www/wallabag/web>
73 AllowOverride None
74 Order Allow,Deny
75 Allow from All
76
77 <IfModule mod_rewrite.c>
78 Options -MultiViews
79 RewriteEngine On
80 RewriteCond %{REQUEST_FILENAME} !-f
81 RewriteRule ^(.*)$ app.php [QSA,L]
82 </IfModule>
83 </Directory>
84
85 # uncomment the following lines if you install assets as symlinks
86 # or run into problems when compiling LESS/Sass/CoffeScript assets
87 # <Directory /var/www/wallabag>
88 # Options FollowSymlinks
89 # </Directory>
90
91 # optionally disable the RewriteEngine for the asset directories
92 # which will allow apache to simply reply with a 404 when files are
93 # not found instead of passing the request into the full symfony stack
94 <Directory /var/www/wallabag/web/bundles>
95 <IfModule mod_rewrite.c>
96 RewriteEngine Off
97 </IfModule>
98 </Directory>
99 ErrorLog /var/log/apache2/wallabag_error.log
100 CustomLog /var/log/apache2/wallabag_access.log combined
101 </VirtualHost>
102
103Après que vous ayez recharché ou redémmaré Apache, vous devriez pouvoir avoir accès à wallabag à l'adresse http://domain.tld.
104
105Installation avec Nginx
106-----------------------
107
108En imaginant que vous vouliez installer wallabag dans le dossier /var/www/wallabag, voici un fichier de configuration Nginx pour wallabag :
109
110::
111
112 server {
113 server_name domain.tld www.domain.tld;
114 root /var/www/wallabag/web;
115
116 location / {
117 # try to serve file directly, fallback to app.php
118 try_files $uri /app.php$is_args$args;
119 }
120 location ~ ^/app\.php(/|$) {
121 fastcgi_pass unix:/var/run/php5-fpm.sock;
122 fastcgi_split_path_info ^(.+\.php)(/.*)$;
123 include fastcgi_params;
124 # When you are using symlinks to link the document root to the
125 # current version of your application, you should pass the real
126 # application path instead of the path to the symlink to PHP
127 # FPM.
128 # Otherwise, PHP's OPcache may not properly detect changes to
129 # your PHP files (see https://github.com/zendtech/ZendOptimizerPlus/issues/126
130 # for more information).
131 fastcgi_param SCRIPT_FILENAME $realpath_root$fastcgi_script_name;
132 fastcgi_param DOCUMENT_ROOT $realpath_root;
133 # Prevents URIs that include the front controller. This will 404:
134 # http://domain.tld/app.php/some-path
135 # Remove the internal directive to allow URIs like this
136 internal;
137 }
138
139 error_log /var/log/nginx/wallabag_error.log;
140 access_log /var/log/nginx/wallabag_access.log;
141 }
142
143Après que vous ayez recharché ou redémmaré Nginx, vous devriez pouvoir avoir accès à wallabag à l'adresse http://domain.tld.