aboutsummaryrefslogblamecommitdiffhomepage
path: root/docs/en/Administrator/hidden_options.html
blob: f9e18332a13fd3ea746276d529a1cf04c8037d2c (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







































































































































































































































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

        <title>wallabag - Hidden options</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">
                    Hidden options
                </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 ">
                                                <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 active">
                                                <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="hidden-options">Hidden options</h1>
<h2 id="caution">Caution</h2>
<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.
<strong>Any error occuring during the modification of a wallabag file could lead to malfunctions</strong>.</p>
<p>This file is created when you install wallabag.
Install wallabag, do a backup copy of the file, then open it in your favorite text editor.</p>
<p>In this file, there are some options that are not, as of now, available in the <strong>config</strong> page of wallabag.</p>
<h2 id="modification-of-advanced-options">Modification of advanced options</h2>
<p>Each option is defined this way:</p>
<pre><code>@define ('OPTION_NAME', 'Value');</code></pre>
<p>For each line, you can only modify the <code>Value</code> field.</p>
<p>Here is the list of each option you can change:</p>
<ul>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<li><code>SHARE_TWITTER</code> (default: <code>TRUE</code>) : enables Twitter sharing. Accepted values: <code>TRUE</code> or <code>FALSE</code>.</li>
<li><code>SHARE_MAIL</code> (default: <code>TRUE</code>) : enables mail sharing. Accepted values: <code>TRUE</code> or <code>FALSE</code>.</li>
<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>
<li><code>SHARE_DIASPORA</code> (default : <code>FALSE</code>) : enables to share an article on your Diaspora account.</li>
<li><code>DIASPORA_URL</code> (default : <code>http://diasporapod.com</code>) : The URL of your Diaspora* pod</li>
<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>
<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>
<li><code>SHAARLI_URL</code> (default: <code>'http://myshaarliurl.com'</code>) : defines your Shaarli installation URL. Accepted values: an URL.</li>
<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>
<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>
<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>
<li><code>PAGINATION</code> (default: <code>'12'</code>) : defines the number of articles that are displayed on a list. Accepted values: number.</li>
</ul>
                </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-11-29 08:06:26 +0000