2017-08-05 11:56:24 +02:00
To install Shaarli, simply place the files in a directory under your webserver's
Document Root (or directly at the document root).
Also, please make sure your server meets the [requirements ](Server-requirements )
and is properly [configured ](Server-configuration ).
2016-10-12 12:36:59 +02:00
Several releases are available:
2017-08-05 11:56:24 +02:00
- by downloading full release archives including all dependencies
- by downloading Github archives
- by cloning the Git repository
---
2016-10-12 12:36:59 +02:00
## Latest release (recommended)
2016-12-12 03:38:12 +01:00
### Download as an archive
2017-01-26 18:52:54 +01:00
Get the latest released version from the [releases ](https://github.com/shaarli/Shaarli/releases ) page.
2016-10-12 12:36:59 +02:00
2016-12-12 03:38:12 +01:00
**Download our *shaarli-full* archive** to include dependencies.
2016-10-12 12:36:59 +02:00
2017-08-23 01:22:07 +02:00
The current latest released version is `v0.9.1`
2016-10-12 12:36:59 +02:00
2016-12-12 03:38:12 +01:00
Or in command lines:
2016-10-12 12:36:59 +02:00
```bash
2017-08-23 01:22:07 +02:00
$ wget https://github.com/shaarli/Shaarli/releases/download/v0.9.1/shaarli-v0.9.1-full.zip
$ unzip shaarli-v0.9.1-full.zip
2016-12-12 03:38:12 +01:00
$ mv Shaarli /path/to/shaarli/
2016-10-12 12:36:59 +02:00
```
2017-08-05 11:56:24 +02:00
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).|
2016-10-12 12:36:59 +02:00
2016-12-12 03:38:12 +01:00
### Using git
2016-10-12 12:36:59 +02:00
2016-12-12 03:38:12 +01:00
```
2017-08-05 11:56:24 +02:00
$ mkdir -p /path/to/shaarli & & cd /path/to/shaarli/
2017-08-05 12:08:09 +02:00
$ git clone -b v0.9 https://github.com/shaarli/Shaarli.git .
2017-08-05 11:56:24 +02:00
$ composer install --no-dev --prefer-dist
2016-12-12 03:38:12 +01:00
```
2016-10-12 12:36:59 +02:00
## Stable version
The stable version has been experienced by Shaarli users, and will receive security updates.
### Download as an archive
As a .zip archive:
```bash
$ wget https://github.com/shaarli/Shaarli/archive/stable.zip
$ unzip stable.zip
$ mv Shaarli-stable /path/to/shaarli/
```
As a .tar.gz archive :
```bash
$ wget https://github.com/shaarli/Shaarli/archive/stable.tar.gz
$ tar xvf stable.tar.gz
$ mv Shaarli-stable /path/to/shaarli/
```
### Clone with Git
2017-01-26 18:52:54 +01:00
[Composer ](https://getcomposer.org/ ) is required to build a functional Shaarli installation when pulling from git.
2016-10-12 12:36:59 +02:00
```bash
$ git clone https://github.com/shaarli/Shaarli.git -b stable /path/to/shaarli/
# install/update third-party dependencies
$ cd /path/to/shaarli/
2017-08-05 11:56:24 +02:00
$ composer install --no-dev --prefer-dist
2016-10-12 12:36:59 +02:00
```
## Development version (mainline)
_Use at your own risk!_
To get the latest changes from the `master` branch:
```bash
# clone the repository
2017-05-07 18:44:05 +02:00
$ git clone https://github.com/shaarli/Shaarli.git -b master /path/to/shaarli/
2016-10-12 12:36:59 +02:00
# install/update third-party dependencies
$ cd /path/to/shaarli
2017-08-05 11:56:24 +02:00
$ composer install --no-dev --prefer-dist
2016-10-12 12:36:59 +02:00
```
## Finish Installation
Once Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser.
2017-01-26 18:52:54 +01:00
![install screenshot ](http://i.imgur.com/wuMpDSN.png )
2016-10-12 12:36:59 +02:00
Setup your Shaarli installation, and it's ready to use!
## Updating Shaarli
2017-01-26 18:52:54 +01:00
See [Upgrade and Migration ](Upgrade-and-migration )