doc/html/Download-and-Installation/index.html

   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
 131     <a class="" href="../Docker-101/">Docker 101</a>
 132                 </li>
 133                 <li class="">
 134
 135     <a class="" href="../Shaarli-images/">Shaarli images</a>
 136                 </li>
 137                 <li class="">
 138
 139     <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
 140                 </li>
 141                 <li class="">
 142
 143     <a class="" href="../Docker-resources/">Docker resources</a>
 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
 189     <a class="" href="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a>
 190                 </li>
 191                 <li class="">
 192
 193     <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a>
 194                 </li>
 195                 <li class="">
 196
 197     <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a>
 198                 </li>
 199                 <li class="">
 200
 201     <a class="" href="../Datastore-hacks/">Datastore hacks</a>
 202                 </li>
 203     </ul>
 204             </li>
 205
 206             <li class="toctree-l1">
 207
 208     <a class="" href="../Troubleshooting/">Troubleshooting</a>
 209             </li>
 210
 211             <li class="toctree-l1">
 212
 213     <span class="caption-text">Development</span>
 214     <ul class="subnav">
 215                 <li class="">
 216
 217     <a class="" href="../Development-guidelines/">Development guidelines</a>
 218                 </li>
 219                 <li class="">
 220
 221     <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a>
 222                 </li>
 223                 <li class="">
 224
 225     <a class="" href="../GnuPG-signature/">GnuPG signature</a>
 226                 </li>
 227                 <li class="">
 228
 229     <a class="" href="../Coding-guidelines/">Coding guidelines</a>
 230                 </li>
 231                 <li class="">
 232
 233     <a class="" href="../Directory-structure/">Directory structure</a>
 234                 </li>
 235                 <li class="">
 236
 237     <a class="" href="../3rd-party-libraries/">3rd party libraries</a>
 238                 </li>
 239                 <li class="">
 240
 241     <a class="" href="../Plugin-System/">Plugin System</a>
 242                 </li>
 243                 <li class="">
 244
 245     <a class="" href="../Release-Shaarli/">Release Shaarli</a>
 246                 </li>
 247                 <li class="">
 248
 249     <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a>
 250                 </li>
 251                 <li class="">
 252
 253     <a class="" href="../Security/">Security</a>
 254                 </li>
 255                 <li class="">
 256
 257     <a class="" href="../Static-analysis/">Static analysis</a>
 258                 </li>
 259                 <li class="">
 260
 261     <a class="" href="../Theming/">Theming</a>
 262                 </li>
 263                 <li class="">
 264
 265     <a class="" href="../Unit-tests/">Unit tests</a>
 266                 </li>
 267     </ul>
 268             </li>
 269
 270             <li class="toctree-l1">
 271
 272     <span class="caption-text">About</span>
 273     <ul class="subnav">
 274                 <li class="">
 275
 276     <a class="" href="../FAQ/">FAQ</a>
 277                 </li>
 278                 <li class="">
 279
 280     <a class="" href="../Community-&-Related-software/">Community & Related software</a>
 281                 </li>
 282     </ul>
 283             </li>
 284
 285         </ul>
 286       </div>
 287       &nbsp;
 288     </nav>
 289
 290     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 291
 292
 293       <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
 294         <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 295         <a href="..">Shaarli Documentation</a>
 296       </nav>
 297
 298
 299       <div class="wy-nav-content">
 300         <div class="rst-content">
 301           <div role="navigation" aria-label="breadcrumbs navigation">
 302   <ul class="wy-breadcrumbs">
 303     <li><a href="..">Docs</a> &raquo;</li>
 304
 305
 306
 307           <li>Setup &raquo;</li>
 308
 309
 310
 311     <li>Download and Installation</li>
 312     <li class="wy-breadcrumbs-aside">
 313
 314         <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Download-and-Installation.md"
 315           class="icon icon-github"> Edit on GitHub</a>
 316
 317     </li>
 318   </ul>
 319   <hr/>
 320 </div>
 321           <div role="main">
 322             <div class="section">
 323
 324                 <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>
 325 <p>Several releases are available:</p>
 326 <hr />
 327 <h2 id="latest-release-recommended">Latest release (recommended)</h2>
 328 <h3 id="download-as-an-archive">Download as an archive</h3>
 329 <p>Get the latest released version from the <a href="https://github.com/shaarli/Shaarli/releases">releases</a> page.</p>
 330 <p><strong>Download our <em>shaarli-full</em> archive</strong> to include dependencies.</p>
 331 <p>The current latest released version is <code>v0.8.4</code></p>
 332 <p>Or in command lines:</p>
 333 <pre><code class="bash">$ wget https://github.com/shaarli/Shaarli/releases/download/v0.8.4/shaarli-v0.8.4-full.zip
 334 $ unzip shaarli-v0.8.4-full.zip
 335 $ mv Shaarli /path/to/shaarli/
 336 </code></pre>
 337
 338 <table>
 339 <thead>
 340 <tr>
 341 <th>!</th>
 342 <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>
 343 </tr>
 344 </thead>
 345 <tbody></tbody>
 346 </table>
 347 <h3 id="using-git">Using git</h3>
 348 <pre><code>mkdir -p /path/to/shaarli &amp;&amp; cd /path/to/shaarli/
 349 git clone -b v0.8 https://github.com/shaarli/Shaarli.git .
 350 composer install --no-dev
 351 </code></pre>
 352
 353 <hr />
 354 <h2 id="stable-version">Stable version</h2>
 355 <p>The stable version has been experienced by Shaarli users, and will receive security updates.</p>
 356 <h3 id="download-as-an-archive_1">Download as an archive</h3>
 357 <p>As a .zip archive:</p>
 358 <pre><code class="bash">$ wget https://github.com/shaarli/Shaarli/archive/stable.zip
 359 $ unzip stable.zip
 360 $ mv Shaarli-stable /path/to/shaarli/
 361 </code></pre>
 362
 363 <p>As a .tar.gz archive :</p>
 364 <pre><code class="bash">$ wget https://github.com/shaarli/Shaarli/archive/stable.tar.gz
 365 $ tar xvf stable.tar.gz
 366 $ mv Shaarli-stable /path/to/shaarli/
 367 </code></pre>
 368
 369 <h3 id="clone-with-git">Clone with Git</h3>
 370 <p><a href="https://getcomposer.org/">Composer</a> is required to build a functional Shaarli installation when pulling from git.</p>
 371 <pre><code class="bash">$ git clone https://github.com/shaarli/Shaarli.git -b stable /path/to/shaarli/
 372 # install/update third-party dependencies
 373 $ cd /path/to/shaarli/
 374 $ composer install --no-dev
 375 </code></pre>
 376
 377 <hr />
 378 <h2 id="development-version-mainline">Development version (mainline)</h2>
 379 <p><em>Use at your own risk!</em></p>
 380 <p>To get the latest changes from the <code>master</code> branch:</p>
 381 <pre><code class="bash"># clone the repository
 382 $ git clone https://github.com/shaarli/Shaarli.git -b master /path/to/shaarli/
 383 # install/update third-party dependencies
 384 $ cd /path/to/shaarli
 385 $ composer install --no-dev
 386 </code></pre>
 387
 388 <hr />
 389 <h2 id="finish-installation">Finish Installation</h2>
 390 <p>Once Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser.</p>
 391 <p><img alt="install screenshot" src="http://i.imgur.com/wuMpDSN.png" /></p>
 392 <p>Setup your Shaarli installation, and it's ready to use!</p>
 393 <hr />
 394 <h2 id="updating-shaarli">Updating Shaarli</h2>
 395 <p>See <a href="../Upgrade-and-migration">Upgrade and Migration</a></p>
 396
 397             </div>
 398           </div>
 399           <footer>
 400
 401     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 402
 403         <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>
 404
 405
 406         <a href=".." class="btn btn-neutral" title="Home"><span class="icon icon-circle-arrow-left"></span> Previous</a>
 407
 408     </div>
 409
 410
 411   <hr/>
 412
 413   <div role="contentinfo">
 414     <!-- Copyright etc -->
 415
 416   </div>
 417
 418   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>.
 419 </footer>
 420
 421         </div>
 422       </div>
 423
 424     </section>
 425
 426   </div>
 427
 428   <div class="rst-versions" role="note" style="cursor: pointer">
 429     <span class="rst-current-version" data-toggle="rst-current-version">
 430
 431           <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
 432
 433
 434         <span><a href=".." style="color: #fcfcfc;">&laquo; Previous</a></span>
 435
 436
 437         <span style="margin-left: 15px"><a href="../Upgrade-and-migration/" style="color: #fcfcfc">Next &raquo;</a></span>
 438
 439     </span>
 440 </div>
 441     <script src="../js/theme.js"></script>
 442
 443 </body>
 444 </html>