[github/shaarli/Shaarli.git] / doc / Download-and-Installation.html

<!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">
  <title>Shaarli – Download and Installation</title>
  <style type="text/css">code{white-space: pre;}</style>
  <style type="text/css">
div.sourceCode { overflow-x: auto; }
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; }
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 */
  </style>
  <link rel="stylesheet" href="github-markdown.css">
  <!--[if lt IE 9]>
    <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
  <![endif]-->
</head>
<body>
<div id="local-sidebar">
<ul>
<li><a href="Home.html">Home</a></li>
<li>Setup
<ul>
<li><a href="Download-and-Installation.html">Download and Installation</a></li>
<li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li>
<li><a href="Server-requirements.html">Server requirements</a></li>
<li><a href="Server-configuration.html">Server configuration</a></li>
<li><a href="Server-security.html">Server security</a></li>
<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
<li><a href="Plugins.html">Plugins</a></li>
</ul></li>
<li><a href="Docker.html">Docker</a></li>
<li><a href="Usage.html">Usage</a>
<ul>
<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
<li><a href="Firefox-share.html">Firefox share</a></li>
<li><a href="RSS-feeds.html">RSS feeds</a></li>
</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>
<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
<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>
<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
<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-&amp;-Related-software.html">Community &amp; Related software</a></li>
</ul></li>
</ul>
</div>
<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>
<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>
<p>The current latest released version is <code>v0.8.0</code></p>
<p>Or in command lines:</p>
<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.0/shaarli-v0.8.0-full.zip
$ <span class="fu">unzip</span> shaarli-v0.8.0-full.zip
$ <span class="fu">mv</span> Shaarli /path/to/shaarli/</code></pre></div>
<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>
<h3 id="using-git">Using git</h3>
<pre><code>mkdir -p /path/to/shaarli &amp;&amp; cd /path/to/shaarli/
git clone -b v0.8.0 https://github.com/shaarli/Shaarli.git .
composer update --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>
<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/
$ <span class="ex">composer</span> update --no-dev</code></pre></div>
<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>
<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="co"># clone the repository  </span>
$ <span class="fu">git</span> clone https://github.com/shaarli/Shaarli.git master /path/to/shaarli/
<span class="co"># install/update third-party dependencies</span>
$ <span class="bu">cd</span> /path/to/shaarli
$ <span class="ex">composer</span> update --no-dev</code></pre></div>
<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>
</body>
</html>
Commit	Line	Data
f8b936e7 V	1	<!DOCTYPE html>
	2	<html>
	3	<head>
	4	<meta charset="utf-8">
	5	<meta name="generator" content="pandoc">
	6	<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
fdf88d19	7	<title>Shaarli – Download and Installation</title>
f8b936e7	8	<style type="text/css">code{white-space: pre;}</style>
f8b936e7	9	<style type="text/css">
5409ade2	10	div.sourceCode { overflow-x: auto; }
f8b936e7 V	11	table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
	12	margin: 0; padding: 0; vertical-align: baseline; border: none; }
	13	table.sourceCode { width: 100%; line-height: 100%; }
	14	td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
	15	td.sourceCode { padding-left: 5px; }
5409ade2 A	16	code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
	17	code > span.dt { color: #902000; } /* DataType */
	18	code > span.dv { color: #40a070; } /* DecVal */
	19	code > span.bn { color: #40a070; } /* BaseN */
	20	code > span.fl { color: #40a070; } /* Float */
	21	code > span.ch { color: #4070a0; } /* Char */
	22	code > span.st { color: #4070a0; } /* String */
	23	code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
	24	code > span.ot { color: #007020; } /* Other */
	25	code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
	26	code > span.fu { color: #06287e; } /* Function */
	27	code > span.er { color: #ff0000; font-weight: bold; } /* Error */
	28	code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
	29	code > span.cn { color: #880000; } /* Constant */
	30	code > span.sc { color: #4070a0; } /* SpecialChar */
	31	code > span.vs { color: #4070a0; } /* VerbatimString */
	32	code > span.ss { color: #bb6688; } /* SpecialString */
	33	code > span.im { } /* Import */
	34	code > span.va { color: #19177c; } /* Variable */
	35	code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
	36	code > span.op { color: #666666; } /* Operator */
	37	code > span.bu { } /* BuiltIn */
	38	code > span.ex { } /* Extension */
	39	code > span.pp { color: #bc7a00; } /* Preprocessor */
	40	code > span.at { color: #7d9029; } /* Attribute */
	41	code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
	42	code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
	43	code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
	44	code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
f8b936e7 V	45	</style>
f8b936e7 V	46	<link rel="stylesheet" href="github-markdown.css">
5409ade2 A	47	<!--[if lt IE 9]>
	48	<script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
	49	<![endif]-->
f8b936e7 V	50	</head>
	51	<body>
	52	<div id="local-sidebar">
	53	<ul>
	54	<li><a href="Home.html">Home</a></li>
fdf88d19	55	<li>Setup
f8b936e7	56	<ul>
fdf88d19 A	57	<li><a href="Download-and-Installation.html">Download and Installation</a></li>
fdf88d19 A	58	<li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li>
f8b936e7 V	59	<li><a href="Server-requirements.html">Server requirements</a></li>
f8b936e7 V	60	<li><a href="Server-configuration.html">Server configuration</a></li>
5409ade2	61	<li><a href="Server-security.html">Server security</a></li>
f8b936e7	62	<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
08dcd8ea	63	<li><a href="Plugins.html">Plugins</a></li>
f8b936e7	64	</ul></li>
5409ade2	65	<li><a href="Docker.html">Docker</a></li>
f8b936e7 V	66	<li><a href="Usage.html">Usage</a>
	67	<ul>
	68	<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
5409ade2	69	<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
f8b936e7 V	70	<li><a href="Firefox-share.html">Firefox share</a></li>
	71	<li><a href="RSS-feeds.html">RSS feeds</a></li>
	72	</ul></li>
	73	<li>How To
	74	<ul>
	75	<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
	76	<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>
5409ade2	77	<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
f8b936e7 V	78	<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
	79	<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
	80	</ul></li>
	81	<li><a href="Troubleshooting.html">Troubleshooting</a></li>
	82	<li><a href="Development.html">Development</a>
	83	<ul>
	84	<li><a href="GnuPG-signature.html">GnuPG signature</a></li>
	85	<li><a href="Coding-guidelines.html">Coding guidelines</a></li>
	86	<li><a href="Directory-structure.html">Directory structure</a></li>
	87	<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
	88	<li><a href="Plugin-System.html">Plugin System</a></li>
5409ade2	89	<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
f8b936e7 V	90	<li><a href="Security.html">Security</a></li>
	91	<li><a href="Static-analysis.html">Static analysis</a></li>
	92	<li><a href="Theming.html">Theming</a></li>
	93	<li><a href="Unit-tests.html">Unit tests</a></li>
	94	</ul></li>
	95	<li>About
	96	<ul>
	97	<li><a href="FAQ.html">FAQ</a></li>
	98	<li><a href="Community-&-Related-software.html">Community & Related software</a></li>
f8b936e7 V	99	</ul></li>
	100	</ul>
	101	</div>
fdf88d19 A	102	<h1 id="download-and-installation">Download and Installation</h1>
	103	<h1 id="get-shaarli">Get Shaarli!</h1>
	104	<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>
	105	<p>Several releases are available:</p>
	106	<hr />
	107	<h2 id="latest-release-recommended">Latest release (recommended)</h2>
fdf88d19	108	<h3 id="download-as-an-archive">Download as an archive</h3>
3cc8c898 A	109	<p>Get the latest released version from the <a href="https://github.com/shaarli/Shaarli/releases">releases</a> page.<a href=".html"></a></p>
	110	<p><strong>Download our <em>shaarli-full</em> archive</strong> to include dependencies.</p>
	111	<p>The current latest released version is <code>v0.8.0</code></p>
	112	<p>Or in command lines:</p>
	113	<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.0/shaarli-v0.8.0-full.zip
	114	$ <span class="fu">unzip</span> shaarli-v0.8.0-full.zip
	115	$ <span class="fu">mv</span> Shaarli /path/to/shaarli/</code></pre></div>
fdf88d19 A	116	<table style="width:46%;">
	117	<colgroup>
	118	<col style="width: 8%" />
	119	<col style="width: 37%" />
	120	</colgroup>
	121	<thead>
	122	<tr class="header">
	123	<th>!</th>
	124	<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>
	125	</tr>
	126	</thead>
	127	<tbody>
	128	</tbody>
	129	</table>
3cc8c898 A	130	<h3 id="using-git">Using git</h3>
	131	<pre><code>mkdir -p /path/to/shaarli && cd /path/to/shaarli/
	132	git clone -b v0.8.0 https://github.com/shaarli/Shaarli.git .
	133	composer update --no-dev</code></pre>
fdf88d19 A	134	<hr />
	135	<h2 id="stable-version">Stable version</h2>
	136	<p>The stable version has been experienced by Shaarli users, and will receive security updates.</p>
	137	<h3 id="download-as-an-archive-1">Download as an archive</h3>
	138	<p>As a .zip archive:</p>
	139	<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="fu">wget</span> https://github.com/shaarli/Shaarli/archive/stable.zip
	140	$ <span class="fu">unzip</span> stable.zip
	141	$ <span class="fu">mv</span> Shaarli-stable /path/to/shaarli/</code></pre></div>
	142	<p>As a .tar.gz archive :</p>
	143	<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
	144	$ <span class="fu">tar</span> xvf stable.tar.gz
	145	$ <span class="fu">mv</span> Shaarli-stable /path/to/shaarli/</code></pre></div>
	146	<h3 id="clone-with-git">Clone with Git</h3>
	147	<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>
	148	<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/
	149	<span class="co"># install/update third-party dependencies</span>
	150	$ <span class="bu">cd</span> /path/to/shaarli/
	151	$ <span class="ex">composer</span> update --no-dev</code></pre></div>
	152	<hr />
	153	<h2 id="development-version-mainline">Development version (mainline)</h2>
f8b936e7	154	<p><em>Use at your own risk!</em></p>
fdf88d19 A	155	<p>To get the latest changes from the <code>master</code> branch:</p>
	156	<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="co"># clone the repository </span>
	157	$ <span class="fu">git</span> clone https://github.com/shaarli/Shaarli.git master /path/to/shaarli/
	158	<span class="co"># install/update third-party dependencies</span>
	159	$ <span class="bu">cd</span> /path/to/shaarli
	160	$ <span class="ex">composer</span> update --no-dev</code></pre></div>
	161	<hr />
	162	<h2 id="finish-installation">Finish Installation</h2>
	163	<p>Once Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser.</p>
	164	<p><img src="http://i.imgur.com/wuMpDSN.png" alt="install screenshot" /><a href=".html"></a></p>
	165	<p>Setup your Shaarli installation, and it's ready to use!</p>
	166	<hr />
	167	<h2 id="updating-shaarli">Updating Shaarli</h2>
	168	<p>See <a href="Upgrade-and-migration">Upgrade and Migration</a><a href=".html"></a></p>
f8b936e7 V	169	</body>
f8b936e7 V	170	</html>