diff options
Diffstat (limited to 'docs/en')
-rw-r--r-- | docs/en/developer/asynchronous.rst | 3 | ||||
-rw-r--r-- | docs/en/developer/maintenance.rst | 32 | ||||
-rw-r--r-- | docs/en/developer/paywall.rst | 56 | ||||
-rw-r--r-- | docs/en/developer/translate.rst | 2 | ||||
-rw-r--r-- | docs/en/index.rst | 2 | ||||
-rw-r--r-- | docs/en/user/configuration.rst | 14 | ||||
-rw-r--r-- | docs/en/user/filters.rst | 5 | ||||
-rw-r--r-- | docs/en/user/import.rst | 32 | ||||
-rw-r--r-- | docs/en/user/parameters.rst | 3 |
9 files changed, 106 insertions, 43 deletions
diff --git a/docs/en/developer/asynchronous.rst b/docs/en/developer/asynchronous.rst index 6a991cf6..2e409e4a 100644 --- a/docs/en/developer/asynchronous.rst +++ b/docs/en/developer/asynchronous.rst | |||
@@ -48,6 +48,7 @@ Edit your ``app/config/parameters.yml`` file to edit RabbitMQ configuration. The | |||
48 | rabbitmq_port: 5672 | 48 | rabbitmq_port: 5672 |
49 | rabbitmq_user: guest | 49 | rabbitmq_user: guest |
50 | rabbitmq_password: guest | 50 | rabbitmq_password: guest |
51 | rabbitmq_prefetch_count: 10 # read http://www.rabbitmq.com/consumer-prefetch.html | ||
51 | 52 | ||
52 | Enable RabbitMQ in wallabag | 53 | Enable RabbitMQ in wallabag |
53 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ | 54 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
@@ -150,7 +151,7 @@ Depending on which service you want to import from you need to enable one (or ma | |||
150 | bin/console wallabag:import:redis-worker -e=prod firefox -vv >> /path/to/wallabag/var/logs/redis-firefox.log | 151 | bin/console wallabag:import:redis-worker -e=prod firefox -vv >> /path/to/wallabag/var/logs/redis-firefox.log |
151 | 152 | ||
152 | # for Chrome import | 153 | # for Chrome import |
153 | bin/console wallabag:import:redis-worker -e=prod instapaper -vv >> /path/to/wallabag/var/logs/redis-chrome.log | 154 | bin/console wallabag:import:redis-worker -e=prod chrome -vv >> /path/to/wallabag/var/logs/redis-chrome.log |
154 | 155 | ||
155 | If you want to launch the import only for some messages and not all, you can specify this number (here 12) and the worker will stop right after the 12th message : | 156 | If you want to launch the import only for some messages and not all, you can specify this number (here 12) and the worker will stop right after the 12th message : |
156 | 157 | ||
diff --git a/docs/en/developer/maintenance.rst b/docs/en/developer/maintenance.rst deleted file mode 100644 index 6d55ed60..00000000 --- a/docs/en/developer/maintenance.rst +++ /dev/null | |||
@@ -1,32 +0,0 @@ | |||
1 | Maintenance mode | ||
2 | ================ | ||
3 | |||
4 | If you have some long tasks to do on your wallabag instance, you can enable a maintenance mode. | ||
5 | Nobody will have access to your instance. | ||
6 | |||
7 | Enable maintenance mode | ||
8 | ----------------------- | ||
9 | |||
10 | To enable maintenance mode, execute this command: | ||
11 | |||
12 | :: | ||
13 | |||
14 | bin/console lexik:maintenance:lock --no-interaction -e=prod | ||
15 | |||
16 | You can set your IP address in ``app/config/config.yml`` if you want to access to wallabag even if maintenance mode is enabled. For example: | ||
17 | |||
18 | :: | ||
19 | |||
20 | lexik_maintenance: | ||
21 | authorized: | ||
22 | ips: ['127.0.0.1'] | ||
23 | |||
24 | |||
25 | Disable maintenance mode | ||
26 | ------------------------ | ||
27 | |||
28 | To disable maintenance mode, execute this command: | ||
29 | |||
30 | :: | ||
31 | |||
32 | bin/console lexik:maintenance:unlock -e=prod | ||
diff --git a/docs/en/developer/paywall.rst b/docs/en/developer/paywall.rst new file mode 100644 index 00000000..365027b4 --- /dev/null +++ b/docs/en/developer/paywall.rst | |||
@@ -0,0 +1,56 @@ | |||
1 | Articles behind a paywall | ||
2 | ========================= | ||
3 | |||
4 | wallabag can fetch articles from websites which use a paywall system. | ||
5 | |||
6 | Enable paywall authentication | ||
7 | ----------------------------- | ||
8 | |||
9 | In internal settings, in the **Article** section, enable authentication for websites with paywall (with the value 1). | ||
10 | |||
11 | Configure credentials in wallabag | ||
12 | --------------------------------- | ||
13 | |||
14 | Edit your ``app/config/parameters.yml`` file to edit credentials for each website with paywall. Here is an example for some french websites: | ||
15 | |||
16 | .. code:: yaml | ||
17 | |||
18 | sites_credentials: | ||
19 | mediapart.fr: {username: "myMediapartLogin", password: "mypassword"} | ||
20 | arretsurimages.net: {username: "myASILogin", password: "mypassword"} | ||
21 | |||
22 | .. note:: | ||
23 | |||
24 | These credentials will be shared between each user of your wallabag instance. | ||
25 | |||
26 | Parsing configuration files | ||
27 | --------------------------- | ||
28 | |||
29 | .. note:: | ||
30 | |||
31 | Read `this part of the documentation <http://doc.wallabag.org/en/master/user/errors_during_fetching.html>`_ to understand the configuration files. | ||
32 | |||
33 | Each parsing configuration file needs to be improved by adding ``requires_login``, ``login_uri``, | ||
34 | ``login_username_field``, ``login_password_field`` and ``not_logged_in_xpath``. | ||
35 | |||
36 | Be careful, the login form must be in the page content when wallabag loads it. It's impossible for wallabag to be authenticated | ||
37 | on a website where the login form is loaded after the page (by ajax for example). | ||
38 | |||
39 | ``login_uri`` is the action URL of the form (``action`` attribute in the form). | ||
40 | ``login_username_field`` is the ``name`` attribute of the login field. | ||
41 | ``login_password_field`` is the ``name`` attribute of the password field. | ||
42 | |||
43 | For example: | ||
44 | |||
45 | .. code:: | ||
46 | |||
47 | title://div[@id="titrage-contenu"]/h1[@class="title"] | ||
48 | body: //div[@class="contenu-html"]/div[@class="page-pane"] | ||
49 | |||
50 | requires_login: yes | ||
51 | |||
52 | login_uri: http://www.arretsurimages.net/forum/login.php | ||
53 | login_username_field: username | ||
54 | login_password_field: password | ||
55 | |||
56 | not_logged_in_xpath: //body[@class="not-logged-in"] | ||
diff --git a/docs/en/developer/translate.rst b/docs/en/developer/translate.rst index d412d3e9..1e5d5009 100644 --- a/docs/en/developer/translate.rst +++ b/docs/en/developer/translate.rst | |||
@@ -20,7 +20,7 @@ is the ISO 639-1 code of your language (`see wikipedia <https://en.wikipedia.org | |||
20 | Other files to translate: | 20 | Other files to translate: |
21 | 21 | ||
22 | - https://github.com/wallabag/wallabag/tree/master/app/Resources/CraueConfigBundle/translations. | 22 | - https://github.com/wallabag/wallabag/tree/master/app/Resources/CraueConfigBundle/translations. |
23 | - https://github.com/wallabag/wallabag/tree/master/app/Resources/FOSUserBundle/translations. | 23 | - https://github.com/wallabag/wallabag/tree/master/src/Wallabag/UserBundle/Resources/translations. |
24 | 24 | ||
25 | You have to create ``THE_TRANSLATION_FILE.CODE.yml`` files. | 25 | You have to create ``THE_TRANSLATION_FILE.CODE.yml`` files. |
26 | 26 | ||
diff --git a/docs/en/index.rst b/docs/en/index.rst index 77425bfa..2e20aee6 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst | |||
@@ -46,7 +46,7 @@ The documentation is available in other languages: | |||
46 | 46 | ||
47 | developer/api | 47 | developer/api |
48 | developer/docker | 48 | developer/docker |
49 | developer/paywall | ||
49 | developer/documentation | 50 | developer/documentation |
50 | developer/translate | 51 | developer/translate |
51 | developer/maintenance | ||
52 | developer/asynchronous | 52 | developer/asynchronous |
diff --git a/docs/en/user/configuration.rst b/docs/en/user/configuration.rst index 2c1385a8..caca834f 100644 --- a/docs/en/user/configuration.rst +++ b/docs/en/user/configuration.rst | |||
@@ -26,6 +26,15 @@ Reading speed | |||
26 | wallabag calculates a reading time for each article. You can define here, thanks to this list, if you are | 26 | wallabag calculates a reading time for each article. You can define here, thanks to this list, if you are |
27 | a fast or a slow reader. wallabag will recalculate the reading time for each article. | 27 | a fast or a slow reader. wallabag will recalculate the reading time for each article. |
28 | 28 | ||
29 | Where do you want to be redirected after mark an article as read? | ||
30 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
31 | |||
32 | Each time you'll do some actions (after marking an article as read/favorite, | ||
33 | after deleting an article, after removing a tag from an entry), you can be redirected: | ||
34 | |||
35 | - To the homepage | ||
36 | - To the current page | ||
37 | |||
29 | Language | 38 | Language |
30 | ~~~~~~~~ | 39 | ~~~~~~~~ |
31 | 40 | ||
@@ -43,11 +52,16 @@ Now you have three links, one for each status: add them into your favourite RSS | |||
43 | 52 | ||
44 | You can also define how many articles you want in each RSS feed (default value: 50). | 53 | You can also define how many articles you want in each RSS feed (default value: 50). |
45 | 54 | ||
55 | There is also a pagination available for these feeds. You can add ``?page=2`` to jump to the second page. | ||
56 | The pagination follow `the RFC <https://tools.ietf.org/html/rfc5005#page-4>`_ about that, which means you'll find the ``next``, ``previous`` & ``last`` page link inside the `<channel>` tag of each RSS feed. | ||
57 | |||
46 | User information | 58 | User information |
47 | ---------------- | 59 | ---------------- |
48 | 60 | ||
49 | You can change your name, your email address and enable ``Two factor authentication``. | 61 | You can change your name, your email address and enable ``Two factor authentication``. |
50 | 62 | ||
63 | If the wallabag instance has more than one enabled user, you can delete your account here. **Take care, we delete all your data**. | ||
64 | |||
51 | Two factor authentication (2FA) | 65 | Two factor authentication (2FA) |
52 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 66 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
53 | 67 | ||
diff --git a/docs/en/user/filters.rst b/docs/en/user/filters.rst index 4d1df6eb..aae8a749 100644 --- a/docs/en/user/filters.rst +++ b/docs/en/user/filters.rst | |||
@@ -30,6 +30,11 @@ Language | |||
30 | wallabag (via graby) can detect article language. It's easy to you to retrieve articles | 30 | wallabag (via graby) can detect article language. It's easy to you to retrieve articles |
31 | written in a specific language. | 31 | written in a specific language. |
32 | 32 | ||
33 | HTTP status | ||
34 | ----------- | ||
35 | |||
36 | You can retrieve the articles by filtering by their HTTP status code: 200, 404, 500, etc. | ||
37 | |||
33 | Reading time | 38 | Reading time |
34 | ------------ | 39 | ------------ |
35 | 40 | ||
diff --git a/docs/en/user/import.rst b/docs/en/user/import.rst index a6754fa0..f420a131 100644 --- a/docs/en/user/import.rst +++ b/docs/en/user/import.rst | |||
@@ -1,13 +1,13 @@ | |||
1 | Migrate from ... | 1 | Migrate from ... |
2 | ================ | 2 | ================ |
3 | 3 | ||
4 | In wallabag 2.x, you can import data from: | 4 | In wallabag 2.x, you can import data from: |
5 | 5 | ||
6 | - `Pocket <#id1>`_ | 6 | - `Pocket <#id1>`_ |
7 | - `Readability <#id2>`_ | 7 | - `Readability <#id2>`_ |
8 | - `Instapaper <#id4>`_ | 8 | - `Instapaper <#id4>`_ |
9 | - `wallabag 1.x <#id6>`_ | 9 | - `wallabag 1.x <#id6>`_ |
10 | - `wallabag 2.x <#id7>`_ | 10 | - `wallabag 2.x <#id7>`_ |
11 | 11 | ||
12 | We also developed `a script to execute migrations via command-line interface <#import-via-command-line-interface-cli>`_. | 12 | We also developed `a script to execute migrations via command-line interface <#import-via-command-line-interface-cli>`_. |
13 | 13 | ||
@@ -57,8 +57,24 @@ and then select your json file and upload it. | |||
57 | 57 | ||
58 | Your data will be imported. Data import can be a demanding process for your server. | 58 | Your data will be imported. Data import can be a demanding process for your server. |
59 | 59 | ||
60 | Instapaper | 60 | From Pinboard |
61 | ---------- | 61 | ------------- |
62 | |||
63 | Export your Pinboard data | ||
64 | ~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
65 | |||
66 | On the backup (`https://pinboard.in/settings/backup <https://pinboard.in/settings/backup>`_) page, click on "JSON" in the "Bookmarks" section. A JSON file will be downloaded (like ``pinboard_export``). | ||
67 | |||
68 | Import your data into wallabag 2.x | ||
69 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
70 | |||
71 | Click on ``Import`` link in the menu, on ``Import contents`` in Pinboard section | ||
72 | and then select your json file and upload it. | ||
73 | |||
74 | Your data will be imported. Data import can be a demanding process for your server. | ||
75 | |||
76 | From Instapaper | ||
77 | --------------- | ||
62 | 78 | ||
63 | Export your Instapaper data | 79 | Export your Instapaper data |
64 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 80 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
diff --git a/docs/en/user/parameters.rst b/docs/en/user/parameters.rst index 2b02a34d..d8a209e7 100644 --- a/docs/en/user/parameters.rst +++ b/docs/en/user/parameters.rst | |||
@@ -39,6 +39,7 @@ If you don't know which value you need to set, please leave the default one. | |||
39 | redis_host: localhost | 39 | redis_host: localhost |
40 | redis_port: 6379 | 40 | redis_port: 6379 |
41 | redis_path: null | 41 | redis_path: null |
42 | redis_password: null | ||
42 | 43 | ||
43 | Meaning of each parameter | 44 | Meaning of each parameter |
44 | ------------------------- | 45 | ------------------------- |
@@ -55,6 +56,7 @@ Meaning of each parameter | |||
55 | "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" | 56 | "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" |
56 | "database_table_prefix", "wallabag_", "all wallabag's tables will be prefixed with that string. You can include a ``_`` for clarity" | 57 | "database_table_prefix", "wallabag_", "all wallabag's tables will be prefixed with that string. You can include a ``_`` for clarity" |
57 | "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)" | 58 | "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)" |
59 | "database_charset", "utf8mb4", "For PostgreSQL & SQLite you should use utf8, for MySQL use utf8mb4 which handle emoji" | ||
58 | 60 | ||
59 | .. csv-table:: Configuration to send emails from wallabag | 61 | .. csv-table:: Configuration to send emails from wallabag |
60 | :header: "name", "default", "description" | 62 | :header: "name", "default", "description" |
@@ -91,3 +93,4 @@ Meaning of each parameter | |||
91 | "redis_host", "localhost", "IP or hostname of the target server (ignored for unix scheme)" | 93 | "redis_host", "localhost", "IP or hostname of the target server (ignored for unix scheme)" |
92 | "redis_port", "6379", "TCP/IP port of the target server (ignored for unix scheme)" | 94 | "redis_port", "6379", "TCP/IP port of the target server (ignored for unix scheme)" |
93 | "redis_path", "null", "Path of the UNIX domain socket file used when connecting to Redis using UNIX domain sockets" | 95 | "redis_path", "null", "Path of the UNIX domain socket file used when connecting to Redis using UNIX domain sockets" |
96 | "redis_password", "null", "Password defined in the Redis server configuration (parameter `requirepass` in `redis.conf`)" | ||