lektor-website/docs/installation/index.html

283 lines
11 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="ie=edge">
<link rel="stylesheet" href="../../static/styles.css?h=7041cc50">
<link rel="stylesheet" href="../../static/pygments.css">
<link rel="shortcut icon" href="../../static/favicon.png?h=fa09bedd">
<title>Installation | Documentation | Lektor Static Content Management System</title>
</head>
<body class="default">
<nav class="navbar navbar-inverse navbar-static-top">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed"
data-toggle="collapse" data-target="#navbar"
aria-expanded="false" aria-controls="navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../../">Lektor</a>
</div>
<div id="navbar" class="collapse navbar-collapse">
<ul class="nav navbar-nav">
<li><a href="../../downloads/">Download</a></li>
<li class="active"><a href="../">Documentation</a></li>
<li><a href="../../showcase/">Showcase</a></li>
<li><a href="../../plugins/">Plugins</a></li>
<li><a href="../../community/">Community</a></li>
<li><a href="../../blog/">Blog</a></li>
</ul>
</div>
</div>
</nav>
<div class="body-wrapper">
<div class="container">
<div class="row">
<div class="col-sm-3">
<ul class="tree-nav nocontent">
<li><a href="../">Welcome</a></li>
<li><a href="../what/">What is Lektor</a>
<li class="active"><a href="./">Installation</a>
<ul></ul>
<li><a href="../quickstart/">Quickstart</a>
<li><a href="../project/">Project</a>
<li><a href="../content/">Content</a>
<li><a href="../templates/">Templates</a>
<li><a href="../themes/">Themes</a>
<li><a href="../guides/">Guides</a>
<li><a href="../deployment/">Deployment</a>
<li><a href="../plugins/">Plugins</a>
<li><a href="../models/">Data Modelling</a>
<li><a href="../cli/">Command Line</a>
<li><a href="../api/">API</a>
<li><a href="../search/">Search</a>
</ul>
<div class="visible-md-block visible-lg-block">
<h4>This Page</h4>
<ul class="toc">
<li><a href="#desktop-application">Desktop Application</a></li>
<li><a href="#command-line-application">Command Line Application</a></li>
<li><a href="#pip">pip</a></li>
<li><a href="#development-version">Development Version</a></li>
</ul>
</div>
</div>
<div class="col-sm-9 doc-styling">
<h1>Installation</h1>
<ul class=page-meta>
</ul>
<p>Lektor comes in two flavors: as a command line executable and as a
desktop application. The desktop version also contains the command
line executable, but it also bundles together all dependencies of Lektor
in an easy to use package which heavily simplifies installation.</p>
<h2 id="desktop-application">Desktop Application</h2><div class="admonition admonition-info"><p>Info: Support for the Mac Desktop Application is paused as of version 3.1. See <a href="/blog/2018/1/lektor-31-released/#support-for-mac-installer-paused">note</a>.</p></div><p>Currently the desktop application is only available for OS X and can be
<a href="../../downloads/">downloaded from the Lektor website</a>. It comes as a downloadable
disk image that you can mount which contains one application by the name of
<code>Lektor.app</code>. Just drag it into your <code>Applications</code> folder and you are good to
go.</p>
<p>If you also want access to the command line tools just launch <code>Lektor.app</code>
and then click in the menu bar on <em>Lektor ➤ Install Shell Command</em>.</p>
<h2 id="command-line-application">Command Line Application</h2><p>If you do not want to install the desktop app then you can just install the command
line executable. This runs on most operating systems (OSX, Linux and Windows) but
the installation is a bit more involved.</p>
<p>You need to make sure you have the following software installed on your computer:</p>
<ul>
<li>Python 3 is recommended (but 2.7 is also supported)
On Ubuntu <code>python3-dev</code>, <code>libssl-dev</code> and <code>libffi-dev</code> are also required
<code>sudo apt-get install python3-dev libssl-dev libffi-dev</code></li>
<li>ImageMagick (<code>brew install imagemagick</code> can get you this on OS X and <code>sudo apt-get install imagemagick</code>
on Ubuntu the <code>imagemagick</code> package needs to be installed.
On Windows do <code>choco install imagemagick</code>, which requires <a href="https://chocolatey.org/" class="ext">chocolatey</a>,
or <a href="http://www.imagemagick.org" class="ext">download from here</a>).</li>
</ul>
<p>Once you have those installed and have made sure that they are on your <code>PATH</code>, you can
get Lektor installed with our installation script:</p>
<pre><code># curl -sf https://www.getlektor.com/installer.py | python3
</code></pre>
<p>This will attempt to install lektor in your user's <code>HOME</code>. If you want a system-wide installation, try this instead:</p>
<pre><code>$ curl -sf https://www.getlektor.com/installer.py | sudo python3
</code></pre>
<p>If you would like to install Lektor without being prompted, set LEKTOR_SILENT before running the prior command.</p>
<p>For Windows, make sure that Python is in your <code>PATH</code> and run in <code>Powershell</code>:</p>
<pre><code>PS C:\&gt; (new-object net.webclient).DownloadString('https://www.getlektor.com/installer.py') | python
</code></pre>
<p>or you can use the <code>command prompt</code> instead:</p>
<pre><code>C:\&gt; @powershell -NoProfile -Command "(new-object net.webclient).DownloadString('https://www.getlektor.com/installer.py') | python"
</code></pre>
<h2 id="pip">pip</h2><p>Alternatively you can manually install the command line version with
<code>virtualenv</code> if you know how that works. Note that this method is <em>heavily
discouraged</em> for anything other than advanced use cases such as build servers.</p>
<pre><code>$ virtualenv venv
$ . venv/bin/activate
$ pip install Lektor
</code></pre>
<div class="admonition admonition-warning"><p>When we say this installation type is discouraged we mean it. The reason
is that it encourages uses of Lektor which are entirely unsupported by us.
Lektor actively manages virtualenvs for plugin installations in very specific
ways and this might or might not work in your setup. We support pip
installations for deployment environments and local development only.</p></div><h2 id="development-version">Development Version</h2><p>If you want to install the development version of Lektor you can do so. It's
the same as with installing the command line application but instead of
using PyPI you install directly from git and you need to have <code>npm</code> installed
to build the admin UI:</p>
<pre><code>$ git clone https://github.com/lektor/lektor
$ cd lektor
$ make build-js
$ virtualenv venv
$ . venv/bin/activate
$ pip install --editable .
</code></pre>
<div class="comment-box">
<h2>Comments</h2>
<div id="disqus_thread"></div>
<script>
var disqus_config = function() { this.page.identifier = "/docs/installation"; this.page.url = "https://www.getlektor.com/docs/installation/"; };
(function() {
var d = document, s = d.createElement('script');
s.src = '//lektordocumentation.disqus.com/embed.js';
s.setAttribute('data-timestamp', +new Date());
(d.head || d.body).appendChild(s);
})();
</script>
<noscript>
Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript"
rel="nofollow">comments powered by Disqus.</a>
</noscript>
</div>
</div>
</div>
</div>
</div>
<div class="bottomsummary">
<div class="container">
</div>
</div>
<footer>
<div class="container">
<div class="row">
<div class="col-sm-4 icon-bar">
<a href="https://github.com/lektor/lektor/" title="Lektor on GitHub"
><i class="fa fa-github"></i></a>
<a href="https://github.com/lektor/lektor/issues/" title="Report Issues for Lektor"
><i class="fa fa-bug"></i></a>
<a href="https://twitter.com/getlektor" title="Find Lektor on Twitter"
><i class="fa fa-twitter"></i></a>
<a href="https://gitter.im/lektor/lektor" title="Chat on Gitter"
><i class="fa fa-comment"></i></a>
<a href="https://github.com/lektor/lektor-website/tree/master/content/docs/installation/contents.lr" title="View source for this page"><i class="fa fa-code"></i></a>
</div>
<div class="col-sm-8">
<a href="../../license/">License & Copyright</a>
<a href="../../contact/">Contact</a>
Made with <i class="fa fa-fw fa-heart" title="Heart"><span hidden>Heart</span></i> in Carinthia
</div>
</div>
</div>
</footer>
<script type=text/javascript src="../../static/app.js?h=d85eb4b1" charset="utf-8"></script>
<script>
((window.gitter = {}).chat = {}).options = {
room: 'lektor/lektor',
activationElement: null
};
document.write('<button class="js-gitter-toggle-chat-button">Toggle Chat</button>');
var dnt = navigator.doNotTrack || window.doNotTrack || navigator.msDoNotTrack;
if (dnt != "1" && dnt != "yes") {
window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date;
ga('create', 'UA-70822533-1', 'auto');
ga('set', 'anonymizeIp', true);
ga('send', 'pageview');
} else {
console.debug("Respecting Do-Not-Track, not running analytics.");
}
</script>
<script async src='https://www.google-analytics.com/analytics.js'></script>
<script async defer id="github-bjs" src="https://buttons.github.io/buttons.js"></script>
<script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script>
<script src="https://sidecar.gitter.im/dist/sidecar.v1.js" async defer></script>
</body>
</html>