lektor-website/docs/installation/index.html

297 lines
10 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=dff0aaad">
<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="#requirements">Requirements</a></li>
<li><a href="#install-pipx">Install pipx</a><ul>
<li><a href="#finally-install-lektor">Finally Install Lektor</a></li>
</ul></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 is a command line utility, and requires some terminal or command line work
to install. If you can read and follow instructions, you will most likely have no
issues.</p>
<h2 id="requirements">Requirements</h2><p>Although <code>lektor</code> would work without Imagemagick or FFmpeg, you would be missing on
significant parts of its capabilities. Therefore, you need to make sure you have the
following software installed on your computer:</p>
<ul>
<li>Python 3.6+ is required. If you got an older version, look at the
<a href="https://realpython.com/installing-python/" class="ext">Python 3 Installation &amp; Setup Guide</a>.<ul>
<li>On Ubuntu you basically don't need anything new.</li>
<li>On macOS you're done as well.</li>
<li>On Windows, make sure that Python is in your <code>PATH</code>.</li>
</ul>
</li>
<li>ImageMagick. <ul>
<li>On macOS <code>brew install imagemagick</code> can get you this.</li>
<li>On Ubuntu <code>sudo apt install imagemagick</code> will solve it.</li>
<li>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>
</li>
<li>FFmpeg (mostly for video thumbnailing).<ul>
<li>On Ubuntu you get it through <code>sudo apt install ffmpeg.</code></li>
<li>On macOS <code>brew install ffmpeg</code> will do the trick.</li>
<li>On Windows you'll have to put a little <a href="https://www.wikihow.com/Install-FFmpeg-on-Windows" class="ext">work</a> in.</li>
</ul>
</li>
</ul>
<h2 id="install-pipx">Install pipx</h2><p>Once you have those installed and have made sure that they are on your <code>PATH</code>, you can
get Lektor installed with <code>pipx</code>. Selcet the <code>pipx</code> install method of your preference:</p>
<p><strong>On Ubuntu through <code>apt</code>.</strong></p>
<pre><code>apt update
sudo apt install python3-venv pipx
pipx ensurepath
</code></pre>
<p><strong>On Ubuntu through <code>pip</code>.</strong></p>
<pre><code>sudo apt install python3-pip python3-venv
python3 -m pip install --user pipx
python3 -m pipx ensurepath
</code></pre>
<p><strong>On macOS</strong></p>
<pre><code>brew install pipx
pipx ensurepath
</code></pre>
<p><strong>On Windows</strong></p>
<pre><code>python -m pip install --user pipx
python -m pipx ensurepath
</code></pre>
<p>For more information on <code>pipx</code> installation see the <a href="https://pypa.github.io/pipx/installation/" class="ext">documentation for pipx</a></p>
<h3 id="finally-install-lektor">Finally Install Lektor</h3><p>Once installed, close terminal (or <code>Powershell</code> or <code>command prompt</code>) for those
changes to take effect. Then proceed to reopen and install Lektor with pipx:</p>
<pre><code>pipx install lektor
</code></pre>
<h2 id="pip">pip</h2><p>Alternatively you can manually install the command line version with
<code>pip</code> after creating a virtual environment, if you know how that works. <code>pipx</code> technically does this for you,
then if you need something particular and you know this will make it easier,
go for it.</p>
<pre><code>virtualenv venv
. venv/bin/activate
pip install Lektor
</code></pre>
<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=ee15141e" 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>