diff options
author | ArthurHoaro <arthur@hoa.ro> | 2017-05-07 18:44:05 +0200 |
---|---|---|
committer | ArthurHoaro <arthur@hoa.ro> | 2017-05-07 18:44:05 +0200 |
commit | b230bf207df576fa2ad165702184edf21f674ce7 (patch) | |
tree | 90af6fbddda19c22c1bd21e2fc6ed135116cce48 /doc/Upgrade-and-migration.md | |
parent | f501caed215bd12caced5106f9226638b2b15fb4 (diff) | |
download | Shaarli-b230bf207df576fa2ad165702184edf21f674ce7.tar.gz Shaarli-b230bf207df576fa2ad165702184edf21f674ce7.tar.zst Shaarli-b230bf207df576fa2ad165702184edf21f674ce7.zip |
Bump version to v0.9.0
Signed-off-by: ArthurHoaro <arthur@hoa.ro>
Diffstat (limited to 'doc/Upgrade-and-migration.md')
-rw-r--r-- | doc/Upgrade-and-migration.md | 41 |
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 | |||
5 | If anything goes wrong, it's important for us to know which version you're upgrading from. | ||
6 | The current version is present in the `version.php` file. | ||
7 | |||
3 | ### Backup your data | 8 | ### Backup your data |
4 | 9 | ||
5 | Shaarli stores all user data under the `data` directory: | 10 | Shaarli 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 | ||
10 | See [Shaarli configuration](Shaarli-configuration.html) for more information about Shaarli resources. | 16 | See [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 |
26 | All tagged revisions can be downloaded as tarballs or ZIP archives from the [releases](https://github.com/shaarli/Shaarli/releases) page.[](.html) | 32 | All tagged revisions can be downloaded as tarballs or ZIP archives from the [releases](https://github.com/shaarli/Shaarli/releases) page.[](.html) |
27 | 33 | ||
28 | We _recommend_ using the releases from the `stable` branch, which are available as: | 34 | 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.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 | ||
32 | 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! | 36 | 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! |
33 | 37 | ||
34 | 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](Shaarli-configuration.html) for more details). | 38 | 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.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 | |||
54 | Shaarli >= `v0.8.x`: install/update third-party PHP dependencies using [Composer](https://getcomposer.org/):[](.html) | 58 | Shaarli >= `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 | ||
59 | Loading composer repositories with package information | 63 | Loading composer repositories with package information |
60 | Updating dependencies | 64 | Updating dependencies |
@@ -129,7 +133,7 @@ $ git branch -vv | |||
129 | Shaarli >= `v0.8.x`: install/update third-party PHP dependencies using [Composer](https://getcomposer.org/):[](.html) | 133 | Shaarli >= `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 | ||
134 | Loading composer repositories with package information | 138 | Loading composer repositories with package information |
135 | Updating dependencies | 139 | Updating dependencies |
@@ -159,3 +163,24 @@ Total 3317 (delta 2050), reused 3301 (delta 2034)to | |||
159 | 163 | ||
160 | #### Step 3: configuration | 164 | #### Step 3: configuration |
161 | 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.html) for more details). | 165 | 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.html) for more details). |
166 | |||
167 | ## Troubleshooting | ||
168 | |||
169 | If 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 | |||
173 | In `v0.8.1` we changed how link keys are handled (from timestamps to incremental integers). | ||
174 | Take a look at `data/updates.txt` content. | ||
175 | |||
176 | #### `updates.txt` contains `updateMethodDatastoreIds` | ||
177 | |||
178 | Try 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. | ||