diff options
author | Nicolas LÅ“uillet <nicolas@loeuillet.org> | 2015-08-03 13:21:11 +0200 |
---|---|---|
committer | Nicolas LÅ“uillet <nicolas@loeuillet.org> | 2015-08-03 13:21:11 +0200 |
commit | c766284d522206578e7ec154961e0fce456f70c8 (patch) | |
tree | a5246151bf8278a0e8053b9dd1ce9d770073c50b /docs/en/Administrator | |
parent | c0cb52c07439c974075c302a190a034a8cce4f92 (diff) | |
parent | e968ec6c2244aee600358b3c87648b2409c97945 (diff) | |
download | wallabag-c766284d522206578e7ec154961e0fce456f70c8.tar.gz wallabag-c766284d522206578e7ec154961e0fce456f70c8.tar.zst wallabag-c766284d522206578e7ec154961e0fce456f70c8.zip |
Merge pull request #1267 from wallabag/dev1.9.1
1.9.1
Diffstat (limited to 'docs/en/Administrator')
-rw-r--r-- | docs/en/Administrator/download_and_install.html | 261 | ||||
-rw-r--r-- | docs/en/Administrator/hidden_options.html | 231 | ||||
-rw-r--r-- | docs/en/Administrator/multiusers.html | 200 | ||||
-rw-r--r-- | docs/en/Administrator/update.html | 210 |
4 files changed, 902 insertions, 0 deletions
diff --git a/docs/en/Administrator/download_and_install.html b/docs/en/Administrator/download_and_install.html new file mode 100644 index 00000000..127739c1 --- /dev/null +++ b/docs/en/Administrator/download_and_install.html | |||
@@ -0,0 +1,261 @@ | |||
1 | <!DOCTYPE html> | ||
2 | <html lang="en"> | ||
3 | <head> | ||
4 | <meta charset="utf-8"> | ||
5 | <meta name="viewport" content="width=device-width, initial-scale=1"> | ||
6 | |||
7 | <title>wallabag - Download and install wallabag</title> | ||
8 | |||
9 | <link rel="stylesheet" href="http://doc.wallabag.org/css/bootstrap.min.css"> | ||
10 | <link rel="stylesheet" href="http://doc.wallabag.org/css/font-awesome.min.css"> | ||
11 | <link rel="stylesheet" href="http://doc.wallabag.org/css/highlight.tomorrow-night.css"> | ||
12 | <link rel="stylesheet" href="http://doc.wallabag.org/css/main.css"> | ||
13 | </head> | ||
14 | <body> | ||
15 | |||
16 | <header class="navbar navbar-default navbar-fixed-top"> | ||
17 | |||
18 | <a class="navbar-brand" href="http://doc.wallabag.org/"> | ||
19 | wallabag | ||
20 | <small class="hidden-xs hidden-sm"> | ||
21 | Download and install wallabag | ||
22 | </small> | ||
23 | </a> | ||
24 | <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> | ||
25 | |||
26 | |||
27 | </header> | ||
28 | |||
29 | <main class="container-fluid"> | ||
30 | <div class="row"> | ||
31 | |||
32 | |||
33 | <nav id="sidebar" class="col-sm-3 col-lg-2" role="navigation"> | ||
34 | |||
35 | <ul class="nav nav-pills nav-stacked"> | ||
36 | |||
37 | <h4 class="text-muted"> | ||
38 | |||
39 | </h4> | ||
40 | |||
41 | <ul class="nav nav-pills nav-stacked"> | ||
42 | <li class="test "> | ||
43 | <a href="http://doc.wallabag.org/en/index.html"> | ||
44 | Getting started | ||
45 | </a> | ||
46 | </li> | ||
47 | <li class="test "> | ||
48 | <a href="http://doc.wallabag.org/en/help_wallabag.html"> | ||
49 | Help us | ||
50 | </a> | ||
51 | </li> | ||
52 | </ul> | ||
53 | |||
54 | <h4 class="text-muted"> | ||
55 | Administrator | ||
56 | </h4> | ||
57 | |||
58 | <ul class="nav nav-pills nav-stacked"> | ||
59 | <li class="test active"> | ||
60 | <a href="http://doc.wallabag.org/en/Administrator/download_and_install.html"> | ||
61 | Download and installation | ||
62 | </a> | ||
63 | </li> | ||
64 | <li class="test "> | ||
65 | <a href="http://doc.wallabag.org/en/Administrator/update.html"> | ||
66 | Update wallabag | ||
67 | </a> | ||
68 | </li> | ||
69 | <li class="test "> | ||
70 | <a href="http://doc.wallabag.org/en/Administrator/hidden_options.html"> | ||
71 | Hidden options | ||
72 | </a> | ||
73 | </li> | ||
74 | <li class="test "> | ||
75 | <a href="http://doc.wallabag.org/en/Administrator/multiusers.html"> | ||
76 | Multi users | ||
77 | </a> | ||
78 | </li> | ||
79 | </ul> | ||
80 | |||
81 | <h4 class="text-muted"> | ||
82 | User | ||
83 | </h4> | ||
84 | |||
85 | <ul class="nav nav-pills nav-stacked"> | ||
86 | <li class="test "> | ||
87 | <a href="http://doc.wallabag.org/en/User/save_your_first_article.html"> | ||
88 | Save your first article | ||
89 | </a> | ||
90 | </li> | ||
91 | <li class="test "> | ||
92 | <a href="http://doc.wallabag.org/en/User/read_an_article.html"> | ||
93 | Read an article | ||
94 | </a> | ||
95 | </li> | ||
96 | <li class="test "> | ||
97 | <a href="http://doc.wallabag.org/en/User/organize_articles.html"> | ||
98 | Organize articles | ||
99 | </a> | ||
100 | </li> | ||
101 | <li class="test "> | ||
102 | <a href="http://doc.wallabag.org/en/User/configure_wallabag.html"> | ||
103 | Configure wallabag | ||
104 | </a> | ||
105 | </li> | ||
106 | <li class="test "> | ||
107 | <a href="http://doc.wallabag.org/en/User/search.html"> | ||
108 | Search | ||
109 | </a> | ||
110 | </li> | ||
111 | <li class="test "> | ||
112 | <a href="http://doc.wallabag.org/en/User/epub_conversion.html"> | ||
113 | ePub conversion | ||
114 | </a> | ||
115 | </li> | ||
116 | <li class="test "> | ||
117 | <a href="http://doc.wallabag.org/en/User/issue_with_article.html"> | ||
118 | Issue with article | ||
119 | </a> | ||
120 | </li> | ||
121 | <li class="test "> | ||
122 | <a href="http://doc.wallabag.org/en/User/rss_feed.html"> | ||
123 | RSS feed | ||
124 | </a> | ||
125 | </li> | ||
126 | <li class="test "> | ||
127 | <a href="http://doc.wallabag.org/en/User/import_export.html"> | ||
128 | Import export | ||
129 | </a> | ||
130 | </li> | ||
131 | <li class="test "> | ||
132 | <a href="http://doc.wallabag.org/en/User/framabag_account_creation.html"> | ||
133 | Framabag account creation | ||
134 | </a> | ||
135 | </li> | ||
136 | </ul> | ||
137 | |||
138 | <h4 class="text-muted"> | ||
139 | Developer | ||
140 | </h4> | ||
141 | |||
142 | <ul class="nav nav-pills nav-stacked"> | ||
143 | <li class="test "> | ||
144 | <a href="http://doc.wallabag.org/en/Developer/write_config_files.html"> | ||
145 | Write config files | ||
146 | </a> | ||
147 | </li> | ||
148 | <li class="test "> | ||
149 | <a href="http://doc.wallabag.org/en/Developer/create_new_theme.html"> | ||
150 | Create a new theme | ||
151 | </a> | ||
152 | </li> | ||
153 | <li class="test "> | ||
154 | <a href="http://doc.wallabag.org/en/Developer/git_repo.html"> | ||
155 | Git repository | ||
156 | </a> | ||
157 | </li> | ||
158 | <li class="test "> | ||
159 | <a href="http://doc.wallabag.org/en/Developer/docker.html"> | ||
160 | Docker | ||
161 | </a> | ||
162 | </li> | ||
163 | <li class="test "> | ||
164 | <a href="http://doc.wallabag.org/en/Developer/vagrant.html"> | ||
165 | Vagrant | ||
166 | </a> | ||
167 | </li> | ||
168 | <li class="test "> | ||
169 | <a href="http://doc.wallabag.org/en/Developer/v2.html"> | ||
170 | wallabag v2 / symfony2 | ||
171 | </a> | ||
172 | </li> | ||
173 | </ul> | ||
174 | </ul> | ||
175 | |||
176 | </nav> | ||
177 | |||
178 | |||
179 | <section class="col-lg-10"> | ||
180 | <h1 id="download-and-install-wallabag">Download and install wallabag</h1> | ||
181 | <h2 id="i-dont-want-to-install-wallabag">I don't want to install wallabag</h2> | ||
182 | <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> | ||
183 | <h2 id="i-want-to-install-wallabag">I want to install wallabag</h2> | ||
184 | <h3 id="i-want-to-download-wallabag-the-easiest-way-possible">I want to download wallabag the easiest way possible</h3> | ||
185 | <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> | ||
186 | <h3 id="i-want-to-download-wallabag-via-composer">I want to download wallabag via composer</h3> | ||
187 | <p>You need to install composer: </p> | ||
188 | <pre><code>curl -s http://getcomposer.org/installer | php</code></pre> | ||
189 | <p>Next, on your web server, run this command: </p> | ||
190 | <pre><code>composer create-project wallabag/wallabag . dev-master</code></pre> | ||
191 | <p>All is downloaded into <code>wallabag</code> folder.</p> | ||
192 | <h3 id="permissions">Permissions</h3> | ||
193 | <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> | ||
194 | <h3 id="installation-of-wallabag-at-last">Installation of wallabag. At last.</h3> | ||
195 | <p>Access to wallabag from your web browser. If your server is correctly configured, you directly reach the setup screen. </p> | ||
196 | <h4 id="prerequisites">Prerequisites</h4> | ||
197 | <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> | ||
198 | <h4 id="twig-installation">Twig installation</h4> | ||
199 | <p>wallabag is build with Twig, a template library. You have to download it for wallabag to work.</p> | ||
200 | <ul> | ||
201 | <li>One option is to choose the automatic download of the package which will be automatically downloaded and installed.</li> | ||
202 | <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> | ||
203 | <li> | ||
204 | <p>Finally, you can here also use Composer to install Twig by following the commands written on screen :</p> | ||
205 | <pre><code>curl -s http://getcomposer.org/installer | php | ||
206 | php composer.phar install</code></pre> | ||
207 | </li> | ||
208 | </ul> | ||
209 | <h4 id="database-connection">Database connection</h4> | ||
210 | <p>You have to choose a database system between:</p> | ||
211 | <ul> | ||
212 | <li><strong>SQLite</strong>: The easiest system of all. No extra configuration needed.</li> | ||
213 | <li><strong>MySQL</strong>: A well known database system, which is in most cases more efficient than SQLite</li> | ||
214 | <li><strong>Postgresql</strong>: Some people found it better than MySQL.</li> | ||
215 | </ul> | ||
216 | <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> | ||
217 | <h4 id="user-account">User Account</h4> | ||
218 | <p>Finally, you need to create an user account. As always, be sure to choose a strong password. | ||
219 | An email field is present but it is not at all required.</p> | ||
220 | <p>If you get a green success message, it means wallabag is now installed.</p> | ||
221 | <h3><a name="Prerequisites"></a>Prerequisites</h3> | ||
222 | <h4 id="list-of-prerequisites-for-your-web-server">List of prerequisites for your web server</h4> | ||
223 | <ul> | ||
224 | <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> | ||
225 | <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> | ||
226 | <li><a href="http://php.net/en/xml">XML for PHP</a></li> | ||
227 | <li><a href="http://php.net/en/pcre">PCRE</a></li> | ||
228 | <li><a href="http://php.net/en/zlib">ZLib</a></li> | ||
229 | <li><a href="http://php.net/en/mbstring">mbstring</a> and/or <a href="http://php.net/en/iconv">iconv</a></li> | ||
230 | <li>The <a href="http://php.net/manual/en/book.dom.php">DOM/XML</a> extension</li> | ||
231 | <li><a href="http://www.php.net/manual/en/filesystem.configuration.php#ini.allow-url-fopen">allow_url_fopen</a></li> | ||
232 | <li><a href="http://php.net/manual/en/book.gettext.php">gettext</a></li> | ||
233 | </ul> | ||
234 | <p>Optionnal:</p> | ||
235 | <ul> | ||
236 | <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> | ||
237 | <li><a href="http://php.net/manual/en/book.image.php">GD</a></li> | ||
238 | <li><a href="http://php.net/manual/en/book.filter.php">Data filtering</a></li> | ||
239 | </ul> | ||
240 | <h2 id="login">Login</h2> | ||
241 | <p>From your web browser, you reach the login screen: fill your username and your password to connect to your account.</p> | ||
242 | <p>Enjoy!</p> | ||
243 | </section> | ||
244 | |||
245 | </div> | ||
246 | </main> | ||
247 | |||
248 | <script src="//code.jquery.com/jquery-1.11.0.min.js"></script> | ||
249 | <script src="//netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script> | ||
250 | <script src="http://yandex.st/highlightjs/7.5/highlight.min.js"></script> | ||
251 | |||
252 | <script> | ||
253 | $(function() { | ||
254 | $("section>h1").wrap('<div class="page-header" />'); | ||
255 | // Syntax highlighting | ||
256 | hljs.initHighlightingOnLoad(); | ||
257 | }); | ||
258 | </script> | ||
259 | |||
260 | </body> | ||
261 | </html> | ||
diff --git a/docs/en/Administrator/hidden_options.html b/docs/en/Administrator/hidden_options.html new file mode 100644 index 00000000..f9e18332 --- /dev/null +++ b/docs/en/Administrator/hidden_options.html | |||
@@ -0,0 +1,231 @@ | |||
1 | <!DOCTYPE html> | ||
2 | <html lang="en"> | ||
3 | <head> | ||
4 | <meta charset="utf-8"> | ||
5 | <meta name="viewport" content="width=device-width, initial-scale=1"> | ||
6 | |||
7 | <title>wallabag - Hidden options</title> | ||
8 | |||
9 | <link rel="stylesheet" href="http://doc.wallabag.org/css/bootstrap.min.css"> | ||
10 | <link rel="stylesheet" href="http://doc.wallabag.org/css/font-awesome.min.css"> | ||
11 | <link rel="stylesheet" href="http://doc.wallabag.org/css/highlight.tomorrow-night.css"> | ||
12 | <link rel="stylesheet" href="http://doc.wallabag.org/css/main.css"> | ||
13 | </head> | ||
14 | <body> | ||
15 | |||
16 | <header class="navbar navbar-default navbar-fixed-top"> | ||
17 | |||
18 | <a class="navbar-brand" href="http://doc.wallabag.org/"> | ||
19 | wallabag | ||
20 | <small class="hidden-xs hidden-sm"> | ||
21 | Hidden options | ||
22 | </small> | ||
23 | </a> | ||
24 | <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> | ||
25 | |||
26 | |||
27 | </header> | ||
28 | |||
29 | <main class="container-fluid"> | ||
30 | <div class="row"> | ||
31 | |||
32 | |||
33 | <nav id="sidebar" class="col-sm-3 col-lg-2" role="navigation"> | ||
34 | |||
35 | <ul class="nav nav-pills nav-stacked"> | ||
36 | |||
37 | <h4 class="text-muted"> | ||
38 | |||
39 | </h4> | ||
40 | |||
41 | <ul class="nav nav-pills nav-stacked"> | ||
42 | <li class="test "> | ||
43 | <a href="http://doc.wallabag.org/en/index.html"> | ||
44 | Getting started | ||
45 | </a> | ||
46 | </li> | ||
47 | <li class="test "> | ||
48 | <a href="http://doc.wallabag.org/en/help_wallabag.html"> | ||
49 | Help us | ||
50 | </a> | ||
51 | </li> | ||
52 | </ul> | ||
53 | |||
54 | <h4 class="text-muted"> | ||
55 | Administrator | ||
56 | </h4> | ||
57 | |||
58 | <ul class="nav nav-pills nav-stacked"> | ||
59 | <li class="test "> | ||
60 | <a href="http://doc.wallabag.org/en/Administrator/download_and_install.html"> | ||
61 | Download and installation | ||
62 | </a> | ||
63 | </li> | ||
64 | <li class="test "> | ||
65 | <a href="http://doc.wallabag.org/en/Administrator/update.html"> | ||
66 | Update wallabag | ||
67 | </a> | ||
68 | </li> | ||
69 | <li class="test active"> | ||
70 | <a href="http://doc.wallabag.org/en/Administrator/hidden_options.html"> | ||
71 | Hidden options | ||
72 | </a> | ||
73 | </li> | ||
74 | <li class="test "> | ||
75 | <a href="http://doc.wallabag.org/en/Administrator/multiusers.html"> | ||
76 | Multi users | ||
77 | </a> | ||
78 | </li> | ||
79 | </ul> | ||
80 | |||
81 | <h4 class="text-muted"> | ||
82 | User | ||
83 | </h4> | ||
84 | |||
85 | <ul class="nav nav-pills nav-stacked"> | ||
86 | <li class="test "> | ||
87 | <a href="http://doc.wallabag.org/en/User/save_your_first_article.html"> | ||
88 | Save your first article | ||
89 | </a> | ||
90 | </li> | ||
91 | <li class="test "> | ||
92 | <a href="http://doc.wallabag.org/en/User/read_an_article.html"> | ||
93 | Read an article | ||
94 | </a> | ||
95 | </li> | ||
96 | <li class="test "> | ||
97 | <a href="http://doc.wallabag.org/en/User/organize_articles.html"> | ||
98 | Organize articles | ||
99 | </a> | ||
100 | </li> | ||
101 | <li class="test "> | ||
102 | <a href="http://doc.wallabag.org/en/User/configure_wallabag.html"> | ||
103 | Configure wallabag | ||
104 | </a> | ||
105 | </li> | ||
106 | <li class="test "> | ||
107 | <a href="http://doc.wallabag.org/en/User/search.html"> | ||
108 | Search | ||
109 | </a> | ||
110 | </li> | ||
111 | <li class="test "> | ||
112 | <a href="http://doc.wallabag.org/en/User/epub_conversion.html"> | ||
113 | ePub conversion | ||
114 | </a> | ||
115 | </li> | ||
116 | <li class="test "> | ||
117 | <a href="http://doc.wallabag.org/en/User/issue_with_article.html"> | ||
118 | Issue with article | ||
119 | </a> | ||
120 | </li> | ||
121 | <li class="test "> | ||
122 | <a href="http://doc.wallabag.org/en/User/rss_feed.html"> | ||
123 | RSS feed | ||
124 | </a> | ||
125 | </li> | ||
126 | <li class="test "> | ||
127 | <a href="http://doc.wallabag.org/en/User/import_export.html"> | ||
128 | Import export | ||
129 | </a> | ||
130 | </li> | ||
131 | <li class="test "> | ||
132 | <a href="http://doc.wallabag.org/en/User/framabag_account_creation.html"> | ||
133 | Framabag account creation | ||
134 | </a> | ||
135 | </li> | ||
136 | </ul> | ||
137 | |||
138 | <h4 class="text-muted"> | ||
139 | Developer | ||
140 | </h4> | ||
141 | |||
142 | <ul class="nav nav-pills nav-stacked"> | ||
143 | <li class="test "> | ||
144 | <a href="http://doc.wallabag.org/en/Developer/write_config_files.html"> | ||
145 | Write config files | ||
146 | </a> | ||
147 | </li> | ||
148 | <li class="test "> | ||
149 | <a href="http://doc.wallabag.org/en/Developer/create_new_theme.html"> | ||
150 | Create a new theme | ||
151 | </a> | ||
152 | </li> | ||
153 | <li class="test "> | ||
154 | <a href="http://doc.wallabag.org/en/Developer/git_repo.html"> | ||
155 | Git repository | ||
156 | </a> | ||
157 | </li> | ||
158 | <li class="test "> | ||
159 | <a href="http://doc.wallabag.org/en/Developer/docker.html"> | ||
160 | Docker | ||
161 | </a> | ||
162 | </li> | ||
163 | <li class="test "> | ||
164 | <a href="http://doc.wallabag.org/en/Developer/vagrant.html"> | ||
165 | Vagrant | ||
166 | </a> | ||
167 | </li> | ||
168 | <li class="test "> | ||
169 | <a href="http://doc.wallabag.org/en/Developer/v2.html"> | ||
170 | wallabag v2 / symfony2 | ||
171 | </a> | ||
172 | </li> | ||
173 | </ul> | ||
174 | </ul> | ||
175 | |||
176 | </nav> | ||
177 | |||
178 | |||
179 | <section class="col-lg-10"> | ||
180 | <h1 id="hidden-options">Hidden options</h1> | ||
181 | <h2 id="caution">Caution</h2> | ||
182 | <p><strong>Be careful</strong>, this section is destined to advanced users. We are going to modify an important wallabag configuration file, <code>inc/poche/config.inc.php</code>. It is therefore advised to do a backup of this file before you proceed. | ||
183 | <strong>Any error occuring during the modification of a wallabag file could lead to malfunctions</strong>.</p> | ||
184 | <p>This file is created when you install wallabag. | ||
185 | Install wallabag, do a backup copy of the file, then open it in your favorite text editor.</p> | ||
186 | <p>In this file, there are some options that are not, as of now, available in the <strong>config</strong> page of wallabag.</p> | ||
187 | <h2 id="modification-of-advanced-options">Modification of advanced options</h2> | ||
188 | <p>Each option is defined this way:</p> | ||
189 | <pre><code>@define ('OPTION_NAME', 'Value');</code></pre> | ||
190 | <p>For each line, you can only modify the <code>Value</code> field.</p> | ||
191 | <p>Here is the list of each option you can change:</p> | ||
192 | <ul> | ||
193 | <li><code>HTTP_PORT</code> (default: <code>80</code>) : the HTTP port of your web server. You may need to change it if your server is behind a proxy. Accepted values: number</li> | ||
194 | <li><code>SSL_PORT</code> (default: <code>443</code>) : the HTTP port of your web server. You may need to change it if your server use SSLH. Accepted values: number</li> | ||
195 | <li><code>MODE_DEMO</code> (default : <code>FALSE)</code>: If you ever wanted to set up a demonstration server... Accepted values: <code>TRUE</code> or <code>FALSE</code>.</li> | ||
196 | <li><code>DEBUG_POCHE</code> (default: <code>FALSE</code>) : if you encounter some problems with wallabag, we may ask you to active Debug mode. Accepted values: <code>TRUE</code> or <code>FALSE</code>. Check the logs in cache/log.txt after activating that.</li> | ||
197 | <li><code>ERROR_REPORTING</code> (default : <code>E_ALL & ~E_NOTICE</code>) : Set to <code>E_ALL</code> if needed to look for eventual PHP errors.</li> | ||
198 | <li><code>DOWNLOAD_PICTURES</code> (default: <code>FALSE</code>) : Allows wallabag to fetch images from the articles you save on your server, instead of fetching only the text. We prefer to let you activate this option yourself. Accepted values: <code>TRUE</code> or <code>FALSE</code>.</li> | ||
199 | <li><code>REGENERATE_PICTURES_QUALITY</code> (default : <code>75</code>) : In order to avoid security problems, pictures are regenerated if you activate the download of pictures. This is the percentage of quality at which they are saved. Increase that numbler if you want better quality, lower if you need better performances.</li> | ||
200 | <li><code>SHARE_TWITTER</code> (default: <code>TRUE</code>) : enables Twitter sharing. Accepted values: <code>TRUE</code> or <code>FALSE</code>.</li> | ||
201 | <li><code>SHARE_MAIL</code> (default: <code>TRUE</code>) : enables mail sharing. Accepted values: <code>TRUE</code> or <code>FALSE</code>.</li> | ||
202 | <li><code>SHARE_EVERNOTE</code>(default : <code>FALSE</code>) : enables sharing with your Evernote account. Accepted values: <code>TRUE</code> or <code>FALSE</code>.</li> | ||
203 | <li><code>SHARE_DIASPORA</code> (default : <code>FALSE</code>) : enables to share an article on your Diaspora account.</li> | ||
204 | <li><code>DIASPORA_URL</code> (default : <code>http://diasporapod.com</code>) : The URL of your Diaspora* pod</li> | ||
205 | <li><code>CARROT</code> (default : <code>FALSE</code>) : Like Flattr, it's a service to give small amounts of money to a web page. See <a href="http://carrot.org/">http://carrot.org/</a></li> | ||
206 | <li><code>SHARE_SHAARLI</code> (default: <code>FALSE</code>) : enables sharing via your Shaarli installation (Shaarli is an open-source bookmark manager). Accepted values: <code>TRUE</code> or <code>FALSE</code>.</li> | ||
207 | <li><code>SHAARLI_URL</code> (default: <code>'http://myshaarliurl.com'</code>) : defines your Shaarli installation URL. Accepted values: an URL.</li> | ||
208 | <li><code>FLATTR</code> (default: <code>TRUE</code>) : enables the possibility to Flattr an article (<a href="http://en.wikipedia.org/wiki/Flattr">Flattr is a microdonation platform</a>). If an article is Flattr-able, an icon will be displayed, allowing you to send a microdonation to the author. Accepted values: <code>TRUE</code> or <code>FALSE</code>.</li> | ||
209 | <li><code>SHOW_PRINTLINK</code> (default: <code>'1'</code>) : enables the Print button for articles. Accepted values: <code>'1'</code> to enable or <code>'0'</code> to disable.</li> | ||
210 | <li><code>SHOW_READPERCENT</code> (default: <code>'1'</code>) : enables the reading progress on articles (working on the <code>default</code>, <code>dark</code>, <code>dmagenta</code>, <code>solarized</code>, <code>solarized-dark</code> themes). Accepted values: <code>'1'</code> to enable or <code>'0'</code> to disable.</li> | ||
211 | <li><code>PAGINATION</code> (default: <code>'12'</code>) : defines the number of articles that are displayed on a list. Accepted values: number.</li> | ||
212 | </ul> | ||
213 | </section> | ||
214 | |||
215 | </div> | ||
216 | </main> | ||
217 | |||
218 | <script src="//code.jquery.com/jquery-1.11.0.min.js"></script> | ||
219 | <script src="//netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script> | ||
220 | <script src="http://yandex.st/highlightjs/7.5/highlight.min.js"></script> | ||
221 | |||
222 | <script> | ||
223 | $(function() { | ||
224 | $("section>h1").wrap('<div class="page-header" />'); | ||
225 | // Syntax highlighting | ||
226 | hljs.initHighlightingOnLoad(); | ||
227 | }); | ||
228 | </script> | ||
229 | |||
230 | </body> | ||
231 | </html> | ||
diff --git a/docs/en/Administrator/multiusers.html b/docs/en/Administrator/multiusers.html new file mode 100644 index 00000000..de673851 --- /dev/null +++ b/docs/en/Administrator/multiusers.html | |||
@@ -0,0 +1,200 @@ | |||
1 | <!DOCTYPE html> | ||
2 | <html lang="en"> | ||
3 | <head> | ||
4 | <meta charset="utf-8"> | ||
5 | <meta name="viewport" content="width=device-width, initial-scale=1"> | ||
6 | |||
7 | <title>wallabag - Multi users</title> | ||
8 | |||
9 | <link rel="stylesheet" href="http://doc.wallabag.org/css/bootstrap.min.css"> | ||
10 | <link rel="stylesheet" href="http://doc.wallabag.org/css/font-awesome.min.css"> | ||
11 | <link rel="stylesheet" href="http://doc.wallabag.org/css/highlight.tomorrow-night.css"> | ||
12 | <link rel="stylesheet" href="http://doc.wallabag.org/css/main.css"> | ||
13 | </head> | ||
14 | <body> | ||
15 | |||
16 | <header class="navbar navbar-default navbar-fixed-top"> | ||
17 | |||
18 | <a class="navbar-brand" href="http://doc.wallabag.org/"> | ||
19 | wallabag | ||
20 | <small class="hidden-xs hidden-sm"> | ||
21 | Multi users | ||
22 | </small> | ||
23 | </a> | ||
24 | <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> | ||
25 | |||
26 | |||
27 | </header> | ||
28 | |||
29 | <main class="container-fluid"> | ||
30 | <div class="row"> | ||
31 | |||
32 | |||
33 | <nav id="sidebar" class="col-sm-3 col-lg-2" role="navigation"> | ||
34 | |||
35 | <ul class="nav nav-pills nav-stacked"> | ||
36 | |||
37 | <h4 class="text-muted"> | ||
38 | |||
39 | </h4> | ||
40 | |||
41 | <ul class="nav nav-pills nav-stacked"> | ||
42 | <li class="test "> | ||
43 | <a href="http://doc.wallabag.org/en/index.html"> | ||
44 | Getting started | ||
45 | </a> | ||
46 | </li> | ||
47 | <li class="test "> | ||
48 | <a href="http://doc.wallabag.org/en/help_wallabag.html"> | ||
49 | Help us | ||
50 | </a> | ||
51 | </li> | ||
52 | </ul> | ||
53 | |||
54 | <h4 class="text-muted"> | ||
55 | Administrator | ||
56 | </h4> | ||
57 | |||
58 | <ul class="nav nav-pills nav-stacked"> | ||
59 | <li class="test "> | ||
60 | <a href="http://doc.wallabag.org/en/Administrator/download_and_install.html"> | ||
61 | Download and installation | ||
62 | </a> | ||
63 | </li> | ||
64 | <li class="test "> | ||
65 | <a href="http://doc.wallabag.org/en/Administrator/update.html"> | ||
66 | Update wallabag | ||
67 | </a> | ||
68 | </li> | ||
69 | <li class="test "> | ||
70 | <a href="http://doc.wallabag.org/en/Administrator/hidden_options.html"> | ||
71 | Hidden options | ||
72 | </a> | ||
73 | </li> | ||
74 | <li class="test active"> | ||
75 | <a href="http://doc.wallabag.org/en/Administrator/multiusers.html"> | ||
76 | Multi users | ||
77 | </a> | ||
78 | </li> | ||
79 | </ul> | ||
80 | |||
81 | <h4 class="text-muted"> | ||
82 | User | ||
83 | </h4> | ||
84 | |||
85 | <ul class="nav nav-pills nav-stacked"> | ||
86 | <li class="test "> | ||
87 | <a href="http://doc.wallabag.org/en/User/save_your_first_article.html"> | ||
88 | Save your first article | ||
89 | </a> | ||
90 | </li> | ||
91 | <li class="test "> | ||
92 | <a href="http://doc.wallabag.org/en/User/read_an_article.html"> | ||
93 | Read an article | ||
94 | </a> | ||
95 | </li> | ||
96 | <li class="test "> | ||
97 | <a href="http://doc.wallabag.org/en/User/organize_articles.html"> | ||
98 | Organize articles | ||
99 | </a> | ||
100 | </li> | ||
101 | <li class="test "> | ||
102 | <a href="http://doc.wallabag.org/en/User/configure_wallabag.html"> | ||
103 | Configure wallabag | ||
104 | </a> | ||
105 | </li> | ||
106 | <li class="test "> | ||
107 | <a href="http://doc.wallabag.org/en/User/search.html"> | ||
108 | Search | ||
109 | </a> | ||
110 | </li> | ||
111 | <li class="test "> | ||
112 | <a href="http://doc.wallabag.org/en/User/epub_conversion.html"> | ||
113 | ePub conversion | ||
114 | </a> | ||
115 | </li> | ||
116 | <li class="test "> | ||
117 | <a href="http://doc.wallabag.org/en/User/issue_with_article.html"> | ||
118 | Issue with article | ||
119 | </a> | ||
120 | </li> | ||
121 | <li class="test "> | ||
122 | <a href="http://doc.wallabag.org/en/User/rss_feed.html"> | ||
123 | RSS feed | ||
124 | </a> | ||
125 | </li> | ||
126 | <li class="test "> | ||
127 | <a href="http://doc.wallabag.org/en/User/import_export.html"> | ||
128 | Import export | ||
129 | </a> | ||
130 | </li> | ||
131 | <li class="test "> | ||
132 | <a href="http://doc.wallabag.org/en/User/framabag_account_creation.html"> | ||
133 | Framabag account creation | ||
134 | </a> | ||
135 | </li> | ||
136 | </ul> | ||
137 | |||
138 | <h4 class="text-muted"> | ||
139 | Developer | ||
140 | </h4> | ||
141 | |||
142 | <ul class="nav nav-pills nav-stacked"> | ||
143 | <li class="test "> | ||
144 | <a href="http://doc.wallabag.org/en/Developer/write_config_files.html"> | ||
145 | Write config files | ||
146 | </a> | ||
147 | </li> | ||
148 | <li class="test "> | ||
149 | <a href="http://doc.wallabag.org/en/Developer/create_new_theme.html"> | ||
150 | Create a new theme | ||
151 | </a> | ||
152 | </li> | ||
153 | <li class="test "> | ||
154 | <a href="http://doc.wallabag.org/en/Developer/git_repo.html"> | ||
155 | Git repository | ||
156 | </a> | ||
157 | </li> | ||
158 | <li class="test "> | ||
159 | <a href="http://doc.wallabag.org/en/Developer/docker.html"> | ||
160 | Docker | ||
161 | </a> | ||
162 | </li> | ||
163 | <li class="test "> | ||
164 | <a href="http://doc.wallabag.org/en/Developer/vagrant.html"> | ||
165 | Vagrant | ||
166 | </a> | ||
167 | </li> | ||
168 | <li class="test "> | ||
169 | <a href="http://doc.wallabag.org/en/Developer/v2.html"> | ||
170 | wallabag v2 / symfony2 | ||
171 | </a> | ||
172 | </li> | ||
173 | </ul> | ||
174 | </ul> | ||
175 | |||
176 | </nav> | ||
177 | |||
178 | |||
179 | <section class="col-lg-10"> | ||
180 | <h1 id="multi-users">Multi users</h1> | ||
181 | <p>To be translated from <a href="../../fr/Administrateur/multi-utilisateurs.html">Multi-utilisateurs</a>.</p> | ||
182 | </section> | ||
183 | |||
184 | </div> | ||
185 | </main> | ||
186 | |||
187 | <script src="//code.jquery.com/jquery-1.11.0.min.js"></script> | ||
188 | <script src="//netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script> | ||
189 | <script src="http://yandex.st/highlightjs/7.5/highlight.min.js"></script> | ||
190 | |||
191 | <script> | ||
192 | $(function() { | ||
193 | $("section>h1").wrap('<div class="page-header" />'); | ||
194 | // Syntax highlighting | ||
195 | hljs.initHighlightingOnLoad(); | ||
196 | }); | ||
197 | </script> | ||
198 | |||
199 | </body> | ||
200 | </html> | ||
diff --git a/docs/en/Administrator/update.html b/docs/en/Administrator/update.html new file mode 100644 index 00000000..af278286 --- /dev/null +++ b/docs/en/Administrator/update.html | |||
@@ -0,0 +1,210 @@ | |||
1 | <!DOCTYPE html> | ||
2 | <html lang="en"> | ||
3 | <head> | ||
4 | <meta charset="utf-8"> | ||
5 | <meta name="viewport" content="width=device-width, initial-scale=1"> | ||
6 | |||
7 | <title>wallabag - Update wallabag</title> | ||
8 | |||
9 | <link rel="stylesheet" href="http://doc.wallabag.org/css/bootstrap.min.css"> | ||
10 | <link rel="stylesheet" href="http://doc.wallabag.org/css/font-awesome.min.css"> | ||
11 | <link rel="stylesheet" href="http://doc.wallabag.org/css/highlight.tomorrow-night.css"> | ||
12 | <link rel="stylesheet" href="http://doc.wallabag.org/css/main.css"> | ||
13 | </head> | ||
14 | <body> | ||
15 | |||
16 | <header class="navbar navbar-default navbar-fixed-top"> | ||
17 | |||
18 | <a class="navbar-brand" href="http://doc.wallabag.org/"> | ||
19 | wallabag | ||
20 | <small class="hidden-xs hidden-sm"> | ||
21 | Update wallabag | ||
22 | </small> | ||
23 | </a> | ||
24 | <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> | ||
25 | |||
26 | |||
27 | </header> | ||
28 | |||
29 | <main class="container-fluid"> | ||
30 | <div class="row"> | ||
31 | |||
32 | |||
33 | <nav id="sidebar" class="col-sm-3 col-lg-2" role="navigation"> | ||
34 | |||
35 | <ul class="nav nav-pills nav-stacked"> | ||
36 | |||
37 | <h4 class="text-muted"> | ||
38 | |||
39 | </h4> | ||
40 | |||
41 | <ul class="nav nav-pills nav-stacked"> | ||
42 | <li class="test "> | ||
43 | <a href="http://doc.wallabag.org/en/index.html"> | ||
44 | Getting started | ||
45 | </a> | ||
46 | </li> | ||
47 | <li class="test "> | ||
48 | <a href="http://doc.wallabag.org/en/help_wallabag.html"> | ||
49 | Help us | ||
50 | </a> | ||
51 | </li> | ||
52 | </ul> | ||
53 | |||
54 | <h4 class="text-muted"> | ||
55 | Administrator | ||
56 | </h4> | ||
57 | |||
58 | <ul class="nav nav-pills nav-stacked"> | ||
59 | <li class="test "> | ||
60 | <a href="http://doc.wallabag.org/en/Administrator/download_and_install.html"> | ||
61 | Download and installation | ||
62 | </a> | ||
63 | </li> | ||
64 | <li class="test active"> | ||
65 | <a href="http://doc.wallabag.org/en/Administrator/update.html"> | ||
66 | Update wallabag | ||
67 | </a> | ||
68 | </li> | ||
69 | <li class="test "> | ||
70 | <a href="http://doc.wallabag.org/en/Administrator/hidden_options.html"> | ||
71 | Hidden options | ||
72 | </a> | ||
73 | </li> | ||
74 | <li class="test "> | ||
75 | <a href="http://doc.wallabag.org/en/Administrator/multiusers.html"> | ||
76 | Multi users | ||
77 | </a> | ||
78 | </li> | ||
79 | </ul> | ||
80 | |||
81 | <h4 class="text-muted"> | ||
82 | User | ||
83 | </h4> | ||
84 | |||
85 | <ul class="nav nav-pills nav-stacked"> | ||
86 | <li class="test "> | ||
87 | <a href="http://doc.wallabag.org/en/User/save_your_first_article.html"> | ||
88 | Save your first article | ||
89 | </a> | ||
90 | </li> | ||
91 | <li class="test "> | ||
92 | <a href="http://doc.wallabag.org/en/User/read_an_article.html"> | ||
93 | Read an article | ||
94 | </a> | ||
95 | </li> | ||
96 | <li class="test "> | ||
97 | <a href="http://doc.wallabag.org/en/User/organize_articles.html"> | ||
98 | Organize articles | ||
99 | </a> | ||
100 | </li> | ||
101 | <li class="test "> | ||
102 | <a href="http://doc.wallabag.org/en/User/configure_wallabag.html"> | ||
103 | Configure wallabag | ||
104 | </a> | ||
105 | </li> | ||
106 | <li class="test "> | ||
107 | <a href="http://doc.wallabag.org/en/User/search.html"> | ||
108 | Search | ||
109 | </a> | ||
110 | </li> | ||
111 | <li class="test "> | ||
112 | <a href="http://doc.wallabag.org/en/User/epub_conversion.html"> | ||
113 | ePub conversion | ||
114 | </a> | ||
115 | </li> | ||
116 | <li class="test "> | ||
117 | <a href="http://doc.wallabag.org/en/User/issue_with_article.html"> | ||
118 | Issue with article | ||
119 | </a> | ||
120 | </li> | ||
121 | <li class="test "> | ||
122 | <a href="http://doc.wallabag.org/en/User/rss_feed.html"> | ||
123 | RSS feed | ||
124 | </a> | ||
125 | </li> | ||
126 | <li class="test "> | ||
127 | <a href="http://doc.wallabag.org/en/User/import_export.html"> | ||
128 | Import export | ||
129 | </a> | ||
130 | </li> | ||
131 | <li class="test "> | ||
132 | <a href="http://doc.wallabag.org/en/User/framabag_account_creation.html"> | ||
133 | Framabag account creation | ||
134 | </a> | ||
135 | </li> | ||
136 | </ul> | ||
137 | |||
138 | <h4 class="text-muted"> | ||
139 | Developer | ||
140 | </h4> | ||
141 | |||
142 | <ul class="nav nav-pills nav-stacked"> | ||
143 | <li class="test "> | ||
144 | <a href="http://doc.wallabag.org/en/Developer/write_config_files.html"> | ||
145 | Write config files | ||
146 | </a> | ||
147 | </li> | ||
148 | <li class="test "> | ||
149 | <a href="http://doc.wallabag.org/en/Developer/create_new_theme.html"> | ||
150 | Create a new theme | ||
151 | </a> | ||
152 | </li> | ||
153 | <li class="test "> | ||
154 | <a href="http://doc.wallabag.org/en/Developer/git_repo.html"> | ||
155 | Git repository | ||
156 | </a> | ||
157 | </li> | ||
158 | <li class="test "> | ||
159 | <a href="http://doc.wallabag.org/en/Developer/docker.html"> | ||
160 | Docker | ||
161 | </a> | ||
162 | </li> | ||
163 | <li class="test "> | ||
164 | <a href="http://doc.wallabag.org/en/Developer/vagrant.html"> | ||
165 | Vagrant | ||
166 | </a> | ||
167 | </li> | ||
168 | <li class="test "> | ||
169 | <a href="http://doc.wallabag.org/en/Developer/v2.html"> | ||
170 | wallabag v2 / symfony2 | ||
171 | </a> | ||
172 | </li> | ||
173 | </ul> | ||
174 | </ul> | ||
175 | |||
176 | </nav> | ||
177 | |||
178 | |||
179 | <section class="col-lg-10"> | ||
180 | <h1 id="update-wallabag">Update wallabag</h1> | ||
181 | <h2 id="update-an-existing-wallabag-installation">Update an existing wallabag installation</h2> | ||
182 | <p>In order to update your installation, download and unzip the archive into your installation folder. For example on Ubuntu/Debian:</p> | ||
183 | <pre><code>wget http://wllbg.org/latest | ||
184 | unzip latest | ||
185 | rsync -ur wallabag-version-number/* /var/www/html/wallabag/ # could be another location such as /srv/html, /usr/share/nginx/html</code></pre> | ||
186 | <p>After that, just access wallabag in your browser and follow the instructions to finish the update.</p> | ||
187 | <p>You can verify at the bottom of the configuration page that you're running the last version.</p> | ||
188 | <p><strong>If it fails</strong>, just delete the <code>install</code> folder and clear the cache:</p> | ||
189 | <pre><code>cd /var/www/html/wallabag/ | ||
190 | rm -r cache/* install/</code></pre> | ||
191 | <p>Clearing the cache is also possible in the configuration page, clicking on the link `Delete Cache.</p> | ||
192 | </section> | ||
193 | |||
194 | </div> | ||
195 | </main> | ||
196 | |||
197 | <script src="//code.jquery.com/jquery-1.11.0.min.js"></script> | ||
198 | <script src="//netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script> | ||
199 | <script src="http://yandex.st/highlightjs/7.5/highlight.min.js"></script> | ||
200 | |||
201 | <script> | ||
202 | $(function() { | ||
203 | $("section>h1").wrap('<div class="page-header" />'); | ||
204 | // Syntax highlighting | ||
205 | hljs.initHighlightingOnLoad(); | ||
206 | }); | ||
207 | </script> | ||
208 | |||
209 | </body> | ||
210 | </html> | ||