X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=doc%2Fmd%2FUpgrade-and-migration.md;h=b3a087644e9b7be11ca1624c5cfaba74e00534a3;hb=43ad7c8e825057747ccf02049050b323878952a7;hp=7348891f31176e90f1357d5b00938d11de02b6c5;hpb=53ed6d7d1e678d7486337ce67a2f17b30bac21ac;p=github%2Fshaarli%2FShaarli.git diff --git a/doc/md/Upgrade-and-migration.md b/doc/md/Upgrade-and-migration.md index 7348891f..b3a08764 100644 --- a/doc/md/Upgrade-and-migration.md +++ b/doc/md/Upgrade-and-migration.md @@ -8,14 +8,16 @@ 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. +See [Shaarli configuration](Shaarli configuration) for more information about Shaarli resources. It is recommended to backup this repository _before_ starting updating/upgrading Shaarli: + - users with SSH access: copy or archive the directory to a temporary location - users with FTP access: download a local copy of your Shaarli installation using your favourite client @@ -25,7 +27,7 @@ As all user data is kept under `data`, this is the only directory you need to wo - backup the `data` directory - install or update Shaarli: - - fresh installation - see [[Download and installation]] + - fresh installation - see [Download and installation](Download and installation) - update - see the following sections - check or restore the `data` directory @@ -33,11 +35,11 @@ As all user data is kept under `data`, this is the only directory you need to wo All tagged revisions can be downloaded as tarballs or ZIP archives from the [releases](https://github.com/shaarli/Shaarli/releases) page. -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. +We recommend that you use the latest release tarball with the `-full` suffix. It contains the dependencies, please read [Download and installation](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). +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](Shaarli configuration) for more details). ## Upgrading with Git @@ -75,6 +77,7 @@ Updating dependencies If you have installed Shaarli from [Sebsauvage's original Git repository](https://github.com/sebsauvage/Shaarli), you can use [Git remotes](https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes) to update your working copy. The following guide assumes that: + - you have a basic knowledge of Git [branching](https://git-scm.com/book/en/v2/Git-Branching-Branches-in-a-Nutshell) and [remote repositories](https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes) - the default remote is named `origin` and points to Sebsauvage's repository - the current branch is `master` @@ -170,11 +173,11 @@ 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). +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](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. +If the solutions provided here don't work, please open an issue specifying which version you're upgrading from and to. ### You must specify an integer as a key @@ -185,10 +188,10 @@ Take a look at `data/updates.txt` content. Try to delete it and refresh your page while being logged in. -#### `updates.txt` doesn't exists or doesn't contain `updateMethodDatastoreIds` +#### `updates.txt` doesn't exist or doesn't contain `updateMethodDatastoreIds` - 1. Create `data/updates.txt` if it doesn't exist. - 2. Paste this string in the update file `;updateMethodRenameDashTags;` - 3. Login to Shaarli. - 4. Delete the update file. - 5. Refresh. +1. Create `data/updates.txt` if it doesn't exist +2. Paste this string in the update file `;updateMethodRenameDashTags;` +3. Login to Shaarli +4. Delete the update file +5. Refresh