diff options
Diffstat (limited to 'docs/en')
-rw-r--r-- | docs/en/developer/api.rst | 2 | ||||
-rw-r--r-- | docs/en/developer/redis.rst | 2 | ||||
-rw-r--r-- | docs/en/index.rst | 2 | ||||
-rw-r--r-- | docs/en/user/android.rst | 2 | ||||
-rw-r--r-- | docs/en/user/backup.rst | 25 | ||||
-rw-r--r-- | docs/en/user/configuration.rst | 2 | ||||
-rw-r--r-- | docs/en/user/installation.rst | 10 | ||||
-rw-r--r-- | docs/en/user/parameters.rst | 4 | ||||
-rw-r--r-- | docs/en/user/upgrade-2.0.x-2.1.1.rst | 5 | ||||
-rw-r--r-- | docs/en/user/upgrade-2.1.x-2.1.y.rst | 2 |
10 files changed, 43 insertions, 13 deletions
diff --git a/docs/en/developer/api.rst b/docs/en/developer/api.rst index 83f0bb8f..4828cddd 100644 --- a/docs/en/developer/api.rst +++ b/docs/en/developer/api.rst | |||
@@ -8,7 +8,7 @@ Requirements | |||
8 | 8 | ||
9 | * wallabag freshly (or not) installed on http://localhost:8000 | 9 | * wallabag freshly (or not) installed on http://localhost:8000 |
10 | * ``httpie`` installed on your computer (`see project website <https://github.com/jkbrzt/httpie>`__). Note that you can also adapt the commands using curl or wget. | 10 | * ``httpie`` installed on your computer (`see project website <https://github.com/jkbrzt/httpie>`__). Note that you can also adapt the commands using curl or wget. |
11 | * all the API methods are documented here http://localhost:8000/api/doc | 11 | * all the API methods are documented here http://localhost:8000/api/doc (on your instance) and `on our example instance <http://v2.wallabag.org/api/doc>`_ |
12 | 12 | ||
13 | Creating a new API client | 13 | Creating a new API client |
14 | ------------------------- | 14 | ------------------------- |
diff --git a/docs/en/developer/redis.rst b/docs/en/developer/redis.rst index 67b6452e..2e2bbbea 100644 --- a/docs/en/developer/redis.rst +++ b/docs/en/developer/redis.rst | |||
@@ -35,7 +35,7 @@ Edit your ``parameters.yml`` file to edit Redis configuration. The default one s | |||
35 | redis_host: localhost | 35 | redis_host: localhost |
36 | redis_port: 6379 | 36 | redis_port: 6379 |
37 | 37 | ||
38 | Enable Redos in wallabag | 38 | Enable Redis in wallabag |
39 | ------------------------ | 39 | ------------------------ |
40 | 40 | ||
41 | In internal settings, in the **Import** section, enable Redis (with the value 1). | 41 | In internal settings, in the **Import** section, enable Redis (with the value 1). |
diff --git a/docs/en/index.rst b/docs/en/index.rst index 4e346ae6..0ead261b 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst | |||
@@ -45,6 +45,8 @@ The documentation is available in other languages: | |||
45 | user/filters | 45 | user/filters |
46 | user/tags | 46 | user/tags |
47 | user/android | 47 | user/android |
48 | user/parameters | ||
49 | user/backup | ||
48 | 50 | ||
49 | .. _dev-docs: | 51 | .. _dev-docs: |
50 | 52 | ||
diff --git a/docs/en/user/android.rst b/docs/en/user/android.rst index ccbad264..91dcb2fc 100644 --- a/docs/en/user/android.rst +++ b/docs/en/user/android.rst | |||
@@ -79,7 +79,7 @@ Known limitations | |||
79 | 2FA | 79 | 2FA |
80 | ~~~ | 80 | ~~~ |
81 | 81 | ||
82 | Currently the does not support two-factor authentication. You should disable that to get the app working. | 82 | Currently the Android application does not support two-factor authentication. You should disable that to get the application working. |
83 | 83 | ||
84 | 84 | ||
85 | Limited amount of articles with wallabag v2 | 85 | Limited amount of articles with wallabag v2 |
diff --git a/docs/en/user/backup.rst b/docs/en/user/backup.rst new file mode 100644 index 00000000..51721000 --- /dev/null +++ b/docs/en/user/backup.rst | |||
@@ -0,0 +1,25 @@ | |||
1 | Backup wallabag | ||
2 | =============== | ||
3 | Because sometimes you may do a mistake with your wallabag and lose data or in case you need to move your wallabag to another server you want to backup your data. | ||
4 | This articles describes what you need to backup. | ||
5 | |||
6 | Basic settings | ||
7 | -------------- | ||
8 | wallabag stores some basic parameters (like SMTP server or database backend) in the file `app/config/parameters.yml`. | ||
9 | |||
10 | Database | ||
11 | -------- | ||
12 | As wallabag supports different kinds of database, the way to perform the backup depends on the database you use, so you need to refer to the vendor documentation. | ||
13 | |||
14 | Here's some examples: | ||
15 | |||
16 | - MySQL: http://dev.mysql.com/doc/refman/5.7/en/backup-methods.html | ||
17 | - PostgreSQL: https://www.postgresql.org/docs/current/static/backup.html | ||
18 | |||
19 | SQLite | ||
20 | ~~~~~~ | ||
21 | To backup the SQLite database, you just need to copy the directory `data/db` from the wallabag application directory. | ||
22 | |||
23 | Images | ||
24 | ------ | ||
25 | The images retrieved by wallabag are stored under `data/assets/images` (the images storage will be implemented in wallabag 2.2). | ||
diff --git a/docs/en/user/configuration.rst b/docs/en/user/configuration.rst index 824878dc..e7055a14 100644 --- a/docs/en/user/configuration.rst +++ b/docs/en/user/configuration.rst | |||
@@ -102,7 +102,7 @@ if *« readingTime >= 5 AND domainName = "github.com" »* then tag as *« long r | |||
102 | Which variables and operators can I use to write rules? | 102 | Which variables and operators can I use to write rules? |
103 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 103 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
104 | 104 | ||
105 | The following variables and operators can be used to create tagging rules: | 105 | The following variables and operators can be used to create tagging rules (be careful, for some values, you need to add quotes, for example ``language = "en"``): |
106 | 106 | ||
107 | =========== ============================================== ======== ========== | 107 | =========== ============================================== ======== ========== |
108 | Variable Meaning Operator Meaning | 108 | Variable Meaning Operator Meaning |
diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index 248c1995..45e14616 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst | |||
@@ -8,7 +8,7 @@ wallabag is compatible with PHP >= 5.5, including PHP 7. | |||
8 | 8 | ||
9 | .. note:: | 9 | .. note:: |
10 | 10 | ||
11 | To install wallabag easily, we create a ``Makefile``, so you need to have the ``make`` tool. | 11 | To install wallabag easily, we provide a ``Makefile``, so you need to have the ``make`` tool. |
12 | 12 | ||
13 | wallabag uses a large number of PHP libraries in order to function. These libraries must be installed with a tool called Composer. You need to install it if you have not already done so and be sure to use the 1.2 version (if you already have Composer, run a ``composer selfupdate``). | 13 | wallabag uses a large number of PHP libraries in order to function. These libraries must be installed with a tool called Composer. You need to install it if you have not already done so and be sure to use the 1.2 version (if you already have Composer, run a ``composer selfupdate``). |
14 | 14 | ||
@@ -95,7 +95,7 @@ If you changed the database configuration to use MySQL or PostgreSQL, you need t | |||
95 | Installation with Docker | 95 | Installation with Docker |
96 | ~~~~~~~~~~~~~~~~~~~~~~~~ | 96 | ~~~~~~~~~~~~~~~~~~~~~~~~ |
97 | 97 | ||
98 | We 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. | 98 | We provide you a Docker image to install wallabag easily. Have a look at our repository on `Docker Hub <https://hub.docker.com/r/wallabag/wallabag/>`__ for more information. |
99 | 99 | ||
100 | Command to launch container | 100 | Command to launch container |
101 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ | 101 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
@@ -194,12 +194,12 @@ After reloading or restarting nginx, you should now be able to access wallabag a | |||
194 | 194 | ||
195 | .. tip:: | 195 | .. tip:: |
196 | 196 | ||
197 | 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``. | 197 | When you want to import large files into wallabag, you need to add this line in your nginx configuration ``client_max_body_size XM; # allows file uploads up to X megabytes``. |
198 | 198 | ||
199 | Configuration on lighttpd | 199 | Configuration on lighttpd |
200 | ~~~~~~~~~~~~~~~~~~~~~~~~~ | 200 | ~~~~~~~~~~~~~~~~~~~~~~~~~ |
201 | 201 | ||
202 | Assuming 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): | 202 | Assuming 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): |
203 | 203 | ||
204 | :: | 204 | :: |
205 | 205 | ||
@@ -249,7 +249,7 @@ As soon as we use Apache or Nginx to access to our wallabag instance, and not fr | |||
249 | 249 | ||
250 | To do so, the folder name, known as ``DocumentRoot`` (for apache) or ``root`` (for Nginx), has to be absolutely accessible by the Apache/Nginx user. Its name is generally ``www-data``, ``apache`` or ``nobody`` (depending on linux system used). | 250 | To do so, the folder name, known as ``DocumentRoot`` (for apache) or ``root`` (for Nginx), has to be absolutely accessible by the Apache/Nginx user. Its name is generally ``www-data``, ``apache`` or ``nobody`` (depending on linux system used). |
251 | 251 | ||
252 | So the folder ``/var/www/wallabag/web`` has to be accessible by this last one. But this could be not enough if we just care about this folder, because we could meet a blank page or get an error 500 when trying to access to the homepage of the project. | 252 | So the folder ``/var/www/wallabag/web`` has to be accessible by this last one. But this may not be enough if we just care about this folder, because we could meet a blank page or get an error 500 when trying to access to the homepage of the project. |
253 | 253 | ||
254 | This is due to the fact that we will need to grant the same rights access on the folder ``/var/www/wallabag/var`` like those we gave on the folder ``/var/www/wallabag/web``. Thus, we fix this problem with the following command: | 254 | This is due to the fact that we will need to grant the same rights access on the folder ``/var/www/wallabag/var`` like those we gave on the folder ``/var/www/wallabag/web``. Thus, we fix this problem with the following command: |
255 | 255 | ||
diff --git a/docs/en/user/parameters.rst b/docs/en/user/parameters.rst index 2fca020e..c35cf3b8 100644 --- a/docs/en/user/parameters.rst +++ b/docs/en/user/parameters.rst | |||
@@ -9,7 +9,7 @@ What is the meaning of the parameters? | |||
9 | "database_name", "symfony", "name of your database" | 9 | "database_name", "symfony", "name of your database" |
10 | "database_user", "root", "user that can write to this database" | 10 | "database_user", "root", "user that can write to this database" |
11 | "database_password", "~", "password of that user" | 11 | "database_password", "~", "password of that user" |
12 | "database_path", "``""%kernel.root_dir%/../data/db/wallabag.sqlite""``", "only for SQLite, define where to put the database file. Leave it for other database" | 12 | "database_path", "``""%kernel.root_dir%/../data/db/wallabag.sqlite""``", "only for SQLite, define where to put the database file. Leave it empty for other database" |
13 | "database_table_prefix", "wallabag_", "all wallabag's tables will be prefixed with that string. You can include a ``_`` for clarity" | 13 | "database_table_prefix", "wallabag_", "all wallabag's tables will be prefixed with that string. You can include a ``_`` for clarity" |
14 | "database_socket", "null", "If your database is using a socket instead of tcp, put the path of the socket (other connection parameters will then be ignored)" | 14 | "database_socket", "null", "If your database is using a socket instead of tcp, put the path of the socket (other connection parameters will then be ignored)" |
15 | "database_charset", "utf8mb4", "For PostgreSQL & SQLite you should use utf8, for MySQL use utf8mb4 which handle emoji" | 15 | "database_charset", "utf8mb4", "For PostgreSQL & SQLite you should use utf8, for MySQL use utf8mb4 which handle emoji" |
@@ -39,7 +39,7 @@ What is the meaning of the parameters? | |||
39 | 39 | ||
40 | "rabbitmq_host", "localhost", "Host of your RabbitMQ" | 40 | "rabbitmq_host", "localhost", "Host of your RabbitMQ" |
41 | "rabbitmq_port", "5672", "Port of your RabbitMQ" | 41 | "rabbitmq_port", "5672", "Port of your RabbitMQ" |
42 | "rabbitmq_user", "guest", "Usee that can read queues" | 42 | "rabbitmq_user", "guest", "User that can read queues" |
43 | "rabbitmq_password", "guest", "Password of that user" | 43 | "rabbitmq_password", "guest", "Password of that user" |
44 | 44 | ||
45 | .. csv-table:: Redis configuration | 45 | .. csv-table:: Redis configuration |
diff --git a/docs/en/user/upgrade-2.0.x-2.1.1.rst b/docs/en/user/upgrade-2.0.x-2.1.1.rst index 2f08b7bd..4f9b9cee 100644 --- a/docs/en/user/upgrade-2.0.x-2.1.1.rst +++ b/docs/en/user/upgrade-2.0.x-2.1.1.rst | |||
@@ -2,7 +2,8 @@ Upgrade from 2.0.x to 2.1.1 | |||
2 | =========================== | 2 | =========================== |
3 | 3 | ||
4 | .. warning:: | 4 | .. warning:: |
5 | Before this migration, if you configured the Pocket import by adding your consumer key in Internal settings, please do a backup of it: you'll have to add it into the Config page after the upgrade. | 5 | |
6 | Before this migration, if you configured the Pocket import by adding your consumer key in Internal settings, please do a backup of it: you'll have to add it into the Config page after the upgrade. | ||
6 | 7 | ||
7 | Upgrade on a dedicated web server | 8 | Upgrade on a dedicated web server |
8 | --------------------------------- | 9 | --------------------------------- |
@@ -64,6 +65,8 @@ Please check that your ``app/config/parameters.yml`` contains all the required p | |||
64 | redis_host: localhost | 65 | redis_host: localhost |
65 | redis_port: 6379 | 66 | redis_port: 6379 |
66 | 67 | ||
68 | You can find `here a documentation about parameters <http://doc.wallabag.org/en/master/user/parameters.html>`_. | ||
69 | |||
67 | If you use SQLite, you must also copy your ``data/`` folder inside the new installation. | 70 | If you use SQLite, you must also copy your ``data/`` folder inside the new installation. |
68 | 71 | ||
69 | Empty ``var/cache`` folder. | 72 | Empty ``var/cache`` folder. |
diff --git a/docs/en/user/upgrade-2.1.x-2.1.y.rst b/docs/en/user/upgrade-2.1.x-2.1.y.rst index 575f4ba9..62cb7dc0 100644 --- a/docs/en/user/upgrade-2.1.x-2.1.y.rst +++ b/docs/en/user/upgrade-2.1.x-2.1.y.rst | |||
@@ -26,7 +26,7 @@ Download the last release of wallabag: | |||
26 | 26 | ||
27 | wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package | 27 | wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package |
28 | 28 | ||
29 | (md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``) | 29 | You will find the `md5 hash of the latest package on our website <https://www.wallabag.org/pages/download-wallabag.html>`_. |
30 | 30 | ||
31 | Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. | 31 | Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. |
32 | 32 | ||