2015-09-04 21:25:47 +02:00
<!DOCTYPE html>
< html >
< head >
< meta charset = "utf-8" >
< meta name = "generator" content = "pandoc" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0, user-scalable=yes" >
2016-10-12 12:36:59 +02:00
< title > Shaarli – < / title >
2015-09-04 21:25:47 +02:00
< style type = "text/css" > code { white-space : pre ; } < / style >
< style type = "text/css" >
2016-04-14 14:20:23 +02:00
div.sourceCode { overflow-x: auto; }
2015-09-04 21:25:47 +02:00
table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
margin: 0; padding: 0; vertical-align: baseline; border: none; }
table.sourceCode { width: 100%; line-height: 100%; }
td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
td.sourceCode { padding-left: 5px; }
2016-04-14 14:20:23 +02:00
code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
code > span.dt { color: #902000; } /* DataType */
code > span.dv { color: #40a070; } /* DecVal */
code > span.bn { color: #40a070; } /* BaseN */
code > span.fl { color: #40a070; } /* Float */
code > span.ch { color: #4070a0; } /* Char */
code > span.st { color: #4070a0; } /* String */
code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
code > span.ot { color: #007020; } /* Other */
code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
code > span.fu { color: #06287e; } /* Function */
code > span.er { color: #ff0000; font-weight: bold; } /* Error */
code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
code > span.cn { color: #880000; } /* Constant */
code > span.sc { color: #4070a0; } /* SpecialChar */
code > span.vs { color: #4070a0; } /* VerbatimString */
code > span.ss { color: #bb6688; } /* SpecialString */
code > span.im { } /* Import */
code > span.va { color: #19177c; } /* Variable */
code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
code > span.op { color: #666666; } /* Operator */
code > span.bu { } /* BuiltIn */
code > span.ex { } /* Extension */
code > span.pp { color: #bc7a00; } /* Preprocessor */
code > span.at { color: #7d9029; } /* Attribute */
code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
2015-09-04 21:25:47 +02:00
< / style >
< link rel = "stylesheet" href = "github-markdown.css" >
2016-04-14 14:20:23 +02:00
<!-- [if lt IE 9]>
< script src = "//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js" > < / script >
<![endif]-->
2015-09-04 21:25:47 +02:00
< / head >
< body >
< div id = "local-sidebar" >
< ul >
< li > < a href = "Home.html" > Home< / a > < / li >
2016-10-12 12:36:59 +02:00
< li > Setup
2015-09-04 21:25:47 +02:00
< ul >
2016-10-12 12:36:59 +02:00
< li > < a href = "Download-and-Installation.html" > Download and Installation< / a > < / li >
< li > < a href = "Upgrade-and-migration.html" > Upgrade and migration< / a > < / li >
2015-09-04 21:25:47 +02:00
< li > < a href = "Server-requirements.html" > Server requirements< / a > < / li >
< li > < a href = "Server-configuration.html" > Server configuration< / a > < / li >
2016-04-14 14:20:23 +02:00
< li > < a href = "Server-security.html" > Server security< / a > < / li >
2015-09-04 21:25:47 +02:00
< li > < a href = "Shaarli-configuration.html" > Shaarli configuration< / a > < / li >
2016-05-14 11:37:28 +02:00
< li > < a href = "Plugins.html" > Plugins< / a > < / li >
2015-09-04 21:25:47 +02:00
< / ul > < / li >
2016-04-14 14:20:23 +02:00
< li > < a href = "Docker.html" > Docker< / a > < / li >
2015-09-04 21:25:47 +02:00
< li > < a href = "Usage.html" > Usage< / a >
< ul >
< li > < a href = "Sharing-button.html" > Sharing button< / a > (bookmarklet)< / li >
2016-04-14 14:20:23 +02:00
< li > < a href = "Browsing-and-Searching.html" > Browsing and Searching< / a > < / li >
2015-09-04 21:25:47 +02:00
< li > < a href = "Firefox-share.html" > Firefox share< / a > < / li >
< li > < a href = "RSS-feeds.html" > RSS feeds< / a > < / li >
2017-05-07 18:44:05 +02:00
< li > < a href = "REST-API.html" > REST API< / a > < / li >
2015-09-04 21:25:47 +02:00
< / ul > < / li >
< li > How To
< ul >
< li > < a href = "Backup,-restore,-import-and-export.html" > Backup, restore, import and export< / a > < / li >
< li > < a href = "Copy-an-existing-installation-over-SSH-and-serve-it-locally.html" > Copy an existing installation over SSH and serve it locally< / a > < / li >
2016-04-14 14:20:23 +02:00
< li > < a href = "Create-and-serve-multiple-Shaarlis-(farm).html" > Create and serve multiple Shaarlis (farm)< / a > < / li >
2015-09-04 21:25:47 +02:00
< li > < a href = "Download-CSS-styles-from-an-OPML-list.html" > Download CSS styles from an OPML list< / a > < / li >
< li > < a href = "Datastore-hacks.html" > Datastore hacks< / a > < / li >
< / ul > < / li >
< li > < a href = "Troubleshooting.html" > Troubleshooting< / a > < / li >
< li > < a href = "Development.html" > Development< / a >
< ul >
< li > < a href = "GnuPG-signature.html" > GnuPG signature< / a > < / li >
< li > < a href = "Coding-guidelines.html" > Coding guidelines< / a > < / li >
< li > < a href = "Directory-structure.html" > Directory structure< / a > < / li >
< li > < a href = "3rd-party-libraries.html" > 3rd party libraries< / a > < / li >
< li > < a href = "Plugin-System.html" > Plugin System< / a > < / li >
2016-04-14 14:20:23 +02:00
< li > < a href = "Release-Shaarli.html" > Release Shaarli< / a > < / li >
2017-05-07 18:44:05 +02:00
< li > < a href = "Versioning-and-Branches.html" > Versioning and Branches< / a > < / li >
2015-09-04 21:25:47 +02:00
< li > < a href = "Security.html" > Security< / a > < / li >
< li > < a href = "Static-analysis.html" > Static analysis< / a > < / li >
< li > < a href = "Theming.html" > Theming< / a > < / li >
< li > < a href = "Unit-tests.html" > Unit tests< / a > < / li >
< / ul > < / li >
< li > About
< ul >
< li > < a href = "FAQ.html" > FAQ< / a > < / li >
< li > < a href = "Community-&-Related-software.html" > Community & Related software< / a > < / li >
< / ul > < / li >
< / ul >
< / div >
2016-10-12 12:36:59 +02:00
< h1 id = "download-and-installation" > Download and Installation< / h1 >
< h1 id = "get-shaarli" > Get Shaarli!< / h1 >
< 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 > .< a href = ".html" > < / 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 >
2016-12-12 03:38:12 +01:00
< p > Get the latest released version from the < a href = "https://github.com/shaarli/Shaarli/releases" > releases< / a > page.< a href = ".html" > < / a > < / p >
< p > < strong > Download our < em > shaarli-full< / em > archive< / strong > to include dependencies.< / p >
2017-05-07 18:44:05 +02:00
< p > The current latest released version is < code > v0.8.4< / code > < / p >
2016-12-12 03:38:12 +01:00
< p > Or in command lines:< / p >
2017-05-07 18:44:05 +02:00
< div class = "sourceCode" > < pre class = "sourceCode bash" > < code class = "sourceCode bash" > $ < span class = "fu" > wget< / span > https://github.com/shaarli/Shaarli/releases/download/v0.8.4/shaarli-v0.8.4-full.zip
$ < span class = "fu" > unzip< / span > shaarli-v0.8.4-full.zip
2016-12-12 03:38:12 +01:00
$ < span class = "fu" > mv< / span > Shaarli /path/to/shaarli/< / code > < / pre > < / div >
2016-10-12 12:36:59 +02:00
< table style = "width:46%;" >
< colgroup >
< col style = "width: 8%" / >
< col style = "width: 37%" / >
< / colgroup >
< thead >
< tr class = "header" >
< 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 >
2016-12-12 03:38:12 +01:00
< h3 id = "using-git" > Using git< / h3 >
< pre > < code > mkdir -p /path/to/shaarli & & cd /path/to/shaarli/
2017-05-07 18:44:05 +02:00
git clone -b v0.8 https://github.com/shaarli/Shaarli.git .
composer install --no-dev< / code > < / pre >
2016-10-12 12:36:59 +02:00
< 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 >
< div class = "sourceCode" > < pre class = "sourceCode bash" > < code class = "sourceCode bash" > $ < span class = "fu" > wget< / span > https://github.com/shaarli/Shaarli/archive/stable.zip
$ < span class = "fu" > unzip< / span > stable.zip
$ < span class = "fu" > mv< / span > Shaarli-stable /path/to/shaarli/< / code > < / pre > < / div >
< p > As a .tar.gz archive :< / p >
< div class = "sourceCode" > < pre class = "sourceCode bash" > < code class = "sourceCode bash" > $ < span class = "fu" > wget< / span > https://github.com/shaarli/Shaarli/archive/stable.tar.gz
$ < span class = "fu" > tar< / span > xvf stable.tar.gz
$ < span class = "fu" > mv< / span > Shaarli-stable /path/to/shaarli/< / code > < / pre > < / div >
< 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.< a href = ".html" > < / a > < / p >
< div class = "sourceCode" > < pre class = "sourceCode bash" > < code class = "sourceCode bash" > $ < span class = "fu" > git< / span > clone https://github.com/shaarli/Shaarli.git -b stable /path/to/shaarli/
< span class = "co" > # install/update third-party dependencies< / span >
$ < span class = "bu" > cd< / span > /path/to/shaarli/
2017-05-07 18:44:05 +02:00
$ < span class = "ex" > composer< / span > install --no-dev< / code > < / pre > < / div >
2016-10-12 12:36:59 +02:00
< hr / >
< h2 id = "development-version-mainline" > Development version (mainline)< / h2 >
2015-09-04 21:25:47 +02:00
< p > < em > Use at your own risk!< / em > < / p >
2016-10-12 12:36:59 +02:00
< p > To get the latest changes from the < code > master< / code > branch:< / p >
< div class = "sourceCode" > < pre class = "sourceCode bash" > < code class = "sourceCode bash" > < span class = "co" > # clone the repository < / span >
2017-05-07 18:44:05 +02:00
$ < span class = "fu" > git< / span > clone https://github.com/shaarli/Shaarli.git -b master /path/to/shaarli/
2016-10-12 12:36:59 +02:00
< span class = "co" > # install/update third-party dependencies< / span >
$ < span class = "bu" > cd< / span > /path/to/shaarli
2017-05-07 18:44:05 +02:00
$ < span class = "ex" > composer< / span > install --no-dev< / code > < / pre > < / div >
2016-10-12 12:36:59 +02:00
< 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 src = "http://i.imgur.com/wuMpDSN.png" alt = "install screenshot" / > < a href = ".html" > < / a > < / 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 > < a href = ".html" > < / a > < / p >
2015-09-04 21:25:47 +02:00
< / body >
< / html >
