]>
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 | 6 | |
cfcc3819 A |
7 | Multiple releases branches are available: |
8 | ||
9 | - latest (last release) | |
10 | - stable (previous major release) | |
11 | - master (development) | |
12 | ||
13 | Using one of the following methods: | |
fdf88d19 | 14 | |
43ad7c8e V |
15 | - by downloading full release archives including all dependencies |
16 | - by downloading Github archives | |
17 | - by cloning the Git repository | |
7a205fb2 | 18 | - using Docker: [see the documentation](docker/shaarli-images.md) |
43ad7c8e | 19 | |
76c3a4db | 20 | -------------------------------------------------------------------------------- |
fdf88d19 A |
21 | |
22 | ## Latest release (recommended) | |
76c3a4db | 23 | |
3cc8c898 | 24 | ### Download as an archive |
fdf88d19 | 25 | |
76c3a4db | 26 | In most cases, you should download the latest Shaarli release from the [releases](https://github.com/shaarli/Shaarli/releases) page. **Download our *shaarli-full* archive** to include dependencies. |
fdf88d19 | 27 | |
ee242ae3 | 28 | The current latest released version is `v0.9.6` |
fdf88d19 | 29 | |
fdf88d19 | 30 | ```bash |
ee242ae3 V |
31 | $ wget https://github.com/shaarli/Shaarli/releases/download/v0.9.6/shaarli-v0.9.6-full.zip |
32 | $ unzip shaarli-v0.9.6-full.zip | |
3cc8c898 | 33 | $ mv Shaarli /path/to/shaarli/ |
fdf88d19 A |
34 | ``` |
35 | ||
3cc8c898 | 36 | ### Using git |
fdf88d19 | 37 | |
76c3a4db | 38 | Cloning using `git` or downloading Github branches as zip files requires additional steps: |
39 | ||
40 | * Install [Composer](Unit-tests.md#install_composer) to manage Shaarli dependencies. | |
d7eb06bd | 41 | * Install [yarn](https://yarnpkg.com/lang/en/docs/install/) to build the frontend dependencies. |
76c3a4db | 42 | * Install [python3-virtualenv](https://pypi.python.org/pypi/virtualenv) to build the local HTML documentation. |
43 | ||
3cc8c898 | 44 | ``` |
43ad7c8e | 45 | $ mkdir -p /path/to/shaarli && cd /path/to/shaarli/ |
cfcc3819 | 46 | $ git clone -b latest https://github.com/shaarli/Shaarli.git . |
43ad7c8e | 47 | $ composer install --no-dev --prefer-dist |
d7eb06bd | 48 | $ make build_frontend |
1a47014f | 49 | $ make translate |
76c3a4db | 50 | $ make htmldoc |
3cc8c898 | 51 | ``` |
fdf88d19 | 52 | |
76c3a4db | 53 | -------------------------------------------------------------------------------- |
54 | ||
fdf88d19 A |
55 | ## Stable version |
56 | ||
57 | The stable version has been experienced by Shaarli users, and will receive security updates. | |
58 | ||
76c3a4db | 59 | |
fdf88d19 A |
60 | ### Download as an archive |
61 | ||
62 | As a .zip archive: | |
63 | ||
64 | ```bash | |
65 | $ wget https://github.com/shaarli/Shaarli/archive/stable.zip | |
66 | $ unzip stable.zip | |
67 | $ mv Shaarli-stable /path/to/shaarli/ | |
68 | ``` | |
69 | ||
70 | As a .tar.gz archive : | |
71 | ||
72 | ```bash | |
73 | $ wget https://github.com/shaarli/Shaarli/archive/stable.tar.gz | |
74 | $ tar xvf stable.tar.gz | |
75 | $ mv Shaarli-stable /path/to/shaarli/ | |
76 | ``` | |
77 | ||
76c3a4db | 78 | ### Using git |
fdf88d19 | 79 | |
76c3a4db | 80 | Install [Composer](Unit-tests.md#install_composer) to manage Shaarli dependencies. |
fdf88d19 A |
81 | |
82 | ```bash | |
83 | $ git clone https://github.com/shaarli/Shaarli.git -b stable /path/to/shaarli/ | |
84 | # install/update third-party dependencies | |
85 | $ cd /path/to/shaarli/ | |
43ad7c8e | 86 | $ composer install --no-dev --prefer-dist |
fdf88d19 A |
87 | ``` |
88 | ||
76c3a4db | 89 | |
90 | -------------------------------------------------------------------------------- | |
91 | ||
fdf88d19 A |
92 | ## Development version (mainline) |
93 | ||
94 | _Use at your own risk!_ | |
95 | ||
d7eb06bd A |
96 | Install [Composer](Unit-tests.md#install_composer) to manage Shaarli PHP dependencies, |
97 | and [yarn](https://yarnpkg.com/lang/en/docs/install/) | |
98 | for front-end dependencies. | |
76c3a4db | 99 | |
fdf88d19 A |
100 | To get the latest changes from the `master` branch: |
101 | ||
102 | ```bash | |
f452d3c4 | 103 | # clone the repository |
b230bf20 | 104 | $ git clone https://github.com/shaarli/Shaarli.git -b master /path/to/shaarli/ |
fdf88d19 A |
105 | # install/update third-party dependencies |
106 | $ cd /path/to/shaarli | |
43ad7c8e | 107 | $ composer install --no-dev --prefer-dist |
d7eb06bd | 108 | $ make build_frontend |
1a47014f | 109 | $ make translate |
76c3a4db | 110 | $ make htmldoc |
fdf88d19 A |
111 | ``` |
112 | ||
76c3a4db | 113 | ------------------------------------------------------------------------------- |
114 | ||
fdf88d19 A |
115 | ## Finish Installation |
116 | ||
117 | Once Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser. | |
118 | ||
1a47014f | 119 | ![install screenshot](images/install-shaarli.png) |
fdf88d19 A |
120 | |
121 | Setup your Shaarli installation, and it's ready to use! | |
122 | ||
fdf88d19 A |
123 | ## Updating Shaarli |
124 | ||
53ed6d7d | 125 | See [Upgrade and Migration](Upgrade-and-migration) |