diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/de/index.rst | 5 | ||||
-rw-r--r-- | docs/de/user/installation.rst | 7 | ||||
-rw-r--r-- | docs/de/user/upgrade.rst | 7 | ||||
-rw-r--r-- | docs/en/developer/rabbitmq.rst | 67 | ||||
-rw-r--r-- | docs/en/developer/redis.rst | 62 | ||||
-rw-r--r-- | docs/en/index.rst | 6 | ||||
-rw-r--r-- | docs/en/user/import.rst | 21 | ||||
-rw-r--r-- | docs/en/user/installation.rst | 9 | ||||
-rw-r--r-- | docs/en/user/migration.rst | 36 | ||||
-rw-r--r-- | docs/en/user/share.rst | 17 | ||||
-rw-r--r-- | docs/en/user/upgrade.rst | 7 | ||||
-rw-r--r-- | docs/fr/index.rst | 6 | ||||
-rw-r--r-- | docs/fr/user/import.rst | 20 | ||||
-rw-r--r-- | docs/fr/user/installation.rst | 11 | ||||
-rw-r--r-- | docs/fr/user/migration.rst | 38 | ||||
-rw-r--r-- | docs/fr/user/share.rst | 17 | ||||
-rw-r--r-- | docs/fr/user/upgrade.rst | 7 | ||||
-rw-r--r-- | docs/img/user/share.png | bin | 0 -> 9435 bytes |
18 files changed, 274 insertions, 69 deletions
diff --git a/docs/de/index.rst b/docs/de/index.rst index 5311150f..d8cd8f39 100644 --- a/docs/de/index.rst +++ b/docs/de/index.rst | |||
@@ -17,6 +17,11 @@ Die Hauptdokumentation für diese Applikation ist in einigen Abschnitten organis | |||
17 | * :ref:`user-docs` | 17 | * :ref:`user-docs` |
18 | * :ref:`dev-docs` | 18 | * :ref:`dev-docs` |
19 | 19 | ||
20 | Die Dokumentation ist in anderen Sprachen verfügbar : | ||
21 | |||
22 | * `Documentation in english <http://doc.wallabag.org/en/master/>`_ | ||
23 | * `Documentation en français <http://doc.wallabag.org/fr/master/>`_ | ||
24 | |||
20 | .. _user-docs: | 25 | .. _user-docs: |
21 | 26 | ||
22 | .. toctree:: | 27 | .. toctree:: |
diff --git a/docs/de/user/installation.rst b/docs/de/user/installation.rst index fced2ed4..05602bf3 100644 --- a/docs/de/user/installation.rst +++ b/docs/de/user/installation.rst | |||
@@ -46,7 +46,7 @@ Composer installieren: | |||
46 | 46 | ||
47 | curl -s http://getcomposer.org/installer | php | 47 | curl -s http://getcomposer.org/installer | php |
48 | 48 | ||
49 | Du kannst eine spezifische Anleitung `hier <https://getcomposer.org/doc/00-intro.md>`__ finden: | 49 | Du kannst eine spezifische Anleitung `hier <https://getcomposer.org/doc/00-intro.md>`__ finden. |
50 | 50 | ||
51 | Um wallabag selbst zu installieren, musst du die folgenden Kommandos ausführen: | 51 | Um wallabag selbst zu installieren, musst du die folgenden Kommandos ausführen: |
52 | 52 | ||
@@ -54,9 +54,8 @@ Um wallabag selbst zu installieren, musst du die folgenden Kommandos ausführen: | |||
54 | 54 | ||
55 | git clone https://github.com/wallabag/wallabag.git | 55 | git clone https://github.com/wallabag/wallabag.git |
56 | cd wallabag | 56 | cd wallabag |
57 | git checkout 2.0.8 | 57 | git checkout 2.1.0 |
58 | SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist | 58 | ./install.sh |
59 | php bin/console wallabag:install --env=prod | ||
60 | 59 | ||
61 | Um PHPs eingebauten Server zu starten und zu testen, ob alles korrekt installiert wurde, kannst du folgendes Kommando ausführen: | 60 | Um PHPs eingebauten Server zu starten und zu testen, ob alles korrekt installiert wurde, kannst du folgendes Kommando ausführen: |
62 | 61 | ||
diff --git a/docs/de/user/upgrade.rst b/docs/de/user/upgrade.rst index c04b68f3..953c84ff 100644 --- a/docs/de/user/upgrade.rst +++ b/docs/de/user/upgrade.rst | |||
@@ -4,15 +4,14 @@ Wallabag updaten | |||
4 | Update auf einem dedizierten Webserver | 4 | Update auf einem dedizierten Webserver |
5 | -------------------------------------- | 5 | -------------------------------------- |
6 | 6 | ||
7 | Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.html veröffentlicht. Um deine wallabag Installation auf die neueste Version upzudaten, führe die folgenden Kommandos in deinem wallabag Ordner aus (ersetze ``2.0.8`` mit der neuesten Releasenummer): | 7 | Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.html veröffentlicht. Um deine wallabag Installation auf die neueste Version upzudaten, führe die folgenden Kommandos in deinem wallabag Ordner aus (ersetze ``2.1.0`` mit der neuesten Releasenummer): |
8 | 8 | ||
9 | :: | 9 | :: |
10 | 10 | ||
11 | git fetch origin | 11 | git fetch origin |
12 | git fetch --tags | 12 | git fetch --tags |
13 | git checkout 2.0.8 | 13 | git checkout 2.1.0 |
14 | SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist | 14 | ./install.sh |
15 | php bin/console cache:clear --env=prod | ||
16 | 15 | ||
17 | Update auf einem Shared Webhosting | 16 | Update auf einem Shared Webhosting |
18 | ---------------------------------- | 17 | ---------------------------------- |
diff --git a/docs/en/developer/rabbitmq.rst b/docs/en/developer/rabbitmq.rst new file mode 100644 index 00000000..8cee45fb --- /dev/null +++ b/docs/en/developer/rabbitmq.rst | |||
@@ -0,0 +1,67 @@ | |||
1 | Install RabbitMQ for asynchronous tasks | ||
2 | ======================================= | ||
3 | |||
4 | In order to launch asynchronous tasks (useful for huge imports for example), we can use RabbitMQ. | ||
5 | |||
6 | Requirements | ||
7 | ------------ | ||
8 | |||
9 | You need to have RabbitMQ installed on your server. | ||
10 | |||
11 | Installation | ||
12 | ~~~~~~~~~~~~ | ||
13 | |||
14 | .. code:: bash | ||
15 | |||
16 | wget https://www.rabbitmq.com/rabbitmq-signing-key-public.asc | ||
17 | apt-key add rabbitmq-signing-key-public.asc | ||
18 | apt-get update | ||
19 | apt-get install rabbitmq-server | ||
20 | |||
21 | Configuration and launch | ||
22 | ~~~~~~~~~~~~~~~~~~~~~~~~ | ||
23 | |||
24 | .. code:: bash | ||
25 | |||
26 | rabbitmq-plugins enable rabbitmq_management # (useful to have a web interface, available at http://localhost:15672/ (guest/guest) | ||
27 | rabbitmq-server -detached | ||
28 | |||
29 | Stop RabbitMQ | ||
30 | ~~~~~~~~~~~~~ | ||
31 | |||
32 | .. code:: bash | ||
33 | |||
34 | rabbitmqctl stop | ||
35 | |||
36 | |||
37 | Configure RabbitMQ in wallabag | ||
38 | ------------------------------ | ||
39 | |||
40 | Edit your ``parameters.yml`` file to edit RabbitMQ configuration. The default one should be ok: | ||
41 | |||
42 | .. code:: yaml | ||
43 | |||
44 | rabbitmq_host: localhost | ||
45 | rabbitmq_port: 5672 | ||
46 | rabbitmq_user: guest | ||
47 | rabbitmq_password: guest | ||
48 | |||
49 | |||
50 | Launch RabbitMQ consumer | ||
51 | ------------------------ | ||
52 | |||
53 | Depending on which service you want to import from you need to enable one (or many if you want to support many) cron job: | ||
54 | |||
55 | .. code:: bash | ||
56 | |||
57 | # for Pocket import | ||
58 | bin/console rabbitmq:consumer import_pocket -w | ||
59 | |||
60 | # for Readbility import | ||
61 | bin/console rabbitmq:consumer import_readability -w | ||
62 | |||
63 | # for wallabag v1 import | ||
64 | bin/console rabbitmq:consumer import_wallabag_v1 -w | ||
65 | |||
66 | # for wallabag v2 import | ||
67 | bin/console rabbitmq:consumer import_wallabag_v2 -w | ||
diff --git a/docs/en/developer/redis.rst b/docs/en/developer/redis.rst new file mode 100644 index 00000000..5748e260 --- /dev/null +++ b/docs/en/developer/redis.rst | |||
@@ -0,0 +1,62 @@ | |||
1 | Install Redis for asynchronous tasks | ||
2 | ======================================= | ||
3 | |||
4 | In order to launch asynchronous tasks (useful for huge imports for example), we can use Redis. | ||
5 | |||
6 | Requirements | ||
7 | ------------ | ||
8 | |||
9 | You need to have Redis installed on your server. | ||
10 | |||
11 | Installation | ||
12 | ~~~~~~~~~~~~ | ||
13 | |||
14 | .. code:: bash | ||
15 | |||
16 | apt-get install redis-server | ||
17 | |||
18 | Launch | ||
19 | ~~~~~~ | ||
20 | |||
21 | The server might be already running after installing, if not you can launch it using: | ||
22 | |||
23 | .. code:: bash | ||
24 | |||
25 | redis-server | ||
26 | |||
27 | |||
28 | Configure Redis in wallabag | ||
29 | --------------------------- | ||
30 | |||
31 | Edit your ``parameters.yml`` file to edit Redis configuration. The default one should be ok: | ||
32 | |||
33 | .. code:: yaml | ||
34 | |||
35 | redis_host: localhost | ||
36 | redis_port: 6379 | ||
37 | |||
38 | |||
39 | Launch Redis consumer | ||
40 | ------------------------ | ||
41 | |||
42 | Depending on which service you want to import from you need to enable one (or many if you want to support many) cron job: | ||
43 | |||
44 | .. code:: bash | ||
45 | |||
46 | # for Pocket import | ||
47 | bin/console wallabag:import:redis-worker pocket -vv >> /path/to/wallabag/var/logs/redis-pocket.log | ||
48 | |||
49 | # for Readbility import | ||
50 | bin/console wallabag:import:redis-worker readability -vv >> /path/to/wallabag/var/logs/redis-readability.log | ||
51 | |||
52 | # for wallabag v1 import | ||
53 | bin/console wallabag:import:redis-worker wallabag_v1 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v1.log | ||
54 | |||
55 | # for wallabag v2 import | ||
56 | bin/console wallabag:import:redis-worker wallabag_v2 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v2.log | ||
57 | |||
58 | 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 : | ||
59 | |||
60 | .. code:: bash | ||
61 | |||
62 | bin/console wallabag:import:redis-worker pocket -vv --maxIterations=12 | ||
diff --git a/docs/en/index.rst b/docs/en/index.rst index 03025ef9..46450b8f 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst | |||
@@ -17,6 +17,11 @@ The main documentation for this application is organized into a couple sections: | |||
17 | * :ref:`user-docs` | 17 | * :ref:`user-docs` |
18 | * :ref:`dev-docs` | 18 | * :ref:`dev-docs` |
19 | 19 | ||
20 | The documentation is available in other languages: | ||
21 | |||
22 | * `Documentation en français <http://doc.wallabag.org/fr/master/>`_ | ||
23 | * `Deutsch Dokumentation <http://doc.wallabag.org/de/master/>`_ | ||
24 | |||
20 | .. _user-docs: | 25 | .. _user-docs: |
21 | 26 | ||
22 | .. toctree:: | 27 | .. toctree:: |
@@ -35,6 +40,7 @@ The main documentation for this application is organized into a couple sections: | |||
35 | user/errors_during_fetching | 40 | user/errors_during_fetching |
36 | user/annotations | 41 | user/annotations |
37 | user/download_articles | 42 | user/download_articles |
43 | user/share | ||
38 | user/filters | 44 | user/filters |
39 | user/tags | 45 | user/tags |
40 | user/android | 46 | user/android |
diff --git a/docs/en/user/import.rst b/docs/en/user/import.rst index 63210484..e6c37d72 100644 --- a/docs/en/user/import.rst +++ b/docs/en/user/import.rst | |||
@@ -30,14 +30,25 @@ You need to authorize wallabag to interact with your Pocket account. | |||
30 | Your data will be imported. Data import can be a demanding process for your server | 30 | Your data will be imported. Data import can be a demanding process for your server |
31 | (we need to work on this import to improve it). | 31 | (we need to work on this import to improve it). |
32 | 32 | ||
33 | From Instapaper | ||
34 | --------------- | ||
35 | |||
36 | *Feature not yet implemented in wallabag v2.* | ||
37 | |||
38 | From Readability | 33 | From Readability |
39 | ---------------- | 34 | ---------------- |
40 | 35 | ||
36 | Export your Readability data | ||
37 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
38 | |||
39 | On the tools (`https://www.readability.com/tools/<https://www.readability.com/tools/>`_) page, click on "Export your data" in the "Data Export" section. You will received an email to download a json (which does not end with .json in fact). | ||
40 | |||
41 | Import your data into wallabag 2.x | ||
42 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
43 | |||
44 | Click on ``Import`` link in the menu, on ``Import contents`` in Readability section | ||
45 | and then select your json file and upload it. | ||
46 | |||
47 | Your data will be imported. Data import can be a demanding process for your server (we need to work on this import to improve it). | ||
48 | |||
49 | From Instapaper | ||
50 | --------------- | ||
51 | |||
41 | *Feature not yet implemented in wallabag v2.* | 52 | *Feature not yet implemented in wallabag v2.* |
42 | 53 | ||
43 | From HTML or JSON file | 54 | From HTML or JSON file |
diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index 763d7c66..8e9f71d4 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst | |||
@@ -37,7 +37,7 @@ Installation | |||
37 | On a dedicated web server (recommended way) | 37 | On a dedicated web server (recommended way) |
38 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 38 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
39 | 39 | ||
40 | wallabag uses a large number of 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``). | 40 | 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``). |
41 | 41 | ||
42 | Install Composer: | 42 | Install Composer: |
43 | 43 | ||
@@ -45,7 +45,7 @@ Install Composer: | |||
45 | 45 | ||
46 | curl -s http://getcomposer.org/installer | php | 46 | curl -s http://getcomposer.org/installer | php |
47 | 47 | ||
48 | You can find specific instructions `here <https://getcomposer.org/doc/00-intro.md>`__: | 48 | You can find specific instructions `here <https://getcomposer.org/doc/00-intro.md>`__. |
49 | 49 | ||
50 | To install wallabag itself, you must run the following commands: | 50 | To install wallabag itself, you must run the following commands: |
51 | 51 | ||
@@ -53,9 +53,8 @@ To install wallabag itself, you must run the following commands: | |||
53 | 53 | ||
54 | git clone https://github.com/wallabag/wallabag.git | 54 | git clone https://github.com/wallabag/wallabag.git |
55 | cd wallabag | 55 | cd wallabag |
56 | git checkout 2.0.8 | 56 | git checkout 2.1.0 |
57 | SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist | 57 | ./install.sh |
58 | php bin/console wallabag:install --env=prod | ||
59 | 58 | ||
60 | To start PHP's build-in server and test if everything did install correctly, you can do: | 59 | To start PHP's build-in server and test if everything did install correctly, you can do: |
61 | 60 | ||
diff --git a/docs/en/user/migration.rst b/docs/en/user/migration.rst index e141ae40..42062796 100644 --- a/docs/en/user/migration.rst +++ b/docs/en/user/migration.rst | |||
@@ -24,20 +24,38 @@ After creating an user account on your new wallabag v2 instance, you must head o | |||
24 | :alt: Import from wallabag v1 | 24 | :alt: Import from wallabag v1 |
25 | :align: center | 25 | :align: center |
26 | 26 | ||
27 | From wallabag 2.x | ||
28 | ----------------- | ||
29 | |||
30 | From the previous wallabag instance on which you were before, go to `All articles`, then export these articles as json. | ||
31 | |||
32 | .. image:: ../../img/user/export_v2.png | ||
33 | :alt: Export depuis wallabag v2 | ||
34 | :align: center | ||
35 | |||
36 | From your new wallabag instance, create your user account and click on the link in the menu to proceed to import. Choose import from wallabag v2 and select your json file to upload it. | ||
37 | |||
38 | .. note:: | ||
39 | If you encounter issues during the export or the import, don't hesitate to `ask for support <https://www.wallabag.org/pages/support.html>`__. | ||
40 | |||
27 | Import via command-line interface (CLI) | 41 | Import via command-line interface (CLI) |
28 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 42 | --------------------------------------- |
29 | 43 | ||
30 | If you have a CLI access on your web server, you can execute this command to import your wallabag v1 export: | 44 | If you have a CLI access on your web server, you can execute this command to import your wallabag v1 export: |
31 | 45 | ||
32 | :: | 46 | :: |
33 | 47 | ||
34 | bin/console wallabag:import-v1 1 ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod | 48 | bin/console wallabag:import 1 ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod |
35 | 49 | ||
36 | Please replace values: | 50 | Please replace values: |
37 | 51 | ||
38 | * ``1`` is the user identifier in database (The ID of the first user created on wallabag is 1) | 52 | * ``1`` is the user identifier in database (The ID of the first user created on wallabag is 1) |
39 | * ``~/Downloads/wallabag-export-1-2016-04-05.json`` is the path of your wallabag v1 export | 53 | * ``~/Downloads/wallabag-export-1-2016-04-05.json`` is the path of your wallabag v1 export |
40 | 54 | ||
55 | If you want to mark all these entries as read, you can add the ``--markAsRead`` option. | ||
56 | |||
57 | To import a wallabag v2 file, you need to add the option ``--importer=v2``. | ||
58 | |||
41 | You'll have this in return: | 59 | You'll have this in return: |
42 | 60 | ||
43 | :: | 61 | :: |
@@ -46,17 +64,3 @@ You'll have this in return: | |||
46 | 403 imported | 64 | 403 imported |
47 | 0 already saved | 65 | 0 already saved |
48 | End : 05-04-2016 11:36:09 --- | 66 | End : 05-04-2016 11:36:09 --- |
49 | |||
50 | From wallabag 2.x | ||
51 | ----------------- | ||
52 | |||
53 | From the previous wallabag instance on which you were before, go to `All articles`, then export these articles as json. | ||
54 | |||
55 | .. image:: ../../img/user/export_v2.png | ||
56 | :alt: Export depuis wallabag v2 | ||
57 | :align: center | ||
58 | |||
59 | From your new wallabag instance, create your user account and click on the link in the menu to proceed to import. Choose import from wallabag v2 and select your json file to upload it. | ||
60 | |||
61 | .. note:: | ||
62 | If you encounter issues during the export or the import, don't hesitate to `ask for support <https://www.wallabag.org/pages/support.html>`__. | ||
diff --git a/docs/en/user/share.rst b/docs/en/user/share.rst new file mode 100644 index 00000000..e99e51ab --- /dev/null +++ b/docs/en/user/share.rst | |||
@@ -0,0 +1,17 @@ | |||
1 | Share articles | ||
2 | ============== | ||
3 | |||
4 | When you're reading an article, you can share it. Just click on the share button: | ||
5 | |||
6 | .. image:: ../../img/user/share.png | ||
7 | :alt: share article | ||
8 | :align: center | ||
9 | |||
10 | Now, you can share the article: | ||
11 | |||
12 | - with a public URL (you'll have a light view of the article) | ||
13 | - with a tweet | ||
14 | - into your Shaarli | ||
15 | - with a post in Diaspora* | ||
16 | - to Carrot | ||
17 | - with an email | ||
diff --git a/docs/en/user/upgrade.rst b/docs/en/user/upgrade.rst index 90ed6c70..5c37be95 100644 --- a/docs/en/user/upgrade.rst +++ b/docs/en/user/upgrade.rst | |||
@@ -4,15 +4,14 @@ Upgrade wallabag | |||
4 | Upgrade on a dedicated web server | 4 | Upgrade on a dedicated web server |
5 | --------------------------------- | 5 | --------------------------------- |
6 | 6 | ||
7 | The 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.8`` by the last release number): | 7 | The 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.1.0`` by the last release number): |
8 | 8 | ||
9 | :: | 9 | :: |
10 | 10 | ||
11 | git fetch origin | 11 | git fetch origin |
12 | git fetch --tags | 12 | git fetch --tags |
13 | git checkout 2.0.8 | 13 | git checkout 2.1.0 |
14 | SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist | 14 | ./install.sh |
15 | php bin/console cache:clear --env=prod | ||
16 | 15 | ||
17 | Upgrade on a shared hosting | 16 | Upgrade on a shared hosting |
18 | --------------------------- | 17 | --------------------------- |
diff --git a/docs/fr/index.rst b/docs/fr/index.rst index 1e72dae7..dfa55afe 100644 --- a/docs/fr/index.rst +++ b/docs/fr/index.rst | |||
@@ -18,6 +18,11 @@ La documentation principale de cette application est découpée en plusieurs sec | |||
18 | * :ref:`user-docs` | 18 | * :ref:`user-docs` |
19 | * :ref:`dev-docs` | 19 | * :ref:`dev-docs` |
20 | 20 | ||
21 | La documentation est disponible dans d'autres langues : | ||
22 | |||
23 | * `Documentation in english <http://doc.wallabag.org/en/master/>`_ | ||
24 | * `Deutsch Dokumentation <http://doc.wallabag.org/de/master/>`_ | ||
25 | |||
21 | .. _user-docs: | 26 | .. _user-docs: |
22 | 27 | ||
23 | .. toctree:: | 28 | .. toctree:: |
@@ -36,6 +41,7 @@ La documentation principale de cette application est découpée en plusieurs sec | |||
36 | user/errors_during_fetching | 41 | user/errors_during_fetching |
37 | user/annotations | 42 | user/annotations |
38 | user/download_articles | 43 | user/download_articles |
44 | user/share | ||
39 | user/filters | 45 | user/filters |
40 | user/tags | 46 | user/tags |
41 | 47 | ||
diff --git a/docs/fr/user/import.rst b/docs/fr/user/import.rst index e6c2fa02..99ac602b 100644 --- a/docs/fr/user/import.rst +++ b/docs/fr/user/import.rst | |||
@@ -30,15 +30,27 @@ Vous devez autoriser wallabag à se connecter à votre compte Pocket. | |||
30 | Vos données vont être importées. L'import de données est une action qui peut être couteuse | 30 | Vos données vont être importées. L'import de données est une action qui peut être couteuse |
31 | pour votre serveur (nous devons encore travailler pour améliorer cet import). | 31 | pour votre serveur (nous devons encore travailler pour améliorer cet import). |
32 | 32 | ||
33 | Depuis Readability | ||
34 | ------------------ | ||
35 | |||
36 | Exportez vos données de Readability | ||
37 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
38 | |||
39 | Sur la page des outils (`https://www.readability.com/tools/<https://www.readability.com/tools/>`_), cliquez sur "Export your data" dans la section "Data Export". Vous allez recevoir un email avec un lien pour télécharger le json. | ||
40 | |||
41 | Importez vos données dans wallabag 2.x | ||
42 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
43 | |||
44 | Cliquez sur le lien ``Importer`` dans le menu, sur ``Importer les contenus`` dans | ||
45 | la section Readability et ensuite sélectionnez votre fichier json pour l'uploader. | ||
46 | |||
47 | Vos données vont être importées. L'import de données est une action qui peut être couteuse pour votre serveur (nous devons encore travailler pour améliorer cet import). | ||
48 | |||
33 | Depuis Instapaper | 49 | Depuis Instapaper |
34 | ----------------- | 50 | ----------------- |
35 | 51 | ||
36 | *Fonctionnalité pas encore implémentée dans wallabag v2.* | 52 | *Fonctionnalité pas encore implémentée dans wallabag v2.* |
37 | 53 | ||
38 | Depuis Readability | ||
39 | ------------------ | ||
40 | |||
41 | *Fonctionnalité pas encore implémentée dans wallabag v2.* | ||
42 | 54 | ||
43 | Depuis un fichier HTML ou JSON | 55 | Depuis un fichier HTML ou JSON |
44 | ------------------------------ | 56 | ------------------------------ |
diff --git a/docs/fr/user/installation.rst b/docs/fr/user/installation.rst index 480970c5..4fccd0d4 100644 --- a/docs/fr/user/installation.rst +++ b/docs/fr/user/installation.rst | |||
@@ -35,7 +35,7 @@ Installation | |||
35 | Sur un serveur dédié (méthode conseillée) | 35 | Sur un serveur dédié (méthode conseillée) |
36 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 36 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
37 | 37 | ||
38 | 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 et vous assurer que vous utilisez bien la version 1.2 (si vous avez déjà Composer, faite un ``composer selfupdate``). | 38 | wallabag utilise un grand nombre de bibliothèques PHP 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 et vous assurer que vous utilisez bien la version 1.2 (si vous avez déjà Composer, faite un ``composer selfupdate``). |
39 | 39 | ||
40 | Installation de Composer : | 40 | Installation de Composer : |
41 | 41 | ||
@@ -43,17 +43,16 @@ Installation de Composer : | |||
43 | 43 | ||
44 | curl -s http://getcomposer.org/installer | php | 44 | curl -s http://getcomposer.org/installer | php |
45 | 45 | ||
46 | Vous pouvez trouver des instructions spécifiques `ici (en anglais) <https://getcomposer.org/doc/00-intro.md>`__ : | 46 | Vous pouvez trouver des instructions spécifiques `ici (en anglais) <https://getcomposer.org/doc/00-intro.md>`__. |
47 | 47 | ||
48 | Pour installer wallabag, vous devez exécuter ces deux commandes : | 48 | Pour installer wallabag, vous devez exécuter ces commandes : |
49 | 49 | ||
50 | :: | 50 | :: |
51 | 51 | ||
52 | git clone https://github.com/wallabag/wallabag.git | 52 | git clone https://github.com/wallabag/wallabag.git |
53 | cd wallabag | 53 | cd wallabag |
54 | git checkout 2.0.8 | 54 | git checkout 2.1.0 |
55 | SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist | 55 | ./install.sh |
56 | php bin/console wallabag:install --env=prod | ||
57 | 56 | ||
58 | Pour démarrer le serveur interne à php et vérifier que tout s'est installé correctement, vous pouvez exécuter : | 57 | Pour démarrer le serveur interne à php et vérifier que tout s'est installé correctement, vous pouvez exécuter : |
59 | 58 | ||
diff --git a/docs/fr/user/migration.rst b/docs/fr/user/migration.rst index 66024572..91f8bab2 100644 --- a/docs/fr/user/migration.rst +++ b/docs/fr/user/migration.rst | |||
@@ -24,20 +24,38 @@ Une fois que vous avez créé un compte utilisateur sur votre nouvelle instance | |||
24 | :alt: Import depuis wallabag v1 | 24 | :alt: Import depuis wallabag v1 |
25 | :align: center | 25 | :align: center |
26 | 26 | ||
27 | Import via via la ligne de commande (CLI) | 27 | Depuis wallabag 2.x |
28 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 28 | ------------------- |
29 | |||
30 | Depuis l'instance sur laquelle vous étiez, rendez-vous dans la section `Tous les articles`, puis exportez ces articles au format json. | ||
31 | |||
32 | .. image:: ../../img/user/export_v2.png | ||
33 | :alt: Export depuis wallabag v2 | ||
34 | :align: center | ||
35 | |||
36 | Depuis votre nouvelle instance de wallabag, créez votre compte utilisateur puis cliquez sur le lien dans le menu pour accéder à l'import. Choisissez l'import depuis wallabag v2 puis sélectionnez votre fichier json pour l'uploader. | ||
37 | |||
38 | .. note:: | ||
39 | S'il vous arrive des problèmes durant l'export ou l'import, n'hésitez pas à `demander de l'aide <https://www.wallabag.org/pages/support.html>`__. | ||
40 | |||
41 | Import via la ligne de commande (CLI) | ||
42 | ------------------------------------- | ||
29 | 43 | ||
30 | Si vous avez accès à la ligne de commandes de votre serveur web, vous pouvez exécuter cette commande pour import votre fichier wallabag v1 : | 44 | Si vous avez accès à la ligne de commandes de votre serveur web, vous pouvez exécuter cette commande pour import votre fichier wallabag v1 : |
31 | 45 | ||
32 | :: | 46 | :: |
33 | 47 | ||
34 | bin/console wallabag:import-v1 1 ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod | 48 | bin/console wallabag:import 1 ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod |
35 | 49 | ||
36 | Remplacez les valeurs : | 50 | Remplacez les valeurs : |
37 | 51 | ||
38 | * ``1`` est l'identifiant de votre utilisateur en base (l'ID de votre premier utilisateur créé sur wallabag est 1) | 52 | * ``1`` est l'identifiant de votre utilisateur en base (l'ID de votre premier utilisateur créé sur wallabag est 1) |
39 | * ``~/Downloads/wallabag-export-1-2016-04-05.json`` est le chemin de votre export wallabag v1 | 53 | * ``~/Downloads/wallabag-export-1-2016-04-05.json`` est le chemin de votre export wallabag v1 |
40 | 54 | ||
55 | Si vous voulez marquer tous ces articles comme lus, vous pouvez ajouter l'option ``--markAsRead``. | ||
56 | |||
57 | Pour importer un fichier wallabag v2, vous devez ajouter l'option ``--importer=v2``. | ||
58 | |||
41 | Vous obtiendrez : | 59 | Vous obtiendrez : |
42 | 60 | ||
43 | :: | 61 | :: |
@@ -46,17 +64,3 @@ Vous obtiendrez : | |||
46 | 403 imported | 64 | 403 imported |
47 | 0 already saved | 65 | 0 already saved |
48 | End : 05-04-2016 11:36:09 --- | 66 | End : 05-04-2016 11:36:09 --- |
49 | |||
50 | Depuis wallabag 2.x | ||
51 | ------------------- | ||
52 | |||
53 | Depuis l'instance sur laquelle vous étiez, rendez-vous dans la section `Tous les articles`, puis exportez ces articles au format json. | ||
54 | |||
55 | .. image:: ../../img/user/export_v2.png | ||
56 | :alt: Export depuis wallabag v2 | ||
57 | :align: center | ||
58 | |||
59 | Depuis votre nouvelle instance de wallabag, créez votre compte utilisateur puis cliquez sur le lien dans le menu pour accéder à l'import. Choisissez l'import depuis wallabag v2 puis sélectionnez votre fichier json pour l'uploader. | ||
60 | |||
61 | .. note:: | ||
62 | S'il vous arrive des problèmes durant l'export ou l'import, n'hésitez pas à `demander de l'aide <https://www.wallabag.org/pages/support.html>`__. | ||
diff --git a/docs/fr/user/share.rst b/docs/fr/user/share.rst new file mode 100644 index 00000000..b5faa5ba --- /dev/null +++ b/docs/fr/user/share.rst | |||
@@ -0,0 +1,17 @@ | |||
1 | Partager des articles | ||
2 | ===================== | ||
3 | |||
4 | Quand vous lisez un article, vous pouvez le partager. Cliquez sur le bouton de partage : | ||
5 | |||
6 | .. image:: ../../img/user/share.png | ||
7 | :alt: partager un article | ||
8 | :align: center | ||
9 | |||
10 | Vous pouvez maintenant le partager : | ||
11 | |||
12 | - avec une URL publique (vous obtiendrez une vue allégée de l'article) | ||
13 | - avec un tweet | ||
14 | - dans votre Shaarli | ||
15 | - avec un message dans Diaspora* | ||
16 | - sur Carrot | ||
17 | - avec un email | ||
diff --git a/docs/fr/user/upgrade.rst b/docs/fr/user/upgrade.rst index 1ead2c94..e3798979 100644 --- a/docs/fr/user/upgrade.rst +++ b/docs/fr/user/upgrade.rst | |||
@@ -4,15 +4,14 @@ Mettre à jour wallabag | |||
4 | Mise à jour sur un serveur dédié | 4 | Mise à jour sur un serveur dédié |
5 | -------------------------------- | 5 | -------------------------------- |
6 | 6 | ||
7 | La dernière version de wallabag est publiée à cette adresse : https://www.wallabag.org/pages/download-wallabag.html. Pour mettre à jour votre installation de wallabag, exécutez les commandes suivantes dans votre répertoire d'installation (remplacez ``2.0.8`` par le numéro de la dernière version) : | 7 | La dernière version de wallabag est publiée à cette adresse : https://www.wallabag.org/pages/download-wallabag.html. Pour mettre à jour votre installation de wallabag, exécutez les commandes suivantes dans votre répertoire d'installation (remplacez ``2.1.0`` par le numéro de la dernière version) : |
8 | 8 | ||
9 | :: | 9 | :: |
10 | 10 | ||
11 | git fetch origin | 11 | git fetch origin |
12 | git fetch --tags | 12 | git fetch --tags |
13 | git checkout 2.0.8 | 13 | git checkout 2.1.0 |
14 | SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist | 14 | ./install.sh |
15 | php bin/console cache:clear --env=prod | ||
16 | 15 | ||
17 | Mise à jour sur un hébergement mutualisé | 16 | Mise à jour sur un hébergement mutualisé |
18 | ---------------------------------------- | 17 | ---------------------------------------- |
diff --git a/docs/img/user/share.png b/docs/img/user/share.png new file mode 100644 index 00000000..4cfe9edb --- /dev/null +++ b/docs/img/user/share.png | |||
Binary files differ | |||