aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/md/Upgrade-and-migration.md
diff options
context:
space:
mode:
authorVirtualTam <virtualtam+github@flibidi.net>2017-08-06 16:15:32 +0200
committerGitHub <noreply@github.com>2017-08-06 16:15:32 +0200
commitc7fcea1347e81072c5b77c1b3c2c6fb13f02c16f (patch)
tree03e4d7bbdcfebdb704266caf4b5c0d87e90c02ce /doc/md/Upgrade-and-migration.md
parent4758c18164f8168be0b3e422c4af86827c913390 (diff)
parentf320efd689f17737ccbdef46cdc430d9e637b807 (diff)
downloadShaarli-c7fcea1347e81072c5b77c1b3c2c6fb13f02c16f.tar.gz
Shaarli-c7fcea1347e81072c5b77c1b3c2c6fb13f02c16f.tar.zst
Shaarli-c7fcea1347e81072c5b77c1b3c2c6fb13f02c16f.zip
Merge pull request #917 from virtualtam/documentation/fixes+improvements
Documentation fixes, improvements and additions
Diffstat (limited to 'doc/md/Upgrade-and-migration.md')
-rw-r--r--doc/md/Upgrade-and-migration.md17
1 files changed, 10 insertions, 7 deletions
diff --git a/doc/md/Upgrade-and-migration.md b/doc/md/Upgrade-and-migration.md
index 2002a4e2..b3a08764 100644
--- a/doc/md/Upgrade-and-migration.md
+++ b/doc/md/Upgrade-and-migration.md
@@ -8,6 +8,7 @@ The current version is present in the `version.php` file.
8### Backup your data 8### Backup your data
9 9
10Shaarli stores all user data under the `data` directory: 10Shaarli stores all user data under the `data` directory:
11
11- `data/config.php` - main configuration file 12- `data/config.php` - main configuration file
12- `data/datastore.php` - bookmarked links 13- `data/datastore.php` - bookmarked links
13- `data/ipbans.php` - banned IP addresses 14- `data/ipbans.php` - banned IP addresses
@@ -16,6 +17,7 @@ Shaarli stores all user data under the `data` directory:
16See [Shaarli configuration](Shaarli configuration) for more information about Shaarli resources. 17See [Shaarli configuration](Shaarli configuration) for more information about Shaarli resources.
17 18
18It is recommended to backup this repository _before_ starting updating/upgrading Shaarli: 19It is recommended to backup this repository _before_ starting updating/upgrading Shaarli:
20
19- users with SSH access: copy or archive the directory to a temporary location 21- users with SSH access: copy or archive the directory to a temporary location
20- users with FTP access: download a local copy of your Shaarli installation using your favourite client 22- users with FTP access: download a local copy of your Shaarli installation using your favourite client
21 23
@@ -75,6 +77,7 @@ Updating dependencies
75If 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. 77If 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.
76 78
77The following guide assumes that: 79The following guide assumes that:
80
78- 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) 81- 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)
79- the default remote is named `origin` and points to Sebsauvage's repository 82- the default remote is named `origin` and points to Sebsauvage's repository
80- the current branch is `master` 83- the current branch is `master`
@@ -174,7 +177,7 @@ After migrating, access your fresh Shaarli installation from a web browser; the
174 177
175## Troubleshooting 178## Troubleshooting
176 179
177If the solutions provided here doesn't work, please open an issue specifying which version you're upgrading from and to. 180If the solutions provided here don't work, please open an issue specifying which version you're upgrading from and to.
178 181
179### You must specify an integer as a key 182### You must specify an integer as a key
180 183
@@ -185,10 +188,10 @@ Take a look at `data/updates.txt` content.
185 188
186Try to delete it and refresh your page while being logged in. 189Try to delete it and refresh your page while being logged in.
187 190
188#### `updates.txt` doesn't exists or doesn't contain `updateMethodDatastoreIds` 191#### `updates.txt` doesn't exist or doesn't contain `updateMethodDatastoreIds`
189 192
190 1. Create `data/updates.txt` if it doesn't exist. 1931. Create `data/updates.txt` if it doesn't exist
191 2. Paste this string in the update file `;updateMethodRenameDashTags;` 1942. Paste this string in the update file `;updateMethodRenameDashTags;`
192 3. Login to Shaarli. 1953. Login to Shaarli
193 4. Delete the update file. 1964. Delete the update file
194 5. Refresh. 1975. Refresh