X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=doc%2Fmd%2FUpgrade-and-migration.md;h=d5682a340dd35d650e8ed025ca4d5e75e666ba99;hb=f39b1242a8bf43441b35a5e4a530b0ec7058dca3;hp=1dc073398fa190c8c3aaa71deded5e0ace7c5246;hpb=286757ab29660916f6b66d1fc0ad3b53aef337c8;p=github%2Fshaarli%2FShaarli.git 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 @@ ### Note your current version -If anything goes wrong, it's important for us to know which version you're upgrading from. -The current version is present in the `version.php` file. +If anything goes wrong, it's important for us to know which version you're upgrading from. +The current version is present in the `shaarli_version.php` file. ### Backup your data Shaarli stores all user data under the `data` directory: -- `data/config.php` - main configuration file +- `data/config.json.php` (or `data/config.php` for older Shaarli versions) - 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 @@ -27,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](Download-and-installation) + - fresh installation - see [Download and Installation](Download-and-Installation) - update - see the following sections - check or restore the `data` directory @@ -35,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](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! -If you use translations in gettext mode - meaning you manually changed the default mode -, +If you use translations in gettext mode - meaning you manually changed the default mode -, reload your web server. 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 If you use translations in gettext mode, reload your web server. +Shaarli >= `v0.10.0` manages its front-end dependencies with nodejs. You need to install +[yarn](https://yarnpkg.com/lang/en/docs/install/): + +```bash +$ make build_frontend +``` + ### Migrating and upgrading from Sebsauvage's repository 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 If you use translations in gettext mode, reload your web server. +Shaarli >= `v0.10.0` manages its front-end dependencies with nodejs. You need to install +[yarn](https://yarnpkg.com/lang/en/docs/install/): + +```bash +$ make build_frontend +``` + Optionally, you can delete information related to the legacy version: ```bash @@ -192,7 +206,10 @@ 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](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.json.php` (see [Shaarli configuration](Shaarli-configuration) for more +details). ## Troubleshooting