]> git.immae.eu Git - github/wallabag/wallabag.git/blob - docs/en/user/upgrade.rst
b3972bce3e63b8e0ace4b8e44abd1b3f8ccdb038
[github/wallabag/wallabag.git] / docs / en / user / upgrade.rst
1 ==================================
2 Upgrade your wallabag installation
3 ==================================
4
5 You will find here different ways to upgrade your wallabag:
6
7 - `from 2.1.x to 2.2.x <#upgrading-from-2-1-x-to-2-2-x>`_
8 - `from 2.0.x to 2.1.1 <#upgrade-from-2-0-x-to-2-1-1>`_
9 - `from 1.x to 2.x <#from-wallabag-1-x>`_
10
11 *****************************
12 Upgrading from 2.1.x to 2.2.x
13 *****************************
14
15 Upgrade on a dedicated web server
16 =================================
17
18 ::
19
20 make update
21
22 Explanations about database migrations
23 --------------------------------------
24
25 During the update, we execute database migrations.
26
27 All the database migrations are stored in ``app/DoctrineMigrations``. You can execute each migration individually:
28 ``bin/console doctrine:migrations:execute 20161001072726 --env=prod``.
29
30 You can also cancel each migration individually: ``bin/console doctrine:migrations:execute 20161001072726 --down --env=prod``.
31
32 Here is the migrations list for 2.1.x to 2.2.0 release:
33
34 * ``20161001072726``: added foreign keys for account resetting
35 * ``20161022134138``: converted database to ``utf8mb4`` encoding (for MySQL only)
36 * ``20161024212538``: added ``user_id`` column on ``oauth2_clients`` to prevent users to delete API clients from other users
37 * ``20161031132655``: added the internal setting to enable/disable downloading pictures
38 * ``20161104073720``: added ``created_at`` index on ``entry`` table
39 * ``20161106113822``: added ``action_mark_as_read`` field on ``config`` table
40 * ``20161117071626``: added the internal setting to share articles to unmark.it
41 * ``20161118134328``: added ``http_status`` field on ``entry`` table
42 * ``20161122144743``: added the internal setting to enable/disable fetching articles with paywall
43 * ``20161122203647``: dropped ``expired`` and ``credentials_expired`` fields on ``user`` table
44 * ``20161128084725``: added ``list_mode`` field on ``config`` table
45 * ``20161128131503``: dropped ``locked``, ``credentials_expire_at`` and ``expires_at`` fields on ``user`` table
46 * ``20161214094403``: added ``uid`` index on ``entry`` table
47
48 Upgrade on a shared hosting
49 ===========================
50
51 Backup your ``app/config/parameters.yml`` file.
52
53 Download the last release of wallabag:
54
55 .. code-block:: bash
56
57 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
58
59 You will find the `md5 hash of the latest package on our website <https://www.wallabag.org/pages/download-wallabag.html>`_.
60
61 Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours.
62
63 Please check that your ``app/config/parameters.yml`` contains all the required parameters. You can find `here a documentation about parameters <http://doc.wallabag.org/en/master/user/parameters.html>`_.
64
65 If you use SQLite, you must also copy your ``data/`` folder inside the new installation.
66
67 Empty ``var/cache`` folder.
68
69 You must run some SQL queries to upgrade your database. We assume that the table prefix is ``wallabag_``. Don't forgete to backup your database before migrating.
70
71 You may encounter issues with indexes names: if so, please change queries with the correct index name.
72
73 Migration 20161001072726
74 ------------------------
75
76 MySQL
77 ^^^^^
78
79 Migration up
80 """"""""""""
81
82 .. code-block:: sql
83
84 ALTER TABLE wallabag_entry_tag DROP FOREIGN KEY FK_C9F0DD7CBA364942
85 ALTER TABLE wallabag_entry_tag DROP FOREIGN KEY FK_C9F0DD7CBAD26311
86 ALTER TABLE wallabag_entry_tag ADD CONSTRAINT FK_entry_tag_entry FOREIGN KEY (entry_id) REFERENCES wallabag_entry (id) ON DELETE CASCADE
87 ALTER TABLE wallabag_entry_tag ADD CONSTRAINT FK_entry_tag_tag FOREIGN KEY (tag_id) REFERENCES wallabag_tag (id) ON DELETE CASCADE
88 ALTER TABLE wallabag_annotation DROP FOREIGN KEY FK_A7AED006BA364942
89 ALTER TABLE wallabag_annotation ADD CONSTRAINT FK_annotation_entry FOREIGN KEY (entry_id) REFERENCES wallabag_entry (id) ON DELETE CASCADE
90
91 Migration down
92 """"""""""""""
93
94 We didn't write down migration for ``20161001072726``.
95
96 PostgreSQL
97 ^^^^^^^^^^
98
99 Migration up
100 """"""""""""
101
102 .. code-block:: sql
103
104 ALTER TABLE wallabag_entry_tag DROP CONSTRAINT fk_c9f0dd7cba364942
105 ALTER TABLE wallabag_entry_tag DROP CONSTRAINT fk_c9f0dd7cbad26311
106 ALTER TABLE wallabag_entry_tag ADD CONSTRAINT FK_entry_tag_entry FOREIGN KEY (entry_id) REFERENCES wallabag_entry (id) ON DELETE CASCADE
107 ALTER TABLE wallabag_entry_tag ADD CONSTRAINT FK_entry_tag_tag FOREIGN KEY (tag_id) REFERENCES wallabag_tag (id) ON DELETE CASCADE
108 ALTER TABLE wallabag_annotation DROP CONSTRAINT fk_a7aed006ba364942
109 ALTER TABLE wallabag_annotation ADD CONSTRAINT FK_annotation_entry FOREIGN KEY (entry_id) REFERENCES wallabag_entry (id) ON DELETE CASCADE
110
111 Migration down
112 """"""""""""""
113
114 We didn't write down migration for ``20161001072726``.
115
116 SQLite
117 ^^^^^^
118
119 This migration can only be executed safely on MySQL or PostgreSQL.
120
121 Migration 20161022134138
122 ------------------------
123
124 MySQL
125 ^^^^^
126
127 Migration up
128 """"""""""""
129
130 .. code-block:: sql
131
132 ALTER DATABASE wallabag CHARACTER SET = utf8mb4 COLLATE = utf8mb4_unicode_ci;
133 ALTER TABLE wallabag_user CHANGE confirmation_token confirmation_token VARCHAR(180) DEFAULT NULL;
134 ALTER TABLE wallabag_user CHANGE salt salt VARCHAR(180) NOT NULL;
135 ALTER TABLE wallabag_user CHANGE password password VARCHAR(180) NOT NULL;
136 ALTER TABLE wallabag_annotation CONVERT TO CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
137 ALTER TABLE wallabag_entry CONVERT TO CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
138 ALTER TABLE wallabag_tag CONVERT TO CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
139 ALTER TABLE wallabag_user CONVERT TO CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
140 ALTER TABLE wallabag_annotation CHANGE `text` `text` longtext CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
141 ALTER TABLE wallabag_annotation CHANGE `quote` `quote` VARCHAR(191) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
142 ALTER TABLE wallabag_entry CHANGE `title` `title` longtext CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
143 ALTER TABLE wallabag_entry CHANGE `content` `content` longtext CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
144 ALTER TABLE wallabag_tag CHANGE `label` `label` longtext CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
145 ALTER TABLE wallabag_user CHANGE `name` `name` longtext CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
146
147 Migration down
148 """"""""""""""
149
150 .. code-block:: sql
151
152 ALTER DATABASE wallabag CHARACTER SET = utf8 COLLATE = utf8_unicode_ci;
153 ALTER TABLE wallabag_annotation CONVERT TO CHARACTER SET utf8 COLLATE utf8_unicode_ci;
154 ALTER TABLE wallabag_entry CONVERT TO CHARACTER SET utf8 COLLATE utf8_unicode_ci;
155 ALTER TABLE wallabag_tag CONVERT TO CHARACTER SET utf8 COLLATE utf8_unicode_ci;
156 ALTER TABLE wallabag_user CONVERT TO CHARACTER SET utf8 COLLATE utf8_unicode_ci;
157 ALTER TABLE wallabag_annotation CHANGE `text` `text` longtext CHARACTER SET utf8 COLLATE utf8_unicode_ci;
158 ALTER TABLE wallabag_annotation CHANGE `quote` `quote` VARCHAR(255) CHARACTER SET utf8 COLLATE utf8_unicode_ci;
159 ALTER TABLE wallabag_entry CHANGE `title` `title` longtext CHARACTER SET utf8 COLLATE utf8_unicode_ci;
160 ALTER TABLE wallabag_entry CHANGE `content` `content` longtext CHARACTER SET utf8 COLLATE utf8_unicode_ci;
161 ALTER TABLE wallabag_tag CHANGE `label` `label` longtext CHARACTER SET utf8 COLLATE utf8_unicode_ci;
162 ALTER TABLE wallabag_user CHANGE `name` `name` longtext CHARACTER SET utf8 COLLATE utf8_unicode_ci;
163
164 PostgreSQL and SQLite
165 ^^^^^^^^^^^^^^^^^^^^^
166
167 This migration only apply to MySQL.
168
169 Migration 20161024212538
170 ------------------------
171
172 MySQL
173 ^^^^^
174
175 Migration up
176 """"""""""""
177
178 .. code-block:: sql
179
180 ALTER TABLE wallabag_oauth2_clients ADD user_id INT NOT NULL
181 ALTER TABLE wallabag_oauth2_clients ADD CONSTRAINT IDX_user_oauth_client FOREIGN KEY (user_id) REFERENCES wallabag_user (id) ON DELETE CASCADE
182 CREATE INDEX IDX_635D765EA76ED395 ON wallabag_oauth2_clients (user_id)
183
184 Migration down
185 """"""""""""""
186
187 .. code-block:: sql
188
189 ALTER TABLE wallabag_oauth2_clients DROP FOREIGN KEY IDX_user_oauth_client
190 ALTER TABLE wallabag_oauth2_clients DROP user_id
191
192 PostgreSQL
193 ^^^^^^^^^^
194
195 Migration up
196 """"""""""""
197
198 .. code-block:: sql
199
200 ALTER TABLE wallabag_oauth2_clients ADD user_id INT DEFAULT NULL
201 ALTER TABLE wallabag_oauth2_clients ADD CONSTRAINT IDX_user_oauth_client FOREIGN KEY (user_id) REFERENCES wallabag_user (id) ON DELETE CASCADE NOT DEFERRABLE INITIALLY IMMEDIATE
202 CREATE INDEX IDX_635D765EA76ED395 ON wallabag_oauth2_clients (user_id)
203
204
205 Migration down
206 """"""""""""""
207
208 .. code-block:: sql
209
210 ALTER TABLE wallabag_oauth2_clients DROP CONSTRAINT idx_user_oauth_client
211 ALTER TABLE wallabag_oauth2_clients DROP user_id
212
213 SQLite
214 ^^^^^^
215
216 Migration up
217 """"""""""""
218
219 .. code-block:: sql
220
221 CREATE TEMPORARY TABLE __temp__wallabag_oauth2_clients AS SELECT id, random_id, redirect_uris, secret, allowed_grant_types, name FROM wallabag_oauth2_clients
222 DROP TABLE wallabag_oauth2_clients
223 CREATE TABLE wallabag_oauth2_clients (id INTEGER NOT NULL, user_id INTEGER DEFAULT NULL, random_id VARCHAR(255) NOT NULL COLLATE BINARY, redirect_uris CLOB NOT NULL COLLATE BINARY, secret VARCHAR(255) NOT NULL COLLATE BINARY, allowed_grant_types CLOB NOT NULL COLLATE BINARY, name CLOB DEFAULT NULL COLLATE BINARY, PRIMARY KEY(id), CONSTRAINT IDX_user_oauth_client FOREIGN KEY (user_id) REFERENCES wallabag_user (id) ON DELETE CASCADE NOT DEFERRABLE INITIALLY IMMEDIATE)
224 INSERT INTO wallabag_oauth2_clients (id, random_id, redirect_uris, secret, allowed_grant_types, name) SELECT id, random_id, redirect_uris, secret, allowed_grant_types, name FROM __temp__wallabag_oauth2_clients
225 DROP TABLE __temp__wallabag_oauth2_clients
226 CREATE INDEX IDX_635D765EA76ED395 ON wallabag_oauth2_clients (user_id)
227
228 Migration down
229 """"""""""""""
230
231 .. code-block:: sql
232
233 DROP INDEX IDX_635D765EA76ED395
234 CREATE TEMPORARY TABLE __temp__wallabag_oauth2_clients AS SELECT id, random_id, redirect_uris, secret, allowed_grant_types, name FROM wallabag_oauth2_clients
235 DROP TABLE wallabag_oauth2_clients
236 CREATE TABLE wallabag_oauth2_clients (id INTEGER NOT NULL, random_id VARCHAR(255) NOT NULL COLLATE BINARY, redirect_uris CLOB NOT NULL COLLATE BINARY, secret VARCHAR(255) NOT NULL COLLATE BINARY, allowed_grant_types CLOB NOT NULL COLLATE BINARY, name CLOB DEFAULT NULL COLLATE BINARY, PRIMARY KEY(id))
237 INSERT INTO wallabag_oauth2_clients (id, random_id, redirect_uris, secret, allowed_grant_types, name) SELECT id, random_id, redirect_uris, secret, allowed_grant_types, name FROM __temp__wallabag_oauth2_clients
238 DROP TABLE __temp__wallabag_oauth2_clients
239
240 Migration 20161031132655
241 ------------------------
242
243 MySQL
244 ^^^^^
245
246 Migration up
247 """"""""""""
248
249 .. code-block:: sql
250
251 INSERT INTO wallabag_craue_config_setting (name, value, section) VALUES ('download_images_enabled', 0, 'misc')
252
253 Migration down
254 """"""""""""""
255
256 .. code-block:: sql
257
258 DELETE FROM wallabag_craue_config_setting WHERE name = 'download_images_enabled';
259
260 PostgreSQL
261 ^^^^^^^^^^
262
263 Migration up
264 """"""""""""
265
266 .. code-block:: sql
267
268 INSERT INTO wallabag_craue_config_setting (name, value, section) VALUES ('download_images_enabled', 0, 'misc')
269
270 Migration down
271 """"""""""""""
272
273 .. code-block:: sql
274
275 DELETE FROM wallabag_craue_config_setting WHERE name = 'download_images_enabled';
276
277 SQLite
278 ^^^^^^
279
280 Migration up
281 """"""""""""
282
283 .. code-block:: sql
284
285 INSERT INTO wallabag_craue_config_setting (name, value, section) VALUES ('download_images_enabled', 0, 'misc')
286
287 Migration down
288 """"""""""""""
289
290 .. code-block:: sql
291
292 DELETE FROM wallabag_craue_config_setting WHERE name = 'download_images_enabled';
293
294 Migration 20161104073720
295 ------------------------
296
297 MySQL
298 ^^^^^
299
300 Migration up
301 """"""""""""
302
303 .. code-block:: sql
304
305 CREATE INDEX IDX_entry_created_at ON wallabag_entry (created_at)
306
307 Migration down
308 """"""""""""""
309
310 .. code-block:: sql
311
312 DROP INDEX IDX_entry_created_at ON wallabag_entry
313
314 PostgreSQL
315 ^^^^^^^^^^
316
317 Migration up
318 """"""""""""
319
320 .. code-block:: sql
321
322 CREATE INDEX IDX_entry_created_at ON wallabag_entry (created_at)
323
324 Migration down
325 """"""""""""""
326
327 .. code-block:: sql
328
329 DROP INDEX idx_entry_created_at
330
331 SQLite
332 ^^^^^^
333
334 Migration up
335 """"""""""""
336
337 .. code-block:: sql
338
339 DROP INDEX created_at_idx
340 DROP INDEX IDX_F4D18282A76ED395
341 CREATE TEMPORARY TABLE __temp__wallabag_entry AS SELECT id, user_id, uuid, title, url, is_archived, is_starred, content, created_at, updated_at, mimetype, language, reading_time, domain_name, preview_picture, is_public FROM wallabag_entry
342 DROP TABLE wallabag_entry
343 CREATE TABLE wallabag_entry (id INTEGER NOT NULL, user_id INTEGER DEFAULT NULL, uuid CLOB DEFAULT NULL COLLATE BINARY, title CLOB DEFAULT NULL COLLATE BINARY, url CLOB DEFAULT NULL COLLATE BINARY, is_archived BOOLEAN NOT NULL, is_starred BOOLEAN NOT NULL, content CLOB DEFAULT NULL COLLATE BINARY, created_at DATETIME NOT NULL, updated_at DATETIME NOT NULL, mimetype CLOB DEFAULT NULL COLLATE BINARY, language CLOB DEFAULT NULL COLLATE BINARY, reading_time INTEGER DEFAULT NULL, domain_name CLOB DEFAULT NULL COLLATE BINARY, preview_picture CLOB DEFAULT NULL COLLATE BINARY, is_public BOOLEAN DEFAULT '0', PRIMARY KEY(id))
344 INSERT INTO wallabag_entry (id, user_id, uuid, title, url, is_archived, is_starred, content, created_at, updated_at, mimetype, language, reading_time, domain_name, preview_picture, is_public) SELECT id, user_id, uuid, title, url, is_archived, is_starred, content, created_at, updated_at, mimetype, language, reading_time, domain_name, preview_picture, is_public FROM __temp__wallabag_entry
345 DROP TABLE __temp__wallabag_entry
346 CREATE INDEX created_at_idx ON wallabag_entry (created_at)
347 CREATE INDEX IDX_F4D18282A76ED395 ON wallabag_entry (user_id)
348 CREATE INDEX IDX_entry_created_at ON wallabag_entry (created_at)
349
350 Migration down
351 """"""""""""""
352
353 .. code-block:: sql
354
355 DROP INDEX IDX_entry_created_at
356 DROP INDEX IDX_F4D18282A76ED395
357 DROP INDEX created_at_idx
358 CREATE TEMPORARY TABLE __temp__wallabag_entry AS SELECT id, user_id, uuid, title, url, is_archived, is_starred, content, created_at, updated_at, mimetype, language, reading_time, domain_name, preview_picture, is_public FROM wallabag_entry
359 DROP TABLE wallabag_entry
360 CREATE TABLE wallabag_entry (id INTEGER NOT NULL, user_id INTEGER DEFAULT NULL, uuid CLOB DEFAULT NULL COLLATE BINARY, title CLOB DEFAULT NULL COLLATE BINARY, url CLOB DEFAULT NULL COLLATE BINARY, is_archived BOOLEAN NOT NULL, is_starred BOOLEAN NOT NULL, content CLOB DEFAULT NULL COLLATE BINARY, created_at DATETIME NOT NULL, updated_at DATETIME NOT NULL, mimetype CLOB DEFAULT NULL COLLATE BINARY, language CLOB DEFAULT NULL COLLATE BINARY, reading_time INTEGER DEFAULT NULL, domain_name CLOB DEFAULT NULL COLLATE BINARY, preview_picture CLOB DEFAULT NULL COLLATE BINARY, is_public BOOLEAN DEFAULT '0', PRIMARY KEY(id))
361 INSERT INTO wallabag_entry (id, user_id, uuid, title, url, is_archived, is_starred, content, created_at, updated_at, mimetype, language, reading_time, domain_name, preview_picture, is_public) SELECT id, user_id, uuid, title, url, is_archived, is_starred, content, created_at, updated_at, mimetype, language, reading_time, domain_name, preview_picture, is_public FROM __temp__wallabag_entry
362 DROP TABLE __temp__wallabag_entry
363 CREATE INDEX IDX_F4D18282A76ED395 ON wallabag_entry (user_id)
364 CREATE INDEX created_at_idx ON wallabag_entry (created_at)
365
366 Migration 20161106113822
367 ------------------------
368
369 MySQL
370 ^^^^^
371
372 Migration up
373 """"""""""""
374
375 .. code-block:: sql
376
377 ALTER TABLE wallabag_config ADD action_mark_as_read INT DEFAULT 0
378
379 Migration down
380 """"""""""""""
381
382 .. code-block:: sql
383
384 ALTER TABLE wallabag_config DROP action_mark_as_read
385
386 PostgreSQL
387 ^^^^^^^^^^
388
389 Migration up
390 """"""""""""
391
392 .. code-block:: sql
393
394 ALTER TABLE wallabag_config ADD action_mark_as_read INT DEFAULT 0
395
396 Migration down
397 """"""""""""""
398
399 .. code-block:: sql
400
401 ALTER TABLE wallabag_config DROP action_mark_as_read
402
403 SQLite
404 ^^^^^^
405
406 Migration up
407 """"""""""""
408
409 .. code-block:: sql
410
411 ALTER TABLE wallabag_config ADD COLUMN action_mark_as_read INTEGER DEFAULT 0
412
413 Migration down
414 """"""""""""""
415
416 .. code-block:: sql
417
418 DROP INDEX UNIQ_87E64C53A76ED395
419 CREATE TEMPORARY TABLE __temp__wallabag_config AS SELECT id, user_id, theme, items_per_page, language, rss_token, rss_limit, reading_speed, pocket_consumer_key FROM wallabag_config
420 DROP TABLE wallabag_config
421 CREATE TABLE wallabag_config (id INTEGER NOT NULL, user_id INTEGER DEFAULT NULL, theme VARCHAR(255) NOT NULL COLLATE BINARY, items_per_page INTEGER NOT NULL, language VARCHAR(255) NOT NULL COLLATE BINARY, rss_token VARCHAR(255) DEFAULT NULL COLLATE BINARY, rss_limit INTEGER DEFAULT NULL, reading_speed DOUBLE PRECISION DEFAULT NULL, pocket_consumer_key VARCHAR(255) DEFAULT NULL COLLATE BINARY, PRIMARY KEY(id))
422 INSERT INTO wallabag_config (id, user_id, theme, items_per_page, language, rss_token, rss_limit, reading_speed, pocket_consumer_key) SELECT id, user_id, theme, items_per_page, language, rss_token, rss_limit, reading_speed, pocket_consumer_key FROM __temp__wallabag_config
423 DROP TABLE __temp__wallabag_config
424 CREATE UNIQUE INDEX UNIQ_87E64C53A76ED395 ON wallabag_config (user_id)
425
426 Migration 20161117071626
427 ------------------------
428
429 MySQL
430 ^^^^^
431
432 Migration up
433 """"""""""""
434
435 .. code-block:: sql
436
437 INSERT INTO wallabag_craue_config_setting (name, value, section) VALUES ('share_unmark', 0, 'entry')
438 INSERT INTO wallabag_craue_config_setting (name, value, section) VALUES ('unmark_url', 'https://unmark.it', 'entry')
439
440 Migration down
441 """"""""""""""
442
443 .. code-block:: sql
444
445 DELETE FROM wallabag_craue_config_setting WHERE name = 'share_unmark';
446 DELETE FROM wallabag_craue_config_setting WHERE name = 'unmark_url';
447
448 PostgreSQL
449 ^^^^^^^^^^
450
451 Migration up
452 """"""""""""
453
454 .. code-block:: sql
455
456 INSERT INTO wallabag_craue_config_setting (name, value, section) VALUES ('share_unmark', 0, 'entry')
457 INSERT INTO wallabag_craue_config_setting (name, value, section) VALUES ('unmark_url', 'https://unmark.it', 'entry')
458
459 Migration down
460 """"""""""""""
461
462 .. code-block:: sql
463
464 DELETE FROM wallabag_craue_config_setting WHERE name = 'share_unmark';
465 DELETE FROM wallabag_craue_config_setting WHERE name = 'unmark_url';
466
467 SQLite
468 ^^^^^^
469
470 Migration up
471 """"""""""""
472
473 .. code-block:: sql
474
475 INSERT INTO wallabag_craue_config_setting (name, value, section) VALUES ('share_unmark', 0, 'entry')
476 INSERT INTO wallabag_craue_config_setting (name, value, section) VALUES ('unmark_url', 'https://unmark.it', 'entry')
477
478 Migration down
479 """"""""""""""
480
481 .. code-block:: sql
482
483 DELETE FROM wallabag_craue_config_setting WHERE name = 'share_unmark';
484 DELETE FROM wallabag_craue_config_setting WHERE name = 'unmark_url';
485
486 Migration 20161118134328
487 ------------------------
488
489 MySQL
490 ^^^^^
491
492 Migration up
493 """"""""""""
494
495 .. code-block:: sql
496
497 ALTER TABLE wallabag_entry ADD http_status VARCHAR(3) DEFAULT NULL
498
499 Migration down
500 """"""""""""""
501
502 .. code-block:: sql
503
504 ALTER TABLE wallabag_entry DROP http_status
505
506 PostgreSQL
507 ^^^^^^^^^^
508
509 Migration up
510 """"""""""""
511
512 .. code-block:: sql
513
514 ALTER TABLE wallabag_entry ADD http_status VARCHAR(3) DEFAULT NULL
515
516 Migration down
517 """"""""""""""
518
519 .. code-block:: sql
520
521 ALTER TABLE wallabag_entry DROP http_status
522
523 SQLite
524 ^^^^^^
525
526 Migration up
527 """"""""""""
528
529 .. code-block:: sql
530
531 ALTER TABLE wallabag_entry ADD COLUMN http_status VARCHAR(3) DEFAULT NULL
532
533 Migration down
534 """"""""""""""
535
536 .. code-block:: sql
537
538 DROP INDEX created_at_idx
539 DROP INDEX IDX_F4D18282A76ED395
540 CREATE TEMPORARY TABLE __temp__wallabag_entry AS SELECT id, user_id, uuid, title, url, is_archived, is_starred, content, created_at, updated_at, mimetype, language, reading_time, domain_name, preview_picture, is_public FROM wallabag_entry
541 DROP TABLE wallabag_entry
542 CREATE TABLE wallabag_entry (id INTEGER NOT NULL, user_id INTEGER DEFAULT NULL, uuid CLOB DEFAULT NULL COLLATE BINARY, title CLOB DEFAULT NULL COLLATE BINARY, url CLOB DEFAULT NULL COLLATE BINARY, is_archived BOOLEAN NOT NULL, is_starred BOOLEAN NOT NULL, content CLOB DEFAULT NULL COLLATE BINARY, created_at DATETIME NOT NULL, updated_at DATETIME NOT NULL, mimetype CLOB DEFAULT NULL COLLATE BINARY, language CLOB DEFAULT NULL COLLATE BINARY, reading_time INTEGER DEFAULT NULL, domain_name CLOB DEFAULT NULL COLLATE BINARY, preview_picture CLOB DEFAULT NULL COLLATE BINARY, is_public BOOLEAN DEFAULT '0', PRIMARY KEY(id))
543 INSERT INTO wallabag_entry (id, user_id, uuid, title, url, is_archived, is_starred, content, created_at, updated_at, mimetype, language, reading_time, domain_name, preview_picture, is_public) SELECT id, user_id, uuid, title, url, is_archived, is_starred, content, created_at, updated_at, mimetype, language, reading_time, domain_name, preview_picture, is_public FROM __temp__wallabag_entry
544 DROP TABLE __temp__wallabag_entry
545 CREATE INDEX created_at_idx ON wallabag_entry (created_at)
546 CREATE INDEX IDX_F4D18282A76ED395 ON wallabag_entry (user_id)
547
548 Migration 20161122144743
549 ------------------------
550
551 MySQL
552 ^^^^^
553
554 Migration up
555 """"""""""""
556
557 .. code-block:: sql
558
559 INSERT INTO wallabag_craue_config_setting (name, value, section) VALUES ('restricted_access', 0, 'entry')
560
561 Migration down
562 """"""""""""""
563
564 .. code-block:: sql
565
566 DELETE FROM wallabag_craue_config_setting WHERE name = 'restricted_access';
567
568 PostgreSQL
569 ^^^^^^^^^^
570
571 Migration up
572 """"""""""""
573
574 .. code-block:: sql
575
576 INSERT INTO wallabag_craue_config_setting (name, value, section) VALUES ('restricted_access', 0, 'entry')
577
578 Migration down
579 """"""""""""""
580
581 .. code-block:: sql
582
583 DELETE FROM wallabag_craue_config_setting WHERE name = 'restricted_access';
584
585 SQLite
586 ^^^^^^
587
588 Migration up
589 """"""""""""
590
591 .. code-block:: sql
592
593 INSERT INTO wallabag_craue_config_setting (name, value, section) VALUES ('restricted_access', 0, 'entry')
594
595 Migration down
596 """"""""""""""
597
598 .. code-block:: sql
599
600 DELETE FROM wallabag_craue_config_setting WHERE name = 'restricted_access';
601
602 Migration 20161122203647
603 ------------------------
604
605 MySQL
606 ^^^^^
607
608 Migration up
609 """"""""""""
610
611 .. code-block:: sql
612
613 ALTER TABLE wallabag_user DROP expired, DROP credentials_expired
614
615 Migration down
616 """"""""""""""
617
618 .. code-block:: sql
619
620 ALTER TABLE wallabag_user ADD expired SMALLINT DEFAULT NULL, ADD credentials_expired SMALLINT DEFAULT NULL
621
622 PostgreSQL
623 ^^^^^^^^^^
624
625 Migration up
626 """"""""""""
627
628 .. code-block:: sql
629
630 ALTER TABLE wallabag_user DROP expired
631 ALTER TABLE wallabag_user DROP credentials_expired
632
633 Migration down
634 """"""""""""""
635
636 .. code-block:: sql
637
638 ALTER TABLE wallabag_user ADD expired SMALLINT DEFAULT NULL
639 ALTER TABLE wallabag_user ADD credentials_expired SMALLINT DEFAULT NULL
640
641 SQLite
642 ^^^^^^
643
644 Migration up
645 """"""""""""
646
647 .. code-block:: sql
648
649 DROP INDEX UNIQ_1D63E7E5C05FB297
650 DROP INDEX UNIQ_1D63E7E5A0D96FBF
651 DROP INDEX UNIQ_1D63E7E592FC23A8
652 CREATE TEMPORARY TABLE __temp__wallabag_user AS SELECT id, username, username_canonical, email, email_canonical, enabled, salt, password, last_login, locked, expires_at, confirmation_token, password_requested_at, roles, credentials_expire_at, name, created_at, updated_at, authCode, twoFactorAuthentication, trusted FROM wallabag_user
653 DROP TABLE wallabag_user
654 CREATE TABLE wallabag_user (id INTEGER NOT NULL, username VARCHAR(180) NOT NULL COLLATE BINARY, username_canonical VARCHAR(180) NOT NULL COLLATE BINARY, email VARCHAR(180) NOT NULL COLLATE BINARY, email_canonical VARCHAR(180) NOT NULL COLLATE BINARY, enabled BOOLEAN NOT NULL, salt VARCHAR(255) NOT NULL COLLATE BINARY, password VARCHAR(255) NOT NULL COLLATE BINARY, last_login DATETIME DEFAULT NULL, locked BOOLEAN NOT NULL, expires_at DATETIME DEFAULT NULL, confirmation_token VARCHAR(180) DEFAULT NULL COLLATE BINARY, password_requested_at DATETIME DEFAULT NULL, roles CLOB NOT NULL COLLATE BINARY, credentials_expire_at DATETIME DEFAULT NULL, name CLOB DEFAULT NULL COLLATE BINARY, created_at DATETIME NOT NULL, updated_at DATETIME NOT NULL, authCode INTEGER DEFAULT NULL, twoFactorAuthentication BOOLEAN NOT NULL, trusted CLOB DEFAULT NULL COLLATE BINARY, PRIMARY KEY(id))
655 INSERT INTO wallabag_user (id, username, username_canonical, email, email_canonical, enabled, salt, password, last_login, locked, expires_at, confirmation_token, password_requested_at, roles, credentials_expire_at, name, created_at, updated_at, authCode, twoFactorAuthentication, trusted) SELECT id, username, username_canonical, email, email_canonical, enabled, salt, password, last_login, locked, expires_at, confirmation_token, password_requested_at, roles, credentials_expire_at, name, created_at, updated_at, authCode, twoFactorAuthentication, trusted FROM __temp__wallabag_user
656 DROP TABLE __temp__wallabag_user
657 CREATE UNIQUE INDEX UNIQ_1D63E7E5C05FB297 ON wallabag_user (confirmation_token)
658 CREATE UNIQUE INDEX UNIQ_1D63E7E5A0D96FBF ON wallabag_user (email_canonical)
659 CREATE UNIQUE INDEX UNIQ_1D63E7E592FC23A8 ON wallabag_user (username_canonical)
660
661 Migration down
662 """"""""""""""
663
664 .. code-block:: sql
665
666 ALTER TABLE wallabag_user ADD COLUMN expired SMALLINT DEFAULT NULL
667 ALTER TABLE wallabag_user ADD COLUMN credentials_expired SMALLINT DEFAULT NULL
668
669 Migration 20161128084725
670 ------------------------
671
672 MySQL
673 ^^^^^
674
675 Migration up
676 """"""""""""
677
678 .. code-block:: sql
679
680 ALTER TABLE wallabag_config ADD list_mode INT DEFAULT NULL
681
682 Migration down
683 """"""""""""""
684
685 .. code-block:: sql
686
687 ALTER TABLE wallabag_config DROP list_mode
688
689 PostgreSQL
690 ^^^^^^^^^^
691
692 Migration up
693 """"""""""""
694
695 .. code-block:: sql
696
697 ALTER TABLE wallabag_config ADD list_mode INT DEFAULT NULL
698
699 Migration down
700 """"""""""""""
701
702 .. code-block:: sql
703
704 ALTER TABLE wallabag_config DROP list_mode
705
706 SQLite
707 ^^^^^^
708
709 Migration up
710 """"""""""""
711
712 .. code-block:: sql
713
714 ALTER TABLE wallabag_config ADD COLUMN list_mode INTEGER DEFAULT NULL
715
716 Migration down
717 """"""""""""""
718
719 .. code-block:: sql
720
721 DROP INDEX UNIQ_87E64C53A76ED395
722 CREATE TEMPORARY TABLE __temp__wallabag_config AS SELECT id, user_id, theme, items_per_page, language, rss_token, rss_limit, reading_speed, pocket_consumer_key FROM wallabag_config
723 DROP TABLE wallabag_config
724 CREATE TABLE wallabag_config (id INTEGER NOT NULL, user_id INTEGER DEFAULT NULL, theme VARCHAR(255) NOT NULL COLLATE BINARY, items_per_page INTEGER NOT NULL, language VARCHAR(255) NOT NULL COLLATE BINARY, rss_token VARCHAR(255) DEFAULT NULL COLLATE BINARY, rss_limit INTEGER DEFAULT NULL, reading_speed DOUBLE PRECISION DEFAULT NULL, pocket_consumer_key VARCHAR(255) DEFAULT NULL COLLATE BINARY, PRIMARY KEY(id))
725 INSERT INTO wallabag_config (id, user_id, theme, items_per_page, language, rss_token, rss_limit, reading_speed, pocket_consumer_key) SELECT id, user_id, theme, items_per_page, language, rss_token, rss_limit, reading_speed, pocket_consumer_key FROM __temp__wallabag_config
726 DROP TABLE __temp__wallabag_config
727 CREATE UNIQUE INDEX UNIQ_87E64C53A76ED395 ON wallabag_config (user_id)
728
729 Migration 20161128131503
730 ------------------------
731
732 MySQL
733 ^^^^^
734
735 Migration up
736 """"""""""""
737
738 .. code-block:: sql
739
740 ALTER TABLE wallabag_user DROP locked, DROP credentials_expire_at, DROP expires_at
741
742 Migration down
743 """"""""""""""
744
745 .. code-block:: sql
746
747 ALTER TABLE wallabag_user ADD locked SMALLINT DEFAULT NULL, ADD credentials_expire_at DATETIME DEFAULT NULL, ADD expires_at DATETIME DEFAULT NULL
748
749 PostgreSQL
750 ^^^^^^^^^^
751
752 Migration up
753 """"""""""""
754
755 .. code-block:: sql
756
757 ALTER TABLE wallabag_user DROP locked
758 ALTER TABLE wallabag_user DROP credentials_expire_at
759 ALTER TABLE wallabag_user DROP expires_at
760
761 Migration down
762 """"""""""""""
763
764 .. code-block:: sql
765
766 ALTER TABLE wallabag_user ADD locked SMALLINT DEFAULT NULL
767 ALTER TABLE wallabag_user ADD credentials_expire_at TIMESTAMP(0) WITHOUT TIME ZONE DEFAULT NULL
768 ALTER TABLE wallabag_user ADD expires_at TIMESTAMP(0) WITHOUT TIME ZONE DEFAULT NULL
769
770 SQLite
771 ^^^^^^
772
773 Migration up
774 """"""""""""
775
776 .. code-block:: sql
777
778 ALTER TABLE wallabag_user ADD COLUMN locked SMALLINT DEFAULT NULL
779 ALTER TABLE wallabag_user ADD COLUMN credentials_expire_at DATETIME DEFAULT NULL
780 ALTER TABLE wallabag_user ADD COLUMN expires_at DATETIME DEFAULT NULL
781
782 Migration down
783 """"""""""""""
784
785 .. code-block:: sql
786
787 DROP INDEX UNIQ_1D63E7E592FC23A8
788 DROP INDEX UNIQ_1D63E7E5A0D96FBF
789 DROP INDEX UNIQ_1D63E7E5C05FB297
790 CREATE TEMPORARY TABLE __temp__wallabag_user AS SELECT id, username, username_canonical, email, email_canonical, enabled, salt, password, last_login, confirmation_token, password_requested_at, roles, name, created_at, updated_at, authCode, twoFactorAuthentication, trusted, expired, credentials_expired FROM wallabag_user
791 DROP TABLE wallabag_user
792 CREATE TABLE wallabag_user (id INTEGER NOT NULL, username VARCHAR(180) NOT NULL COLLATE BINARY, username_canonical VARCHAR(180) NOT NULL COLLATE BINARY, email VARCHAR(180) NOT NULL COLLATE BINARY, email_canonical VARCHAR(180) NOT NULL COLLATE BINARY, enabled BOOLEAN NOT NULL, salt VARCHAR(255) NOT NULL COLLATE BINARY, password VARCHAR(255) NOT NULL COLLATE BINARY, last_login DATETIME DEFAULT NULL, confirmation_token VARCHAR(180) DEFAULT NULL COLLATE BINARY, password_requested_at DATETIME DEFAULT NULL, roles CLOB NOT NULL COLLATE BINARY, name CLOB DEFAULT NULL COLLATE BINARY, created_at DATETIME NOT NULL, updated_at DATETIME NOT NULL, authCode INTEGER DEFAULT NULL, twoFactorAuthentication BOOLEAN NOT NULL, trusted CLOB DEFAULT NULL COLLATE BINARY, expired SMALLINT DEFAULT NULL, credentials_expired SMALLINT DEFAULT NULL, PRIMARY KEY(id))
793 INSERT INTO wallabag_user (id, username, username_canonical, email, email_canonical, enabled, salt, password, last_login, confirmation_token, password_requested_at, roles, name, created_at, updated_at, authCode, twoFactorAuthentication, trusted, expired, credentials_expired) SELECT id, username, username_canonical, email, email_canonical, enabled, salt, password, last_login, confirmation_token, password_requested_at, roles, name, created_at, updated_at, authCode, twoFactorAuthentication, trusted, expired, credentials_expired FROM __temp__wallabag_user
794 DROP TABLE __temp__wallabag_user
795 CREATE UNIQUE INDEX UNIQ_1D63E7E592FC23A8 ON wallabag_user (username_canonical)
796 CREATE UNIQUE INDEX UNIQ_1D63E7E5A0D96FBF ON wallabag_user (email_canonical)
797 CREATE UNIQUE INDEX UNIQ_1D63E7E5C05FB297 ON wallabag_user (confirmation_token)
798
799 Migration 20161214094403
800 ------------------------
801
802 MySQL
803 ^^^^^
804
805 Migration up
806 """"""""""""
807
808 .. code-block:: sql
809
810 CREATE INDEX IDX_entry_uid ON wallabag_entry (uid)
811
812 Migration down
813 """"""""""""""
814
815 .. code-block:: sql
816
817 DROP INDEX IDX_entry_uid ON wallabag_entry
818
819 PostgreSQL
820 ^^^^^^^^^^
821
822 Migration up
823 """"""""""""
824
825 .. code-block:: sql
826
827 CREATE INDEX IDX_entry_uid ON wallabag_entry (uid)
828
829 Migration down
830 """"""""""""""
831
832 .. code-block:: sql
833
834 DROP INDEX idx_entry_uid
835
836 SQLite
837 ^^^^^^
838
839 Migration up
840 """"""""""""
841
842 .. code-block:: sql
843
844 DROP INDEX IDX_F4D18282A76ED395
845 DROP INDEX created_at_idx
846 CREATE TEMPORARY TABLE __temp__wallabag_entry AS SELECT id, user_id, uid, title, url, is_archived, is_starred, content, created_at, updated_at, mimetype, language, reading_time, domain_name, preview_picture, is_public FROM wallabag_entry
847 DROP TABLE wallabag_entry
848 CREATE TABLE wallabag_entry (id INTEGER NOT NULL, user_id INTEGER DEFAULT NULL, uid CLOB DEFAULT NULL COLLATE BINARY, title CLOB DEFAULT NULL COLLATE BINARY, url CLOB DEFAULT NULL COLLATE BINARY, is_archived BOOLEAN NOT NULL, is_starred BOOLEAN NOT NULL, content CLOB DEFAULT NULL COLLATE BINARY, created_at DATETIME NOT NULL, updated_at DATETIME NOT NULL, mimetype CLOB DEFAULT NULL COLLATE BINARY, language CLOB DEFAULT NULL COLLATE BINARY, reading_time INTEGER DEFAULT NULL, domain_name CLOB DEFAULT NULL COLLATE BINARY, preview_picture CLOB DEFAULT NULL COLLATE BINARY, is_public BOOLEAN DEFAULT '0', PRIMARY KEY(id))
849 INSERT INTO wallabag_entry (id, user_id, uid, title, url, is_archived, is_starred, content, created_at, updated_at, mimetype, language, reading_time, domain_name, preview_picture, is_public) SELECT id, user_id, uid, title, url, is_archived, is_starred, content, created_at, updated_at, mimetype, language, reading_time, domain_name, preview_picture, is_public FROM __temp__wallabag_entry
850 DROP TABLE __temp__wallabag_entry
851 CREATE INDEX IDX_F4D18282A76ED395 ON wallabag_entry (user_id)
852 CREATE INDEX created_at_idx ON wallabag_entry (created_at)
853 CREATE INDEX IDX_entry_uid ON wallabag_entry (uid)
854
855 Migration down
856 """"""""""""""
857
858 .. code-block:: sql
859
860 DROP INDEX IDX_entry_uid
861 DROP INDEX created_at_idx
862 DROP INDEX IDX_F4D18282A76ED395
863 CREATE TEMPORARY TABLE __temp__wallabag_entry AS SELECT id, user_id, uid, title, url, is_archived, is_starred, content, created_at, updated_at, mimetype, language, reading_time, domain_name, preview_picture, is_public FROM wallabag_entry
864 DROP TABLE wallabag_entry
865 CREATE TABLE wallabag_entry (id INTEGER NOT NULL, user_id INTEGER DEFAULT NULL, uid CLOB DEFAULT NULL COLLATE BINARY, title CLOB DEFAULT NULL COLLATE BINARY, url CLOB DEFAULT NULL COLLATE BINARY, is_archived BOOLEAN NOT NULL, is_starred BOOLEAN NOT NULL, content CLOB DEFAULT NULL COLLATE BINARY, created_at DATETIME NOT NULL, updated_at DATETIME NOT NULL, mimetype CLOB DEFAULT NULL COLLATE BINARY, language CLOB DEFAULT NULL COLLATE BINARY, reading_time INTEGER DEFAULT NULL, domain_name CLOB DEFAULT NULL COLLATE BINARY, preview_picture CLOB DEFAULT NULL COLLATE BINARY, is_public BOOLEAN DEFAULT '0', PRIMARY KEY(id))
866 INSERT INTO wallabag_entry (id, user_id, uid, title, url, is_archived, is_starred, content, created_at, updated_at, mimetype, language, reading_time, domain_name, preview_picture, is_public) SELECT id, user_id, uid, title, url, is_archived, is_starred, content, created_at, updated_at, mimetype, language, reading_time, domain_name, preview_picture, is_public FROM __temp__wallabag_entry
867 DROP TABLE __temp__wallabag_entry
868 CREATE INDEX created_at_idx ON wallabag_entry (created_at)
869 CREATE INDEX IDX_F4D18282A76ED395 ON wallabag_entry (user_id)
870
871 ***************************
872 Upgrade from 2.0.x to 2.1.1
873 ***************************
874
875 .. warning::
876
877 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.
878
879 Upgrade on a dedicated web server
880 =================================
881
882 ::
883
884 rm -rf var/cache/*
885 git fetch origin
886 git fetch --tags
887 git checkout 2.1.1 --force
888 SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
889 php bin/console doctrine:migrations:migrate --env=prod
890 php bin/console cache:clear --env=prod
891
892 Upgrade on a shared hosting
893 ===========================
894
895 Backup your ``app/config/parameters.yml`` file.
896
897 Download the 2.1.1 release of wallabag:
898
899 .. code-block:: bash
900
901 wget http://framabag.org/wallabag-release-2.1.1.tar.gz && tar xvf wallabag-release-2.1.1.tar.gz
902
903 (md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``)
904
905 Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours.
906
907 Please check that your ``app/config/parameters.yml`` contains all the required parameters. You can find `here a documentation about parameters <http://doc.wallabag.org/en/master/user/parameters.html>`_.
908
909 If you use SQLite, you must also copy your ``data/`` folder inside the new installation.
910
911 Empty ``var/cache`` folder.
912
913 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:
914
915 .. code-block:: sql
916
917 ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL;
918 INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry');
919 ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL;
920 INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import');
921 INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import');
922 ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL;
923 DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key';
924
925 *****************
926 From wallabag 1.x
927 *****************
928
929 There is no automatic script to update from wallabag 1.x to wallabag 2.x. You need to:
930
931 - export your data
932 - install wallabag 2.x (`read the installation documentation <http://doc.wallabag.org/en/master/user/installation.html>`_ )
933 - import data in this fresh installation (`read the import documentation <http://doc.wallabag.org/en/master/user/import.html>`_ )