aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/en/user
diff options
context:
space:
mode:
authorJeremy Benoist <j0k3r@users.noreply.github.com>2016-05-07 11:10:21 +0200
committerJeremy Benoist <j0k3r@users.noreply.github.com>2016-05-07 11:10:21 +0200
commit1556c925a42619c1298edebb73eb86c009b3f3c8 (patch)
tree2e893a9ed9ab1fb28db290d3643d7945e0ad611b /docs/en/user
parentf54de6817ea320e6d92bea368123b2fb1395d95f (diff)
parente0f4f25fd6fba6f41532e9bf5cb6fa4c515c7a46 (diff)
downloadwallabag-1556c925a42619c1298edebb73eb86c009b3f3c8.tar.gz
wallabag-1556c925a42619c1298edebb73eb86c009b3f3c8.tar.zst
wallabag-1556c925a42619c1298edebb73eb86c009b3f3c8.zip
Merge pull request #2016 from wallabag/update-documentation
Update documentation
Diffstat (limited to 'docs/en/user')
-rw-r--r--docs/en/user/create_account.rst21
-rw-r--r--docs/en/user/faq.rst25
-rw-r--r--docs/en/user/import.rst43
-rw-r--r--docs/en/user/installation.rst99
-rw-r--r--docs/en/user/login.rst10
-rw-r--r--docs/en/user/migration.rst4
-rw-r--r--docs/en/user/upgrade.rst12
7 files changed, 125 insertions, 89 deletions
diff --git a/docs/en/user/create_account.rst b/docs/en/user/create_account.rst
index f0110e55..2e883c88 100644
--- a/docs/en/user/create_account.rst
+++ b/docs/en/user/create_account.rst
@@ -23,24 +23,3 @@ Your account is now activated.
23.. image:: ../../img/user/activated_account.png 23.. image:: ../../img/user/activated_account.png
24 :alt: Welcome on board! 24 :alt: Welcome on board!
25 :align: center 25 :align: center
26
27Frequently asked questions
28--------------------------
29
30I can't valid the registration form
31~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
32
33Make sure that all fields are well filled:
34
35* valid email address
36* same passwords in two fields
37
38I don't receive my activation email
39~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
40
41Are you sure your email address was correct? Did you check your spams folder?
42
43When I click on the activation link, I've got this message: ``The user with confirmation token "DtrOPfbQeVkWf6N" does not exist``.
44~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
45
46You already enabled your account or the URL of the activation email is wrong.
diff --git a/docs/en/user/faq.rst b/docs/en/user/faq.rst
index 04fb25e3..1e36dc26 100644
--- a/docs/en/user/faq.rst
+++ b/docs/en/user/faq.rst
@@ -8,3 +8,28 @@ It seems you have a problem with your ``composer`` installation. Try to uninstal
8 8
9`Read the documentation about composer to know how to install it 9`Read the documentation about composer to know how to install it
10<https://getcomposer.org/doc/00-intro.md>`__. 10<https://getcomposer.org/doc/00-intro.md>`__.
11
12I can't valid the registration form
13-----------------------------------
14
15Make sure that all fields are well filled:
16
17* valid email address
18* same passwords in two fields
19
20I don't receive my activation email
21-----------------------------------
22
23Are you sure your email address was correct? Did you check your spams folder?
24
25When I click on the activation link, I've got this message: ``The user with confirmation token "DtrOPfbQeVkWf6N" does not exist``.
26----------------------------------------------------------------------------------------------------------------------------------
27
28You already enabled your account or the URL of the activation email is wrong.
29
30I forgot my password
31--------------------
32
33You can reset your password by clicking on ``Forgot your password?`` link,
34on the login page. Then, fill the form with your email address or your username,
35you'll receive an email to reset your password.
diff --git a/docs/en/user/import.rst b/docs/en/user/import.rst
index d6054d39..63210484 100644
--- a/docs/en/user/import.rst
+++ b/docs/en/user/import.rst
@@ -1,42 +1,5 @@
1Migrate to wallabag 1Migrate from a third service
2=================== 2============================
3
4From wallabag
5-------------
6
7Export your data from your wallabag 1.x
8~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9
10On your config page, click on ``JSON export`` in the ``Export your wallabag data`` section.
11
12.. image:: ../../img/user/export_wllbg_1.png
13 :alt: Export from wallabag 1.x
14 :align: center
15
16You will have a ``wallabag-export-1-1970-01-01.json`` file.
17
18Export your data from your wallabag 2.x
19~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20
21On the export sidebar, click on ``JSON``.
22
23.. image:: ../../img/user/export_wllbg_2.png
24 :alt: Export from wallabag 2.x
25 :align: center
26
27You will have a ``Unread articles.json`` file.
28
29Import your data into wallabag 2.x
30~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
31
32Click on ``Import`` link in the menu, choose the right wallabag version,
33select your export file on your computer and import it.
34
35.. image:: ../../img/user/import_wllbg.png
36 :alt: Import from wallabag 1.x
37 :align: center
38
39All your wallabag articles will be imported.
40 3
41From Pocket 4From Pocket
42----------- 5-----------
@@ -53,7 +16,7 @@ a new application on their developer website to continue.
53 and submit your new application 16 and submit your new application
54 17
55Pocket will give you a **Consumer Key** (for example, `49961-985e4b92fe21fe4c78d682c1`). 18Pocket will give you a **Consumer Key** (for example, `49961-985e4b92fe21fe4c78d682c1`).
56You need to configure the ``pocket_consumer_key`` into the ``app/config/parameters.yml`` file in wallabag. 19You need to configure the ``pocket_consumer_key`` into the ``Import`` section in the ``Internal settings`` menu.
57 20
58Now, all is fine to migrate from Pocket. 21Now, all is fine to migrate from Pocket.
59 22
diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst
index c2174a53..d22f8549 100644
--- a/docs/en/user/installation.rst
+++ b/docs/en/user/installation.rst
@@ -34,6 +34,9 @@ and it's corresponding database server.
34Installation 34Installation
35------------ 35------------
36 36
37On a dedicated web server (recommended way)
38~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
39
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. 40wallabag 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 41
39Install Composer: 42Install Composer:
@@ -54,7 +57,7 @@ To install wallabag itself, you must run these two commands:
54 SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist 57 SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
55 php bin/console wallabag:install --env=prod 58 php bin/console wallabag:install --env=prod
56 59
57To start php's build-in server and test if everything did install correctly, you can do: 60To start PHP's build-in server and test if everything did install correctly, you can do:
58 61
59:: 62::
60 63
@@ -62,14 +65,48 @@ To start php's build-in server and test if everything did install correctly, you
62 65
63And access wallabag at http://yourserverip:8000 66And access wallabag at http://yourserverip:8000
64 67
65.. note:: 68.. tip::
66 69
67 To define parameters with environment variables, you have to set these variables with ``SYMFONY__`` prefix. For example, ``SYMFONY__DATABASE_DRIVER``. You can have a look to the `Symfony documentation <http://symfony.com/doc/current/cookbook/configuration/external_parameters.html>`__. 70 To define parameters with environment variables, you have to set these variables with ``SYMFONY__`` prefix. For example, ``SYMFONY__DATABASE_DRIVER``. You can have a look to the `Symfony documentation <http://symfony.com/doc/current/cookbook/configuration/external_parameters.html>`__.
68 71
69Installing on Apache 72On a shared hosting
70-------------------- 73~~~~~~~~~~~~~~~~~~~
74
75We provide you a package with all dependancies inside.
76The default configuration uses SQLite for the database. If you want to change these settings, please edit ``app/config/parameters.yml``.
77
78We already created a user: login and password are ``wallabag``.
79
80.. caution:: With this package, wallabag don't check mandatory extensions used in the application (theses checks are made during ``composer install`` when you have a dedicated web server, see above).
81
82Execute this command to download and extract the latest package:
83
84.. code-block:: bash
71 85
72Assuming 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: 86 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
87
88Now, read the following documentation to create your virtual host, then access to your wallabag.
89If you changed the database configuration to use MySQL or PostgreSQL, you need to create a user via this command ``php bin/console wallabag:install --env=prod``.
90
91Installation with Docker
92------------------------
93
94We provide you a Docker image to install wallabag easily. Have a look to our repository on `Docker Hub <https://hub.docker.com/r/wallabag/wallabag/>`__ to have more information.
95
96Command to launch container
97~~~~~~~~~~~~~~~~~~~~~~~~~~~
98
99.. code-block:: bash
100
101 docker pull wallabag/wallabag
102
103Virtual hosts
104-------------
105
106Configuration on Apache
107~~~~~~~~~~~~~~~~~~~~~~~
108
109Assuming 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:
73 110
74:: 111::
75 112
@@ -111,10 +148,10 @@ Assuming you install wallabag in the /var/www/wallabag folder and that you want
111 148
112After reloading or restarting Apache, you should now be able to access wallabag at http://domain.tld. 149After reloading or restarting Apache, you should now be able to access wallabag at http://domain.tld.
113 150
114Installing on Nginx 151Configuration on Nginx
115------------------- 152~~~~~~~~~~~~~~~~~~~~~~
116 153
117Assuming you install wallabag in the /var/www/wallabag folder, here's the recipe for wallabag : 154Assuming you install wallabag in the ``/var/www/wallabag`` folder, here's the recipe for wallabag :
118 155
119:: 156::
120 157
@@ -151,22 +188,57 @@ Assuming you install wallabag in the /var/www/wallabag folder, here's the recipe
151 188
152After reloading or restarting nginx, you should now be able to access wallabag at http://domain.tld. 189After reloading or restarting nginx, you should now be able to access wallabag at http://domain.tld.
153 190
154.. note:: 191.. tip::
155 192
156 When you want to import large file into wallabag, you need to add this line in your nginx configuration ``client_max_body_size XM; # allows file uploads up to X megabytes``. 193 When you want to import large file into wallabag, you need to add this line in your nginx configuration ``client_max_body_size XM; # allows file uploads up to X megabytes``.
157 194
195Configuration on lighttpd
196~~~~~~~~~~~~~~~~~~~~~~~~~
197
198Assuming you install wallabag in the /var/www/wallabag folder, here's the recipe for wallabag (edit your ``lighttpd.conf`` file and paste this configuration into it):
199
200::
201
202 server.modules = (
203 "mod_fastcgi",
204 "mod_access",
205 "mod_alias",
206 "mod_compress",
207 "mod_redirect",
208 "mod_rewrite",
209 )
210 server.document-root = "/var/www/wallabag/web"
211 server.upload-dirs = ( "/var/cache/lighttpd/uploads" )
212 server.errorlog = "/var/log/lighttpd/error.log"
213 server.pid-file = "/var/run/lighttpd.pid"
214 server.username = "www-data"
215 server.groupname = "www-data"
216 server.port = 80
217 server.follow-symlink = "enable"
218 index-file.names = ( "index.php", "index.html", "index.lighttpd.html")
219 url.access-deny = ( "~", ".inc" )
220 static-file.exclude-extensions = ( ".php", ".pl", ".fcgi" )
221 compress.cache-dir = "/var/cache/lighttpd/compress/"
222 compress.filetype = ( "application/javascript", "text/css", "text/html", "text/plain" )
223 include_shell "/usr/share/lighttpd/use-ipv6.pl " + server.port
224 include_shell "/usr/share/lighttpd/create-mime.assign.pl"
225 include_shell "/usr/share/lighttpd/include-conf-enabled.pl"
226 dir-listing.activate = "disable"
227
228 url.rewrite-if-not-file = (
229 "^/([^?])(?:\?(.))?" => "/app.php?$1&$2",
230 "^/([^?]*)" => "/app.php?=$1",
231 )
158 232
159Rights access to the folders of the project 233Rights access to the folders of the project
160------------------------------------------- 234-------------------------------------------
161 235
162 236Test environment
163Test Environment
164~~~~~~~~~~~~~~~~ 237~~~~~~~~~~~~~~~~
165 238
166When we just want to test wallabag, we just run the command ``php bin/console server:run --env=prod`` to start our wallabag instance and everything will go smoothly because the user who started the project can access to the current folder naturally, without any problem. 239When we just want to test wallabag, we just run the command ``php bin/console server:run --env=prod`` to start our wallabag instance and everything will go smoothly because the user who started the project can access to the current folder naturally, without any problem.
167 240
168 241Production environment
169Production Environment
170~~~~~~~~~~~~~~~~~~~~~~ 242~~~~~~~~~~~~~~~~~~~~~~
171 243
172As soon as we use Apache or Nginx to access to our wallabag instance, and not from the command ``php bin/console server:run --env=prod`` to start it, we should take care to grant the good rights on the good folders to keep safe all the folders of the project. 244As soon as we use Apache or Nginx to access to our wallabag instance, and not from the command ``php bin/console server:run --env=prod`` to start it, we should take care to grant the good rights on the good folders to keep safe all the folders of the project.
@@ -180,4 +252,3 @@ This is due to the fact that we will need to grant the same rights access on the
180.. code-block:: bash 252.. code-block:: bash
181 253
182 chown -R www-data:www-data /var/www/wallabag/var 254 chown -R www-data:www-data /var/www/wallabag/var
183
diff --git a/docs/en/user/login.rst b/docs/en/user/login.rst
index 1813f3d8..e66089bd 100644
--- a/docs/en/user/login.rst
+++ b/docs/en/user/login.rst
@@ -11,13 +11,3 @@ you can check the ``Keep me logged in`` checkbox: wallabag will remember you for
11.. image:: ../../img/user/login_form.png 11.. image:: ../../img/user/login_form.png
12 :alt: Login form 12 :alt: Login form
13 :align: center 13 :align: center
14
15Frequently asked questions
16--------------------------
17
18I forgot my password
19~~~~~~~~~~~~~~~~~~~~
20
21You can reset your password by clicking on ``Forgot your password?`` link,
22on the login page. Then, fill the form with your email address or your username,
23you'll receive an email to reset your password.
diff --git a/docs/en/user/migration.rst b/docs/en/user/migration.rst
index e97c6315..e141ae40 100644
--- a/docs/en/user/migration.rst
+++ b/docs/en/user/migration.rst
@@ -1,5 +1,5 @@
1Migrate wallabag 1Migrate from v1 or v2
2================ 2=====================
3 3
4From wallabag 1.x 4From wallabag 1.x
5----------------- 5-----------------
diff --git a/docs/en/user/upgrade.rst b/docs/en/user/upgrade.rst
index e4735631..7782dc8a 100644
--- a/docs/en/user/upgrade.rst
+++ b/docs/en/user/upgrade.rst
@@ -5,6 +5,7 @@ Upgrade on a dedicated web server
5--------------------------------- 5---------------------------------
6 6
7The last release is published on https://www.wallabag.org/pages/download-wallabag.html. In order to upgrade your wallabag installation and get the last version, run the following commands in you wallabag folder (replace ``2.0.3`` by the last release number): 7The last release is published on https://www.wallabag.org/pages/download-wallabag.html. In order to upgrade your wallabag installation and get the last version, run the following commands in you wallabag folder (replace ``2.0.3`` by the last release number):
8
8:: 9::
9 10
10 git fetch origin 11 git fetch origin
@@ -12,12 +13,19 @@ The last release is published on https://www.wallabag.org/pages/download-wallaba
12 git checkout 2.0.3 13 git checkout 2.0.3
13 SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist 14 SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
14 php bin/console cache:clear --env=prod 15 php bin/console cache:clear --env=prod
15
16 16
17Upgrade on a shared hosting 17Upgrade on a shared hosting
18--------------------------- 18---------------------------
19 19
20Backup your ``app/config/parameters.yml`` file. Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. 20Backup your ``app/config/parameters.yml`` file.
21
22Download the last release of wallabag:
23
24.. code-block:: bash
25
26 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
27
28Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours.
21 29
22If you use SQLite, you must also copy your ``data/`` folder inside the new installation. 30If you use SQLite, you must also copy your ``data/`` folder inside the new installation.
23 31