aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/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/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/Download-and-Installation.md')
-rw-r--r--doc/Download-and-Installation.md102
1 files changed, 0 insertions, 102 deletions
diff --git a/doc/Download-and-Installation.md b/doc/Download-and-Installation.md
deleted file mode 100644
index 970144a5..00000000
--- a/doc/Download-and-Installation.md
+++ /dev/null
@@ -1,102 +0,0 @@
1#Download and Installation
2# Get Shaarli!
3
4To 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).[](.html)
5
6Several releases are available:
7
8--------------------------------------------------------
9
10## Latest release (recommended)
11### Download as an archive
12Get the latest released version from the [releases](https://github.com/shaarli/Shaarli/releases) page.[](.html)
13
14**Download our *shaarli-full* archive** to include dependencies.
15
16The current latest released version is `v0.8.4`
17
18Or in command lines:
19
20```bash
21$ wget https://github.com/shaarli/Shaarli/releases/download/v0.8.4/shaarli-v0.8.4-full.zip
22$ unzip shaarli-v0.8.4-full.zip
23$ mv Shaarli /path/to/shaarli/
24```
25
26| ! |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).|[](.html)
27|-----|--------------------------|
28
29### Using git
30
31```
32mkdir -p /path/to/shaarli && cd /path/to/shaarli/
33git clone -b v0.8 https://github.com/shaarli/Shaarli.git .
34composer install --no-dev
35```
36
37--------------------------------------------------------
38
39## Stable version
40
41The stable version has been experienced by Shaarli users, and will receive security updates.
42
43### Download as an archive
44
45As a .zip archive:
46
47```bash
48$ wget https://github.com/shaarli/Shaarli/archive/stable.zip
49$ unzip stable.zip
50$ mv Shaarli-stable /path/to/shaarli/
51```
52
53As a .tar.gz archive :
54
55```bash
56$ wget https://github.com/shaarli/Shaarli/archive/stable.tar.gz
57$ tar xvf stable.tar.gz
58$ mv Shaarli-stable /path/to/shaarli/
59```
60
61### Clone with Git
62
63[Composer](https://getcomposer.org/) is required to build a functional Shaarli installation when pulling from git.[](.html)
64
65```bash
66$ git clone https://github.com/shaarli/Shaarli.git -b stable /path/to/shaarli/
67# install/update third-party dependencies
68$ cd /path/to/shaarli/
69$ composer install --no-dev
70```
71
72--------------------------------------------------------
73
74## Development version (mainline)
75
76_Use at your own risk!_
77
78To get the latest changes from the `master` branch:
79
80```bash
81# clone the repository
82$ git clone https://github.com/shaarli/Shaarli.git -b master /path/to/shaarli/
83# install/update third-party dependencies
84$ cd /path/to/shaarli
85$ composer install --no-dev
86```
87
88--------------------------------------------------------
89
90## Finish Installation
91
92Once Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser.
93
94![install screenshot](http://i.imgur.com/wuMpDSN.png)[](.html)
95
96Setup your Shaarli installation, and it's ready to use!
97
98--------------------------------------------------------
99
100## Updating Shaarli
101
102See [Upgrade and Migration](Upgrade-and-migration)[](.html)