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