diff options
Diffstat (limited to 'docs/en')
-rw-r--r-- | docs/en/developer/api.rst | 235 | ||||
-rw-r--r-- | docs/en/developer/translate.rst | 2 | ||||
-rw-r--r-- | docs/en/index.rst | 3 | ||||
-rw-r--r-- | docs/en/user/installation.rst | 12 | ||||
-rw-r--r-- | docs/en/user/migration.rst | 62 |
5 files changed, 306 insertions, 8 deletions
diff --git a/docs/en/developer/api.rst b/docs/en/developer/api.rst new file mode 100644 index 00000000..ac00d3a4 --- /dev/null +++ b/docs/en/developer/api.rst | |||
@@ -0,0 +1,235 @@ | |||
1 | API documentation | ||
2 | ================= | ||
3 | |||
4 | Thanks to this documentation, we'll see how to interact with the wallabag API. | ||
5 | |||
6 | Requirements | ||
7 | ------------ | ||
8 | |||
9 | * wallabag freshly (or not) installed on http://localhost:8000 | ||
10 | * ``httpie`` installed on your computer (`see project website <https://github.com/jkbrzt/httpie>`__). Note that you can also adapt the commands using curl or wget. | ||
11 | * all the API methods are documented here http://localhost:8000/api/doc | ||
12 | |||
13 | Creating a new API client | ||
14 | ------------------------- | ||
15 | |||
16 | In your wallabag account, you can create a new API client at this URL http://localhost:8000/developer/client/create. | ||
17 | |||
18 | Just give the redirect URL of your application and create your client. If your application is a desktop one, put whatever URL suits you the most. | ||
19 | |||
20 | You get information like this: | ||
21 | |||
22 | :: | ||
23 | |||
24 | Client ID: | ||
25 | |||
26 | 1_3o53gl30vhgk0c8ks4cocww08o84448osgo40wgw4gwkoo8skc | ||
27 | |||
28 | Client secret: | ||
29 | |||
30 | 636ocbqo978ckw0gsw4gcwwocg8044sco0w8w84cws48ggogs4 | ||
31 | |||
32 | |||
33 | Obtaining a refresh token | ||
34 | ------------------------- | ||
35 | |||
36 | For each API call, you'll need a token. Let's create it with this command (replace ``client_id``, ``client_secret``, ``username`` and ``password`` with their values): | ||
37 | |||
38 | :: | ||
39 | |||
40 | http POST http://localhost:8000/oauth/v2/token \ | ||
41 | grant_type=password \ | ||
42 | client_id=1_3o53gl30vhgk0c8ks4cocww08o84448osgo40wgw4gwkoo8skc \ | ||
43 | client_secret=636ocbqo978ckw0gsw4gcwwocg8044sco0w8w84cws48ggogs4 \ | ||
44 | username=wallabag \ | ||
45 | password=wallabag | ||
46 | |||
47 | You'll have this in return: | ||
48 | |||
49 | :: | ||
50 | |||
51 | HTTP/1.1 200 OK | ||
52 | Cache-Control: no-store, private | ||
53 | Connection: close | ||
54 | Content-Type: application/json | ||
55 | Date: Tue, 05 Apr 2016 08:44:33 GMT | ||
56 | Host: localhost:8000 | ||
57 | Pragma: no-cache | ||
58 | X-Debug-Token: 19c8e0 | ||
59 | X-Debug-Token-Link: /_profiler/19c8e0 | ||
60 | X-Powered-By: PHP/7.0.4 | ||
61 | |||
62 | { | ||
63 | "access_token": "ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA", | ||
64 | "expires_in": 3600, | ||
65 | "refresh_token": "OTNlZGE5OTJjNWQwYzc2NDI5ZGE5MDg3ZTNjNmNkYTY0ZWZhZDVhNDBkZTc1ZTNiMmQ0MjQ0OThlNTFjNTQyMQ", | ||
66 | "scope": null, | ||
67 | "token_type": "bearer" | ||
68 | } | ||
69 | |||
70 | We'll work with the ``access_token`` value in our next calls. | ||
71 | |||
72 | Getting existing entries | ||
73 | ------------------------ | ||
74 | |||
75 | Documentation for this method: http://localhost:8000/api/doc#get--api-entries.{_format} | ||
76 | |||
77 | As we work on a fresh wallabag installation, we'll have no result with this command: | ||
78 | |||
79 | :: | ||
80 | |||
81 | http GET http://localhost:8000/api/entries.json \ | ||
82 | "Authorization:Bearer ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" | ||
83 | |||
84 | returns: | ||
85 | |||
86 | :: | ||
87 | |||
88 | HTTP/1.1 200 OK | ||
89 | 0: application/json | ||
90 | Cache-Control: no-cache | ||
91 | Connection: close | ||
92 | Content-Type: application/json | ||
93 | Date: Tue, 05 Apr 2016 08:51:32 GMT | ||
94 | Host: localhost:8000 | ||
95 | Set-Cookie: PHPSESSID=nrogm748md610ovhu6j70c3q63; path=/; HttpOnly | ||
96 | X-Debug-Token: 4fbbc4 | ||
97 | X-Debug-Token-Link: /_profiler/4fbbc4 | ||
98 | X-Powered-By: PHP/7.0.4 | ||
99 | |||
100 | { | ||
101 | "_embedded": { | ||
102 | "items": [] | ||
103 | }, | ||
104 | "_links": { | ||
105 | "first": { | ||
106 | "href": "http://localhost:8000/api/entries?page=1&perPage=30" | ||
107 | }, | ||
108 | "last": { | ||
109 | "href": "http://localhost:8000/api/entries?page=1&perPage=30" | ||
110 | }, | ||
111 | "self": { | ||
112 | "href": "http://localhost:8000/api/entries?page=1&perPage=30" | ||
113 | } | ||
114 | }, | ||
115 | "limit": 30, | ||
116 | "page": 1, | ||
117 | "pages": 1, | ||
118 | "total": 0 | ||
119 | } | ||
120 | |||
121 | The ``items`` array is empty. | ||
122 | |||
123 | Adding your first entry | ||
124 | ----------------------- | ||
125 | |||
126 | Documentation for this method: http://localhost:8000/api/doc#post--api-entries.{_format} | ||
127 | |||
128 | :: | ||
129 | |||
130 | http POST http://localhost:8000/api/entries.json \ | ||
131 | "Authorization:Bearer ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" \ | ||
132 | url="http://www.numerama.com/tech/160115-le-pocket-libre-wallabag-fait-le-plein-de-fonctionnalites.html" | ||
133 | |||
134 | returns | ||
135 | |||
136 | :: | ||
137 | |||
138 | HTTP/1.1 200 OK | ||
139 | 0: application/json | ||
140 | Cache-Control: no-cache | ||
141 | Connection: close | ||
142 | Content-Type: application/json | ||
143 | Date: Tue, 05 Apr 2016 09:07:54 GMT | ||
144 | Host: localhost:8000 | ||
145 | Set-Cookie: PHPSESSID=bjie40ck72kp2pst3i71gf43a4; path=/; HttpOnly | ||
146 | X-Debug-Token: e01c51 | ||
147 | X-Debug-Token-Link: /_profiler/e01c51 | ||
148 | X-Powered-By: PHP/7.0.4 | ||
149 | |||
150 | { | ||
151 | "_links": { | ||
152 | "self": { | ||
153 | "href": "/api/entries/1" | ||
154 | } | ||
155 | }, | ||
156 | "content": "<p class=\"chapo\">Fonctionnant sur le même principe que Pocket, Instapaper ou Readability, le logiciel Wallabag permet de mémoriser des articles pour les lire plus tard. Sa nouvelle version apporte une multitude de nouvelles fonctionnalités.</p><p>Si vous utilisez Firefox comme navigateur web, vous avez peut-être constaté l’arrivée d’<a href=\"http://www.numerama.com/magazine/33292-update-firefox.html\">une fonctionnalité intitulée Pocket</a>. Disponible autrefois sous la forme d’un module complémentaire, et sous un autre nom (Read it Later), elle est depuis le mois de juin 2015 directement incluse au sein de Firefox.</p>\n<p>Concrètement, Pocket sert à garder en mémoire des contenus que vous croisez au fil de la navigation, comme des articles de presse ou des vidéos, afin de pouvoir les consulter plus tard. Pocket fonctionne un peu comme un système de favoris, mais en bien plus élaboré grâce à ses options supplémentaires.</p>\n<p>Mais <a href=\"https://en.wikipedia.org/wiki/Pocket_%28application%29#Firefox_integration\" target=\"_blank\">Pocket fait polémique</a>, car il s’agit d’un projet propriétaire qui est intégré dans un logiciel libre. C’est pour cette raison que des utilisateurs ont choisi de se tourner vers d’autres solutions, comme <strong>Wallabag</strong>, qui est l’équivalent libre de Pocket et d’autres systèmes du même genre, comme Instapaper et Readability.</p>\n<p>Et justement, Wallabag évolue. C’est ce dimanche que la <a href=\"https://www.wallabag.org/blog/2016/04/03/wallabag-v2\" target=\"_blank\">version 2.0.0 du logiciel</a> a été publiée par l’équipe en charge de son développement et celle-ci contient de nombreux changements par rapport aux moutures précédentes (la <a href=\"http://doc.wallabag.org/fr/v2/\" target=\"_blank\">documentation est traduite</a> en français), lui permettant d’apparaître comme une alternative à Pocket, Instapaper et Readability.</p>\n<p><img class=\"aligncenter size-medium wp-image-160439\" src=\"http://www.numerama.com/content/uploads/2016/04/homepage-680x347.png\" alt=\"homepage\" width=\"680\" height=\"347\" srcset=\"//www.numerama.com/content/uploads/2016/04/homepage-680x347.png 680w, //www.numerama.com/content/uploads/2016/04/homepage-1024x523.png 1024w, //www.numerama.com/content/uploads/2016/04/homepage-270x138.png 270w, //www.numerama.com/content/uploads/2016/04/homepage.png 1286w\" sizes=\"(max-width: 680px) 100vw, 680px\"/></p>\n<p>Parmi les principaux changements que l’on peut retenir avec cette nouvelle version, notons la possibilité d’écrire des annotations dans les articles mémorisés, de filtrer les contenus selon divers critères (temps de lecture, nom de domaine, date de création, statut…), d’assigner des mots-clés aux entrées, de modifier le titre des articles, le support des flux RSS ou encore le support de plusieurs langues dont le français.</p>\n<p>D’autres options sont également à signaler, comme l’aperçu d’un article mémorisé (si l’option est disponible), un guide de démarrage rapide pour les débutants, un outil d’export dans divers formats (PDF, JSON, EPUB, MOBI, XML, CSV et TXT) et, surtout, la possibilité de migrer vers Wallabag depuis Pocket, afin de convaincre les usagers de se lancer.</p>\n \n \n <footer class=\"clearfix\" readability=\"1\"><p class=\"source\">\n Crédit photo de la une : <a href=\"https://www.flickr.com/photos/bookgrl/2388310523/\">Laura Taylor</a>\n </p>\n \n <p><a href=\"http://www.numerama.com/tech/160115-le-pocket-libre-wallabag-fait-le-plein-de-fonctionnalites.html?&show_reader_reports\" target=\"_blank\" rel=\"nofollow\">Signaler une erreur dans le texte</a></p>\n \n</footer> <section class=\"related-article\"><header><h3>Articles liés</h3>\n </header><article class=\"post-grid format-article\"><a class=\"floatleft\" href=\"http://www.numerama.com/magazine/34444-firefox-prepare-l-enterrement-des-vieux-plugins.html\" title=\"Firefox prépare l'enterrement des vieux plugins\">\n <div class=\"cover-preview cover-tech\">\n <p>Lire</p>\n \n \n \n <img class=\"cover-preview_img\" src=\"http://c2.lestechnophiles.com/www.numerama.com/content/uploads/2015/10/cimetierecolleville.jpg?resize=200,135\" srcset=\" //c2.lestechnophiles.com/www.numerama.com/content/uploads/2015/10/cimetierecolleville.jpg?resize=200,135 200w, //c2.lestechnophiles.com/www.numerama.com/content/uploads/2015/10/cimetierecolleville.jpg?resize=100,67 100w, \" sizes=\"(min-width: 1001px) 200px, (max-width: 1000px) 100px\" alt=\"Firefox prépare l'enterrement des vieux plugins\"/></div>\n <h4> Firefox prépare l'enterrement des vieux plugins </h4>\n </a>\n <footer class=\"span12\">\n </footer></article><article class=\"post-grid format-article\"><a class=\"floatleft\" href=\"http://www.numerama.com/tech/131636-activer-navigation-privee-navigateur-web.html\" title=\"Comment activer la navigation privée sur son navigateur web\">\n <div class=\"cover-preview cover-tech\">\n <p>Lire</p>\n \n \n \n <img class=\"cover-preview_img\" src=\"http://c1.lestechnophiles.com/www.numerama.com/content/uploads/2015/11/Incognito.jpg?resize=200,135\" srcset=\" //c1.lestechnophiles.com/www.numerama.com/content/uploads/2015/11/Incognito.jpg?resize=200,135 200w, //c1.lestechnophiles.com/www.numerama.com/content/uploads/2015/11/Incognito.jpg?resize=100,67 100w, \" sizes=\"(min-width: 1001px) 200px, (max-width: 1000px) 100px\" alt=\"Comment activer la navigation privée sur son navigateur web\"/></div>\n <h4> Comment activer la navigation privée sur son navigateur web </h4>\n </a>\n <footer class=\"span12\">\n </footer></article><article class=\"post-grid format-article\"><a class=\"floatleft\" href=\"http://www.numerama.com/tech/144028-firefox-se-mettra-a-jour-regulierement.html\" title=\"Firefox se mettra à jour un peu moins régulièrement\">\n <div class=\"cover-preview cover-tech\">\n <p>Lire</p>\n \n \n \n <img class=\"cover-preview_img\" src=\"http://c0.lestechnophiles.com/www.numerama.com/content/uploads/2016/02/firefox-mobile.jpg?resize=200,135\" srcset=\" //c0.lestechnophiles.com/www.numerama.com/content/uploads/2016/02/firefox-mobile.jpg?resize=200,135 200w, //c0.lestechnophiles.com/www.numerama.com/content/uploads/2016/02/firefox-mobile.jpg?resize=100,67 100w, \" sizes=\"(min-width: 1001px) 200px, (max-width: 1000px) 100px\" alt=\"Firefox se mettra à jour un peu moins régulièrement\"/></div>\n <h4> Firefox se mettra à jour un peu moins régulièrement </h4>\n </a>\n <footer class=\"span12\">\n </footer></article>\n</section>\n", | ||
157 | "created_at": "2016-04-05T09:07:54+0000", | ||
158 | "domain_name": "www.numerama.com", | ||
159 | "id": 1, | ||
160 | "is_archived": 0, | ||
161 | "is_starred": 0, | ||
162 | "language": "fr-FR", | ||
163 | "mimetype": "text/html", | ||
164 | "preview_picture": "http://www.numerama.com/content/uploads/2016/04/post-it.jpg", | ||
165 | "reading_time": 2, | ||
166 | "tags": [], | ||
167 | "title": "Le Pocket libre Wallabag fait le plein de fonctionnalités - Tech - Numerama", | ||
168 | "updated_at": "2016-04-05T09:07:54+0000", | ||
169 | "url": "http://www.numerama.com/tech/160115-le-pocket-libre-wallabag-fait-le-plein-de-fonctionnalites.html", | ||
170 | "user_email": "", | ||
171 | "user_id": 1, | ||
172 | "user_name": "wallabag" | ||
173 | } | ||
174 | |||
175 | Now, if you execute the previous command (see **Get existing entries**), you'll have data. | ||
176 | |||
177 | Deleting an entry | ||
178 | ----------------- | ||
179 | |||
180 | Documentation for this method: http://localhost:8000/api/doc#delete--api-entries-{entry}.{_format} | ||
181 | |||
182 | :: | ||
183 | |||
184 | http DELETE http://localhost:8000/api/entries/1.json \ | ||
185 | "Authorization:Bearer ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" | ||
186 | |||
187 | returns | ||
188 | |||
189 | :: | ||
190 | |||
191 | HTTP/1.1 200 OK | ||
192 | 0: application/json | ||
193 | Cache-Control: no-cache | ||
194 | Connection: close | ||
195 | Content-Type: application/json | ||
196 | Date: Tue, 05 Apr 2016 09:19:07 GMT | ||
197 | Host: localhost:8000 | ||
198 | Set-Cookie: PHPSESSID=jopgnfvmuc9a62b27sqm6iulr6; path=/; HttpOnly | ||
199 | X-Debug-Token: 887cef | ||
200 | X-Debug-Token-Link: /_profiler/887cef | ||
201 | X-Powered-By: PHP/7.0.4 | ||
202 | |||
203 | { | ||
204 | "_links": { | ||
205 | "self": { | ||
206 | "href": "/api/entries/" | ||
207 | } | ||
208 | }, | ||
209 | "annotations": [], | ||
210 | "content": "<p class=\"chapo\">Fonctionnant sur le même principe que Pocket, Instapaper ou Readability, le logiciel Wallabag permet de mémoriser des articles pour les lire plus tard. Sa nouvelle version apporte une multitude de nouvelles fonctionnalités.</p><p>Si vous utilisez Firefox comme navigateur web, vous avez peut-être constaté l’arrivée d’<a href=\"http://www.numerama.com/magazine/33292-update-firefox.html\">une fonctionnalité intitulée Pocket</a>. Disponible autrefois sous la forme d’un module complémentaire, et sous un autre nom (Read it Later), elle est depuis le mois de juin 2015 directement incluse au sein de Firefox.</p>\n<p>Concrètement, Pocket sert à garder en mémoire des contenus que vous croisez au fil de la navigation, comme des articles de presse ou des vidéos, afin de pouvoir les consulter plus tard. Pocket fonctionne un peu comme un système de favoris, mais en bien plus élaboré grâce à ses options supplémentaires.</p>\n<p>Mais <a href=\"https://en.wikipedia.org/wiki/Pocket_%28application%29#Firefox_integration\" target=\"_blank\">Pocket fait polémique</a>, car il s’agit d’un projet propriétaire qui est intégré dans un logiciel libre. C’est pour cette raison que des utilisateurs ont choisi de se tourner vers d’autres solutions, comme <strong>Wallabag</strong>, qui est l’équivalent libre de Pocket et d’autres systèmes du même genre, comme Instapaper et Readability.</p>\n<p>Et justement, Wallabag évolue. C’est ce dimanche que la <a href=\"https://www.wallabag.org/blog/2016/04/03/wallabag-v2\" target=\"_blank\">version 2.0.0 du logiciel</a> a été publiée par l’équipe en charge de son développement et celle-ci contient de nombreux changements par rapport aux moutures précédentes (la <a href=\"http://doc.wallabag.org/fr/v2/\" target=\"_blank\">documentation est traduite</a> en français), lui permettant d’apparaître comme une alternative à Pocket, Instapaper et Readability.</p>\n<p><img class=\"aligncenter size-medium wp-image-160439\" src=\"http://www.numerama.com/content/uploads/2016/04/homepage-680x347.png\" alt=\"homepage\" width=\"680\" height=\"347\" srcset=\"//www.numerama.com/content/uploads/2016/04/homepage-680x347.png 680w, //www.numerama.com/content/uploads/2016/04/homepage-1024x523.png 1024w, //www.numerama.com/content/uploads/2016/04/homepage-270x138.png 270w, //www.numerama.com/content/uploads/2016/04/homepage.png 1286w\" sizes=\"(max-width: 680px) 100vw, 680px\"/></p>\n<p>Parmi les principaux changements que l’on peut retenir avec cette nouvelle version, notons la possibilité d’écrire des annotations dans les articles mémorisés, de filtrer les contenus selon divers critères (temps de lecture, nom de domaine, date de création, statut…), d’assigner des mots-clés aux entrées, de modifier le titre des articles, le support des flux RSS ou encore le support de plusieurs langues dont le français.</p>\n<p>D’autres options sont également à signaler, comme l’aperçu d’un article mémorisé (si l’option est disponible), un guide de démarrage rapide pour les débutants, un outil d’export dans divers formats (PDF, JSON, EPUB, MOBI, XML, CSV et TXT) et, surtout, la possibilité de migrer vers Wallabag depuis Pocket, afin de convaincre les usagers de se lancer.</p>\n \n \n <footer class=\"clearfix\" readability=\"1\"><p class=\"source\">\n Crédit photo de la une : <a href=\"https://www.flickr.com/photos/bookgrl/2388310523/\">Laura Taylor</a>\n </p>\n \n <p><a href=\"http://www.numerama.com/tech/160115-le-pocket-libre-wallabag-fait-le-plein-de-fonctionnalites.html?&show_reader_reports\" target=\"_blank\" rel=\"nofollow\">Signaler une erreur dans le texte</a></p>\n \n</footer> <section class=\"related-article\"><header><h3>Articles liés</h3>\n </header><article class=\"post-grid format-article\"><a class=\"floatleft\" href=\"http://www.numerama.com/magazine/34444-firefox-prepare-l-enterrement-des-vieux-plugins.html\" title=\"Firefox prépare l'enterrement des vieux plugins\">\n <div class=\"cover-preview cover-tech\">\n <p>Lire</p>\n \n \n \n <img class=\"cover-preview_img\" src=\"http://c2.lestechnophiles.com/www.numerama.com/content/uploads/2015/10/cimetierecolleville.jpg?resize=200,135\" srcset=\" //c2.lestechnophiles.com/www.numerama.com/content/uploads/2015/10/cimetierecolleville.jpg?resize=200,135 200w, //c2.lestechnophiles.com/www.numerama.com/content/uploads/2015/10/cimetierecolleville.jpg?resize=100,67 100w, \" sizes=\"(min-width: 1001px) 200px, (max-width: 1000px) 100px\" alt=\"Firefox prépare l'enterrement des vieux plugins\"/></div>\n <h4> Firefox prépare l'enterrement des vieux plugins </h4>\n </a>\n <footer class=\"span12\">\n </footer></article><article class=\"post-grid format-article\"><a class=\"floatleft\" href=\"http://www.numerama.com/tech/131636-activer-navigation-privee-navigateur-web.html\" title=\"Comment activer la navigation privée sur son navigateur web\">\n <div class=\"cover-preview cover-tech\">\n <p>Lire</p>\n \n \n \n <img class=\"cover-preview_img\" src=\"http://c1.lestechnophiles.com/www.numerama.com/content/uploads/2015/11/Incognito.jpg?resize=200,135\" srcset=\" //c1.lestechnophiles.com/www.numerama.com/content/uploads/2015/11/Incognito.jpg?resize=200,135 200w, //c1.lestechnophiles.com/www.numerama.com/content/uploads/2015/11/Incognito.jpg?resize=100,67 100w, \" sizes=\"(min-width: 1001px) 200px, (max-width: 1000px) 100px\" alt=\"Comment activer la navigation privée sur son navigateur web\"/></div>\n <h4> Comment activer la navigation privée sur son navigateur web </h4>\n </a>\n <footer class=\"span12\">\n </footer></article><article class=\"post-grid format-article\"><a class=\"floatleft\" href=\"http://www.numerama.com/tech/144028-firefox-se-mettra-a-jour-regulierement.html\" title=\"Firefox se mettra à jour un peu moins régulièrement\">\n <div class=\"cover-preview cover-tech\">\n <p>Lire</p>\n \n \n \n <img class=\"cover-preview_img\" src=\"http://c0.lestechnophiles.com/www.numerama.com/content/uploads/2016/02/firefox-mobile.jpg?resize=200,135\" srcset=\" //c0.lestechnophiles.com/www.numerama.com/content/uploads/2016/02/firefox-mobile.jpg?resize=200,135 200w, //c0.lestechnophiles.com/www.numerama.com/content/uploads/2016/02/firefox-mobile.jpg?resize=100,67 100w, \" sizes=\"(min-width: 1001px) 200px, (max-width: 1000px) 100px\" alt=\"Firefox se mettra à jour un peu moins régulièrement\"/></div>\n <h4> Firefox se mettra à jour un peu moins régulièrement </h4>\n </a>\n <footer class=\"span12\">\n </footer></article>\n</section>\n", | ||
211 | "created_at": "2016-04-05T09:07:54+0000", | ||
212 | "domain_name": "www.numerama.com", | ||
213 | "is_archived": 0, | ||
214 | "is_starred": 0, | ||
215 | "language": "fr-FR", | ||
216 | "mimetype": "text/html", | ||
217 | "preview_picture": "http://www.numerama.com/content/uploads/2016/04/post-it.jpg", | ||
218 | "reading_time": 2, | ||
219 | "tags": [], | ||
220 | "title": "Le Pocket libre Wallabag fait le plein de fonctionnalités - Tech - Numerama", | ||
221 | "updated_at": "2016-04-05T09:07:54+0000", | ||
222 | "url": "http://www.numerama.com/tech/160115-le-pocket-libre-wallabag-fait-le-plein-de-fonctionnalites.html", | ||
223 | "user_email": "", | ||
224 | "user_id": 1, | ||
225 | "user_name": "wallabag" | ||
226 | } | ||
227 | |||
228 | And if you want to list the existing entries (see **Get existing entries**), the array is empty. | ||
229 | |||
230 | Other methods | ||
231 | ------------- | ||
232 | |||
233 | We won't write samples for each API method. | ||
234 | |||
235 | Have a look on the listing here: http://localhost:8000/api/doc to know each method. | ||
diff --git a/docs/en/developer/translate.rst b/docs/en/developer/translate.rst index 33b0ebdb..39478fd5 100644 --- a/docs/en/developer/translate.rst +++ b/docs/en/developer/translate.rst | |||
@@ -14,7 +14,7 @@ Translation files | |||
14 | 14 | ||
15 | You can find translation files here: https://github.com/wallabag/wallabag/tree/v2/src/Wallabag/CoreBundle/Resources/translations. | 15 | You can find translation files here: https://github.com/wallabag/wallabag/tree/v2/src/Wallabag/CoreBundle/Resources/translations. |
16 | 16 | ||
17 | You have to create ``messages.CODE.yml`` and ``validators.CODE.yml``, where CODE | 17 | You have to create ``messages.CODE.yml``, where CODE |
18 | is the ISO 639-1 code of your language (`see wikipedia <https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes>`__). | 18 | is the ISO 639-1 code of your language (`see wikipedia <https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes>`__). |
19 | 19 | ||
20 | Other files to translate: | 20 | Other files to translate: |
diff --git a/docs/en/index.rst b/docs/en/index.rst index 3367c8a9..87b62121 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst | |||
@@ -24,6 +24,7 @@ The main documentation for this application is organized into a couple sections: | |||
24 | :caption: User documentation | 24 | :caption: User documentation |
25 | 25 | ||
26 | user/installation | 26 | user/installation |
27 | user/migration | ||
27 | user/create_account | 28 | user/create_account |
28 | user/login | 29 | user/login |
29 | user/configuration | 30 | user/configuration |
@@ -41,7 +42,7 @@ The main documentation for this application is organized into a couple sections: | |||
41 | :maxdepth: 2 | 42 | :maxdepth: 2 |
42 | :caption: Developer documentation | 43 | :caption: Developer documentation |
43 | 44 | ||
45 | developer/api | ||
44 | developer/docker | 46 | developer/docker |
45 | developer/translate | 47 | developer/translate |
46 | developer/maintenance | 48 | developer/maintenance |
47 | developer/releasing | ||
diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index 11ad54fd..bc35a02b 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst | |||
@@ -4,9 +4,9 @@ Install wallabag | |||
4 | Requirements | 4 | Requirements |
5 | ------------ | 5 | ------------ |
6 | 6 | ||
7 | wallabag is compatible with php >= 5.5, including php 7. | 7 | wallabag is compatible with PHP >= 5.5, including PHP 7. |
8 | 8 | ||
9 | You'll need the following extensions for wallabag to work. Some of these may already activated in your version of php, so you may not have to install all corresponding packages. | 9 | You'll need the following extensions for wallabag to work. Some of these may already activated in your version of PHP, so you may not have to install all corresponding packages. |
10 | 10 | ||
11 | - php-session | 11 | - php-session |
12 | - php-ctype | 12 | - php-ctype |
@@ -25,9 +25,9 @@ You'll need the following extensions for wallabag to work. Some of these may alr | |||
25 | 25 | ||
26 | wallabag uses PDO to connect to database, so you'll need one of: | 26 | wallabag uses PDO to connect to database, so you'll need one of: |
27 | 27 | ||
28 | - php-pdo_mysql | 28 | - pdo_mysql |
29 | - php-pdo_sqlite | 29 | - pdo_sqlite |
30 | - php-pdo_pgsql | 30 | - pdo_pgsql |
31 | 31 | ||
32 | and it's corresponding database server. | 32 | and it's corresponding database server. |
33 | 33 | ||
@@ -50,7 +50,7 @@ To install wallabag itself, you must run these two commands: | |||
50 | 50 | ||
51 | git clone https://github.com/wallabag/wallabag.git | 51 | git clone https://github.com/wallabag/wallabag.git |
52 | cd wallabag | 52 | cd wallabag |
53 | git checkout 2.0.0-beta.2 | 53 | git checkout 2.0.0 |
54 | SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist | 54 | SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist |
55 | php bin/console wallabag:install --env=prod | 55 | php bin/console wallabag:install --env=prod |
56 | 56 | ||
diff --git a/docs/en/user/migration.rst b/docs/en/user/migration.rst new file mode 100644 index 00000000..e1fee961 --- /dev/null +++ b/docs/en/user/migration.rst | |||
@@ -0,0 +1,62 @@ | |||
1 | Migrate wallabag | ||
2 | ================ | ||
3 | |||
4 | From wallabag 1.x | ||
5 | ----------------- | ||
6 | |||
7 | If you were using wallabag v1.x, you need to export your data before migrating to wallabag v2.x, because the application and its database changed a lot. In your old wallabag installation, you can export your data, which can be done on the Config page of your old wallabag installation. | ||
8 | |||
9 | .. image:: ../../img/user/export_v1.png | ||
10 | :alt: Exporting from wallabag v1 | ||
11 | :align: center | ||
12 | |||
13 | .. note:: | ||
14 | If you have multiple accounts on the same instance of wallabag, each user must export from v1 and import into v2 its data. | ||
15 | |||
16 | .. note:: | ||
17 | If you encounter issues during the export or the import, don't hesitate to `ask for support <https://www.wallabag.org/pages/support.html>`__. | ||
18 | |||
19 | When you have retrieved the json file containing your entries, you can install wallabag v2 if needed by following `the standard procedure <http://doc.wallabag.org/en/v2/user/installation.html>`__. | ||
20 | |||
21 | After creating an user account on your new wallabag v2 instance, you must head over to the `Import` section and select `Import from wallabag v1`. Select your json file and upload it. | ||
22 | |||
23 | .. image:: ../../img/user/import_wallabagv1.png | ||
24 | :alt: Import from wallabag v1 | ||
25 | :align: center | ||
26 | |||
27 | Import via command-line interface (CLI) | ||
28 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
29 | |||
30 | If you have a CLI access on your web server, you can execute this command to import your wallabag v1 export: | ||
31 | |||
32 | :: | ||
33 | |||
34 | bin/console wallabag:import-v1 1 ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod | ||
35 | |||
36 | Please replace values: | ||
37 | |||
38 | * ``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 | ||
40 | |||
41 | You'll have this in return: | ||
42 | |||
43 | :: | ||
44 | |||
45 | Start : 05-04-2016 11:36:07 --- | ||
46 | 403 imported | ||
47 | 0 already saved | ||
48 | 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>`__. | ||