53ed6d7d1e
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
100 lines
2.8 KiB
Markdown
100 lines
2.8 KiB
Markdown
To 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).
|
|
|
|
Several releases are available:
|
|
|
|
--------------------------------------------------------
|
|
|
|
## Latest release (recommended)
|
|
### Download as an archive
|
|
Get the latest released version from the [releases](https://github.com/shaarli/Shaarli/releases) page.
|
|
|
|
**Download our *shaarli-full* archive** to include dependencies.
|
|
|
|
The current latest released version is `v0.8.4`
|
|
|
|
Or in command lines:
|
|
|
|
```bash
|
|
$ wget https://github.com/shaarli/Shaarli/releases/download/v0.8.4/shaarli-v0.8.4-full.zip
|
|
$ unzip shaarli-v0.8.4-full.zip
|
|
$ mv Shaarli /path/to/shaarli/
|
|
```
|
|
|
|
| ! |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).|
|
|
|-----|--------------------------|
|
|
|
|
### Using git
|
|
|
|
```
|
|
mkdir -p /path/to/shaarli && cd /path/to/shaarli/
|
|
git clone -b v0.8 https://github.com/shaarli/Shaarli.git .
|
|
composer install --no-dev
|
|
```
|
|
|
|
--------------------------------------------------------
|
|
|
|
## Stable version
|
|
|
|
The stable version has been experienced by Shaarli users, and will receive security updates.
|
|
|
|
### Download as an archive
|
|
|
|
As a .zip archive:
|
|
|
|
```bash
|
|
$ wget https://github.com/shaarli/Shaarli/archive/stable.zip
|
|
$ unzip stable.zip
|
|
$ mv Shaarli-stable /path/to/shaarli/
|
|
```
|
|
|
|
As a .tar.gz archive :
|
|
|
|
```bash
|
|
$ wget https://github.com/shaarli/Shaarli/archive/stable.tar.gz
|
|
$ tar xvf stable.tar.gz
|
|
$ mv Shaarli-stable /path/to/shaarli/
|
|
```
|
|
|
|
### Clone with Git
|
|
|
|
[Composer](https://getcomposer.org/) is required to build a functional Shaarli installation when pulling from git.
|
|
|
|
```bash
|
|
$ git clone https://github.com/shaarli/Shaarli.git -b stable /path/to/shaarli/
|
|
# install/update third-party dependencies
|
|
$ cd /path/to/shaarli/
|
|
$ composer install --no-dev
|
|
```
|
|
|
|
--------------------------------------------------------
|
|
|
|
## Development version (mainline)
|
|
|
|
_Use at your own risk!_
|
|
|
|
To get the latest changes from the `master` branch:
|
|
|
|
```bash
|
|
# clone the repository
|
|
$ git clone https://github.com/shaarli/Shaarli.git -b master /path/to/shaarli/
|
|
# install/update third-party dependencies
|
|
$ cd /path/to/shaarli
|
|
$ composer install --no-dev
|
|
```
|
|
|
|
--------------------------------------------------------
|
|
|
|
## Finish Installation
|
|
|
|
Once Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser.
|
|
|
|
|
|
|
|
Setup your Shaarli installation, and it's ready to use!
|
|
|
|
--------------------------------------------------------
|
|
|
|
## Updating Shaarli
|
|
|
|
See [Upgrade and Migration](Upgrade-and-migration)
|