wallabag/docs/en/User_documentation/Download_and_install.html

122 lines
7.9 KiB
HTML
Raw Normal View History

2014-11-04 08:33:05 +01:00
<!DOCTYPE html>
<!--[if lt IE 7]> <html class="no-js ie6 oldie" lang="en"> <![endif]-->
<!--[if IE 7]> <html class="no-js ie7 oldie" lang="en"> <![endif]-->
<!--[if IE 8]> <html class="no-js ie8 oldie" lang="en"> <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en"> <!--<![endif]-->
<head>
<title>Download and install</title>
2014-11-24 13:46:39 +01:00
<meta charset="utf-8">
2014-11-04 08:33:05 +01:00
<meta name="description" content="Documentation for wallabag" />
<meta name="author" content="Nicolas Lœuillet">
<link rel="icon" href="../../templates/default/themes/daux-blue/img/favicon-blue.png" type="image/x-icon">
<!-- Mobile -->
<meta name="apple-mobile-web-app-capable" content="yes" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<!-- Font -->
2014-11-24 13:46:39 +01:00
2014-11-04 08:33:05 +01:00
<!-- CSS -->
<link href='../../templates/default/themes/daux-blue/css/daux-blue.css' rel='stylesheet' type='text/css'>
</head>
<body>
<!-- Docs -->
<div class="container-fluid fluid-height wrapper">
<div class="navbar navbar-fixed-top hidden-print">
<div class="container-fluid">
<a class="brand navbar-brand pull-left" href="../../index.html">wallabag</a>
<p class="navbar-text pull-right">Generated by <a href="http://daux.io">Daux.io</a></p>
</div>
</div>
<div class="row columns content">
<div class="left-column article-tree col-sm-3 hidden-print">
<!-- For Mobile -->
<div class="responsive-collapse">
<button type="button" class="btn btn-sidebar" id="menu-spinner-button">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
</div>
<div id="sub-nav-collapse" class="sub-nav-collapse">
<!-- Navigation -->
2014-11-24 13:46:39 +01:00
<ul class="nav nav-list"><li><a href="../../en/Getting_started.html">Getting started</a></li><li><a href="../../en/Help_wallabag.html">Help wallabag</a></li><li class="open"><a href="#" class="aj-nav folder">User documentation</a><ul class="nav nav-list"><li class="active"><a href="../../en/User_documentation/Download_and_install.html">Download and install</a></li><li><a href="../../en/User_documentation/Save_your_first_article.html">Save your first article</a></li><li><a href="../../en/User_documentation/Configure_wallabag.html">Configure wallabag</a></li><li><a href="../../en/User_documentation/Hidden_options.html">Hidden options</a></li></ul></li></ul> <div class="well well-sidebar">
2014-11-04 08:33:05 +01:00
<!-- Links -->
<a href="https://www.wallabag.org/downloads" target="_blank">Download</a><br><a href="https://github.com/wallabag/wallabag" target="_blank">GitHub Repo</a><br><a href="http://support.wallabag.org" target="_blank">Help</a><br><a href="https://github.com/wallabag/documentation/graphs/contributors" target="_blank">Documentation contributors</a><br>
<!-- Twitter -->
</div>
</div>
</div>
<div class="right-column content-area col-sm-9">
<div class="content-page">
<article>
<div class="page-header sub-header clearfix">
2014-11-24 13:46:39 +01:00
<h1>Download and install <a href="https://github.com/wallabag/documentation/blob/master/en/02_User_documentation/02_Download_and_install.md" class="btn">Fix this page</a> </h1>
2014-11-04 08:33:05 +01:00
<span style="float: left; font-size: 10px; color: gray;">
2014-11-24 13:46:39 +01:00
Sunday, November 16, 2014 </span>
2014-11-04 08:33:05 +01:00
<span style="float: right; font-size: 10px; color: gray;">
2014-11-24 13:46:39 +01:00
9:22 PM </span>
2014-11-04 08:33:05 +01:00
</div>
<h2>I don't want to install wallabag</h2>
<p>If you can't or don't want to install Wallabag on your server, we suggest you create a free account on Framabag wich uses our software: read the complete documentation here (TODO write Create a framabag account).</p>
<h2>I want to install wallabag</h2>
<p><a href="http://www.wallabag.org/download">Download the latest wallabag version</a> and unpack it. Copy the files on your web server.</p>
<h2>Prerequisites for your web server</h2>
<ul>
<li><a href="http://php.net/manual/en/install.php">PHP 5.3.3 or more</a></li>
<li><a href="http://php.net/manual/en/book.sqlite.php">SQLite</a> or <a href="http://php.net/manual/fr/book.mysql.php">MySQL</a> or <a href="http://php.net/manual/en/book.pgsql.php">PostgreSQL</a></li>
<li><a href="http://php.net/xml">XML for PHP</a></li>
<li><a href="http://php.net/pcre">PCRE</a></li>
<li><a href="http://php.net/manual/book.filter.php">Data filtering</a></li>
<li><a href="http://php.net/tidy">Tidy for PHP</a></li>
<li><a href="http://php.net/curl">cURL</a></li>
<li><a href="http://www.php.net/manual/en/filesystem.configuration.php#ini.allow-url-fopen">allow_url_fopen</a></li>
<li><a href="http://php.net/manual/en/book.gettext.php">gettext</a></li>
</ul>
<p>To ensure that your server has all the prerequisites, you can run the file <code>wallabag_compatibility_test.php</code> that is located in the <code>install</code> directory of wallabag.</p>
<h2>Installation of the dependencies</h2>
<p>In order to work properly, wallabag needs some dependencies. To install them, you have to use <code>composer</code>. In your wallabag folder, run the following commands:</p>
<pre><code>curl -s http://getcomposer.org/installer | php
php composer.phar install</code></pre>
<p>If you can't install <code>composer</code> (In order to work properly, Wallabag needs some dependencies), we provide you a <a href="http://wllbg.org/vendor">vendor.zip</a> file to unpack in your wallabag directory. </p>
<h2>Permissions</h2>
<p>Your web server needs a writing access in <code>assets</code>, <code>cache</code> and <code>db</code> directory. Otherwise, a message will report that the installation is impossible.</p>
<h2>Installation of wallabag. At last.</h2>
<p>Access to wallabag from your web browser. If your server is correctly configured, you reach the setup screen. </p>
2014-11-24 13:46:39 +01:00
<p>Fill your database type (<code>sqlite</code>, <code>mysql</code> or <code>postgresql</code>) and finally the information for your user account.</p>
2014-11-04 08:33:05 +01:00
<p>wallabag is now installed. </p>
<h2>Login</h2>
<p>From your web browser, you reach the login screen : fill your username and your password to connect to your account.</p>
2014-11-24 13:46:39 +01:00
<p>Enjoy!</p>
</article>
2014-11-04 08:33:05 +01:00
</div>
</div>
</div>
</div>
<!-- jQuery -->
<script src="//ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js"></script>
<script>
if (typeof jQuery == 'undefined')
document.write(unescape("%3Cscript src='../../js/jquery-1.11.0.min.js' type='text/javascript'%3E%3C/script%3E"));
</script>
<!-- hightlight.js -->
<script src="../../js/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
<!-- JS -->
<!-- Front end file editor -->
<script src="../../js/custom.js"></script>
<!--[if lt IE 9]>
<script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
</body>
</html>