X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=docs%2Fen%2Fuser%2Fupgrade.rst;h=b4635075b06f0b7778077b124677e7f4fc32ab5d;hb=d3a8322a64851a8f45f2661fa6f02ab4fc981a60;hp=e47356312e4695cf926f1cb190797045794b7691;hpb=12d3bbccbd060e7ede4cff6ab425ae3df947db4a;p=github%2Fwallabag%2Fwallabag.git diff --git a/docs/en/user/upgrade.rst b/docs/en/user/upgrade.rst index e4735631..b4635075 100644 --- a/docs/en/user/upgrade.rst +++ b/docs/en/user/upgrade.rst @@ -1,24 +1,148 @@ -Upgrade wallabag -================ +================================== +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 ---------------------------------- +================================= + +**From 2.1.x:** -The last release is published on https://www.wallabag.org/pages/download-wallabag.html. In order to upgrade your wallabag installation and get the last version, run the following commands in you wallabag folder (replace ``2.0.3`` by the last release number): :: + make update + php bin/console doctrine:migrations:migrate --no-interaction -e=prod + +**From 2.2.0:** + +:: + + 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 +* ``20161214094402``: renamed ``uuid`` to ``uid`` on ``entry`` table +* ``20161214094403``: added ``uid`` index on ``entry`` table +* ``20170127093841``: added ``is_starred`` and ``is_archived`` indexes 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 `_. + +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 `_. + +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. + +`You can find all the queries here `_. + +*************************** +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.0.3 + 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 ---------------------------- +Upgrade on a shared hosting +=========================== -Backup your ``app/config/parameters.yml`` file. Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. +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 `_. 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 `_ ) +- import data in this fresh installation (`read the import documentation `_ )