]>
Commit | Line | Data |
---|---|---|
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"> | |
7 | <title>Shaarli – Download and Installation</title> | |
8 | <style type="text/css">code{white-space: pre;}</style> | |
9 | <style type="text/css"> | |
10 | div.sourceCode { overflow-x: auto; } | |
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; } | |
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 */ | |
45 | </style> | |
46 | <link rel="stylesheet" href="github-markdown.css"> | |
47 | <!--[if lt IE 9]> | |
48 | <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script> | |
49 | <![endif]--> | |
50 | </head> | |
51 | <body> | |
52 | <div id="local-sidebar"> | |
53 | <ul> | |
54 | <li><a href="Home.html">Home</a></li> | |
55 | <li>Setup | |
56 | <ul> | |
57 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> | |
58 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | |
59 | <li><a href="Server-requirements.html">Server requirements</a></li> | |
60 | <li><a href="Server-configuration.html">Server configuration</a></li> | |
61 | <li><a href="Server-security.html">Server security</a></li> | |
62 | <li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> | |
63 | <li><a href="Plugins.html">Plugins</a></li> | |
64 | </ul></li> | |
65 | <li><a href="Docker.html">Docker</a></li> | |
66 | <li><a href="Usage.html">Usage</a> | |
67 | <ul> | |
68 | <li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> | |
69 | <li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li> | |
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> | |
77 | <li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li> | |
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> | |
89 | <li><a href="Release-Shaarli.html">Release Shaarli</a></li> | |
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> | |
99 | </ul></li> | |
100 | </ul> | |
101 | </div> | |
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> | |
108 | <p>Get the latest released version from the <a href="https://github.com/shaarli/Shaarli/releases">releases</a> page.<a href=".html"></a></p> | |
109 | <p>The current latest released version is <code>v0.7.0</code>.</p> | |
110 | <h3 id="download-as-an-archive">Download as an archive</h3> | |
111 | <p>As a .zip archive:</p> | |
112 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="fu">wget</span> https://github.com/shaarli/Shaarli/archive/v0.7.0.zip | |
113 | $ <span class="fu">unzip</span> Shaarli-v0.7.0.zip | |
114 | $ <span class="fu">mv</span> Shaarli-v0.7.0 /path/to/shaarli/</code></pre></div> | |
115 | <table style="width:46%;"> | |
116 | <colgroup> | |
117 | <col style="width: 8%" /> | |
118 | <col style="width: 37%" /> | |
119 | </colgroup> | |
120 | <thead> | |
121 | <tr class="header"> | |
122 | <th>!</th> | |
123 | <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> | |
124 | </tr> | |
125 | </thead> | |
126 | <tbody> | |
127 | </tbody> | |
128 | </table> | |
129 | <hr /> | |
130 | <h2 id="stable-version">Stable version</h2> | |
131 | <p>The stable version has been experienced by Shaarli users, and will receive security updates.</p> | |
132 | <h3 id="download-as-an-archive-1">Download as an archive</h3> | |
133 | <p>As a .zip archive:</p> | |
134 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="fu">wget</span> https://github.com/shaarli/Shaarli/archive/stable.zip | |
135 | $ <span class="fu">unzip</span> stable.zip | |
136 | $ <span class="fu">mv</span> Shaarli-stable /path/to/shaarli/</code></pre></div> | |
137 | <p>As a .tar.gz archive :</p> | |
138 | <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 | |
139 | $ <span class="fu">tar</span> xvf stable.tar.gz | |
140 | $ <span class="fu">mv</span> Shaarli-stable /path/to/shaarli/</code></pre></div> | |
141 | <h3 id="clone-with-git">Clone with Git</h3> | |
142 | <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> | |
143 | <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/ | |
144 | <span class="co"># install/update third-party dependencies</span> | |
145 | $ <span class="bu">cd</span> /path/to/shaarli/ | |
146 | $ <span class="ex">composer</span> update --no-dev</code></pre></div> | |
147 | <hr /> | |
148 | <h2 id="development-version-mainline">Development version (mainline)</h2> | |
149 | <p><em>Use at your own risk!</em></p> | |
150 | <p>To get the latest changes from the <code>master</code> branch:</p> | |
151 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="co"># clone the repository </span> | |
152 | $ <span class="fu">git</span> clone https://github.com/shaarli/Shaarli.git master /path/to/shaarli/ | |
153 | <span class="co"># install/update third-party dependencies</span> | |
154 | $ <span class="bu">cd</span> /path/to/shaarli | |
155 | $ <span class="ex">composer</span> update --no-dev</code></pre></div> | |
156 | <hr /> | |
157 | <h2 id="finish-installation">Finish Installation</h2> | |
158 | <p>Once Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser.</p> | |
159 | <p><img src="http://i.imgur.com/wuMpDSN.png" alt="install screenshot" /><a href=".html"></a></p> | |
160 | <p>Setup your Shaarli installation, and it's ready to use!</p> | |
161 | <hr /> | |
162 | <h2 id="updating-shaarli">Updating Shaarli</h2> | |
163 | <p>See <a href="Upgrade-and-migration">Upgrade and Migration</a><a href=".html"></a></p> | |
164 | </body> | |
165 | </html> |