aboutsummaryrefslogblamecommitdiffhomepage
path: root/docs/en/Administrator/download_and_install.html
blob: 127739c128fbfee1c26cfc851dc6a3e53405bd18 (plain) (tree) 
7f8f8271





































































































































































































































































1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261





































































































































































































































































                                                                                                                                                                                                                                                                                                                        
<!DOCTYPE html>
<html lang="en">
    <head>
        <meta charset="utf-8">
        <meta name="viewport" content="width=device-width, initial-scale=1">

        <title>wallabag - Download and install wallabag</title>

        <link rel="stylesheet" href="http://doc.wallabag.org/css/bootstrap.min.css">
        <link rel="stylesheet" href="http://doc.wallabag.org/css/font-awesome.min.css">
        <link rel="stylesheet" href="http://doc.wallabag.org/css/highlight.tomorrow-night.css">
        <link rel="stylesheet" href="http://doc.wallabag.org/css/main.css">
    </head>
    <body>

        <header class="navbar navbar-default navbar-fixed-top">

            <a class="navbar-brand" href="http://doc.wallabag.org/">
                wallabag
                <small class="hidden-xs hidden-sm">
                    Download and install wallabag
                </small>
            </a>
            <a href="http://doc.wallabag.org/en">EN</a> - <a href="http://doc.wallabag.org/fr">FR</a> - <a href="http://doc.wallabag.org/de">DE</a> - <a href="http://doc.wallabag.org/ru">RU</a>

            
        </header>

        <main class="container-fluid">
            <div class="row">

                
                    <nav id="sidebar" class="col-sm-3 col-lg-2" role="navigation">

                                                                                    <ul class="nav nav-pills nav-stacked">
                                    
                                    <h4 class="text-muted">
                                        
                                    </h4>

                                        <ul class="nav nav-pills nav-stacked">
                                                                                    <li class="test ">
                                                <a href="http://doc.wallabag.org/en/index.html">
                                                   Getting started
                                                </a>
                                            </li>
                                                                                    <li class="test ">
                                                <a href="http://doc.wallabag.org/en/help_wallabag.html">
                                                   Help us
                                                </a>
                                            </li>
                                                                                </ul>
                                    
                                    <h4 class="text-muted">
                                        Administrator
                                    </h4>

                                        <ul class="nav nav-pills nav-stacked">
                                                                                    <li class="test active">
                                                <a href="http://doc.wallabag.org/en/Administrator/download_and_install.html">
                                                   Download and installation
                                                </a>
                                            </li>
                                                                                    <li class="test ">
                                                <a href="http://doc.wallabag.org/en/Administrator/update.html">
                                                   Update wallabag
                                                </a>
                                            </li>
                                                                                    <li class="test ">
                                                <a href="http://doc.wallabag.org/en/Administrator/hidden_options.html">
                                                   Hidden options
                                                </a>
                                            </li>
                                                                                    <li class="test ">
                                                <a href="http://doc.wallabag.org/en/Administrator/multiusers.html">
                                                   Multi users
                                                </a>
                                            </li>
                                                                                </ul>
                                    
                                    <h4 class="text-muted">
                                        User
                                    </h4>

                                        <ul class="nav nav-pills nav-stacked">
                                                                                    <li class="test ">
                                                <a href="http://doc.wallabag.org/en/User/save_your_first_article.html">
                                                   Save your first article
                                                </a>
                                            </li>
                                                                                    <li class="test ">
                                                <a href="http://doc.wallabag.org/en/User/read_an_article.html">
                                                   Read an article
                                                </a>
                                            </li>
                                                                                    <li class="test ">
                                                <a href="http://doc.wallabag.org/en/User/organize_articles.html">
                                                   Organize articles
                                                </a>
                                            </li>
                                                                                    <li class="test ">
                                                <a href="http://doc.wallabag.org/en/User/configure_wallabag.html">
                                                   Configure wallabag
                                                </a>
                                            </li>
                                                                                    <li class="test ">
                                                <a href="http://doc.wallabag.org/en/User/search.html">
                                                   Search
                                                </a>
                                            </li>
                                                                                    <li class="test ">
                                                <a href="http://doc.wallabag.org/en/User/epub_conversion.html">
                                                   ePub conversion
                                                </a>
                                            </li>
                                                                                    <li class="test ">
                                                <a href="http://doc.wallabag.org/en/User/issue_with_article.html">
                                                   Issue with article
                                                </a>
                                            </li>
                                                                                    <li class="test ">
                                                <a href="http://doc.wallabag.org/en/User/rss_feed.html">
                                                   RSS feed
                                                </a>
                                            </li>
                                                                                    <li class="test ">
                                                <a href="http://doc.wallabag.org/en/User/import_export.html">
                                                   Import export
                                                </a>
                                            </li>
                                                                                    <li class="test ">
                                                <a href="http://doc.wallabag.org/en/User/framabag_account_creation.html">
                                                   Framabag account creation
                                                </a>
                                            </li>
                                                                                </ul>
                                    
                                    <h4 class="text-muted">
                                        Developer
                                    </h4>

                                        <ul class="nav nav-pills nav-stacked">
                                                                                    <li class="test ">
                                                <a href="http://doc.wallabag.org/en/Developer/write_config_files.html">
                                                   Write config files
                                                </a>
                                            </li>
                                                                                    <li class="test ">
                                                <a href="http://doc.wallabag.org/en/Developer/create_new_theme.html">
                                                   Create a new theme
                                                </a>
                                            </li>
                                                                                    <li class="test ">
                                                <a href="http://doc.wallabag.org/en/Developer/git_repo.html">
                                                   Git repository
                                                </a>
                                            </li>
                                                                                    <li class="test ">
                                                <a href="http://doc.wallabag.org/en/Developer/docker.html">
                                                   Docker
                                                </a>
                                            </li>
                                                                                    <li class="test ">
                                                <a href="http://doc.wallabag.org/en/Developer/vagrant.html">
                                                   Vagrant
                                                </a>
                                            </li>
                                                                                    <li class="test ">
                                                <a href="http://doc.wallabag.org/en/Developer/v2.html">
                                                   wallabag v2 / symfony2
                                                </a>
                                            </li>
                                                                                </ul>
                                                                    </ul>
                                                                                                                                                                                                                
                    </nav>

                
                <section class="col-lg-10">
                    <h1 id="download-and-install-wallabag">Download and install wallabag</h1>
<h2 id="i-dont-want-to-install-wallabag">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 <a href="https://framabag.org/">Framabag</a> wich uses our software: read the complete documentation here (TODO write Create a framabag account).</p>
<h2 id="i-want-to-install-wallabag">I want to install wallabag</h2>
<h3 id="i-want-to-download-wallabag-the-easiest-way-possible">I want to download wallabag the easiest way possible</h3>
<p><a href="http://wllbg.org/latest">Download the latest wallabag version</a> and unpack it. Copy the files on your web server. Jump off to next section.</p>
<h3 id="i-want-to-download-wallabag-via-composer">I want to download wallabag via composer</h3>
<p>You need to install composer: </p>
<pre><code>curl -s http://getcomposer.org/installer | php</code></pre>
<p>Next, on your web server, run this command: </p>
<pre><code>composer create-project wallabag/wallabag . dev-master</code></pre>
<p>All is downloaded into <code>wallabag</code> folder.</p>
<h3 id="permissions">Permissions</h3>
<p>Your web server needs a writing access to the <code>assets</code>, <code>cache</code> and <code>db</code> directories. Otherwise, a message will report that the installation is impossible.</p>
<h3 id="installation-of-wallabag-at-last">Installation of wallabag. At last.</h3>
<p>Access to wallabag from your web browser. If your server is correctly configured, you directly reach the setup screen. </p>
<h4 id="prerequisites">Prerequisites</h4>
<p>The installer will tell you which prerequisites are missing. If there's any, jump off to the <a href="#Prerequisites">corresponding session</a> to know how to deal with that problem.</p>
<h4 id="twig-installation">Twig installation</h4>
<p>wallabag is build with Twig, a template library. You have to download it for wallabag to work.</p>
<ul>
<li>One option is to choose the automatic download of the package which will be automatically downloaded and installed.</li>
<li>If this option fails, you can choose the second option which is to manually download <a href="http://wllbg.org/vendor">the vendor package</a>, unzip it and copy the vendor directory in your wallabag directory</li>
<li>
<p>Finally, you can here also use Composer to install Twig by following the commands written on screen :</p>
<pre><code>curl -s http://getcomposer.org/installer | php
php composer.phar install</code></pre>
</li>
</ul>
<h4 id="database-connection">Database connection</h4>
<p>You have to choose a database system between:</p>
<ul>
<li><strong>SQLite</strong>: The easiest system of all. No extra configuration needed.</li>
<li><strong>MySQL</strong>: A well known database system, which is in most cases more efficient than SQLite</li>
<li><strong>Postgresql</strong>: Some people found it better than MySQL.</li>
</ul>
<p><em>Note :</em> If you're using MySQL or Postgresql, you have to <strong>fill all the fields</strong>, otherwise the installation will not work and an error message will tell you what's wrong. You must create the database that you will use for wallabag manually with a tool like PHPMyAdmin or the console.</p>
<h4 id="user-account">User Account</h4>
<p>Finally, you need to create an user account. As always, be sure to choose a strong password.
An email field is present but it is not at all required.</p>
<p>If you get a green success message, it means wallabag is now installed.</p>
<h3><a name="Prerequisites"></a>Prerequisites</h3>
<h4 id="list-of-prerequisites-for-your-web-server">List of prerequisites for your web server</h4>
<ul>
<li><a href="http://php.net/manual/en/install.php">PHP 5.3.3 or more</a> <strong>with <a href="http://php.net/manual/en/book.pdo.php">PDO</a> support</strong></li>
<li><a href="http://php.net/manual/en/book.sqlite.php">SQLite</a> <strong>or</strong> <a href="http://php.net/manual/en/book.mysql.php">MySQL</a> <strong>or</strong> <a href="http://php.net/manual/en/book.pgsql.php">PostgreSQL</a></li>
<li><a href="http://php.net/en/xml">XML for PHP</a></li>
<li><a href="http://php.net/en/pcre">PCRE</a></li>
<li><a href="http://php.net/en/zlib">ZLib</a></li>
<li><a href="http://php.net/en/mbstring">mbstring</a> and/or <a href="http://php.net/en/iconv">iconv</a></li>
<li>The <a href="http://php.net/manual/en/book.dom.php">DOM/XML</a> extension</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>Optionnal:</p>
<ul>
<li><a href="http://php.net/en/curl">cURL</a> (with Parallel URL fetching) or <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.image.php">GD</a></li>
<li><a href="http://php.net/manual/en/book.filter.php">Data filtering</a></li>
</ul>
<h2 id="login">Login</h2>
<p>From your web browser, you reach the login screen: fill your username and your password to connect to your account.</p>
<p>Enjoy!</p>
                </section>

            </div>
        </main>

        <script src="//code.jquery.com/jquery-1.11.0.min.js"></script>
        <script src="//netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script>
        <script src="http://yandex.st/highlightjs/7.5/highlight.min.js"></script>

        <script>
            $(function() {
                $("section>h1").wrap('<div class="page-header" />');
                // Syntax highlighting
                hljs.initHighlightingOnLoad();
            });
        </script>

    </body>
</html>
generated by cgit v1.2.3 (git 2.25.1) at 2024-07-02 09:34:42 +0000