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

Also, please make sure your server meets the [requirements](Server-requirements)
and is properly [configured](Server-configuration).

Several releases are available:

- by downloading full release archives including all dependencies
- by downloading Github archives
- by cloning the Git repository

---

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

Or in command lines:

```bash
$ wget https://github.com/shaarli/Shaarli/releases/download/v0.9.0/shaarli-v0.9.0-full.zip
$ unzip shaarli-v0.9.0-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.9 https://github.com/shaarli/Shaarli.git .
$ composer install --no-dev --prefer-dist
```

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

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

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