]>
Commit | Line | Data |
---|---|---|
53ed6d7d | 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). |
fdf88d19 A |
2 | |
3 | Several releases are available: | |
4 | ||
5 | -------------------------------------------------------- | |
6 | ||
7 | ## Latest release (recommended) | |
3cc8c898 | 8 | ### Download as an archive |
53ed6d7d | 9 | Get the latest released version from the [releases](https://github.com/shaarli/Shaarli/releases) page. |
fdf88d19 | 10 | |
3cc8c898 | 11 | **Download our *shaarli-full* archive** to include dependencies. |
fdf88d19 | 12 | |
b230bf20 | 13 | The current latest released version is `v0.8.4` |
fdf88d19 | 14 | |
3cc8c898 | 15 | Or in command lines: |
fdf88d19 A |
16 | |
17 | ```bash | |
b230bf20 A |
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 | |
3cc8c898 | 20 | $ mv Shaarli /path/to/shaarli/ |
fdf88d19 A |
21 | ``` |
22 | ||
53ed6d7d | 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).| |
fdf88d19 A |
24 | |-----|--------------------------| |
25 | ||
3cc8c898 | 26 | ### Using git |
fdf88d19 | 27 | |
3cc8c898 A |
28 | ``` |
29 | mkdir -p /path/to/shaarli && cd /path/to/shaarli/ | |
b230bf20 A |
30 | git clone -b v0.8 https://github.com/shaarli/Shaarli.git . |
31 | composer install --no-dev | |
3cc8c898 | 32 | ``` |
fdf88d19 A |
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 | ||
53ed6d7d | 60 | [Composer](https://getcomposer.org/) is required to build a functional Shaarli installation when pulling from git. |
fdf88d19 A |
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/ | |
b230bf20 | 66 | $ composer install --no-dev |
fdf88d19 A |
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 | |
b230bf20 | 79 | $ git clone https://github.com/shaarli/Shaarli.git -b master /path/to/shaarli/ |
fdf88d19 A |
80 | # install/update third-party dependencies |
81 | $ cd /path/to/shaarli | |
b230bf20 | 82 | $ composer install --no-dev |
fdf88d19 A |
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 | ||
53ed6d7d | 91 | ![install screenshot](http://i.imgur.com/wuMpDSN.png) |
fdf88d19 A |
92 | |
93 | Setup your Shaarli installation, and it's ready to use! | |
94 | ||
95 | -------------------------------------------------------- | |
96 | ||
97 | ## Updating Shaarli | |
98 | ||
53ed6d7d | 99 | See [Upgrade and Migration](Upgrade-and-migration) |