Settings

The Feedability configuration settings are stored as a JSON file named settings.json in the application directory. It is possible and recommended to create a user_settings.json file to overwrite the default settings, this way there is no need to merge the settings file after the git version changes.

proxy

• bind: IP address or hostname the server should listening on (use 0.0.0.0 for all interfaces) (Default: 127.0.0.1)
• port: The port the server is listening for, use port numbers greater than 1024 (or use iptables) (Default: 1912)
• banner: The response header (Server:) the server is sending to identify itself (Default: Feedability/0.0)
• preserve_order: Keep the item order of the original feed. Some feedreaders (if not all) do not sort the feed items by date, they use the order of the feed. Feedability processes each article individually and it is not guaranteed that the items finish in order. (Default: true)
• use_auth: Use HTTP Basic Authentication with the auth credentials. (Default: false)
• auth: User credentials <username>:<password>

urlopen

The HTTP client is used to fetch the feed and articles.

• cache: Use HTTP caching features (Etag and Last-Modified) This does not effect the article fetching, they use a force_cache option per default. (Default: true)
• headers: Contains a array of request headers that are used. Default:

"headers": {
  "User-Agent": "Mozilla/5.0 (compatible; Feedability/0.0; +https://github.com/4poc/feedability)", 
  "Accept": "*/*"
}

• ignore_http_charset: Ignore the charset send by the http header Content-Type, if encoding/charset can be found in the received document. (Default: true)
• convert_charset: Use iconv to recode the received document to UTF-8. (Default: true)

cookies

Use firefox cookies:

• activate: Activates this feature. (Default: false)
• whitelist: A list of hosts you want to send cookies to. (all if empty) (Default: empty)
• type: The type of the cookie_jar, currently only firefox_sqlite is supported. (Default: firefox_sqlite)
• cookie_jar: Full path to the file/database storage. Located in the profile directory of the browser.

filter

For a more in-depth explanation read Filters.

• activate: Set to false to deactivate the filter (Default: true)
• jquery_url: The url to jquery that is used to create a context for selecting elements (Default: http://code.jquery.com/jquery-1.4.2.min.js)
• rules: Contains an array with filtering rules that are applied before/after the readability extraction process. The keys of the array are used as regular expressions to match with the article url. The different jquery selectors within, are grouped by the time they are applied and the different filter types: replace, remove, exclusive, prepend and append. Read Filters for a more detailed explanation. Example:

"rules": {
  "sixserv.org": {
    "pre": {
      "remove": ["#sidebar", ".commentlist"],
      "exclusive": []
    }
  }
}

cache

Read the developer documentation on Caching for more information.

• path: Specify a directory feedability should store cache files. It gets created at startup if it does not exist (Default: ./cache)

log

Logging to console and file is supported. The type of the messages are specified by the following log levels:

0 – No Logging
1 – Error
2 – Warning
3 – Info
4 – Debug

• console: Activates stdout console logging. (Default: true)
• stderr: Uses stderr for console logging. This is blocking. (Default: true)
• file: Activates logging to files. (Default: true)
• file_seperate: Separate files by level. (Default: false)
• syncronized: Using syncronized file writing method. (Default: false)
• path: Path to logging directory. Gets created if not exists. (Default: ./logs)
• console_level: Log messages up to this level are logged to console. (Default: 3)
• file_level: Log messages up to this level are logged to file. (Default: 4)