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