From b230bf207df576fa2ad165702184edf21f674ce7 Mon Sep 17 00:00:00 2001 From: ArthurHoaro Date: Sun, 7 May 2017 18:44:05 +0200 Subject: Bump version to v0.9.0 Signed-off-by: ArthurHoaro --- doc/Upgrade-and-migration.html | 37 +++++++++++++++++++++++++++---------- 1 file changed, 27 insertions(+), 10 deletions(-) (limited to 'doc/Upgrade-and-migration.html') diff --git a/doc/Upgrade-and-migration.html b/doc/Upgrade-and-migration.html index a5b041d5..667215ab 100644 --- a/doc/Upgrade-and-migration.html +++ b/doc/Upgrade-and-migration.html @@ -69,6 +69,7 @@ code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Inf
  • Browsing and Searching
  • Firefox share
  • RSS feeds
  • +
  • REST API
  • How To
      @@ -87,6 +88,7 @@ code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Inf
    • 3rd party libraries
    • Plugin System
    • Release Shaarli
    • +
    • Versioning and Branches
    • Security
    • Static analysis
    • Theming
    • @@ -101,12 +103,16 @@ code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Inf

      Upgrade and migration

      Preparation

      +

      Note your current version

      +

      If anything goes wrong, it's important for us to know which version you're upgrading from.
      +The current version is present in the version.php file.

      Backup your data

      Shaarli stores all user data under the data directory:

      • data/config.php - main configuration file
      • data/datastore.php - bookmarked links
      • data/ipbans.php - banned IP addresses
      • +
      • data/updates.txt - contains all automatic update to the configuration and datastore files already run

      See Shaarli configuration for more information about Shaarli resources.

      It is recommended to backup this repository before starting updating/upgrading Shaarli:

      @@ -125,15 +131,11 @@ code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Inf
  • check or restore the data directory
  • -

    Upgrading from release archives

    +

    All tagged revisions can be downloaded as tarballs or ZIP archives from the releases page.

    -

    We recommend using the releases from the stable branch, which are available as:

    - -

    Once downloaded, extract the archive locally and update your remote installation (e.g. via FTP) -be sure you keep the contents of the data directory!

    -

    After upgrading, access your fresh Shaarli installation from a web browser; the configuration will then be automatically updated, and new settings added to data/config.php (see Shaarli configuration for more details).

    +

    We recommend that you use the latest release tarball with the -full suffix. It contains the dependencies, please read Download and installation for git complete instructions.

    +

    Once downloaded, extract the archive locally and update your remote installation (e.g. via FTP) -be sure you keep the content of the data directory!

    +

    After upgrading, access your fresh Shaarli installation from a web browser; the configuration and data store will then be automatically updated, and new settings added to data/config.json.php (see Shaarli configuration for more details).

    Upgrading with Git

    Updating a community Shaarli

    If you have installed Shaarli from the community Git repository, simply pull new changes from your local clone:

    @@ -149,7 +151,7 @@ $ git pull tests/Url/UrlTest.php | 1 + 3 files changed, 3 insertions(+), 1 deletion(-)

    Shaarli >= v0.8.x: install/update third-party PHP dependencies using Composer:

    -
    $ composer update --no-dev
    +
    $ composer install --no-dev
     
     Loading composer repositories with package information
     Updating dependencies
    @@ -214,7 +216,7 @@ $ git branch -vv
       master 029f75f [sebsauvage/master] Update README.md[](.html)
     * stable 890afc3 [origin/stable] Merge pull request #509 from ArthurHoaro/v0.6.5[](.html)

    Shaarli >= v0.8.x: install/update third-party PHP dependencies using Composer:

    -
    $ composer update --no-dev
    +
    $ composer install --no-dev
     
     Loading composer repositories with package information
     Updating dependencies
    @@ -238,5 +240,20 @@ $ git gc
     Total 3317 (delta 2050), reused 3301 (delta 2034)to

    Step 3: configuration

    After migrating, access your fresh Shaarli installation from a web browser; the configuration will then be automatically updated, and new settings added to data/config.php (see Shaarli configuration for more details).

    +

    Troubleshooting

    +

    If the solutions provided here doesn't work, please open an issue specifying which version you're upgrading from and to.

    +

    You must specify an integer as a key

    +

    In v0.8.1 we changed how link keys are handled (from timestamps to incremental integers).
    +Take a look at data/updates.txt content.

    +

    updates.txt contains updateMethodDatastoreIds

    +

    Try to delete it and refresh your page while being logged in.

    +

    updates.txt doesn't exists or doesn't contain updateMethodDatastoreIds

    +
      +
    1. Create data/updates.txt if it doesn't exist.
    2. +
    3. Paste this string in the update file ;updateMethodRenameDashTags;
    4. +
    5. Login to Shaarli.
    6. +
    7. Delete the update file.
    8. +
    9. Refresh.
    10. +
    -- cgit v1.2.3