X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=doc%2Fmd%2FDownload-and-Installation.md;h=be848c97e9ab44f8629b5ffbeb2ad69d82c67b31;hb=2e6314af312229467ca63b6dc0c337f92eb5ddeb;hp=7880aef43aff7a7f7d175436a423af44c3f58bfa;hpb=5b25a9635fe808bc1c4f3eee8cdf8485115da75d;p=github%2Fshaarli%2FShaarli.git diff --git a/doc/md/Download-and-Installation.md b/doc/md/Download-and-Installation.md index 7880aef4..be848c97 100644 --- a/doc/md/Download-and-Installation.md +++ b/doc/md/Download-and-Installation.md @@ -1,8 +1,23 @@ -To install Shaarli, simply place the files in a directory under your webserver's Document Root (or directly at the document root). Make sure your [server](Server-requirements) is properly [configured](Server-configuration). +To install Shaarli, simply place the files in a directory under your webserver's +Document Root (or directly at the document root). -Several releases are available: +Also, please make sure your server meets the [requirements](Server-requirements) +and is properly [configured](Server-configuration). --------------------------------------------------------- +Multiple releases branches are available: + +- latest (last release) +- stable (previous major release) +- master (development) + +Using one of the following methods: + +- by downloading full release archives including all dependencies +- by downloading Github archives +- by cloning the Git repository +- using Docker: [see the documentation](docker/shaarli-images) + +--- ## Latest release (recommended) ### Download as an archive @@ -10,29 +25,28 @@ Get the latest released version from the [releases](https://github.com/shaarli/S **Download our *shaarli-full* archive** to include dependencies. -The current latest released version is `v0.8.4` +The current latest released version is `v0.9.1` Or in command lines: ```bash -$ wget https://github.com/shaarli/Shaarli/releases/download/v0.8.4/shaarli-v0.8.4-full.zip -$ unzip shaarli-v0.8.4-full.zip +$ wget https://github.com/shaarli/Shaarli/releases/download/v0.9.1/shaarli-v0.9.1-full.zip +$ unzip shaarli-v0.9.1-full.zip $ mv Shaarli /path/to/shaarli/ ``` -| ! |In most cases, download Shaarli from the [releases](https://github.com/shaarli/Shaarli/releases) page. Cloning using `git` or downloading Github branches as zip files requires additional steps (see below).| -|-----|--------------------------| +In most cases, download Shaarli from the [releases](https://github.com/shaarli/Shaarli/releases) page. +Cloning using `git` or downloading Github branches as zip files requires additional steps (see below). ### Using git ``` -mkdir -p /path/to/shaarli && cd /path/to/shaarli/ -git clone -b v0.8 https://github.com/shaarli/Shaarli.git . -composer install --no-dev +$ mkdir -p /path/to/shaarli && cd /path/to/shaarli/ +$ git clone -b latest https://github.com/shaarli/Shaarli.git . +$ composer install --no-dev --prefer-dist +$ make translate ``` --------------------------------------------------------- - ## Stable version The stable version has been experienced by Shaarli users, and will receive security updates. @@ -63,11 +77,9 @@ $ mv Shaarli-stable /path/to/shaarli/ $ git clone https://github.com/shaarli/Shaarli.git -b stable /path/to/shaarli/ # install/update third-party dependencies $ cd /path/to/shaarli/ -$ composer install --no-dev +$ composer install --no-dev --prefer-dist ``` --------------------------------------------------------- - ## Development version (mainline) _Use at your own risk!_ @@ -79,21 +91,18 @@ To get the latest changes from the `master` branch: $ git clone https://github.com/shaarli/Shaarli.git -b master /path/to/shaarli/ # install/update third-party dependencies $ cd /path/to/shaarli -$ composer install --no-dev +$ composer install --no-dev --prefer-dist +$ make translate ``` --------------------------------------------------------- - ## Finish Installation Once Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser. -![install screenshot](http://i.imgur.com/wuMpDSN.png) +![install screenshot](images/install-shaarli.png) Setup your Shaarli installation, and it's ready to use! --------------------------------------------------------- - ## Updating Shaarli See [Upgrade and Migration](Upgrade-and-migration)