diff options
Diffstat (limited to 'doc/md/Upgrade-and-migration.md')
-rw-r--r-- | doc/md/Upgrade-and-migration.md | 31 |
1 files changed, 24 insertions, 7 deletions
diff --git a/doc/md/Upgrade-and-migration.md b/doc/md/Upgrade-and-migration.md index 1dc07339..d5682a34 100644 --- a/doc/md/Upgrade-and-migration.md +++ b/doc/md/Upgrade-and-migration.md | |||
@@ -2,14 +2,14 @@ | |||
2 | 2 | ||
3 | ### Note your current version | 3 | ### Note your current version |
4 | 4 | ||
5 | If anything goes wrong, it's important for us to know which version you're upgrading from. | 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. | 6 | The current version is present in the `shaarli_version.php` file. |
7 | 7 | ||
8 | ### Backup your data | 8 | ### Backup your data |
9 | 9 | ||
10 | Shaarli stores all user data under the `data` directory: | 10 | Shaarli stores all user data under the `data` directory: |
11 | 11 | ||
12 | - `data/config.php` - main configuration file | 12 | - `data/config.json.php` (or `data/config.php` for older Shaarli versions) - main configuration file |
13 | - `data/datastore.php` - bookmarked links | 13 | - `data/datastore.php` - bookmarked links |
14 | - `data/ipbans.php` - banned IP addresses | 14 | - `data/ipbans.php` - banned IP addresses |
15 | - `data/updates.txt` - contains all automatic update to the configuration and datastore files already run | 15 | - `data/updates.txt` - contains all automatic update to the configuration and datastore files already run |
@@ -27,7 +27,7 @@ As all user data is kept under `data`, this is the only directory you need to wo | |||
27 | 27 | ||
28 | - backup the `data` directory | 28 | - backup the `data` directory |
29 | - install or update Shaarli: | 29 | - install or update Shaarli: |
30 | - fresh installation - see [Download and installation](Download-and-installation) | 30 | - fresh installation - see [Download and Installation](Download-and-Installation) |
31 | - update - see the following sections | 31 | - update - see the following sections |
32 | - check or restore the `data` directory | 32 | - check or restore the `data` directory |
33 | 33 | ||
@@ -35,11 +35,11 @@ As all user data is kept under `data`, this is the only directory you need to wo | |||
35 | 35 | ||
36 | All tagged revisions can be downloaded as tarballs or ZIP archives from the [releases](https://github.com/shaarli/Shaarli/releases) page. | 36 | All tagged revisions can be downloaded as tarballs or ZIP archives from the [releases](https://github.com/shaarli/Shaarli/releases) page. |
37 | 37 | ||
38 | 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. | 38 | 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. |
39 | 39 | ||
40 | 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! | 40 | 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! |
41 | 41 | ||
42 | If you use translations in gettext mode - meaning you manually changed the default mode -, | 42 | If you use translations in gettext mode - meaning you manually changed the default mode -, |
43 | reload your web server. | 43 | reload your web server. |
44 | 44 | ||
45 | 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). | 45 | 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). |
@@ -83,6 +83,13 @@ $ make translate | |||
83 | 83 | ||
84 | If you use translations in gettext mode, reload your web server. | 84 | If you use translations in gettext mode, reload your web server. |
85 | 85 | ||
86 | Shaarli >= `v0.10.0` manages its front-end dependencies with nodejs. You need to install | ||
87 | [yarn](https://yarnpkg.com/lang/en/docs/install/): | ||
88 | |||
89 | ```bash | ||
90 | $ make build_frontend | ||
91 | ``` | ||
92 | |||
86 | ### Migrating and upgrading from Sebsauvage's repository | 93 | ### Migrating and upgrading from Sebsauvage's repository |
87 | 94 | ||
88 | 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. | 95 | 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. |
@@ -170,6 +177,13 @@ $ make translate | |||
170 | 177 | ||
171 | If you use translations in gettext mode, reload your web server. | 178 | If you use translations in gettext mode, reload your web server. |
172 | 179 | ||
180 | Shaarli >= `v0.10.0` manages its front-end dependencies with nodejs. You need to install | ||
181 | [yarn](https://yarnpkg.com/lang/en/docs/install/): | ||
182 | |||
183 | ```bash | ||
184 | $ make build_frontend | ||
185 | ``` | ||
186 | |||
173 | Optionally, you can delete information related to the legacy version: | 187 | Optionally, you can delete information related to the legacy version: |
174 | 188 | ||
175 | ```bash | 189 | ```bash |
@@ -192,7 +206,10 @@ Total 3317 (delta 2050), reused 3301 (delta 2034)to | |||
192 | 206 | ||
193 | #### Step 3: configuration | 207 | #### Step 3: configuration |
194 | 208 | ||
195 | 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). | 209 | After migrating, access your fresh Shaarli installation from a web browser; the |
210 | configuration will then be automatically updated, and new settings added to | ||
211 | `data/config.json.php` (see [Shaarli configuration](Shaarli-configuration) for more | ||
212 | details). | ||
196 | 213 | ||
197 | ## Troubleshooting | 214 | ## Troubleshooting |
198 | 215 | ||