[github/shaarli/Shaarli.git] / doc / md / Download-and-Installation.md

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).

Several releases are available:

--------------------------------------------------------

## Latest release (recommended)
### Download as an archive
Get the latest released version from the [releases](https://github.com/shaarli/Shaarli/releases) page.

**Download our *shaarli-full* archive** to include dependencies.

The current latest released version is `v0.8.4`

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
$ 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).|
|-----|--------------------------|

### 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
```

--------------------------------------------------------

## 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 

[Composer](https://getcomposer.org/) is required to build a functional Shaarli installation when pulling from git.

```bash
$ 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
```

--------------------------------------------------------

## Development version (mainline)

_Use at your own risk!_

To get the latest changes from the `master` branch:

```bash
# clone the repository  
$ 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
```

--------------------------------------------------------

## 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)

Setup your Shaarli installation, and it's ready to use!

--------------------------------------------------------

## Updating Shaarli

See [Upgrade and Migration](Upgrade-and-migration)
Commit	Line	Data
	1	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).
	2
	3	Several releases are available:
	4
	5	--------------------------------------------------------
	6
	7	## Latest release (recommended)
	8	### Download as an archive
	9	Get the latest released version from the [releases](https://github.com/shaarli/Shaarli/releases) page.
	10
	11	*Download our shaarli-full* archive** to include dependencies.
	12
	13	The current latest released version is `v0.8.4`
	14
	15	Or in command lines:
	16
	17	```bash
	18	$ wget https://github.com/shaarli/Shaarli/releases/download/v0.8.4/shaarli-v0.8.4-full.zip
	19	$ unzip shaarli-v0.8.4-full.zip
	20	$ mv Shaarli /path/to/shaarli/
	21	```
	22
	23	\| ! \|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).\|
	24	\|-----\|--------------------------\|
	25
	26	### Using git
	27
	28	```
	29	mkdir -p /path/to/shaarli && cd /path/to/shaarli/
	30	git clone -b v0.8 https://github.com/shaarli/Shaarli.git .
	31	composer install --no-dev
	32	```
	33
	34	--------------------------------------------------------
	35
	36	## Stable version
	37
	38	The stable version has been experienced by Shaarli users, and will receive security updates.
	39
	40	### Download as an archive
	41
	42	As a .zip archive:
	43
	44	```bash
	45	$ wget https://github.com/shaarli/Shaarli/archive/stable.zip
	46	$ unzip stable.zip
	47	$ mv Shaarli-stable /path/to/shaarli/
	48	```
	49
	50	As a .tar.gz archive :
	51
	52	```bash
	53	$ wget https://github.com/shaarli/Shaarli/archive/stable.tar.gz
	54	$ tar xvf stable.tar.gz
	55	$ mv Shaarli-stable /path/to/shaarli/
	56	```
	57
	58	### Clone with Git
	59
	60	[Composer](https://getcomposer.org/) is required to build a functional Shaarli installation when pulling from git.
	61
	62	```bash
	63	$ git clone https://github.com/shaarli/Shaarli.git -b stable /path/to/shaarli/
	64	# install/update third-party dependencies
	65	$ cd /path/to/shaarli/
	66	$ composer install --no-dev
	67	```
	68
	69	--------------------------------------------------------
	70
	71	## Development version (mainline)
	72
	73	_Use at your own risk!_
	74
	75	To get the latest changes from the `master` branch:
	76
	77	```bash
	78	# clone the repository
	79	$ git clone https://github.com/shaarli/Shaarli.git -b master /path/to/shaarli/
	80	# install/update third-party dependencies
	81	$ cd /path/to/shaarli
	82	$ composer install --no-dev
	83	```
	84
	85	--------------------------------------------------------
	86
	87	## Finish Installation
	88
	89	Once Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser.
	90
	91	![install screenshot](http://i.imgur.com/wuMpDSN.png)
	92
	93	Setup your Shaarli installation, and it's ready to use!
	94
	95	--------------------------------------------------------
	96
	97	## Updating Shaarli
	98
	99	See [Upgrade and Migration](Upgrade-and-migration)