aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/Upgrade-and-migration.md
diff options
context:
space:
mode:
authorArthurHoaro <arthur@hoa.ro>2017-05-07 18:45:02 +0200
committerGitHub <noreply@github.com>2017-05-07 18:45:02 +0200
commit510f7233006e9ea2e0d653049e2ff62537a4fda8 (patch)
tree90af6fbddda19c22c1bd21e2fc6ed135116cce48 /doc/Upgrade-and-migration.md
parentf501caed215bd12caced5106f9226638b2b15fb4 (diff)
parentb230bf207df576fa2ad165702184edf21f674ce7 (diff)
downloadShaarli-510f7233006e9ea2e0d653049e2ff62537a4fda8.tar.gz
Shaarli-510f7233006e9ea2e0d653049e2ff62537a4fda8.tar.zst
Shaarli-510f7233006e9ea2e0d653049e2ff62537a4fda8.zip
Merge pull request #863 from ArthurHoaro/v0.9.0
Bump version to v0.9.0
Diffstat (limited to 'doc/Upgrade-and-migration.md')
-rw-r--r--doc/Upgrade-and-migration.md41
1 files changed, 33 insertions, 8 deletions
diff --git a/doc/Upgrade-and-migration.md b/doc/Upgrade-and-migration.md
index 0bc33824..d36eb862 100644
--- a/doc/Upgrade-and-migration.md
+++ b/doc/Upgrade-and-migration.md
@@ -1,11 +1,17 @@
1#Upgrade and migration 1#Upgrade and migration
2## Preparation 2## Preparation
3### Note your current version
4
5If anything goes wrong, it's important for us to know which version you're upgrading from.
6The current version is present in the `version.php` file.
7
3### Backup your data 8### Backup your data
4 9
5Shaarli stores all user data under the `data` directory: 10Shaarli stores all user data under the `data` directory:
6- `data/config.php` - main configuration file 11- `data/config.php` - main configuration file
7- `data/datastore.php` - bookmarked links 12- `data/datastore.php` - bookmarked links
8- `data/ipbans.php` - banned IP addresses 13- `data/ipbans.php` - banned IP addresses
14- `data/updates.txt` - contains all automatic update to the configuration and datastore files already run
9 15
10See [Shaarli configuration](Shaarli-configuration.html) for more information about Shaarli resources. 16See [Shaarli configuration](Shaarli-configuration.html) for more information about Shaarli resources.
11 17
@@ -22,16 +28,14 @@ As all user data is kept under `data`, this is the only directory you need to wo
22 - update - see the following sections 28 - update - see the following sections
23- check or restore the `data` directory 29- check or restore the `data` directory
24 30
25## Upgrading from release archives 31## Recommended : Upgrading from release archives
26All tagged revisions can be downloaded as tarballs or ZIP archives from the [releases](https://github.com/shaarli/Shaarli/releases) page.[](.html) 32All tagged revisions can be downloaded as tarballs or ZIP archives from the [releases](https://github.com/shaarli/Shaarli/releases) page.[](.html)
27 33
28We _recommend_ using the releases from the `stable` branch, which are available as: 34We recommend that you use the latest release tarball with the `-full` suffix. It contains the dependencies, please read [Download and installation](Download-and-installation.html) for `git` complete instructions.
29- gzipped tarball - https://github.com/shaarli/Shaarli/archive/stable.tar.gz
30- ZIP archive - https://github.com/shaarli/Shaarli/archive/stable.zip
31 35
32Once downloaded, extract the archive locally and update your remote installation (e.g. via FTP) -be sure you keep the contents of the `data` directory! 36Once downloaded, extract the archive locally and update your remote installation (e.g. via FTP) -be sure you keep the content of the `data` directory!
33 37
34After 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](Shaarli-configuration.html) for more details). 38After 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.html) for more details).
35 39
36## Upgrading with Git 40## Upgrading with Git
37### Updating a community Shaarli 41### Updating a community Shaarli
@@ -54,7 +58,7 @@ Fast-forward
54Shaarli >= `v0.8.x`: install/update third-party PHP dependencies using [Composer](https://getcomposer.org/):[](.html) 58Shaarli >= `v0.8.x`: install/update third-party PHP dependencies using [Composer](https://getcomposer.org/):[](.html)
55 59
56```bash 60```bash
57$ composer update --no-dev 61$ composer install --no-dev
58 62
59Loading composer repositories with package information 63Loading composer repositories with package information
60Updating dependencies 64Updating dependencies
@@ -129,7 +133,7 @@ $ git branch -vv
129Shaarli >= `v0.8.x`: install/update third-party PHP dependencies using [Composer](https://getcomposer.org/):[](.html) 133Shaarli >= `v0.8.x`: install/update third-party PHP dependencies using [Composer](https://getcomposer.org/):[](.html)
130 134
131```bash 135```bash
132$ composer update --no-dev 136$ composer install --no-dev
133 137
134Loading composer repositories with package information 138Loading composer repositories with package information
135Updating dependencies 139Updating dependencies
@@ -159,3 +163,24 @@ Total 3317 (delta 2050), reused 3301 (delta 2034)to
159 163
160#### Step 3: configuration 164#### Step 3: configuration
161After 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.html) for more details). 165After 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.html) for more details).
166
167## Troubleshooting
168
169If the solutions provided here doesn't work, please open an issue specifying which version you're upgrading from and to.
170
171### You must specify an integer as a key
172
173In `v0.8.1` we changed how link keys are handled (from timestamps to incremental integers).
174Take a look at `data/updates.txt` content.
175
176#### `updates.txt` contains `updateMethodDatastoreIds`
177
178Try to delete it and refresh your page while being logged in.
179
180#### `updates.txt` doesn't exists or doesn't contain `updateMethodDatastoreIds`
181
182 1. Create `data/updates.txt` if it doesn't exist.
183 2. Paste this string in the update file `;updateMethodRenameDashTags;`
184 3. Login to Shaarli.
185 4. Delete the update file.
186 5. Refresh.