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

<!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="">
                    
    <a class="" href="../docker/docker-101/">Docker 101</a>
                </li>
                <li class="">
                    
    <a class="" href="../docker/shaarli-images/">Shaarli images</a>
                </li>
                <li class="">
                    
    <a class="" href="../docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
                </li>
                <li class="">
                    
    <a class="" href="../docker/resources/">Docker resources</a>
                </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="">
                    
    <a class="" href="../Various-hacks/">Various hacks</a>
                </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>
      &nbsp;
    </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> &raquo;</li>
    
      
        
          <li>Setup &raquo;</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 &amp;&amp; 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;">&laquo; Previous</a></span>
      
      
        <span style="margin-left: 15px"><a href="../Upgrade-and-migration/" style="color: #fcfcfc">Next &raquo;</a></span>
      
    </span>
</div>
    <script src="../js/theme.js"></script>

</body>
</html>
Commit	Line	Data
53ed6d7d	1	<!DOCTYPE html>
	2	<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
	3	<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
	4	<head>
	5	<meta charset="utf-8">
	6	<meta http-equiv="X-UA-Compatible" content="IE=edge">
	7	<meta name="viewport" content="width=device-width, initial-scale=1.0">
	8
	9
	10	<link rel="shortcut icon" href="../img/favicon.ico">
	11	<title>Download and Installation - Shaarli Documentation</title>
	12	<link href='https://fonts.googleapis.com/css?family=Lato:400,700\|Roboto+Slab:400,700\|Inconsolata:400,700' rel='stylesheet' type='text/css'>
	13
	14	<link rel="stylesheet" href="../css/theme.css" type="text/css" />
	15	<link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
	16	<link rel="stylesheet" href="../css/highlight.css">
	17	<link href="../github-markdown.css" rel="stylesheet">
	18
	19	<script>
	20	// Current page data
	21	var mkdocs_page_name = "Download and Installation";
	22	var mkdocs_page_input_path = "Download-and-Installation.md";
	23	var mkdocs_page_url = "/Download-and-Installation/";
	24	</script>
	25
	26	<script src="../js/jquery-2.1.1.min.js"></script>
	27	<script src="../js/modernizr-2.8.3.min.js"></script>
	28	<script type="text/javascript" src="../js/highlight.pack.js"></script>
	29
	30	</head>
	31
	32	<body class="wy-body-for-nav" role="document">
	33
	34	<div class="wy-grid-for-nav">
	35
	36
	37	<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
	38	<div class="wy-side-nav-search">
	39	<a href=".." class="icon icon-home"> Shaarli Documentation</a>
	40	<div role="search">
	41	<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
	42	<input type="text" name="q" placeholder="Search docs" />
	43	</form>
	44	</div>
	45	</div>
	46
	47	<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
	48	<ul class="current">
	49
	50
	51	<li class="toctree-l1">
	52
	53	<a class="" href="..">Home</a>
	54	</li>
	55
	56	<li class="toctree-l1">
	57
	58	<span class="caption-text">Setup</span>
	59	<ul class="subnav">
	60	<li class=" current">
	61
	62	<a class="current" href="./">Download and Installation</a>
	63	<ul class="subnav">
	64
65	<li class="toctree-l3"><a href="#latest-release-recommended">Latest release (recommended)</a></li>
66
67	<ul>
68
69	<li><a class="toctree-l4" href="#download-as-an-archive">Download as an archive</a></li>
70
71	<li><a class="toctree-l4" href="#using-git">Using git</a></li>
72
73	</ul>
74
75
76	<li class="toctree-l3"><a href="#stable-version">Stable version</a></li>
77
78	<ul>
79
80	<li><a class="toctree-l4" href="#download-as-an-archive_1">Download as an archive</a></li>
81
82	<li><a class="toctree-l4" href="#clone-with-git">Clone with Git</a></li>
83
84	</ul>
85
86
87	<li class="toctree-l3"><a href="#development-version-mainline">Development version (mainline)</a></li>
88
89
90	<li class="toctree-l3"><a href="#finish-installation">Finish Installation</a></li>
91
92
93	<li class="toctree-l3"><a href="#updating-shaarli">Updating Shaarli</a></li>
94
95
96	</ul>
97	</li>
98	<li class="">
99
100	<a class="" href="../Upgrade-and-migration/">Upgrade and migration</a>
101	</li>
102	<li class="">
103
104	<a class="" href="../Server-requirements/">Server requirements</a>
105	</li>
106	<li class="">
107
108	<a class="" href="../Server-configuration/">Server configuration</a>
109	</li>
110	<li class="">
111
112	<a class="" href="../Server-security/">Server security</a>
113	</li>
114	<li class="">
115
116	<a class="" href="../Shaarli-configuration/">Shaarli configuration</a>
117	</li>
118	<li class="">
119
120	<a class="" href="../Plugins/">Plugins</a>
121	</li>
122	</ul>
123	</li>
124
125	<li class="toctree-l1">
126
127	<span class="caption-text">Docker</span>
128	<ul class="subnav">
129	<li class="">
130
3a6f91a9	131	<a class="" href="../docker/docker-101/">Docker 101</a>
53ed6d7d	132	</li>
	133	<li class="">
	134
3a6f91a9	135	<a class="" href="../docker/shaarli-images/">Shaarli images</a>
53ed6d7d	136	</li>
	137	<li class="">
	138
3a6f91a9	139	<a class="" href="../docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
53ed6d7d	140	</li>
	141	<li class="">
	142
3a6f91a9	143	<a class="" href="../docker/resources/">Docker resources</a>
53ed6d7d	144	</li>
	145	</ul>
	146	</li>
	147
	148	<li class="toctree-l1">
	149
	150	<span class="caption-text">Usage</span>
	151	<ul class="subnav">
	152	<li class="">
	153
	154	<a class="" href="../Features/">Features</a>
	155	</li>
	156	<li class="">
	157
	158	<a class="" href="../Bookmarklet/">Bookmarklet</a>
	159	</li>
	160	<li class="">
	161
	162	<a class="" href="../Browsing-and-searching/">Browsing and searching</a>
	163	</li>
	164	<li class="">
	165
	166	<a class="" href="../Firefox-share/">Firefox share</a>
	167	</li>
	168	<li class="">
	169
	170	<a class="" href="../RSS-feeds/">RSS feeds</a>
	171	</li>
	172	<li class="">
	173
	174	<a class="" href="../REST-API/">REST API</a>
	175	</li>
	176	</ul>
	177	</li>
	178
	179	<li class="toctree-l1">
	180
	181	<span class="caption-text">How To</span>
	182	<ul class="subnav">
	183	<li class="">
	184
	185	<a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a>
	186	</li>
	187	<li class="">
	188
0433c688	189	<a class="" href="../Various-hacks/">Various hacks</a>
53ed6d7d	190	</li>
	191	</ul>
	192	</li>
	193
	194	<li class="toctree-l1">
	195
	196	<a class="" href="../Troubleshooting/">Troubleshooting</a>
	197	</li>
	198
	199	<li class="toctree-l1">
	200
	201	<span class="caption-text">Development</span>
	202	<ul class="subnav">
	203	<li class="">
	204
	205	<a class="" href="../Development-guidelines/">Development guidelines</a>
	206	</li>
	207	<li class="">
	208
	209	<a class="" href="../Continuous-integration-tools/">Continuous integration tools</a>
	210	</li>
	211	<li class="">
	212
	213	<a class="" href="../GnuPG-signature/">GnuPG signature</a>
	214	</li>
	215	<li class="">
	216
	217	<a class="" href="../Coding-guidelines/">Coding guidelines</a>
	218	</li>
	219	<li class="">
	220
	221	<a class="" href="../Directory-structure/">Directory structure</a>
	222	</li>
	223	<li class="">
	224
	225	<a class="" href="../3rd-party-libraries/">3rd party libraries</a>
	226	</li>
	227	<li class="">
	228
	229	<a class="" href="../Plugin-System/">Plugin System</a>
	230	</li>
	231	<li class="">
	232
	233	<a class="" href="../Release-Shaarli/">Release Shaarli</a>
	234	</li>
	235	<li class="">
	236
	237	<a class="" href="../Versioning-and-Branches/">Versioning and Branches</a>
	238	</li>
	239	<li class="">
	240
	241	<a class="" href="../Security/">Security</a>
	242	</li>
	243	<li class="">
	244
	245	<a class="" href="../Static-analysis/">Static analysis</a>
	246	</li>
	247	<li class="">
	248
	249	<a class="" href="../Theming/">Theming</a>
	250	</li>
	251	<li class="">
	252
	253	<a class="" href="../Unit-tests/">Unit tests</a>
254	</li>
255	</ul>
256	</li>
257
258	<li class="toctree-l1">
259
260	<span class="caption-text">About</span>
261	<ul class="subnav">
262	<li class="">
263
264	<a class="" href="../FAQ/">FAQ</a>
265	</li>
266	<li class="">
267
268	<a class="" href="../Community-&-Related-software/">Community & Related software</a>
269	</li>
270	</ul>
271	</li>
272
273	</ul>
274	</div>
275
276	</nav>
277
278	<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
279
280
281	<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
282	<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
283	<a href="..">Shaarli Documentation</a>
284	</nav>
285
286
287	<div class="wy-nav-content">
288	<div class="rst-content">
289	<div role="navigation" aria-label="breadcrumbs navigation">
290	<ul class="wy-breadcrumbs">
291	<li><a href="..">Docs</a> »</li>
292
293
294
295	<li>Setup »</li>
296
297
298
299	<li>Download and Installation</li>
300	<li class="wy-breadcrumbs-aside">
301
302	<a href="https://github.com/shaarli/Shaarli/edit/master/docs/Download-and-Installation.md"
303	class="icon icon-github"> Edit on GitHub</a>
304
305	</li>
306	</ul>
307	<hr/>
308	</div>
309	<div role="main">
310	<div class="section">
311
312	<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>
313	<p>Several releases are available:</p>
314	<hr />
315	<h2 id="latest-release-recommended">Latest release (recommended)</h2>
316	<h3 id="download-as-an-archive">Download as an archive</h3>
317	<p>Get the latest released version from the <a href="https://github.com/shaarli/Shaarli/releases">releases</a> page.</p>
318	<p><strong>Download our <em>shaarli-full</em> archive</strong> to include dependencies.</p>
319	<p>The current latest released version is <code>v0.8.4</code></p>
320	<p>Or in command lines:</p>
321	<pre><code class="bash">$ wget https://github.com/shaarli/Shaarli/releases/download/v0.8.4/shaarli-v0.8.4-full.zip
322	$ unzip shaarli-v0.8.4-full.zip
323	$ mv Shaarli /path/to/shaarli/
324	</code></pre>
325
326	<table>
327	<thead>
328	<tr>
329	<th>!</th>
330	<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>
331	</tr>
332	</thead>
333	<tbody></tbody>
334	</table>
335	<h3 id="using-git">Using git</h3>
336	<pre><code>mkdir -p /path/to/shaarli && cd /path/to/shaarli/
337	git clone -b v0.8 https://github.com/shaarli/Shaarli.git .
338	composer install --no-dev
339	</code></pre>
340
341	<hr />
342	<h2 id="stable-version">Stable version</h2>
343	<p>The stable version has been experienced by Shaarli users, and will receive security updates.</p>
344	<h3 id="download-as-an-archive_1">Download as an archive</h3>
345	<p>As a .zip archive:</p>
346	<pre><code class="bash">$ wget https://github.com/shaarli/Shaarli/archive/stable.zip
347	$ unzip stable.zip
348	$ mv Shaarli-stable /path/to/shaarli/
349	</code></pre>
350
351	<p>As a .tar.gz archive :</p>
352	<pre><code class="bash">$ wget https://github.com/shaarli/Shaarli/archive/stable.tar.gz
353	$ tar xvf stable.tar.gz
354	$ mv Shaarli-stable /path/to/shaarli/
355	</code></pre>
356
357	<h3 id="clone-with-git">Clone with Git</h3>
358	<p><a href="https://getcomposer.org/">Composer</a> is required to build a functional Shaarli installation when pulling from git.</p>
359	<pre><code class="bash">$ git clone https://github.com/shaarli/Shaarli.git -b stable /path/to/shaarli/
360	# install/update third-party dependencies
361	$ cd /path/to/shaarli/
362	$ composer install --no-dev
363	</code></pre>
364
365	<hr />
366	<h2 id="development-version-mainline">Development version (mainline)</h2>
367	<p><em>Use at your own risk!</em></p>
368	<p>To get the latest changes from the <code>master</code> branch:</p>
369	<pre><code class="bash"># clone the repository
370	$ git clone https://github.com/shaarli/Shaarli.git -b master /path/to/shaarli/
371	# install/update third-party dependencies
372	$ cd /path/to/shaarli
373	$ composer install --no-dev
374	</code></pre>
375
376	<hr />
377	<h2 id="finish-installation">Finish Installation</h2>
378	<p>Once Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser.</p>
379	<p><img alt="install screenshot" src="http://i.imgur.com/wuMpDSN.png" /></p>
380	<p>Setup your Shaarli installation, and it's ready to use!</p>
381	<hr />
382	<h2 id="updating-shaarli">Updating Shaarli</h2>
383	<p>See <a href="../Upgrade-and-migration">Upgrade and Migration</a></p>
384
385	</div>
386	</div>
387	<footer>
388
389	<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
390
391	<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>
392
393
394	<a href=".." class="btn btn-neutral" title="Home"><span class="icon icon-circle-arrow-left"></span> Previous</a>
395
396	</div>
397
398
399	<hr/>
400
401	<div role="contentinfo">
402	<!-- Copyright etc -->
403
404	</div>
405
406	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>.
407	</footer>
408
409	</div>
410	</div>
411
412	</section>
413
414	</div>
415
416	<div class="rst-versions" role="note" style="cursor: pointer">
417	<span class="rst-current-version" data-toggle="rst-current-version">
418
419	<a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
420
421
422	<span><a href=".." style="color: #fcfcfc;">« Previous</a></span>
423
424
425	<span style="margin-left: 15px"><a href="../Upgrade-and-migration/" style="color: #fcfcfc">Next »</a></span>
426
427	</span>
428	</div>
429	<script src="../js/theme.js"></script>
430
431	</body>
432	</html>