docs/en/Administrator/hidden_options.rst

   1 Hidden options
   2 ==============
   3
   4 Caution
   5 -------
   6
   7 **Be careful**, this section is destined to advanced users. We are going
   8 to modify an important wallabag configuration file,
   9 ``inc/poche/config.inc.php``. It is therefore advised to do a backup of
  10 this file before you proceed. **Any error occuring during the
  11 modification of a wallabag file could lead to malfunctions**.
  12
  13 This file is created when you install wallabag. Install wallabag, do a
  14 backup copy of the file, then open it in your favorite text editor.
  15
  16 In this file, there are some options that are not, as of now, available
  17 in the **config** page of wallabag.
  18
  19 Modification of advanced options
  20 --------------------------------
  21
  22 Each option is defined this way:
  23
  24 ::
  25
  26     @define ('OPTION_NAME', 'Value');
  27
  28 For each line, you can only modify the ``Value`` field.
  29
  30 Here is the list of each option you can change:
  31
  32 -  ``HTTP_PORT`` (default: ``80``) : the HTTP port of your web server.
  33    You may need to change it if your server is behind a proxy. Accepted
  34    values: number
  35 -  ``SSL_PORT`` (default: ``443``) : the HTTP port of your web server.
  36    You may need to change it if your server use SSLH. Accepted values:
  37    number
  38 -  ``MODE_DEMO`` (default : ``FALSE)``: If you ever wanted to set up a
  39    demonstration server… Accepted values: ``TRUE`` or ``FALSE``.
  40 -  ``DEBUG_POCHE`` (default: ``FALSE``) : if you encounter some problems
  41    with wallabag, we may ask you to active Debug mode. Accepted values:
  42    ``TRUE`` or ``FALSE``. Check the logs in cache/log.txt after
  43    activating that.
  44 -  ``ERROR_REPORTING`` (default : ``E_ALL & ~E_NOTICE``) : Set to
  45    ``E_ALL`` if needed to look for eventual PHP errors.
  46 -  ``DOWNLOAD_PICTURES`` (default: ``FALSE``) : Allows wallabag to fetch
  47    images from the articles you save on your server, instead of fetching
  48    only the text. We prefer to let you activate this option yourself.
  49    Accepted values: ``TRUE`` or ``FALSE``.
  50 -  ``REGENERATE_PICTURES_QUALITY`` (default : ``75``) : In order to
  51    avoid security problems, pictures are regenerated if you activate the
  52    download of pictures. This is the percentage of quality at which they
  53    are saved. Increase that numbler if you want better quality, lower if
  54    you need better performances.
  55 -  ``SHARE_TWITTER`` (default: ``TRUE``) : enables Twitter sharing.
  56    Accepted values: ``TRUE`` or ``FALSE``.
  57 -  ``SHARE_MAIL`` (default: ``TRUE``) : enables mail sharing. Accepted
  58    values: ``TRUE`` or ``FALSE``.
  59 -  ``SHARE_EVERNOTE``\ (default : ``FALSE``) : enables sharing with your
  60    Evernote account. Accepted values: ``TRUE`` or ``FALSE``.
  61 -  ``SHARE_DIASPORA`` (default : ``FALSE``) : enables to share an
  62    article on your Diaspora account.
  63 -  ``DIASPORA_URL`` (default : ``http://diasporapod.com``) : The URL of
  64    your Diaspora\* pod
  65 -  ``CARROT`` (default : ``FALSE``) : Like Flattr, it’s a service to
  66    give small amounts of money to a web page. See http://carrot.org/
  67 -  ``SHARE_SHAARLI`` (default: ``FALSE``) : enables sharing via your
  68    Shaarli installation (Shaarli is an open-source bookmark manager).
  69    Accepted values: ``TRUE`` or ``FALSE``.
  70 -  ``SHAARLI_URL`` (default: ``'http://myshaarliurl.com'``) : defines
  71    your Shaarli installation URL. Accepted values: an URL.
  72 -  ``FLATTR`` (default: ``TRUE``) : enables the possibility to Flattr an
  73    article (`Flattr is a microdonation platform`_). If an article is
  74    Flattr-able, an icon will be displayed, allowing you to send a
  75    microdonation to the author. Accepted values: ``TRUE`` or ``FALSE``.
  76 -  ``SHOW_PRINTLINK`` (default: ``'1'``) : enables the Print button for
  77    articles. Accepted values: ``'1'`` to enable or ``'0'`` to disable.
  78 -  ``SHOW_READPERCENT`` (default: ``'1'``) : enables the reading
  79    progress on articles (working on the ``default``, ``dark``,
  80    ``dmagenta``, ``solarized``, ``solarized-dark`` themes). Accepted
  81    values: ``'1'`` to enable or ``'0'`` to disable.
  82 -  ``PAGINATION`` (default: ``'12'``) : defines the number of articles
  83    that are displayed on a list. Accepted values: number.
  84
  85 .. _Flattr is a microdonation platform: http://en.wikipedia.org/wiki/Flattr