aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/de/conf.py2
-rw-r--r--docs/de/developer/docker.rst2
-rw-r--r--docs/de/developer/rabbitmq.rst77
-rw-r--r--docs/de/developer/redis.rst71
-rw-r--r--docs/de/index.rst5
-rw-r--r--docs/de/user/upgrade-2.0.x-2.0.y.rst (renamed from docs/de/user/upgrade.rst)11
-rw-r--r--docs/de/user/upgrade-2.0.x-2.1.y.rst64
-rw-r--r--docs/en/conf.py2
-rw-r--r--docs/en/developer/docker.rst2
-rw-r--r--docs/en/developer/rabbitmq.rst11
-rw-r--r--docs/en/developer/redis.rst15
-rw-r--r--docs/en/index.rst5
-rw-r--r--docs/en/user/import.rst22
-rw-r--r--docs/en/user/upgrade-2.0.x-2.0.y.rst (renamed from docs/en/user/upgrade.rst)13
-rw-r--r--docs/en/user/upgrade-2.0.x-2.1.y.rst64
-rw-r--r--docs/fr/conf.py2
-rw-r--r--docs/fr/developer/docker.rst2
-rw-r--r--docs/fr/developer/rabbitmq.rst76
-rw-r--r--docs/fr/developer/redis.rst71
-rw-r--r--docs/fr/index.rst5
-rw-r--r--docs/fr/user/import.rst17
-rw-r--r--docs/fr/user/upgrade-2.0.x-2.0.y.rst (renamed from docs/fr/user/upgrade.rst)13
-rw-r--r--docs/fr/user/upgrade-2.0.x-2.1.y.rst65
23 files changed, 578 insertions, 39 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'
12master_doc = 'index' 12master_doc = 'index'
13project = u'wallabag-fr' 13project = u'wallabag-fr'
14copyright = u'2013-2016, Nicolas Lœuillet - MIT Licence' 14copyright = u'2013-2016, Nicolas Lœuillet - MIT Licence'
15version = '2.0.0' 15version = '2.1.0'
16release = version 16release = version
17exclude_patterns = ['_build'] 17exclude_patterns = ['_build']
18pygments_style = 'sphinx' 18pygments_style = 'sphinx'
diff --git a/docs/de/developer/docker.rst b/docs/de/developer/docker.rst
index c63194aa..9948fe8c 100644
--- a/docs/de/developer/docker.rst
+++ b/docs/de/developer/docker.rst
@@ -44,7 +44,7 @@ wallabag laufen lassen
44 Eigenschaften mit den kommentierten zu ersetzen (mit Werten 44 Eigenschaften mit den kommentierten zu ersetzen (mit Werten
45 mit ``env.`` Präfix) 45 mit ``env.`` Präfix)
46#. ``composer install`` die Projektabhängigkeiten 46#. ``composer install`` die Projektabhängigkeiten
47#. ``php app/console wallabag:install``, um das Schema zu erstellen 47#. ``php bin/console wallabag:install``, um das Schema zu erstellen
48#. ``docker-compose up`` um die Container laufen zu lassen 48#. ``docker-compose up`` um die Container laufen zu lassen
49#. Schließlich öffne http://localhost:8080/, um dein frisch 49#. Schließlich öffne http://localhost:8080/, um dein frisch
50 installiertes wallabag zu finden. 50 installiertes wallabag zu finden.
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 @@
1Installiere RabbitMQ für asynchrone Aufgaben
2============================================
3
4Um asynchrone Aufgaben zu starten (nützlich z.B. für große Imports), können wir RabbitMQ nutzen.
5
6Voraussetzungen
7---------------
8
9Du musst RabbitMQ auf deinem Server installiert haben.
10
11Installation
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
21Konfiguration 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
29RabbitMQ stoppen
30~~~~~~~~~~~~~~~
31
32.. code:: bash
33
34 rabbitmqctl stop
35
36
37Konfigure RabbitMQ in wallabag
38------------------------------
39
40Bearbeite 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
50Starte den RabbitMQ Consumer
51----------------------------
52
53Abhä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 @@
1Installiere Redis für asynchrone Aufgaben
2=========================================
3
4Um asynchrone Aufgaben zu starten (nützlich z.B. für große Imports), können wir Redis nutzen.
5
6Voraussetzungen
7---------------
8
9Du musst Redis auf deinem Server installiert haben.
10
11Installation
12~~~~~~~~~~~~
13
14.. code:: bash
15
16 apt-get install redis-server
17
18Starten
19~~~~~~
20
21Der 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
28Konfigure Redis in wallabag
29---------------------------
30
31Bearbeite 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
39Starte den Redis Consumer
40-------------------------
41
42Abhä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
67Wenn 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 d8cd8f39..b3cd33b0 100644
--- a/docs/de/index.rst
+++ b/docs/de/index.rst
@@ -30,7 +30,8 @@ Die Dokumentation ist in anderen Sprachen verfügbar :
30 30
31 user/faq 31 user/faq
32 user/installation 32 user/installation
33 user/upgrade 33 user/upgrade-2.0.x-2.1.y
34 user/upgrade-2.0.x-2.0.y
34 user/migration 35 user/migration
35 user/import 36 user/import
36 user/create_account 37 user/create_account
@@ -55,3 +56,5 @@ Die Dokumentation ist in anderen Sprachen verfügbar :
55 developer/documentation 56 developer/documentation
56 developer/translate 57 developer/translate
57 developer/maintenance 58 developer/maintenance
59 developer/redis
60 developer/rabbitmq
diff --git a/docs/de/user/upgrade.rst b/docs/de/user/upgrade-2.0.x-2.0.y.rst
index 953c84ff..adf288bd 100644
--- a/docs/de/user/upgrade.rst
+++ b/docs/de/user/upgrade-2.0.x-2.0.y.rst
@@ -1,17 +1,18 @@
1Wallabag updaten 1Wallabag updaten 2.0.x -> 2.1.x
2================ 2===============================
3 3
4Update auf einem dedizierten Webserver 4Update auf einem dedizierten Webserver
5-------------------------------------- 5--------------------------------------
6 6
7Das 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): 7Das 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):
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.1.0 13 git checkout 2.0.8
14 ./install.sh 14 SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
15 php bin/console cache:clear --env=prod
15 16
16Update auf einem Shared Webhosting 17Update auf einem Shared Webhosting
17---------------------------------- 18----------------------------------
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 @@
1Wallabag updaten
2================
3
4.. warning::
5Wenn 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
7Update auf einem dedizierten Webserver
8--------------------------------------
9
10Das 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
21Update auf einem Shared Webhosting
22----------------------------------
23
24Sichere deine ``app/config/parameters.yml`` Datei.
25
26Lade 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
34Entpacke das Archiv in deinen wallabag-Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei.
35
36Bitte 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
50Wenn du SQLite nutzt, musst auch das ``data/`` Verzeichnis in die neue Installation kopieren.
51
52Leere den ``var/cache`` Ordner.
53
54Du 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'
12master_doc = 'index' 12master_doc = 'index'
13project = u'wallabag' 13project = u'wallabag'
14copyright = u'2013-2016, Nicolas Lœuillet - MIT Licence' 14copyright = u'2013-2016, Nicolas Lœuillet - MIT Licence'
15version = '2.0.0' 15version = '2.1.0'
16release = version 16release = version
17exclude_patterns = ['_build'] 17exclude_patterns = ['_build']
18pygments_style = 'sphinx' 18pygments_style = 'sphinx'
diff --git a/docs/en/developer/docker.rst b/docs/en/developer/docker.rst
index 8816cbcf..5e4f2ce6 100644
--- a/docs/en/developer/docker.rst
+++ b/docs/en/developer/docker.rst
@@ -40,7 +40,7 @@ Run wallabag
40#. Edit ``app/config/parameters.yml`` to replace ``database_*`` 40#. Edit ``app/config/parameters.yml`` to replace ``database_*``
41 properties with commented ones (with values prefixed by ``env.``) 41 properties with commented ones (with values prefixed by ``env.``)
42#. ``composer install`` the project dependencies 42#. ``composer install`` the project dependencies
43#. ``php app/console wallabag:install`` to create the schema 43#. ``php bin/console wallabag:install`` to create the schema
44#. ``docker-compose up`` to run the containers 44#. ``docker-compose up`` to run the containers
45#. Finally, browse to http://localhost:8080/ to find your freshly 45#. Finally, browse to http://localhost:8080/ to find your freshly
46 installed wallabag. 46 installed wallabag.
diff --git a/docs/en/developer/rabbitmq.rst b/docs/en/developer/rabbitmq.rst
index 8cee45fb..63b85106 100644
--- a/docs/en/developer/rabbitmq.rst
+++ b/docs/en/developer/rabbitmq.rst
@@ -57,11 +57,20 @@ Depending on which service you want to import from you need to enable one (or ma
57 # for Pocket import 57 # for Pocket import
58 bin/console rabbitmq:consumer import_pocket -w 58 bin/console rabbitmq:consumer import_pocket -w
59 59
60 # for Readbility import 60 # for Readability import
61 bin/console rabbitmq:consumer import_readability -w 61 bin/console rabbitmq:consumer import_readability -w
62 62
63 # for Instapaper import
64 bin/console rabbitmq:consumer import_instapaper -w
65
63 # for wallabag v1 import 66 # for wallabag v1 import
64 bin/console rabbitmq:consumer import_wallabag_v1 -w 67 bin/console rabbitmq:consumer import_wallabag_v1 -w
65 68
66 # for wallabag v2 import 69 # for wallabag v2 import
67 bin/console rabbitmq:consumer import_wallabag_v2 -w 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
index 5748e260..820a52e9 100644
--- a/docs/en/developer/redis.rst
+++ b/docs/en/developer/redis.rst
@@ -1,5 +1,5 @@
1Install Redis for asynchronous tasks 1Install Redis for asynchronous tasks
2======================================= 2====================================
3 3
4In order to launch asynchronous tasks (useful for huge imports for example), we can use Redis. 4In order to launch asynchronous tasks (useful for huge imports for example), we can use Redis.
5 5
@@ -37,7 +37,7 @@ Edit your ``parameters.yml`` file to edit Redis configuration. The default one s
37 37
38 38
39Launch Redis consumer 39Launch Redis consumer
40------------------------ 40---------------------
41 41
42Depending on which service you want to import from you need to enable one (or many if you want to support many) cron job: 42Depending on which service you want to import from you need to enable one (or many if you want to support many) cron job:
43 43
@@ -46,15 +46,24 @@ Depending on which service you want to import from you need to enable one (or ma
46 # for Pocket import 46 # for Pocket import
47 bin/console wallabag:import:redis-worker pocket -vv >> /path/to/wallabag/var/logs/redis-pocket.log 47 bin/console wallabag:import:redis-worker pocket -vv >> /path/to/wallabag/var/logs/redis-pocket.log
48 48
49 # for Readbility import 49 # for Readability import
50 bin/console wallabag:import:redis-worker readability -vv >> /path/to/wallabag/var/logs/redis-readability.log 50 bin/console wallabag:import:redis-worker readability -vv >> /path/to/wallabag/var/logs/redis-readability.log
51 51
52 # for Instapaper import
53 bin/console wallabag:import:redis-worker instapaper -vv >> /path/to/wallabag/var/logs/redis-instapaper.log
54
52 # for wallabag v1 import 55 # for wallabag v1 import
53 bin/console wallabag:import:redis-worker wallabag_v1 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v1.log 56 bin/console wallabag:import:redis-worker wallabag_v1 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v1.log
54 57
55 # for wallabag v2 import 58 # for wallabag v2 import
56 bin/console wallabag:import:redis-worker wallabag_v2 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v2.log 59 bin/console wallabag:import:redis-worker wallabag_v2 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v2.log
57 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
58If 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 : 67If 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 68
60.. code:: bash 69.. code:: bash
diff --git a/docs/en/index.rst b/docs/en/index.rst
index 46450b8f..beb3816e 100644
--- a/docs/en/index.rst
+++ b/docs/en/index.rst
@@ -30,7 +30,8 @@ The documentation is available in other languages:
30 30
31 user/faq 31 user/faq
32 user/installation 32 user/installation
33 user/upgrade 33 user/upgrade-2.0.x-2.1.y
34 user/upgrade-2.0.x-2.0.y
34 user/migration 35 user/migration
35 user/import 36 user/import
36 user/create_account 37 user/create_account
@@ -56,3 +57,5 @@ The documentation is available in other languages:
56 developer/documentation 57 developer/documentation
57 developer/translate 58 developer/translate
58 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 e6c37d72..758e3816 100644
--- a/docs/en/user/import.rst
+++ b/docs/en/user/import.rst
@@ -23,12 +23,11 @@ Now, all is fine to migrate from Pocket.
23Import your data into wallabag 2.x 23Import your data into wallabag 2.x
24~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 24~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
25 25
26Click on ``Import`` link in the menu, on ``Import contents`` in Pocket section 26Click on ``Import`` link in the menu, on ``Import contents`` in Pocket section
27and then on ``Connect to Pocket and import data``. 27and then on ``Connect to Pocket and import data``.
28 28
29You need to authorize wallabag to interact with your Pocket account. 29You need to authorize wallabag to interact with your Pocket account.
30Your data will be imported. Data import can be a demanding process for your server 30Your 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).
32 31
33From Readability 32From Readability
34---------------- 33----------------
@@ -41,15 +40,26 @@ On the tools (`https://www.readability.com/tools/<https://www.readability.com/to
41Import your data into wallabag 2.x 40Import your data into wallabag 2.x
42~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 41~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
43 42
44Click on ``Import`` link in the menu, on ``Import contents`` in Readability section 43Click on ``Import`` link in the menu, on ``Import contents`` in Readability section
45and then select your json file and upload it. 44and then select your json file and upload it.
46 45
47Your data will be imported. Data import can be a demanding process for your server (we need to work on this import to improve it). 46Your data will be imported. Data import can be a demanding process for your server.
48 47
49From Instapaper 48From Instapaper
50--------------- 49---------------
51 50
52*Feature not yet implemented in wallabag v2.* 51Export your Instapaper data
52~~~~~~~~~~~~~~~~~~~~~~~~~~~~
53
54On 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``).
55
56Import your data into wallabag 2.x
57~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
58
59Click on ``Import`` link in the menu, on ``Import contents`` in Instapaper section
60and then select your CSV file and upload it.
61
62Your data will be imported. Data import can be a demanding process for your server.
53 63
54From HTML or JSON file 64From HTML or JSON file
55---------------------- 65----------------------
diff --git a/docs/en/user/upgrade.rst b/docs/en/user/upgrade-2.0.x-2.0.y.rst
index 5c37be95..6a0818b3 100644
--- a/docs/en/user/upgrade.rst
+++ b/docs/en/user/upgrade-2.0.x-2.0.y.rst
@@ -1,17 +1,18 @@
1Upgrade wallabag 1Upgrade from 2.0.x to 2.0.y
2================ 2===========================
3 3
4Upgrade on a dedicated web server 4Upgrade on a dedicated web server
5--------------------------------- 5---------------------------------
6 6
7The last release is published on https://www.wallabag.org/pages/download-wallabag.html. In order to upgrade your wallabag installation and get the last version, run the following commands in you wallabag folder (replace ``2.1.0`` by the last release number): 7The last release is published on https://www.wallabag.org/pages/download-wallabag.html. In order to upgrade your wallabag installation and get the last version, run the following commands in you wallabag folder (replace ``2.0.8`` 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.1.0 13 git checkout 2.0.8
14 ./install.sh 14 SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
15 php bin/console cache:clear --env=prod
15 16
16Upgrade on a shared hosting 17Upgrade on a shared hosting
17--------------------------- 18---------------------------
@@ -24,7 +25,7 @@ Download the last release of wallabag:
24 25
25 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
26 27
27(md5 hash of the package: ``4f84c725d1d6e3345eae0a406115e5ff``) 28(md5 hash of the 2.0.8 package: ``4f84c725d1d6e3345eae0a406115e5ff``)
28 29
29Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. 30Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours.
30 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 @@
1Upgrading from 2.0.x to 2.1.y
2=============================
3
4.. warning::
5Before 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
7Upgrade on a dedicated web server
8---------------------------------
9
10The 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
21Upgrade on a shared hosting
22---------------------------
23
24Backup your ``app/config/parameters.yml`` file.
25
26Download 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
34Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours.
35
36Please 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
50If you use SQLite, you must also copy your ``data/`` folder inside the new installation.
51
52Empty ``var/cache`` folder.
53
54You 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'
12master_doc = 'index' 12master_doc = 'index'
13project = u'wallabag-fr' 13project = u'wallabag-fr'
14copyright = u'2013-2016, Nicolas Lœuillet - MIT Licence' 14copyright = u'2013-2016, Nicolas Lœuillet - MIT Licence'
15version = '2.0.0' 15version = '2.1.0'
16release = version 16release = version
17exclude_patterns = ['_build'] 17exclude_patterns = ['_build']
18pygments_style = 'sphinx' 18pygments_style = 'sphinx'
diff --git a/docs/fr/developer/docker.rst b/docs/fr/developer/docker.rst
index 73cb56be..84724ed3 100644
--- a/docs/fr/developer/docker.rst
+++ b/docs/fr/developer/docker.rst
@@ -39,7 +39,7 @@ Exécuter wallabag
39#. Editer ``app/config/parameters.yml`` pour remplacer les propriétés ``database_*`` 39#. Editer ``app/config/parameters.yml`` pour remplacer les propriétés ``database_*``
40 par les lignes commentées (celles avec des valeurs préfixées par ``env.``) 40 par les lignes commentées (celles avec des valeurs préfixées par ``env.``)
41#. ``composer install`` pour installer les dépendances 41#. ``composer install`` pour installer les dépendances
42#. ``php app/console wallabag:install`` pour créer le schéma de la BDD 42#. ``php bin/console wallabag:install`` pour créer le schéma de la BDD
43#. ``docker-compose up`` pour démarrer les conteneurs 43#. ``docker-compose up`` pour démarrer les conteneurs
44#. Enfin, se rendre sur http://localhost:8080/ pour accéder à une installation 44#. Enfin, se rendre sur http://localhost:8080/ pour accéder à une installation
45 tout propre de wallabag. 45 tout propre de wallabag.
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 @@
1Installer RabbitMQ pour des tâches asynchrones
2==============================================
3
4Pour lancer des tâches asynchrones (utile pour des imports importants par exemple), nous pouvons utiliser RabbitMQ.
5
6Pré-requis
7----------
8
9Vous devez installer RabbitMQ sur votre serveur.
10
11Installation
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
21Configuration 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
29Arrêter RabbitMQ
30~~~~~~~~~~~~~~~~
31
32.. code:: bash
33
34 rabbitmqctl stop
35
36
37Configurer RabbitMQ dans wallabag
38---------------------------------
39
40Modifiez 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
50Démarrer les clients RabbitMQ
51-----------------------------
52
53En 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 @@
1Installer Redis pour des tâches asynchrones
2===========================================
3
4Pour lancer des tâches asynchrones (utile pour des imports importants par exemple), nous pouvons utiliser Redis.
5
6Pré-requis
7----------
8
9Vous devez installer Redis sur votre serveur.
10
11Installation
12~~~~~~~~~~~~
13
14.. code:: bash
15
16 apt-get install redis-server
17
18Démarrage
19~~~~~~~~~
20
21Le 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
28Configurer Redis dans wallabag
29-------------------------------
30
31Modifiez 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
39Démarrer les clients Redis
40--------------------------
41
42En 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
67Si 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 dfa55afe..359b103c 100644
--- a/docs/fr/index.rst
+++ b/docs/fr/index.rst
@@ -31,7 +31,8 @@ La documentation est disponible dans d'autres langues :
31 31
32 user/faq 32 user/faq
33 user/installation 33 user/installation
34 user/upgrade 34 user/upgrade-2.0.x-2.1.y
35 user/upgrade-2.0.x-2.0.y
35 user/migration 36 user/migration
36 user/import 37 user/import
37 user/create_account 38 user/create_account
@@ -56,3 +57,5 @@ La documentation est disponible dans d'autres langues :
56 developer/documentation 57 developer/documentation
57 developer/translate 58 developer/translate
58 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 99ac602b..6f114dd6 100644
--- a/docs/fr/user/import.rst
+++ b/docs/fr/user/import.rst
@@ -28,7 +28,7 @@ la section Pocket puis sur ``Se connecter à Pocket et importer les données``.
28 28
29Vous devez autoriser wallabag à se connecter à votre compte Pocket. 29Vous devez autoriser wallabag à se connecter à votre compte Pocket.
30Vos données vont être importées. L'import de données est une action qui peut être couteuse 30Vos données vont être importées. L'import de données est une action qui peut être couteuse
31pour votre serveur (nous devons encore travailler pour améliorer cet import). 31pour votre serveur.
32 32
33Depuis Readability 33Depuis Readability
34------------------ 34------------------
@@ -44,12 +44,23 @@ Importez vos données dans wallabag 2.x
44Cliquez sur le lien ``Importer`` dans le menu, sur ``Importer les contenus`` dans 44Cliquez sur le lien ``Importer`` dans le menu, sur ``Importer les contenus`` dans
45la section Readability et ensuite sélectionnez votre fichier json pour l'uploader. 45la section Readability et ensuite sélectionnez votre fichier json pour l'uploader.
46 46
47Vos 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). 47Vos données vont être importées. L'import de données est une action qui peut être couteuse pour votre serveur.
48 48
49Depuis Instapaper 49Depuis Instapaper
50----------------- 50-----------------
51 51
52*Fonctionnalité pas encore implémentée dans wallabag v2.* 52Exportez vos données de Instapaper
53~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
54
55Sur 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``).
56
57Importez vos données dans wallabag 2.x
58~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
59
60Cliquez sur le lien ``Importer`` dans le menu, sur ``Importer les contenus`` dans
61la section Instapaper et ensuite sélectionnez votre fichier CSV pour l'uploader.
62
63Vos données vont être importées. L'import de données est une action qui peut être couteuse pour votre serveur.
53 64
54 65
55Depuis un fichier HTML ou JSON 66Depuis un fichier HTML ou JSON
diff --git a/docs/fr/user/upgrade.rst b/docs/fr/user/upgrade-2.0.x-2.0.y.rst
index e3798979..d8dfac6e 100644
--- a/docs/fr/user/upgrade.rst
+++ b/docs/fr/user/upgrade-2.0.x-2.0.y.rst
@@ -1,17 +1,18 @@
1Mettre à jour wallabag 1Mettre à jour de la 2.0.x à la 2.0.y
2====================== 2====================================
3 3
4Mise à jour sur un serveur dédié 4Mise à jour sur un serveur dédié
5-------------------------------- 5--------------------------------
6 6
7La 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) : 7La 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) :
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.1.0 13 git checkout 2.0.8
14 ./install.sh 14 SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
15 php bin/console cache:clear --env=prod
15 16
16Mise à jour sur un hébergement mutualisé 17Mise à jour sur un hébergement mutualisé
17---------------------------------------- 18----------------------------------------
@@ -24,7 +25,7 @@ Téléchargez la dernière version de wallabag :
24 25
25 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
26 27
27(hash md5 de l'archive : ``4f84c725d1d6e3345eae0a406115e5ff``) 28(hash md5 de l'archive 2.0.8 : ``4f84c725d1d6e3345eae0a406115e5ff``)
28 29
29Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre. 30Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre.
30 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 @@
1Mettre à jour de la 2.0.x à la 2.1.y
2====================================
3
4.. warning::
5Avant 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
7Mise à jour sur un serveur dédié
8--------------------------------
9
10La 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
21Mise à jour sur un hébergement mutualisé
22----------------------------------------
23
24Effectuez une sauvegarde du fichier ``app/config/parameters.yml``.
25
26Té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
34Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre.
35
36Nous 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
50Si vous utilisez SQLite, vous devez également conserver le contenu du répertoire ``data/``.
51
52Videz le répertoire ``var/cache``.
53
54Vous 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