aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/md/Download-and-Installation.md
diff options
context:
space:
mode:
authornodiscc <nodiscc@gmail.com>2017-01-26 18:52:54 +0100
committernodiscc <nodiscc@gmail.com>2017-06-18 00:19:49 +0200
commit53ed6d7d1e678d7486337ce67a2f17b30bac21ac (patch)
treef8bef0164a70bd03d2b9781951c01bdd018f1842 /doc/md/Download-and-Installation.md
parentd5d22a6d07917865c44148ad76f43c65a929a890 (diff)
downloadShaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.tar.gz
Shaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.tar.zst
Shaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.zip
Generate HTML documentation using MkDocs (WIP)
MkDocs is a static site generator geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML file. * http://www.mkdocs.org/ * http://www.mkdocs.org/user-guide/configuration/ Ref. #312 * remove pandoc-generated HTML documentation * move markdown doc to doc/md/, * mkdocs.yml: * generate HTML doc in doc/html * add pages TOC/ordering * use index.md as index page * Makefile: remove execute permissions from generated files * Makefile: rewrite htmlpages GFM to markdown conversion using sed: awk expression aslo matched '][' which causes invalid output on complex links with images or code blocks * Add mkdocs.yml to .gitattributes, exclude this file from release archives * Makefile: rename: htmldoc -> doc_html target * run make doc: pull latest markdown documentation from wiki * run make htmlpages: update html documentation
Diffstat (limited to 'doc/md/Download-and-Installation.md')
-rw-r--r--doc/md/Download-and-Installation.md99
1 files changed, 99 insertions, 0 deletions
diff --git a/doc/md/Download-and-Installation.md b/doc/md/Download-and-Installation.md
new file mode 100644
index 00000000..7880aef4
--- /dev/null
+++ b/doc/md/Download-and-Installation.md
@@ -0,0 +1,99 @@
1To 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).
2
3Several releases are available:
4
5--------------------------------------------------------
6
7## Latest release (recommended)
8### Download as an archive
9Get the latest released version from the [releases](https://github.com/shaarli/Shaarli/releases) page.
10
11**Download our *shaarli-full* archive** to include dependencies.
12
13The current latest released version is `v0.8.4`
14
15Or in command lines:
16
17```bash
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
20$ mv Shaarli /path/to/shaarli/
21```
22
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).|
24|-----|--------------------------|
25
26### Using git
27
28```
29mkdir -p /path/to/shaarli && cd /path/to/shaarli/
30git clone -b v0.8 https://github.com/shaarli/Shaarli.git .
31composer install --no-dev
32```
33
34--------------------------------------------------------
35
36## Stable version
37
38The stable version has been experienced by Shaarli users, and will receive security updates.
39
40### Download as an archive
41
42As 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
50As 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
60[Composer](https://getcomposer.org/) is required to build a functional Shaarli installation when pulling from git.
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/
66$ composer install --no-dev
67```
68
69--------------------------------------------------------
70
71## Development version (mainline)
72
73_Use at your own risk!_
74
75To get the latest changes from the `master` branch:
76
77```bash
78# clone the repository
79$ git clone https://github.com/shaarli/Shaarli.git -b master /path/to/shaarli/
80# install/update third-party dependencies
81$ cd /path/to/shaarli
82$ composer install --no-dev
83```
84
85--------------------------------------------------------
86
87## Finish Installation
88
89Once Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser.
90
91![install screenshot](http://i.imgur.com/wuMpDSN.png)
92
93Setup your Shaarli installation, and it's ready to use!
94
95--------------------------------------------------------
96
97## Updating Shaarli
98
99See [Upgrade and Migration](Upgrade-and-migration)