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