diff options
Diffstat (limited to 'doc/md/Installation.md')
-rw-r--r-- | doc/md/Installation.md | 78 |
1 files changed, 78 insertions, 0 deletions
diff --git a/doc/md/Installation.md b/doc/md/Installation.md new file mode 100644 index 00000000..11b5da85 --- /dev/null +++ b/doc/md/Installation.md | |||
@@ -0,0 +1,78 @@ | |||
1 | # Installation | ||
2 | |||
3 | Once your server is [configured](Server-configuration.md), install Shaarli: | ||
4 | |||
5 | ## From release ZIP | ||
6 | |||
7 | To install Shaarli, simply place the files from the latest [release .zip archive](https://github.com/shaarli/Shaarli/releases) under your webserver's document root (directly at the document root, or in a subdirectory). Download the **shaarli-vX.X.X-full** archive to include dependencies. | ||
8 | |||
9 | ```bash | ||
10 | wget https://github.com/shaarli/Shaarli/releases/download/v0.11.1/shaarli-v0.11.1-full.zip | ||
11 | unzip shaarli-v0.11.1-full.zip | ||
12 | sudo rsync -avP Shaarli/ /var/www/shaarli.mydomain.org/ | ||
13 | ``` | ||
14 | |||
15 | ## From sources | ||
16 | |||
17 | These components are required to build Shaarli: | ||
18 | |||
19 | - [Composer](dev/Development.md#install-composer) to manage third-party [PHP dependencies](dev/Development#third-party-libraries). | ||
20 | - [yarn](https://yarnpkg.com/lang/en/docs/install/) to build frontend dependencies. | ||
21 | - [python3-virtualenv](https://pypi.python.org/pypi/virtualenv) to build local HTML documentation. | ||
22 | |||
23 | Clone the repository, either pointing to: | ||
24 | |||
25 | - any [tagged release](https://github.com/shaarli/Shaarli/releases) | ||
26 | - `latest`: the latest tagged release | ||
27 | - `master`: development branch | ||
28 | |||
29 | ```bash | ||
30 | # clone the branch/tag of your choice | ||
31 | $ git clone -b latest https://github.com/shaarli/Shaarli.git /home/me/Shaarli | ||
32 | # OR download/extract the tar.gz/zip: wget https://github.com/shaarli/Shaarli/archive/latest.tar.gz... | ||
33 | |||
34 | # enter the directory | ||
35 | $ cd /home/me/Shaarli | ||
36 | # install 3rd-party PHP dependencies | ||
37 | $ composer install --no-dev --prefer-dist | ||
38 | # build frontend static assets | ||
39 | $ make build_frontend | ||
40 | # build translations | ||
41 | $ make translate | ||
42 | # build HTML documentation | ||
43 | $ make htmldoc | ||
44 | # copy the resulting shaarli directory under your webserver's document root | ||
45 | $ rsync -avP /home/me/Shaarli/ /var/www/shaarli.mydomain.org/ | ||
46 | ``` | ||
47 | |||
48 | ## Set file permissions | ||
49 | |||
50 | Regardless of the installation method, appropriate [file permissions](dev/Development.md#directory-structure) must be set: | ||
51 | |||
52 | ```bash | ||
53 | sudo chown -R root:www-data /var/www/shaarli.mydomain.org | ||
54 | sudo chmod -R g+rX /var/www/shaarli.mydomain.org | ||
55 | sudo chmod -R g+rwX /var/www/shaarli.mydomain.org/{cache/,data/,pagecache/,tmp/} | ||
56 | ``` | ||
57 | |||
58 | ## Using Docker | ||
59 | |||
60 | [See the documentation](Docker.md) | ||
61 | |||
62 | |||
63 | ## Finish Installation | ||
64 | |||
65 | Once Shaarli is downloaded and files have been placed at the correct location, open this location your web browser. | ||
66 | |||
67 | Enter basic settings for your Shaarli installation, and it's ready to use! | ||
68 | |||
69 | ![](images/07-installation.jpg) | ||
70 | |||
71 | Congratulations! Your Shaarli is now available at `https://shaarli.mydomain.org`. | ||
72 | |||
73 | You can further [configure Shaarli](Shaarli-configuration.md), setup [Plugins](Plugins.md) or [additional software](Community-and-related-software.md). | ||
74 | |||
75 | |||
76 | ## Upgrading Shaarli | ||
77 | |||
78 | See [Upgrade and Migration](Upgrade-and-migration) | ||