aboutsummaryrefslogblamecommitdiffhomepage
path: root/docs/en/user/upgrade.rst
blob: b3972bce3e63b8e0ace4b8e44abd1b3f8ccdb038 (plain) (tree)
1
2
3
4
5
6
7
8
9
10
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
                                  




                                                           
                                                         
                                                       

                                         
                             
                             
                             

                                 
                                 
 

  


                                      
                                      
 

                                                  
                                                                                                                  


                                                                                                                              
 
                                                       
 
                                                              








                                                                                                                            


                                                                                                               

                           
                           


                                               
                                      


                    
                                                                        
 
                                                                                                                           


                                                                                                 
                                                                                                                                                                                                          
 



                                                                                        












































































































































































































































































































































































                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  


                   





































































































































































































































































































































































































































                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 
 











                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 
                           
                           



                                                                                                                                                                                                        

                                 
                                 
 

  






                                                               

                           
                           


                                               
                                       


                    
                                                                                                   
 
                                                                     








                                                                                                                                                                                                          











                                                                                                                                                
                 
                 
                 





                                                                                                                                 
==================================
Upgrade your wallabag installation
==================================

You will find here different ways to upgrade your wallabag:

- `from 2.1.x to 2.2.x <#upgrading-from-2-1-x-to-2-2-x>`_
- `from 2.0.x to 2.1.1 <#upgrade-from-2-0-x-to-2-1-1>`_
- `from 1.x to 2.x <#from-wallabag-1-x>`_

*****************************
Upgrading from 2.1.x to 2.2.x
*****************************

Upgrade on a dedicated web server
=================================

::

    make update

Explanations about database migrations
--------------------------------------

During the update, we execute database migrations.

All the database migrations are stored in ``app/DoctrineMigrations``. You can execute each migration individually:
``bin/console doctrine:migrations:execute 20161001072726 --env=prod``.

You can also cancel each migration individually: ``bin/console doctrine:migrations:execute 20161001072726 --down --env=prod``.

Here is the migrations list for 2.1.x to 2.2.0 release:

* ``20161001072726``: added foreign keys for account resetting
* ``20161022134138``: converted database to ``utf8mb4`` encoding (for MySQL only)
* ``20161024212538``: added ``user_id`` column on ``oauth2_clients`` to prevent users to delete API clients from other users
* ``20161031132655``: added the internal setting to enable/disable downloading pictures
* ``20161104073720``: added ``created_at`` index on ``entry`` table
* ``20161106113822``: added ``action_mark_as_read`` field on ``config`` table
* ``20161117071626``: added the internal setting to share articles to unmark.it
* ``20161118134328``: added ``http_status`` field on ``entry`` table
* ``20161122144743``: added the internal setting to enable/disable fetching articles with paywall
* ``20161122203647``: dropped ``expired`` and ``credentials_expired`` fields on ``user`` table
* ``20161128084725``: added ``list_mode`` field on ``config`` table
* ``20161128131503``: dropped ``locked``, ``credentials_expire_at`` and ``expires_at`` fields on ``user`` table
* ``20161214094403``: added ``uid`` index on ``entry`` table

Upgrade on a shared hosting
===========================

Backup your ``app/config/parameters.yml`` file.

Download the last release of wallabag:

.. code-block:: bash

    wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package

You will find the `md5 hash of the latest package on our website <https://www.wallabag.org/pages/download-wallabag.html>`_.

Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours.

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>`_.

If you use SQLite, you must also copy your ``data/`` folder inside the new installation.

Empty ``var/cache`` folder.

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.

You may encounter issues with indexes names: if so, please change queries with the correct index name.

Migration 20161001072726
------------------------

MySQL
^^^^^

Migration up
""""""""""""

.. code-block:: sql

    ALTER TABLE wallabag_entry_tag DROP FOREIGN KEY FK_C9F0DD7CBA364942
    ALTER TABLE wallabag_entry_tag DROP FOREIGN KEY FK_C9F0DD7CBAD26311
    ALTER TABLE wallabag_entry_tag ADD CONSTRAINT FK_entry_tag_entry FOREIGN KEY (entry_id) REFERENCES wallabag_entry (id) ON DELETE CASCADE
    ALTER TABLE wallabag_entry_tag ADD CONSTRAINT FK_entry_tag_tag FOREIGN KEY (tag_id) REFERENCES wallabag_tag (id) ON DELETE CASCADE
    ALTER TABLE wallabag_annotation DROP FOREIGN KEY FK_A7AED006BA364942
    ALTER TABLE wallabag_annotation ADD CONSTRAINT FK_annotation_entry FOREIGN KEY (entry_id) REFERENCES wallabag_entry (id) ON DELETE CASCADE

Migration down
""""""""""""""

We didn't write down migration for ``20161001072726``.

PostgreSQL
^^^^^^^^^^

Migration up
""""""""""""

.. code-block:: sql

    ALTER TABLE wallabag_entry_tag DROP CONSTRAINT fk_c9f0dd7cba364942
    ALTER TABLE wallabag_entry_tag DROP CONSTRAINT fk_c9f0dd7cbad26311
    ALTER TABLE wallabag_entry_tag ADD CONSTRAINT FK_entry_tag_entry FOREIGN KEY (entry_id) REFERENCES wallabag_entry (id) ON DELETE CASCADE
    ALTER TABLE wallabag_entry_tag ADD CONSTRAINT FK_entry_tag_tag FOREIGN KEY (tag_id) REFERENCES wallabag_tag (id) ON DELETE CASCADE
    ALTER TABLE wallabag_annotation DROP CONSTRAINT fk_a7aed006ba364942
    ALTER TABLE wallabag_annotation ADD CONSTRAINT FK_annotation_entry FOREIGN KEY (entry_id) REFERENCES wallabag_entry (id) ON DELETE CASCADE

Migration down
""""""""""""""

We didn't write down migration for ``20161001072726``.

SQLite
^^^^^^

This migration can only be executed safely on MySQL or PostgreSQL.

Migration 20161022134138
------------------------

MySQL
^^^^^

Migration up
""""""""""""

.. code-block:: sql

    ALTER DATABASE wallabag CHARACTER SET = utf8mb4 COLLATE = utf8mb4_unicode_ci;
    ALTER TABLE wallabag_user CHANGE confirmation_token confirmation_token VARCHAR(180) DEFAULT NULL;
    ALTER TABLE wallabag_user CHANGE salt salt VARCHAR(180) NOT NULL;
    ALTER TABLE wallabag_user CHANGE password password VARCHAR(180) NOT NULL;
    ALTER TABLE wallabag_annotation CONVERT TO CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
    ALTER TABLE wallabag_entry CONVERT TO CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
    ALTER TABLE wallabag_tag CONVERT TO CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
    ALTER TABLE wallabag_user CONVERT TO CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
    ALTER TABLE wallabag_annotation CHANGE `text` `text` longtext CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
    ALTER TABLE wallabag_annotation CHANGE `quote` `quote` VARCHAR(191) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
    ALTER TABLE wallabag_entry CHANGE `title` `title` longtext CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
    ALTER TABLE wallabag_entry CHANGE `content` `content` longtext CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
    ALTER TABLE wallabag_tag CHANGE `label` `label` longtext CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
    ALTER TABLE wallabag_user CHANGE `name` `name` longtext CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;

Migration down
""""""""""""""

.. code-block:: sql

    ALTER DATABASE wallabag CHARACTER SET = utf8 COLLATE = utf8_unicode_ci;
    ALTER TABLE wallabag_annotation CONVERT TO CHARACTER SET utf8 COLLATE utf8_unicode_ci;
    ALTER TABLE wallabag_entry CONVERT TO CHARACTER SET utf8 COLLATE utf8_unicode_ci;
    ALTER TABLE wallabag_tag CONVERT TO CHARACTER SET utf8 COLLATE utf8_unicode_ci;
    ALTER TABLE wallabag_user CONVERT TO CHARACTER SET utf8 COLLATE utf8_unicode_ci;
    ALTER TABLE wallabag_annotation CHANGE `text` `text` longtext CHARACTER SET utf8 COLLATE utf8_unicode_ci;
    ALTER TABLE wallabag_annotation CHANGE `quote` `quote` VARCHAR(255) CHARACTER SET utf8 COLLATE utf8_unicode_ci;
    ALTER TABLE wallabag_entry CHANGE `title` `title` longtext CHARACTER SET utf8 COLLATE utf8_unicode_ci;
    ALTER TABLE wallabag_entry CHANGE `content` `content` longtext CHARACTER SET utf8 COLLATE utf8_unicode_ci;
    ALTER TABLE wallabag_tag CHANGE `label` `label` longtext CHARACTER SET utf8 COLLATE utf8_unicode_ci;
    ALTER TABLE wallabag_user CHANGE `name` `name` longtext CHARACTER SET utf8 COLLATE utf8_unicode_ci;

PostgreSQL and SQLite
^^^^^^^^^^^^^^^^^^^^^

This migration only apply to MySQL.

Migration 20161024212538
------------------------

MySQL
^^^^^

Migration up
""""""""""""

.. code-block:: sql

    ALTER TABLE wallabag_oauth2_clients ADD user_id INT NOT NULL
    ALTER TABLE wallabag_oauth2_clients ADD CONSTRAINT IDX_user_oauth_client FOREIGN KEY (user_id) REFERENCES wallabag_user (id) ON DELETE CASCADE
    CREATE INDEX IDX_635D765EA76ED395 ON wallabag_oauth2_clients (user_id)

Migration down
""""""""""""""

.. code-block:: sql

    ALTER TABLE wallabag_oauth2_clients DROP FOREIGN KEY IDX_user_oauth_client
    ALTER TABLE wallabag_oauth2_clients DROP user_id

PostgreSQL
^^^^^^^^^^

Migration up
""""""""""""

.. code-block:: sql

    ALTER TABLE wallabag_oauth2_clients ADD user_id INT DEFAULT NULL
    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
    CREATE INDEX IDX_635D765EA76ED395 ON wallabag_oauth2_clients (user_id)


Migration down
""""""""""""""

.. code-block:: sql

    ALTER TABLE wallabag_oauth2_clients DROP CONSTRAINT idx_user_oauth_client
    ALTER TABLE wallabag_oauth2_clients DROP user_id

SQLite
^^^^^^

Migration up
""""""""""""

.. code-block:: sql

    CREATE TEMPORARY TABLE __temp__wallabag_oauth2_clients AS SELECT id, random_id, redirect_uris, secret, allowed_grant_types, name FROM wallabag_oauth2_clients
    DROP TABLE wallabag_oauth2_clients
    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)
    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
    DROP TABLE __temp__wallabag_oauth2_clients
    CREATE INDEX IDX_635D765EA76ED395 ON wallabag_oauth2_clients (user_id)

Migration down
""""""""""""""

.. code-block:: sql

    DROP INDEX IDX_635D765EA76ED395
    CREATE TEMPORARY TABLE __temp__wallabag_oauth2_clients AS SELECT id, random_id, redirect_uris, secret, allowed_grant_types, name FROM wallabag_oauth2_clients
    DROP TABLE wallabag_oauth2_clients
    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))
    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
    DROP TABLE __temp__wallabag_oauth2_clients

Migration 20161031132655
------------------------

MySQL
^^^^^

Migration up
""""""""""""

.. code-block:: sql

    INSERT INTO wallabag_craue_config_setting (name, value, section) VALUES ('download_images_enabled', 0, 'misc')

Migration down
""""""""""""""

.. code-block:: sql

    DELETE FROM wallabag_craue_config_setting WHERE name = 'download_images_enabled';

PostgreSQL
^^^^^^^^^^

Migration up
""""""""""""

.. code-block:: sql

    INSERT INTO wallabag_craue_config_setting (name, value, section) VALUES ('download_images_enabled', 0, 'misc')

Migration down
""""""""""""""

.. code-block:: sql

    DELETE FROM wallabag_craue_config_setting WHERE name = 'download_images_enabled';

SQLite
^^^^^^

Migration up
""""""""""""

.. code-block:: sql

    INSERT INTO wallabag_craue_config_setting (name, value, section) VALUES ('download_images_enabled', 0, 'misc')

Migration down
""""""""""""""

.. code-block:: sql

    DELETE FROM wallabag_craue_config_setting WHERE name = 'download_images_enabled';

Migration 20161104073720
------------------------

MySQL
^^^^^

Migration up
""""""""""""

.. code-block:: sql

    CREATE INDEX IDX_entry_created_at ON wallabag_entry (created_at)

Migration down
""""""""""""""

.. code-block:: sql

    DROP INDEX IDX_entry_created_at ON wallabag_entry

PostgreSQL
^^^^^^^^^^

Migration up
""""""""""""

.. code-block:: sql

    CREATE INDEX IDX_entry_created_at ON wallabag_entry (created_at)

Migration down
""""""""""""""

.. code-block:: sql

    DROP INDEX idx_entry_created_at

SQLite
^^^^^^

Migration up
""""""""""""

.. code-block:: sql

    DROP INDEX created_at_idx
    DROP INDEX IDX_F4D18282A76ED395
    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
    DROP TABLE wallabag_entry
    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))
    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
    DROP TABLE __temp__wallabag_entry
    CREATE INDEX created_at_idx ON wallabag_entry (created_at)
    CREATE INDEX IDX_F4D18282A76ED395 ON wallabag_entry (user_id)
    CREATE INDEX IDX_entry_created_at ON wallabag_entry (created_at)

Migration down
""""""""""""""

.. code-block:: sql

    DROP INDEX IDX_entry_created_at
    DROP INDEX IDX_F4D18282A76ED395
    DROP INDEX created_at_idx
    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
    DROP TABLE wallabag_entry
    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))
    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
    DROP TABLE __temp__wallabag_entry
    CREATE INDEX IDX_F4D18282A76ED395 ON wallabag_entry (user_id)
    CREATE INDEX created_at_idx ON wallabag_entry (created_at)

Migration 20161106113822
------------------------

MySQL
^^^^^

Migration up
""""""""""""

.. code-block:: sql

    ALTER TABLE wallabag_config ADD action_mark_as_read INT DEFAULT 0

Migration down
""""""""""""""

.. code-block:: sql

    ALTER TABLE wallabag_config DROP action_mark_as_read

PostgreSQL
^^^^^^^^^^

Migration up
""""""""""""

.. code-block:: sql

    ALTER TABLE wallabag_config ADD action_mark_as_read INT DEFAULT 0

Migration down
""""""""""""""

.. code-block:: sql

    ALTER TABLE wallabag_config DROP action_mark_as_read

SQLite
^^^^^^

Migration up
""""""""""""

.. code-block:: sql

    ALTER TABLE wallabag_config ADD COLUMN action_mark_as_read INTEGER DEFAULT 0

Migration down
""""""""""""""

.. code-block:: sql

    DROP INDEX UNIQ_87E64C53A76ED395
    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
    DROP TABLE wallabag_config
    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))
    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
    DROP TABLE __temp__wallabag_config
    CREATE UNIQUE INDEX UNIQ_87E64C53A76ED395 ON wallabag_config (user_id)

Migration 20161117071626
------------------------

MySQL
^^^^^

Migration up
""""""""""""

.. code-block:: sql

    INSERT INTO wallabag_craue_config_setting (name, value, section) VALUES ('share_unmark', 0, 'entry')
    INSERT INTO wallabag_craue_config_setting (name, value, section) VALUES ('unmark_url', 'https://unmark.it', 'entry')

Migration down
""""""""""""""

.. code-block:: sql

    DELETE FROM wallabag_craue_config_setting WHERE name = 'share_unmark';
    DELETE FROM wallabag_craue_config_setting WHERE name = 'unmark_url';

PostgreSQL
^^^^^^^^^^

Migration up
""""""""""""

.. code-block:: sql

    INSERT INTO wallabag_craue_config_setting (name, value, section) VALUES ('share_unmark', 0, 'entry')
    INSERT INTO wallabag_craue_config_setting (name, value, section) VALUES ('unmark_url', 'https://unmark.it', 'entry')

Migration down
""""""""""""""

.. code-block:: sql

    DELETE FROM wallabag_craue_config_setting WHERE name = 'share_unmark';
    DELETE FROM wallabag_craue_config_setting WHERE name = 'unmark_url';

SQLite
^^^^^^

Migration up
""""""""""""

.. code-block:: sql

    INSERT INTO wallabag_craue_config_setting (name, value, section) VALUES ('share_unmark', 0, 'entry')
    INSERT INTO wallabag_craue_config_setting (name, value, section) VALUES ('unmark_url', 'https://unmark.it', 'entry')

Migration down
""""""""""""""

.. code-block:: sql

    DELETE FROM wallabag_craue_config_setting WHERE name = 'share_unmark';
    DELETE FROM wallabag_craue_config_setting WHERE name = 'unmark_url';

Migration 20161118134328
------------------------

MySQL
^^^^^

Migration up
""""""""""""

.. code-block:: sql

    ALTER TABLE wallabag_entry ADD http_status VARCHAR(3) DEFAULT NULL

Migration down
""""""""""""""

.. code-block:: sql

    ALTER TABLE wallabag_entry DROP http_status

PostgreSQL
^^^^^^^^^^

Migration up
""""""""""""

.. code-block:: sql

    ALTER TABLE wallabag_entry ADD http_status VARCHAR(3) DEFAULT NULL

Migration down
""""""""""""""

.. code-block:: sql

    ALTER TABLE wallabag_entry DROP http_status

SQLite
^^^^^^

Migration up
""""""""""""

.. code-block:: sql

    ALTER TABLE wallabag_entry ADD COLUMN http_status VARCHAR(3) DEFAULT NULL

Migration down
""""""""""""""

.. code-block:: sql

    DROP INDEX created_at_idx
    DROP INDEX IDX_F4D18282A76ED395
    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
    DROP TABLE wallabag_entry
    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))
    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
    DROP TABLE __temp__wallabag_entry
    CREATE INDEX created_at_idx ON wallabag_entry (created_at)
    CREATE INDEX IDX_F4D18282A76ED395 ON wallabag_entry (user_id)

Migration 20161122144743
------------------------

MySQL
^^^^^

Migration up
""""""""""""

.. code-block:: sql

    INSERT INTO wallabag_craue_config_setting (name, value, section) VALUES ('restricted_access', 0, 'entry')

Migration down
""""""""""""""

.. code-block:: sql

    DELETE FROM wallabag_craue_config_setting WHERE name = 'restricted_access';

PostgreSQL
^^^^^^^^^^

Migration up
""""""""""""

.. code-block:: sql

    INSERT INTO wallabag_craue_config_setting (name, value, section) VALUES ('restricted_access', 0, 'entry')

Migration down
""""""""""""""

.. code-block:: sql

    DELETE FROM wallabag_craue_config_setting WHERE name = 'restricted_access';

SQLite
^^^^^^

Migration up
""""""""""""

.. code-block:: sql

    INSERT INTO wallabag_craue_config_setting (name, value, section) VALUES ('restricted_access', 0, 'entry')

Migration down
""""""""""""""

.. code-block:: sql

    DELETE FROM wallabag_craue_config_setting WHERE name = 'restricted_access';

Migration 20161122203647
------------------------

MySQL
^^^^^

Migration up
""""""""""""

.. code-block:: sql

    ALTER TABLE wallabag_user DROP expired, DROP credentials_expired

Migration down
""""""""""""""

.. code-block:: sql

    ALTER TABLE wallabag_user ADD expired SMALLINT DEFAULT NULL, ADD credentials_expired SMALLINT DEFAULT NULL

PostgreSQL
^^^^^^^^^^

Migration up
""""""""""""

.. code-block:: sql

    ALTER TABLE wallabag_user DROP expired
    ALTER TABLE wallabag_user DROP credentials_expired

Migration down
""""""""""""""

.. code-block:: sql

    ALTER TABLE wallabag_user ADD expired SMALLINT DEFAULT NULL
    ALTER TABLE wallabag_user ADD credentials_expired SMALLINT DEFAULT NULL

SQLite
^^^^^^

Migration up
""""""""""""

.. code-block:: sql

    DROP INDEX UNIQ_1D63E7E5C05FB297
    DROP INDEX UNIQ_1D63E7E5A0D96FBF
    DROP INDEX UNIQ_1D63E7E592FC23A8
    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
    DROP TABLE wallabag_user
    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))
    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
    DROP TABLE __temp__wallabag_user
    CREATE UNIQUE INDEX UNIQ_1D63E7E5C05FB297 ON wallabag_user (confirmation_token)
    CREATE UNIQUE INDEX UNIQ_1D63E7E5A0D96FBF ON wallabag_user (email_canonical)
    CREATE UNIQUE INDEX UNIQ_1D63E7E592FC23A8 ON wallabag_user (username_canonical)

Migration down
""""""""""""""

.. code-block:: sql

    ALTER TABLE wallabag_user ADD COLUMN expired SMALLINT DEFAULT NULL
    ALTER TABLE wallabag_user ADD COLUMN credentials_expired SMALLINT DEFAULT NULL

Migration 20161128084725
------------------------

MySQL
^^^^^

Migration up
""""""""""""

.. code-block:: sql

    ALTER TABLE wallabag_config ADD list_mode INT DEFAULT NULL

Migration down
""""""""""""""

.. code-block:: sql

    ALTER TABLE wallabag_config DROP list_mode

PostgreSQL
^^^^^^^^^^

Migration up
""""""""""""

.. code-block:: sql

    ALTER TABLE wallabag_config ADD list_mode INT DEFAULT NULL

Migration down
""""""""""""""

.. code-block:: sql

    ALTER TABLE wallabag_config DROP list_mode

SQLite
^^^^^^

Migration up
""""""""""""

.. code-block:: sql

    ALTER TABLE wallabag_config ADD COLUMN list_mode INTEGER DEFAULT NULL

Migration down
""""""""""""""

.. code-block:: sql

    DROP INDEX UNIQ_87E64C53A76ED395
    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
    DROP TABLE wallabag_config
    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))
    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
    DROP TABLE __temp__wallabag_config
    CREATE UNIQUE INDEX UNIQ_87E64C53A76ED395 ON wallabag_config (user_id)

Migration 20161128131503
------------------------

MySQL
^^^^^

Migration up
""""""""""""

.. code-block:: sql

    ALTER TABLE wallabag_user DROP locked, DROP credentials_expire_at, DROP expires_at

Migration down
""""""""""""""

.. code-block:: sql

    ALTER TABLE wallabag_user ADD locked SMALLINT DEFAULT NULL, ADD credentials_expire_at DATETIME DEFAULT NULL, ADD expires_at DATETIME DEFAULT NULL

PostgreSQL
^^^^^^^^^^

Migration up
""""""""""""

.. code-block:: sql

    ALTER TABLE wallabag_user DROP locked
    ALTER TABLE wallabag_user DROP credentials_expire_at
    ALTER TABLE wallabag_user DROP expires_at

Migration down
""""""""""""""

.. code-block:: sql

    ALTER TABLE wallabag_user ADD locked SMALLINT DEFAULT NULL
    ALTER TABLE wallabag_user ADD credentials_expire_at TIMESTAMP(0) WITHOUT TIME ZONE DEFAULT NULL
    ALTER TABLE wallabag_user ADD expires_at TIMESTAMP(0) WITHOUT TIME ZONE DEFAULT NULL

SQLite
^^^^^^

Migration up
""""""""""""

.. code-block:: sql

    ALTER TABLE wallabag_user ADD COLUMN locked SMALLINT DEFAULT NULL
    ALTER TABLE wallabag_user ADD COLUMN credentials_expire_at DATETIME DEFAULT NULL
    ALTER TABLE wallabag_user ADD COLUMN expires_at DATETIME DEFAULT NULL

Migration down
""""""""""""""

.. code-block:: sql

    DROP INDEX UNIQ_1D63E7E592FC23A8
    DROP INDEX UNIQ_1D63E7E5A0D96FBF
    DROP INDEX UNIQ_1D63E7E5C05FB297
    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
    DROP TABLE wallabag_user
    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))
    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
    DROP TABLE __temp__wallabag_user
    CREATE UNIQUE INDEX UNIQ_1D63E7E592FC23A8 ON wallabag_user (username_canonical)
    CREATE UNIQUE INDEX UNIQ_1D63E7E5A0D96FBF ON wallabag_user (email_canonical)
    CREATE UNIQUE INDEX UNIQ_1D63E7E5C05FB297 ON wallabag_user (confirmation_token)

Migration 20161214094403
------------------------

MySQL
^^^^^

Migration up
""""""""""""

.. code-block:: sql

    CREATE INDEX IDX_entry_uid ON wallabag_entry (uid)

Migration down
""""""""""""""

.. code-block:: sql

    DROP INDEX IDX_entry_uid ON wallabag_entry

PostgreSQL
^^^^^^^^^^

Migration up
""""""""""""

.. code-block:: sql

    CREATE INDEX IDX_entry_uid ON wallabag_entry (uid)

Migration down
""""""""""""""

.. code-block:: sql

    DROP INDEX idx_entry_uid

SQLite
^^^^^^

Migration up
""""""""""""

.. code-block:: sql

    DROP INDEX IDX_F4D18282A76ED395
    DROP INDEX created_at_idx
    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
    DROP TABLE wallabag_entry
    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))
    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
    DROP TABLE __temp__wallabag_entry
    CREATE INDEX IDX_F4D18282A76ED395 ON wallabag_entry (user_id)
    CREATE INDEX created_at_idx ON wallabag_entry (created_at)
    CREATE INDEX IDX_entry_uid ON wallabag_entry (uid)

Migration down
""""""""""""""

.. code-block:: sql

    DROP INDEX IDX_entry_uid
    DROP INDEX created_at_idx
    DROP INDEX IDX_F4D18282A76ED395
    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
    DROP TABLE wallabag_entry
    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))
    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
    DROP TABLE __temp__wallabag_entry
    CREATE INDEX created_at_idx ON wallabag_entry (created_at)
    CREATE INDEX IDX_F4D18282A76ED395 ON wallabag_entry (user_id)

***************************
Upgrade from 2.0.x to 2.1.1
***************************

.. warning::

    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.

Upgrade on a dedicated web server
=================================

::

    rm -rf var/cache/*
    git fetch origin
    git fetch --tags
    git checkout 2.1.1 --force
    SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
    php bin/console doctrine:migrations:migrate --env=prod
    php bin/console cache:clear --env=prod

Upgrade on a shared hosting
===========================

Backup your ``app/config/parameters.yml`` file.

Download the 2.1.1 release of wallabag:

.. code-block:: bash

    wget http://framabag.org/wallabag-release-2.1.1.tar.gz && tar xvf wallabag-release-2.1.1.tar.gz

(md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``)

Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours.

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>`_.

If you use SQLite, you must also copy your ``data/`` folder inside the new installation.

Empty ``var/cache`` folder.

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:

.. code-block:: sql

    ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL;
    INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry');
    ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL;
    INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import');
    INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import');
    ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL;
    DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key';

*****************
From wallabag 1.x
*****************

There is no automatic script to update from wallabag 1.x to wallabag 2.x. You need to:

- export your data
- install wallabag 2.x (`read the installation documentation <http://doc.wallabag.org/en/master/user/installation.html>`_ )
- import data in this fresh installation (`read the import documentation <http://doc.wallabag.org/en/master/user/import.html>`_ )