diff options
Diffstat (limited to 'docs')
28 files changed, 818 insertions, 74 deletions
diff --git a/docs/de/conf.py b/docs/de/conf.py index 8f2d130d..cc9dcdf8 100644 --- a/docs/de/conf.py +++ b/docs/de/conf.py | |||
@@ -12,7 +12,7 @@ source_suffix = '.rst' | |||
12 | master_doc = 'index' | 12 | master_doc = 'index' |
13 | project = u'wallabag-fr' | 13 | project = u'wallabag-fr' |
14 | copyright = u'2013-2016, Nicolas Lœuillet - MIT Licence' | 14 | copyright = u'2013-2016, Nicolas Lœuillet - MIT Licence' |
15 | version = '2.0.0' | 15 | version = '2.1.0' |
16 | release = version | 16 | release = version |
17 | exclude_patterns = ['_build'] | 17 | exclude_patterns = ['_build'] |
18 | pygments_style = 'sphinx' | 18 | pygments_style = 'sphinx' |
diff --git a/docs/de/developer/rabbitmq.rst b/docs/de/developer/rabbitmq.rst new file mode 100644 index 00000000..bea02ff4 --- /dev/null +++ b/docs/de/developer/rabbitmq.rst | |||
@@ -0,0 +1,77 @@ | |||
1 | Installiere RabbitMQ für asynchrone Aufgaben | ||
2 | ============================================ | ||
3 | |||
4 | Um asynchrone Aufgaben zu starten (nützlich z.B. für große Imports), können wir RabbitMQ nutzen. | ||
5 | |||
6 | Voraussetzungen | ||
7 | --------------- | ||
8 | |||
9 | Du musst RabbitMQ auf deinem Server installiert haben. | ||
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 | Konfiguration und Starten | ||
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 | RabbitMQ stoppen | ||
30 | ~~~~~~~~~~~~~~~ | ||
31 | |||
32 | .. code:: bash | ||
33 | |||
34 | rabbitmqctl stop | ||
35 | |||
36 | |||
37 | Konfigure RabbitMQ in wallabag | ||
38 | ------------------------------ | ||
39 | |||
40 | Bearbeite die Datei ``parameters.yml``, um die RabbitMQ Konfiguration einzurichten. Die Standardkonfiguration sollte ok sein: | ||
41 | |||
42 | .. code:: yaml | ||
43 | |||
44 | rabbitmq_host: localhost | ||
45 | rabbitmq_port: 5672 | ||
46 | rabbitmq_user: guest | ||
47 | rabbitmq_password: guest | ||
48 | |||
49 | |||
50 | Starte den RabbitMQ Consumer | ||
51 | ---------------------------- | ||
52 | |||
53 | Abhängig von welchem Service du importieren möchtest, solltest du einen Cron Job aktivieren (oder mehrere, wenn du viele unterstützen willst): | ||
54 | |||
55 | .. code:: bash | ||
56 | |||
57 | # for Pocket import | ||
58 | bin/console rabbitmq:consumer import_pocket -w | ||
59 | |||
60 | # for Readability import | ||
61 | bin/console rabbitmq:consumer import_readability -w | ||
62 | |||
63 | # for Instapaper import | ||
64 | bin/console rabbitmq:consumer import_instapaper -w | ||
65 | |||
66 | # for wallabag v1 import | ||
67 | bin/console rabbitmq:consumer import_wallabag_v1 -w | ||
68 | |||
69 | # for wallabag v2 import | ||
70 | bin/console rabbitmq:consumer import_wallabag_v2 -w | ||
71 | |||
72 | # for Firefox import | ||
73 | bin/console rabbitmq:consumer import_firefox -w | ||
74 | |||
75 | # for Chrome import | ||
76 | bin/console rabbitmq:consumer import_chrome -w | ||
77 | |||
diff --git a/docs/de/developer/redis.rst b/docs/de/developer/redis.rst new file mode 100644 index 00000000..d613ce6c --- /dev/null +++ b/docs/de/developer/redis.rst | |||
@@ -0,0 +1,71 @@ | |||
1 | Installiere Redis für asynchrone Aufgaben | ||
2 | ========================================= | ||
3 | |||
4 | Um asynchrone Aufgaben zu starten (nützlich z.B. für große Imports), können wir Redis nutzen. | ||
5 | |||
6 | Voraussetzungen | ||
7 | --------------- | ||
8 | |||
9 | Du musst Redis auf deinem Server installiert haben. | ||
10 | |||
11 | Installation | ||
12 | ~~~~~~~~~~~~ | ||
13 | |||
14 | .. code:: bash | ||
15 | |||
16 | apt-get install redis-server | ||
17 | |||
18 | Starten | ||
19 | ~~~~~~ | ||
20 | |||
21 | Der Redis Service läuft eventuell schon direkt nach der Installation. Falls nicht kannst du ihn wie folgt starten: | ||
22 | |||
23 | .. code:: bash | ||
24 | |||
25 | redis-server | ||
26 | |||
27 | |||
28 | Konfigure Redis in wallabag | ||
29 | --------------------------- | ||
30 | |||
31 | Bearbeite die Datei ``parameters.yml``, um die RabbitMQ Konfiguration einzurichten. Die Standardkonfiguration sollte ok sein: | ||
32 | |||
33 | .. code:: yaml | ||
34 | |||
35 | redis_host: localhost | ||
36 | redis_port: 6379 | ||
37 | |||
38 | |||
39 | Starte den Redis Consumer | ||
40 | ------------------------- | ||
41 | |||
42 | Abhängig von welchem Service du importieren möchtest, solltest du einen Cron Job aktivieren (oder mehrere, wenn du viele unterstützen willst): | ||
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 Readability import | ||
50 | bin/console wallabag:import:redis-worker readability -vv >> /path/to/wallabag/var/logs/redis-readability.log | ||
51 | |||
52 | # for Instapaper import | ||
53 | bin/console wallabag:import:redis-worker instapaper -vv >> /path/to/wallabag/var/logs/redis-instapaper.log | ||
54 | |||
55 | # for wallabag v1 import | ||
56 | bin/console wallabag:import:redis-worker wallabag_v1 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v1.log | ||
57 | |||
58 | # for wallabag v2 import | ||
59 | bin/console wallabag:import:redis-worker wallabag_v2 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v2.log | ||
60 | |||
61 | # for Firefox import | ||
62 | bin/console wallabag:import:redis-worker firefox -vv >> /path/to/wallabag/var/logs/redis-firefox.log | ||
63 | |||
64 | # for Chrome import | ||
65 | bin/console wallabag:import:redis-worker instapaper -vv >> /path/to/wallabag/var/logs/redis-chrome.log | ||
66 | |||
67 | Wenn du den Import nur für ein paar Nachrichten und nicht für alle starten willst, kannst du die Nummer (im folgenden Beispiel 12) angeben. Der Redis Worker wird dann nach der 12. Nachricht stoppen: | ||
68 | |||
69 | .. code:: bash | ||
70 | |||
71 | bin/console wallabag:import:redis-worker pocket -vv --maxIterations=12 | ||
diff --git a/docs/de/index.rst b/docs/de/index.rst index 5311150f..b3cd33b0 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:: |
@@ -25,7 +30,8 @@ Die Hauptdokumentation für diese Applikation ist in einigen Abschnitten organis | |||
25 | 30 | ||
26 | user/faq | 31 | user/faq |
27 | user/installation | 32 | user/installation |
28 | user/upgrade | 33 | user/upgrade-2.0.x-2.1.y |
34 | user/upgrade-2.0.x-2.0.y | ||
29 | user/migration | 35 | user/migration |
30 | user/import | 36 | user/import |
31 | user/create_account | 37 | user/create_account |
@@ -50,3 +56,5 @@ Die Hauptdokumentation für diese Applikation ist in einigen Abschnitten organis | |||
50 | developer/documentation | 56 | developer/documentation |
51 | developer/translate | 57 | developer/translate |
52 | developer/maintenance | 58 | developer/maintenance |
59 | developer/redis | ||
60 | developer/rabbitmq | ||
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-2.0.x-2.0.y.rst index c04b68f3..adf288bd 100644 --- a/docs/de/user/upgrade.rst +++ b/docs/de/user/upgrade-2.0.x-2.0.y.rst | |||
@@ -1,5 +1,5 @@ | |||
1 | Wallabag updaten | 1 | Wallabag updaten 2.0.x -> 2.1.x |
2 | ================ | 2 | =============================== |
3 | 3 | ||
4 | Update auf einem dedizierten Webserver | 4 | Update auf einem dedizierten Webserver |
5 | -------------------------------------- | 5 | -------------------------------------- |
diff --git a/docs/de/user/upgrade-2.0.x-2.1.y.rst b/docs/de/user/upgrade-2.0.x-2.1.y.rst new file mode 100644 index 00000000..85229d30 --- /dev/null +++ b/docs/de/user/upgrade-2.0.x-2.1.y.rst | |||
@@ -0,0 +1,64 @@ | |||
1 | Wallabag updaten | ||
2 | ================ | ||
3 | |||
4 | .. warning:: | ||
5 | Wenn du den Import von Pocket durch das Hinzufügen des Consumer Key in den internen Einstellungen konfiguriert hast, fertige bitte ein Backup deines Keys an, bevor du auf das neue Release migrierst: Du wirst den Key nach dem Update in der Konfiguration erneut eintragen müssen. | ||
6 | |||
7 | Update auf einem dedizierten Webserver | ||
8 | -------------------------------------- | ||
9 | |||
10 | Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.html veröffentlicht. Um deine wallabag-Installation auf die neueste Version zu aktualisieren, führe die folgenden Kommandos in deinem wallabag-Ordner aus (ersetze ``2.1.0`` mit der neuesten Releasenummer): | ||
11 | |||
12 | :: | ||
13 | |||
14 | git fetch origin | ||
15 | git fetch --tags | ||
16 | git checkout 2.1.0 | ||
17 | ASSETS=build ./install.sh | ||
18 | php bin/console doctrine:migrations:migrate --env=prod | ||
19 | php bin/console cache:clear --env=prod | ||
20 | |||
21 | Update auf einem Shared Webhosting | ||
22 | ---------------------------------- | ||
23 | |||
24 | Sichere deine ``app/config/parameters.yml`` Datei. | ||
25 | |||
26 | Lade das neueste Release von wallabag herunter: | ||
27 | |||
28 | .. code-block:: bash | ||
29 | |||
30 | wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package | ||
31 | |||
32 | (md5 hash: ``4f84c725d1d6e3345eae0a406115e5ff``) | ||
33 | |||
34 | Entpacke das Archiv in deinen wallabag-Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei. | ||
35 | |||
36 | Bitte beachte, dass wir in dieser Version neue Parameter hinzugefügt haben. Du musst die Datei ``app/config/parameters.yml`` bearbeiten und die folgenden Zeilen hinzufügen (ersetze die Werte mit deiner Konfiguration): | ||
37 | |||
38 | .. code-block:: bash | ||
39 | |||
40 | # RabbitMQ processing | ||
41 | rabbitmq_host: localhost | ||
42 | rabbitmq_port: 5672 | ||
43 | rabbitmq_user: guest | ||
44 | rabbitmq_password: guest | ||
45 | |||
46 | # Redis processing | ||
47 | redis_host: localhost | ||
48 | redis_port: 6379 | ||
49 | |||
50 | Wenn du SQLite nutzt, musst auch das ``data/`` Verzeichnis in die neue Installation kopieren. | ||
51 | |||
52 | Leere den ``var/cache`` Ordner. | ||
53 | |||
54 | Du musst einige SQL-Abfragen ausführen, um die Datenbank zu aktualisieren. Wir nehmen in diesem Fall an, dass das Tabellenpräfix ``wallabag_`` ist und eine MySQL-Datenbank genutzt wird: | ||
55 | |||
56 | .. code-block:: sql | ||
57 | |||
58 | ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL; | ||
59 | INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry'); | ||
60 | ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL; | ||
61 | INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import'); | ||
62 | INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import'); | ||
63 | ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL; | ||
64 | DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key'; | ||
diff --git a/docs/en/conf.py b/docs/en/conf.py index 86e33704..717b35f1 100644 --- a/docs/en/conf.py +++ b/docs/en/conf.py | |||
@@ -12,7 +12,7 @@ source_suffix = '.rst' | |||
12 | master_doc = 'index' | 12 | master_doc = 'index' |
13 | project = u'wallabag' | 13 | project = u'wallabag' |
14 | copyright = u'2013-2016, Nicolas Lœuillet - MIT Licence' | 14 | copyright = u'2013-2016, Nicolas Lœuillet - MIT Licence' |
15 | version = '2.0.0' | 15 | version = '2.1.0' |
16 | release = version | 16 | release = version |
17 | exclude_patterns = ['_build'] | 17 | exclude_patterns = ['_build'] |
18 | pygments_style = 'sphinx' | 18 | pygments_style = 'sphinx' |
diff --git a/docs/en/developer/rabbitmq.rst b/docs/en/developer/rabbitmq.rst new file mode 100644 index 00000000..63b85106 --- /dev/null +++ b/docs/en/developer/rabbitmq.rst | |||
@@ -0,0 +1,76 @@ | |||
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 Readability import | ||
61 | bin/console rabbitmq:consumer import_readability -w | ||
62 | |||
63 | # for Instapaper import | ||
64 | bin/console rabbitmq:consumer import_instapaper -w | ||
65 | |||
66 | # for wallabag v1 import | ||
67 | bin/console rabbitmq:consumer import_wallabag_v1 -w | ||
68 | |||
69 | # for wallabag v2 import | ||
70 | bin/console rabbitmq:consumer import_wallabag_v2 -w | ||
71 | |||
72 | # for Firefox import | ||
73 | bin/console rabbitmq:consumer import_firefox -w | ||
74 | |||
75 | # for Chrome import | ||
76 | bin/console rabbitmq:consumer import_chrome -w | ||
diff --git a/docs/en/developer/redis.rst b/docs/en/developer/redis.rst new file mode 100644 index 00000000..820a52e9 --- /dev/null +++ b/docs/en/developer/redis.rst | |||
@@ -0,0 +1,71 @@ | |||
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 Readability import | ||
50 | bin/console wallabag:import:redis-worker readability -vv >> /path/to/wallabag/var/logs/redis-readability.log | ||
51 | |||
52 | # for Instapaper import | ||
53 | bin/console wallabag:import:redis-worker instapaper -vv >> /path/to/wallabag/var/logs/redis-instapaper.log | ||
54 | |||
55 | # for wallabag v1 import | ||
56 | bin/console wallabag:import:redis-worker wallabag_v1 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v1.log | ||
57 | |||
58 | # for wallabag v2 import | ||
59 | bin/console wallabag:import:redis-worker wallabag_v2 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v2.log | ||
60 | |||
61 | # for Firefox import | ||
62 | bin/console wallabag:import:redis-worker firefox -vv >> /path/to/wallabag/var/logs/redis-firefox.log | ||
63 | |||
64 | # for Chrome import | ||
65 | bin/console wallabag:import:redis-worker instapaper -vv >> /path/to/wallabag/var/logs/redis-chrome.log | ||
66 | |||
67 | 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 : | ||
68 | |||
69 | .. code:: bash | ||
70 | |||
71 | bin/console wallabag:import:redis-worker pocket -vv --maxIterations=12 | ||
diff --git a/docs/en/index.rst b/docs/en/index.rst index 03025ef9..beb3816e 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:: |
@@ -25,7 +30,8 @@ The main documentation for this application is organized into a couple sections: | |||
25 | 30 | ||
26 | user/faq | 31 | user/faq |
27 | user/installation | 32 | user/installation |
28 | user/upgrade | 33 | user/upgrade-2.0.x-2.1.y |
34 | user/upgrade-2.0.x-2.0.y | ||
29 | user/migration | 35 | user/migration |
30 | user/import | 36 | user/import |
31 | user/create_account | 37 | user/create_account |
@@ -35,6 +41,7 @@ The main documentation for this application is organized into a couple sections: | |||
35 | user/errors_during_fetching | 41 | user/errors_during_fetching |
36 | user/annotations | 42 | user/annotations |
37 | user/download_articles | 43 | user/download_articles |
44 | user/share | ||
38 | user/filters | 45 | user/filters |
39 | user/tags | 46 | user/tags |
40 | user/android | 47 | user/android |
@@ -50,3 +57,5 @@ The main documentation for this application is organized into a couple sections: | |||
50 | developer/documentation | 57 | developer/documentation |
51 | developer/translate | 58 | developer/translate |
52 | developer/maintenance | 59 | developer/maintenance |
60 | developer/redis | ||
61 | developer/rabbitmq | ||
diff --git a/docs/en/user/import.rst b/docs/en/user/import.rst index 63210484..758e3816 100644 --- a/docs/en/user/import.rst +++ b/docs/en/user/import.rst | |||
@@ -23,22 +23,43 @@ Now, all is fine to migrate from Pocket. | |||
23 | Import your data into wallabag 2.x | 23 | Import your data into wallabag 2.x |
24 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 24 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
25 | 25 | ||
26 | Click on ``Import`` link in the menu, on ``Import contents`` in Pocket section | 26 | Click on ``Import`` link in the menu, on ``Import contents`` in Pocket section |
27 | and then on ``Connect to Pocket and import data``. | 27 | and then on ``Connect to Pocket and import data``. |
28 | 28 | ||
29 | You need to authorize wallabag to interact with your Pocket account. | 29 | 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 | |
32 | From Readability | ||
33 | ---------------- | ||
34 | |||
35 | Export your Readability data | ||
36 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
37 | |||
38 | 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). | ||
39 | |||
40 | Import your data into wallabag 2.x | ||
41 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
42 | |||
43 | Click on ``Import`` link in the menu, on ``Import contents`` in Readability section | ||
44 | and then select your json file and upload it. | ||
45 | |||
46 | Your data will be imported. Data import can be a demanding process for your server. | ||
32 | 47 | ||
33 | From Instapaper | 48 | From Instapaper |
34 | --------------- | 49 | --------------- |
35 | 50 | ||
36 | *Feature not yet implemented in wallabag v2.* | 51 | Export your Instapaper data |
52 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
37 | 53 | ||
38 | From Readability | 54 | On the settings (`https://www.instapaper.com/user<https://www.instapaper.com/user>`_) page, click on "Download .CSV file" in the "Export" section. A CSV file will be downloaded (like ``instapaper-export.csv``). |
39 | ---------------- | ||
40 | 55 | ||
41 | *Feature not yet implemented in wallabag v2.* | 56 | Import your data into wallabag 2.x |
57 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
58 | |||
59 | Click on ``Import`` link in the menu, on ``Import contents`` in Instapaper section | ||
60 | and then select your CSV file and upload it. | ||
61 | |||
62 | Your data will be imported. Data import can be a demanding process for your server. | ||
42 | 63 | ||
43 | From HTML or JSON file | 64 | From HTML or JSON file |
44 | ---------------------- | 65 | ---------------------- |
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-2.0.x-2.0.y.rst index 90ed6c70..6a0818b3 100644 --- a/docs/en/user/upgrade.rst +++ b/docs/en/user/upgrade-2.0.x-2.0.y.rst | |||
@@ -1,5 +1,5 @@ | |||
1 | Upgrade wallabag | 1 | Upgrade from 2.0.x to 2.0.y |
2 | ================ | 2 | =========================== |
3 | 3 | ||
4 | Upgrade on a dedicated web server | 4 | Upgrade on a dedicated web server |
5 | --------------------------------- | 5 | --------------------------------- |
@@ -25,7 +25,7 @@ Download the last release of wallabag: | |||
25 | 25 | ||
26 | wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package | 26 | wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package |
27 | 27 | ||
28 | (md5 hash of the package: ``4f84c725d1d6e3345eae0a406115e5ff``) | 28 | (md5 hash of the 2.0.8 package: ``4f84c725d1d6e3345eae0a406115e5ff``) |
29 | 29 | ||
30 | Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. | 30 | Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. |
31 | 31 | ||
diff --git a/docs/en/user/upgrade-2.0.x-2.1.y.rst b/docs/en/user/upgrade-2.0.x-2.1.y.rst new file mode 100644 index 00000000..5ae5eb43 --- /dev/null +++ b/docs/en/user/upgrade-2.0.x-2.1.y.rst | |||
@@ -0,0 +1,64 @@ | |||
1 | Upgrading from 2.0.x to 2.1.y | ||
2 | ============================= | ||
3 | |||
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. | ||
6 | |||
7 | Upgrade on a dedicated web server | ||
8 | --------------------------------- | ||
9 | |||
10 | 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): | ||
11 | |||
12 | :: | ||
13 | |||
14 | git fetch origin | ||
15 | git fetch --tags | ||
16 | git checkout 2.1.0 | ||
17 | ASSETS=build ./install.sh | ||
18 | php bin/console doctrine:migrations:migrate --env=prod | ||
19 | php bin/console cache:clear --env=prod | ||
20 | |||
21 | Upgrade on a shared hosting | ||
22 | --------------------------- | ||
23 | |||
24 | Backup your ``app/config/parameters.yml`` file. | ||
25 | |||
26 | Download the last release of wallabag: | ||
27 | |||
28 | .. code-block:: bash | ||
29 | |||
30 | wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package | ||
31 | |||
32 | (md5 hash of the package: ``4f84c725d1d6e3345eae0a406115e5ff``) | ||
33 | |||
34 | Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. | ||
35 | |||
36 | Please note that we added new parameters in this version. You have to edit ``app/config/parameters.yml`` by adding these lines (replace with your configuration) : | ||
37 | |||
38 | .. code-block:: bash | ||
39 | |||
40 | # RabbitMQ processing | ||
41 | rabbitmq_host: localhost | ||
42 | rabbitmq_port: 5672 | ||
43 | rabbitmq_user: guest | ||
44 | rabbitmq_password: guest | ||
45 | |||
46 | # Redis processing | ||
47 | redis_host: localhost | ||
48 | redis_port: 6379 | ||
49 | |||
50 | If you use SQLite, you must also copy your ``data/`` folder inside the new installation. | ||
51 | |||
52 | Empty ``var/cache`` folder. | ||
53 | |||
54 | You must run some SQL queries to upgrade your database. We assume that the table prefix is ``wallabag_`` and the database server is a MySQL one: | ||
55 | |||
56 | .. code-block:: sql | ||
57 | |||
58 | ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL; | ||
59 | INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry'); | ||
60 | ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL; | ||
61 | INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import'); | ||
62 | INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import'); | ||
63 | ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL; | ||
64 | DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key'; | ||
diff --git a/docs/fr/conf.py b/docs/fr/conf.py index f1fe3967..49a57e2d 100644 --- a/docs/fr/conf.py +++ b/docs/fr/conf.py | |||
@@ -12,7 +12,7 @@ source_suffix = '.rst' | |||
12 | master_doc = 'index' | 12 | master_doc = 'index' |
13 | project = u'wallabag-fr' | 13 | project = u'wallabag-fr' |
14 | copyright = u'2013-2016, Nicolas Lœuillet - MIT Licence' | 14 | copyright = u'2013-2016, Nicolas Lœuillet - MIT Licence' |
15 | version = '2.0.0' | 15 | version = '2.1.0' |
16 | release = version | 16 | release = version |
17 | exclude_patterns = ['_build'] | 17 | exclude_patterns = ['_build'] |
18 | pygments_style = 'sphinx' | 18 | pygments_style = 'sphinx' |
diff --git a/docs/fr/developer/rabbitmq.rst b/docs/fr/developer/rabbitmq.rst new file mode 100644 index 00000000..20182e6e --- /dev/null +++ b/docs/fr/developer/rabbitmq.rst | |||
@@ -0,0 +1,76 @@ | |||
1 | Installer RabbitMQ pour des tâches asynchrones | ||
2 | ============================================== | ||
3 | |||
4 | Pour lancer des tâches asynchrones (utile pour des imports importants par exemple), nous pouvons utiliser RabbitMQ. | ||
5 | |||
6 | Pré-requis | ||
7 | ---------- | ||
8 | |||
9 | Vous devez installer RabbitMQ sur votre serveur. | ||
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 et démarrage | ||
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 | Arrêter RabbitMQ | ||
30 | ~~~~~~~~~~~~~~~~ | ||
31 | |||
32 | .. code:: bash | ||
33 | |||
34 | rabbitmqctl stop | ||
35 | |||
36 | |||
37 | Configurer RabbitMQ dans wallabag | ||
38 | --------------------------------- | ||
39 | |||
40 | Modifiez votre fichier ``parameters.yml`` pour éditer la configuration RabbitMQ. Celle par défaut devrait convenir : | ||
41 | |||
42 | .. code:: yaml | ||
43 | |||
44 | rabbitmq_host: localhost | ||
45 | rabbitmq_port: 5672 | ||
46 | rabbitmq_user: guest | ||
47 | rabbitmq_password: guest | ||
48 | |||
49 | |||
50 | Démarrer les clients RabbitMQ | ||
51 | ----------------------------- | ||
52 | |||
53 | En fonction du service dont vous souhaitez importer vos données, vous devez activer un (ou plusieurs si vous souhaitez en supporter plusieurs) cron job : | ||
54 | |||
55 | .. code:: bash | ||
56 | |||
57 | # for Pocket import | ||
58 | bin/console rabbitmq:consumer import_pocket -w | ||
59 | |||
60 | # for Readability import | ||
61 | bin/console rabbitmq:consumer import_readability -w | ||
62 | |||
63 | # for Instapaper import | ||
64 | bin/console rabbitmq:consumer import_instapaper -w | ||
65 | |||
66 | # for wallabag v1 import | ||
67 | bin/console rabbitmq:consumer import_wallabag_v1 -w | ||
68 | |||
69 | # for wallabag v2 import | ||
70 | bin/console rabbitmq:consumer import_wallabag_v2 -w | ||
71 | |||
72 | # for Firefox import | ||
73 | bin/console rabbitmq:consumer import_firefox -w | ||
74 | |||
75 | # for Chrome import | ||
76 | bin/console rabbitmq:consumer import_chrome -w | ||
diff --git a/docs/fr/developer/redis.rst b/docs/fr/developer/redis.rst new file mode 100644 index 00000000..097e375d --- /dev/null +++ b/docs/fr/developer/redis.rst | |||
@@ -0,0 +1,71 @@ | |||
1 | Installer Redis pour des tâches asynchrones | ||
2 | =========================================== | ||
3 | |||
4 | Pour lancer des tâches asynchrones (utile pour des imports importants par exemple), nous pouvons utiliser Redis. | ||
5 | |||
6 | Pré-requis | ||
7 | ---------- | ||
8 | |||
9 | Vous devez installer Redis sur votre serveur. | ||
10 | |||
11 | Installation | ||
12 | ~~~~~~~~~~~~ | ||
13 | |||
14 | .. code:: bash | ||
15 | |||
16 | apt-get install redis-server | ||
17 | |||
18 | Démarrage | ||
19 | ~~~~~~~~~ | ||
20 | |||
21 | Le serveur devrait déjà être démarré après l'installation. Si ce n'est pas le cas, vous pouvez le démarrer ainsi : | ||
22 | |||
23 | .. code:: bash | ||
24 | |||
25 | redis-server | ||
26 | |||
27 | |||
28 | Configurer Redis dans wallabag | ||
29 | ------------------------------- | ||
30 | |||
31 | Modifiez votre fichier ``parameters.yml`` pour éditer la configuration Redis. Celle par défaut devrait convenir : | ||
32 | |||
33 | .. code:: yaml | ||
34 | |||
35 | redis_host: localhost | ||
36 | redis_port: 6379 | ||
37 | |||
38 | |||
39 | Démarrer les clients Redis | ||
40 | -------------------------- | ||
41 | |||
42 | En fonction du service dont vous souhaitez importer vos données, vous devez activer un (ou plusieurs si vous souhaitez en supporter plusieurs) 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 Readability import | ||
50 | bin/console wallabag:import:redis-worker readability -vv >> /path/to/wallabag/var/logs/redis-readability.log | ||
51 | |||
52 | # for Instapaper import | ||
53 | bin/console wallabag:import:redis-worker instapaper -vv >> /path/to/wallabag/var/logs/redis-instapaper.log | ||
54 | |||
55 | # for wallabag v1 import | ||
56 | bin/console wallabag:import:redis-worker wallabag_v1 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v1.log | ||
57 | |||
58 | # for wallabag v2 import | ||
59 | bin/console wallabag:import:redis-worker wallabag_v2 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v2.log | ||
60 | |||
61 | # for Firefox import | ||
62 | bin/console wallabag:import:redis-worker firefox -vv >> /path/to/wallabag/var/logs/redis-firefox.log | ||
63 | |||
64 | # for Chrome import | ||
65 | bin/console wallabag:import:redis-worker instapaper -vv >> /path/to/wallabag/var/logs/redis-chrome.log | ||
66 | |||
67 | Si vous souhaitez démarrer l'import pour quelques messages uniquement, vous pouvez spécifier cette valeur en paramètre (ici 12) et le client va s'arrêter après le 12ème message : | ||
68 | |||
69 | .. code:: bash | ||
70 | |||
71 | bin/console wallabag:import:redis-worker pocket -vv --maxIterations=12 | ||
diff --git a/docs/fr/index.rst b/docs/fr/index.rst index 1e72dae7..359b103c 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:: |
@@ -26,7 +31,8 @@ La documentation principale de cette application est découpée en plusieurs sec | |||
26 | 31 | ||
27 | user/faq | 32 | user/faq |
28 | user/installation | 33 | user/installation |
29 | user/upgrade | 34 | user/upgrade-2.0.x-2.1.y |
35 | user/upgrade-2.0.x-2.0.y | ||
30 | user/migration | 36 | user/migration |
31 | user/import | 37 | user/import |
32 | user/create_account | 38 | user/create_account |
@@ -36,6 +42,7 @@ La documentation principale de cette application est découpée en plusieurs sec | |||
36 | user/errors_during_fetching | 42 | user/errors_during_fetching |
37 | user/annotations | 43 | user/annotations |
38 | user/download_articles | 44 | user/download_articles |
45 | user/share | ||
39 | user/filters | 46 | user/filters |
40 | user/tags | 47 | user/tags |
41 | 48 | ||
@@ -50,3 +57,5 @@ La documentation principale de cette application est découpée en plusieurs sec | |||
50 | developer/documentation | 57 | developer/documentation |
51 | developer/translate | 58 | developer/translate |
52 | developer/maintenance | 59 | developer/maintenance |
60 | developer/redis | ||
61 | developer/rabbitmq | ||
diff --git a/docs/fr/user/import.rst b/docs/fr/user/import.rst index e6c2fa02..6f114dd6 100644 --- a/docs/fr/user/import.rst +++ b/docs/fr/user/import.rst | |||
@@ -28,17 +28,40 @@ la section Pocket puis sur ``Se connecter à Pocket et importer les données``. | |||
28 | 28 | ||
29 | Vous devez autoriser wallabag à se connecter à votre compte Pocket. | 29 | 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. |
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. | ||
32 | 48 | ||
33 | Depuis Instapaper | 49 | Depuis Instapaper |
34 | ----------------- | 50 | ----------------- |
35 | 51 | ||
36 | *Fonctionnalité pas encore implémentée dans wallabag v2.* | 52 | Exportez vos données de Instapaper |
53 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
37 | 54 | ||
38 | Depuis Readability | 55 | Sur la page des paramètres (`https://www.instapaper.com/user<https://www.instapaper.com/user>`_), cliquez sur "Download .CSV file" dans la section "Export". Un fichier CSV se téléchargera (``instapaper-export.csv``). |
39 | ------------------ | 56 | |
57 | Importez vos données dans wallabag 2.x | ||
58 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
59 | |||
60 | Cliquez sur le lien ``Importer`` dans le menu, sur ``Importer les contenus`` dans | ||
61 | la section Instapaper et ensuite sélectionnez votre fichier CSV pour l'uploader. | ||
62 | |||
63 | Vos données vont être importées. L'import de données est une action qui peut être couteuse pour votre serveur. | ||
40 | 64 | ||
41 | *Fonctionnalité pas encore implémentée dans wallabag v2.* | ||
42 | 65 | ||
43 | Depuis un fichier HTML ou JSON | 66 | Depuis un fichier HTML ou JSON |
44 | ------------------------------ | 67 | ------------------------------ |
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-2.0.x-2.0.y.rst index 1ead2c94..d8dfac6e 100644 --- a/docs/fr/user/upgrade.rst +++ b/docs/fr/user/upgrade-2.0.x-2.0.y.rst | |||
@@ -1,5 +1,5 @@ | |||
1 | Mettre à jour wallabag | 1 | Mettre à jour de la 2.0.x à la 2.0.y |
2 | ====================== | 2 | ==================================== |
3 | 3 | ||
4 | Mise à jour sur un serveur dédié | 4 | Mise à jour sur un serveur dédié |
5 | -------------------------------- | 5 | -------------------------------- |
@@ -25,7 +25,7 @@ Téléchargez la dernière version de wallabag : | |||
25 | 25 | ||
26 | wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package | 26 | wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package |
27 | 27 | ||
28 | (hash md5 de l'archive : ``4f84c725d1d6e3345eae0a406115e5ff``) | 28 | (hash md5 de l'archive 2.0.8 : ``4f84c725d1d6e3345eae0a406115e5ff``) |
29 | 29 | ||
30 | Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre. | 30 | Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre. |
31 | 31 | ||
diff --git a/docs/fr/user/upgrade-2.0.x-2.1.y.rst b/docs/fr/user/upgrade-2.0.x-2.1.y.rst new file mode 100644 index 00000000..a4afe768 --- /dev/null +++ b/docs/fr/user/upgrade-2.0.x-2.1.y.rst | |||
@@ -0,0 +1,65 @@ | |||
1 | Mettre à jour de la 2.0.x à la 2.1.y | ||
2 | ==================================== | ||
3 | |||
4 | .. warning:: | ||
5 | Avant cette migration, si vous aviez configuré l'import depuis Pocket en ajoutant votre consumer key dans les paramètres internes, pensez à effectuer une sauvegarde de celle-ci : vous devrez l'ajouter dans la configuration de wallabag après la mise à jour. | ||
6 | |||
7 | Mise à jour sur un serveur dédié | ||
8 | -------------------------------- | ||
9 | |||
10 | 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) : | ||
11 | |||
12 | :: | ||
13 | |||
14 | git fetch origin | ||
15 | git fetch --tags | ||
16 | git checkout 2.1.0 | ||
17 | ASSETS=build ./install.sh | ||
18 | php bin/console doctrine:migrations:migrate --env=prod | ||
19 | php bin/console cache:clear --env=prod | ||
20 | |||
21 | Mise à jour sur un hébergement mutualisé | ||
22 | ---------------------------------------- | ||
23 | |||
24 | Effectuez une sauvegarde du fichier ``app/config/parameters.yml``. | ||
25 | |||
26 | Téléchargez la dernière version de wallabag : | ||
27 | |||
28 | .. code-block:: bash | ||
29 | |||
30 | wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package | ||
31 | |||
32 | (hash md5 de l'archive : ``4f84c725d1d6e3345eae0a406115e5ff``) | ||
33 | |||
34 | Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre. | ||
35 | |||
36 | Nous avons ajouté de nouveaux paramètres dans cette nouvelle version. Vous devez donc éditer le fichier ``app/config/parameters.yml`` en ajoutant ces lignes (et en remplaçant par votre configuration) : | ||
37 | |||
38 | .. code-block:: bash | ||
39 | |||
40 | # RabbitMQ processing | ||
41 | rabbitmq_host: localhost | ||
42 | rabbitmq_port: 5672 | ||
43 | rabbitmq_user: guest | ||
44 | rabbitmq_password: guest | ||
45 | |||
46 | # Redis processing | ||
47 | redis_host: localhost | ||
48 | redis_port: 6379 | ||
49 | |||
50 | Si vous utilisez SQLite, vous devez également conserver le contenu du répertoire ``data/``. | ||
51 | |||
52 | Videz le répertoire ``var/cache``. | ||
53 | |||
54 | Vous allez devoir également exécuter des requêtes SQL pour mettre à jour votre base de données. Nous partons du principe que le préfixe de vos tables est ``wallabag_`` et que le serveur SQL est un serveur MySQL : | ||
55 | |||
56 | .. code-block:: sql | ||
57 | |||
58 | ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL; | ||
59 | INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry'); | ||
60 | ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL; | ||
61 | INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import'); | ||
62 | INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import'); | ||
63 | ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL; | ||
64 | DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key'; | ||
65 | |||
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 | |||