aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/en/Administrator/hidden_options.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/en/Administrator/hidden_options.html')
-rw-r--r--docs/en/Administrator/hidden_options.html231
1 files changed, 231 insertions, 0 deletions
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.
185Install 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 &amp; ~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>
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-09 23:43:21 +0000