2017-01-26 18:52:54 +01:00
<!DOCTYPE html>
<!-- [if IE 8]><html class="no - js lt - ie9" lang="en" > <![endif] -->
<!-- [if gt IE 8]><! --> < html class = "no-js" lang = "en" > <!-- <![endif] -->
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< link rel = "shortcut icon" href = "../img/favicon.ico" >
< title > Download and Installation - Shaarli Documentation< / title >
< link href = 'https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel = 'stylesheet' type = 'text/css' >
< link rel = "stylesheet" href = "../css/theme.css" type = "text/css" / >
< link rel = "stylesheet" href = "../css/theme_extra.css" type = "text/css" / >
< link rel = "stylesheet" href = "../css/highlight.css" >
< link href = "../github-markdown.css" rel = "stylesheet" >
< script >
// Current page data
var mkdocs_page_name = "Download and Installation";
var mkdocs_page_input_path = "Download-and-Installation.md";
var mkdocs_page_url = "/Download-and-Installation/";
< / script >
< script src = "../js/jquery-2.1.1.min.js" > < / script >
< script src = "../js/modernizr-2.8.3.min.js" > < / script >
< script type = "text/javascript" src = "../js/highlight.pack.js" > < / script >
< / head >
< body class = "wy-body-for-nav" role = "document" >
< div class = "wy-grid-for-nav" >
< nav data-toggle = "wy-nav-shift" class = "wy-nav-side stickynav" >
< div class = "wy-side-nav-search" >
< a href = ".." class = "icon icon-home" > Shaarli Documentation< / a >
< div role = "search" >
< form id = "rtd-search-form" class = "wy-form" action = "../search.html" method = "get" >
< input type = "text" name = "q" placeholder = "Search docs" / >
< / form >
< / div >
< / div >
< div class = "wy-menu wy-menu-vertical" data-spy = "affix" role = "navigation" aria-label = "main navigation" >
< ul class = "current" >
< li class = "toctree-l1" >
< a class = "" href = ".." > Home< / a >
< / li >
< li class = "toctree-l1" >
< span class = "caption-text" > Setup< / span >
< ul class = "subnav" >
< li class = " current" >
< a class = "current" href = "./" > Download and Installation< / a >
< ul class = "subnav" >
< li class = "toctree-l3" > < a href = "#latest-release-recommended" > Latest release (recommended)< / a > < / li >
< ul >
< li > < a class = "toctree-l4" href = "#download-as-an-archive" > Download as an archive< / a > < / li >
< li > < a class = "toctree-l4" href = "#using-git" > Using git< / a > < / li >
< / ul >
< li class = "toctree-l3" > < a href = "#stable-version" > Stable version< / a > < / li >
< ul >
< li > < a class = "toctree-l4" href = "#download-as-an-archive_1" > Download as an archive< / a > < / li >
< li > < a class = "toctree-l4" href = "#clone-with-git" > Clone with Git< / a > < / li >
< / ul >
< li class = "toctree-l3" > < a href = "#development-version-mainline" > Development version (mainline)< / a > < / li >
< li class = "toctree-l3" > < a href = "#finish-installation" > Finish Installation< / a > < / li >
< li class = "toctree-l3" > < a href = "#updating-shaarli" > Updating Shaarli< / a > < / li >
< / ul >
< / li >
< li class = "" >
< a class = "" href = "../Upgrade-and-migration/" > Upgrade and migration< / a >
< / li >
< li class = "" >
< a class = "" href = "../Server-requirements/" > Server requirements< / a >
< / li >
< li class = "" >
< a class = "" href = "../Server-configuration/" > Server configuration< / a >
< / li >
< li class = "" >
< a class = "" href = "../Server-security/" > Server security< / a >
< / li >
< li class = "" >
< a class = "" href = "../Shaarli-configuration/" > Shaarli configuration< / a >
< / li >
< li class = "" >
< a class = "" href = "../Plugins/" > Plugins< / a >
< / li >
< / ul >
< / li >
< li class = "toctree-l1" >
< span class = "caption-text" > Docker< / span >
< ul class = "subnav" >
< li class = "" >
2017-07-29 15:29:54 +02:00
< a class = "" href = "../docker/docker-101/" > Docker 101< / a >
2017-01-26 18:52:54 +01:00
< / li >
< li class = "" >
2017-07-29 15:29:54 +02:00
< a class = "" href = "../docker/shaarli-images/" > Shaarli images< / a >
2017-01-26 18:52:54 +01:00
< / li >
< li class = "" >
2017-07-29 15:29:54 +02:00
< a class = "" href = "../docker/reverse-proxy-configuration/" > Reverse proxy configuration< / a >
2017-01-26 18:52:54 +01:00
< / li >
< li class = "" >
2017-07-29 15:29:54 +02:00
< a class = "" href = "../docker/resources/" > Docker resources< / a >
2017-01-26 18:52:54 +01:00
< / li >
< / ul >
< / li >
< li class = "toctree-l1" >
< span class = "caption-text" > Usage< / span >
< ul class = "subnav" >
< li class = "" >
< a class = "" href = "../Features/" > Features< / a >
< / li >
< li class = "" >
< a class = "" href = "../Bookmarklet/" > Bookmarklet< / a >
< / li >
< li class = "" >
< a class = "" href = "../Browsing-and-searching/" > Browsing and searching< / a >
< / li >
< li class = "" >
< a class = "" href = "../Firefox-share/" > Firefox share< / a >
< / li >
< li class = "" >
< a class = "" href = "../RSS-feeds/" > RSS feeds< / a >
< / li >
< li class = "" >
< a class = "" href = "../REST-API/" > REST API< / a >
< / li >
< / ul >
< / li >
< li class = "toctree-l1" >
< span class = "caption-text" > How To< / span >
< ul class = "subnav" >
< li class = "" >
< a class = "" href = "../Backup,-restore,-import-and-export/" > Backup, restore, import and export< / a >
< / li >
< li class = "" >
2017-06-18 06:32:30 +02:00
< a class = "" href = "../Various-hacks/" > Various hacks< / a >
2017-01-26 18:52:54 +01:00
< / li >
< / ul >
< / li >
< li class = "toctree-l1" >
< a class = "" href = "../Troubleshooting/" > Troubleshooting< / a >
< / li >
< li class = "toctree-l1" >
< span class = "caption-text" > Development< / span >
< ul class = "subnav" >
< li class = "" >
< a class = "" href = "../Development-guidelines/" > Development guidelines< / a >
< / li >
< li class = "" >
< a class = "" href = "../Continuous-integration-tools/" > Continuous integration tools< / a >
< / li >
< li class = "" >
< a class = "" href = "../GnuPG-signature/" > GnuPG signature< / a >
< / li >
< li class = "" >
< a class = "" href = "../Coding-guidelines/" > Coding guidelines< / a >
< / li >
< li class = "" >
< a class = "" href = "../Directory-structure/" > Directory structure< / a >
< / li >
< li class = "" >
< a class = "" href = "../3rd-party-libraries/" > 3rd party libraries< / a >
< / li >
< li class = "" >
< a class = "" href = "../Plugin-System/" > Plugin System< / a >
< / li >
< li class = "" >
< a class = "" href = "../Release-Shaarli/" > Release Shaarli< / a >
< / li >
< li class = "" >
< a class = "" href = "../Versioning-and-Branches/" > Versioning and Branches< / a >
< / li >
< li class = "" >
< a class = "" href = "../Security/" > Security< / a >
< / li >
< li class = "" >
< a class = "" href = "../Static-analysis/" > Static analysis< / a >
< / li >
< li class = "" >
< a class = "" href = "../Theming/" > Theming< / a >
< / li >
< li class = "" >
< a class = "" href = "../Unit-tests/" > Unit tests< / a >
< / li >
< / ul >
< / li >
< li class = "toctree-l1" >
< span class = "caption-text" > About< / span >
< ul class = "subnav" >
< li class = "" >
< a class = "" href = "../FAQ/" > FAQ< / a >
< / li >
< li class = "" >
< a class = "" href = "../Community-&-Related-software/" > Community & Related software< / a >
< / li >
< / ul >
< / li >
< / ul >
< / div >
< / nav >
< section data-toggle = "wy-nav-shift" class = "wy-nav-content-wrap" >
< nav class = "wy-nav-top" role = "navigation" aria-label = "top navigation" >
< i data-toggle = "wy-nav-top" class = "fa fa-bars" > < / i >
< a href = ".." > Shaarli Documentation< / a >
< / nav >
< div class = "wy-nav-content" >
< div class = "rst-content" >
< div role = "navigation" aria-label = "breadcrumbs navigation" >
< ul class = "wy-breadcrumbs" >
< li > < a href = ".." > Docs< / a > » < / li >
< li > Setup » < / li >
< li > Download and Installation< / li >
< li class = "wy-breadcrumbs-aside" >
< a href = "https://github.com/shaarli/Shaarli/edit/master/docs/Download-and-Installation.md"
class="icon icon-github"> Edit on GitHub< / a >
< / li >
< / ul >
< hr / >
< / div >
< div role = "main" >
< div class = "section" >
< p > 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 < a href = "../Server-requirements" > server< / a > is properly < a href = "../Server-configuration" > configured< / a > .< / p >
< p > Several releases are available:< / p >
< hr / >
< h2 id = "latest-release-recommended" > Latest release (recommended)< / h2 >
< h3 id = "download-as-an-archive" > Download as an archive< / h3 >
< p > Get the latest released version from the < a href = "https://github.com/shaarli/Shaarli/releases" > releases< / a > page.< / p >
< p > < strong > Download our < em > shaarli-full< / em > archive< / strong > to include dependencies.< / p >
< p > The current latest released version is < code > v0.8.4< / code > < / p >
< p > Or in command lines:< / p >
< pre > < code class = "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/
< / code > < / pre >
< table >
< thead >
< tr >
< th > !< / th >
< th > In most cases, download Shaarli from the < a href = "https://github.com/shaarli/Shaarli/releases" > releases< / a > page. Cloning using < code > git< / code > or downloading Github branches as zip files requires additional steps (see below).< / th >
< / tr >
< / thead >
< tbody > < / tbody >
< / table >
< h3 id = "using-git" > Using git< / h3 >
< pre > < code > mkdir -p /path/to/shaarli & & cd /path/to/shaarli/
git clone -b v0.8 https://github.com/shaarli/Shaarli.git .
composer install --no-dev
< / code > < / pre >
< hr / >
< h2 id = "stable-version" > Stable version< / h2 >
< p > The stable version has been experienced by Shaarli users, and will receive security updates.< / p >
< h3 id = "download-as-an-archive_1" > Download as an archive< / h3 >
< p > As a .zip archive:< / p >
< pre > < code class = "bash" > $ wget https://github.com/shaarli/Shaarli/archive/stable.zip
$ unzip stable.zip
$ mv Shaarli-stable /path/to/shaarli/
< / code > < / pre >
< p > As a .tar.gz archive :< / p >
< pre > < code class = "bash" > $ wget https://github.com/shaarli/Shaarli/archive/stable.tar.gz
$ tar xvf stable.tar.gz
$ mv Shaarli-stable /path/to/shaarli/
< / code > < / pre >
< h3 id = "clone-with-git" > Clone with Git< / h3 >
< p > < a href = "https://getcomposer.org/" > Composer< / a > is required to build a functional Shaarli installation when pulling from git.< / p >
< pre > < code class = "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
< / code > < / pre >
< hr / >
< h2 id = "development-version-mainline" > Development version (mainline)< / h2 >
< p > < em > Use at your own risk!< / em > < / p >
< p > To get the latest changes from the < code > master< / code > branch:< / p >
< pre > < code class = "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
< / code > < / pre >
< hr / >
< h2 id = "finish-installation" > Finish Installation< / h2 >
< p > Once Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser.< / p >
< p > < img alt = "install screenshot" src = "http://i.imgur.com/wuMpDSN.png" / > < / p >
< p > Setup your Shaarli installation, and it's ready to use!< / p >
< hr / >
< h2 id = "updating-shaarli" > Updating Shaarli< / h2 >
< p > See < a href = "../Upgrade-and-migration" > Upgrade and Migration< / a > < / p >
< / div >
< / div >
< footer >
< div class = "rst-footer-buttons" role = "navigation" aria-label = "footer navigation" >
< a href = "../Upgrade-and-migration/" class = "btn btn-neutral float-right" title = "Upgrade and migration" > Next < span class = "icon icon-circle-arrow-right" > < / span > < / a >
< a href = ".." class = "btn btn-neutral" title = "Home" > < span class = "icon icon-circle-arrow-left" > < / span > Previous< / a >
< / div >
< hr / >
< div role = "contentinfo" >
<!-- Copyright etc -->
< / div >
Built with < a href = "http://www.mkdocs.org" > MkDocs< / a > using a < a href = "https://github.com/snide/sphinx_rtd_theme" > theme< / a > provided by < a href = "https://readthedocs.org" > Read the Docs< / a > .
< / footer >
< / div >
< / div >
< / section >
< / div >
< div class = "rst-versions" role = "note" style = "cursor: pointer" >
< span class = "rst-current-version" data-toggle = "rst-current-version" >
< a href = "https://github.com/shaarli/Shaarli" class = "fa fa-github" style = "float: left; color: #fcfcfc" > GitHub< / a >
< span > < a href = ".." style = "color: #fcfcfc;" > « Previous< / a > < / span >
< span style = "margin-left: 15px" > < a href = "../Upgrade-and-migration/" style = "color: #fcfcfc" > Next » < / a > < / span >
< / span >
< / div >
< script src = "../js/theme.js" > < / script >
< / body >
< / html >
