Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
253 lines (160 sloc) 6.33 KB

To customize some of Fava's behaviour, you can add custom entries like the following to your Beancount file.

<textarea class="editor-readonly">
2016-06-14 custom "fava-option" "default-file"
2016-06-14 custom "fava-option" "interval" "week"
2016-04-14 custom "fava-option" "auto-reload" "true"
2016-04-14 custom "fava-option" "journal-show" "transaction open"
2016-04-14 custom "fava-option" "currency-column" "100" </textarea>

Below is a list of all possible options for Fava.


language

Default: Not set

If this setting is not specified, Fava will try to guess the language from your browser settings. Fava currently ships translations into the following languages:

  • Chinese (zh_CN and zh_TW)
  • Dutch (nl)
  • English (en)
  • French (fr)
  • German (de)
  • Persian (fa)
  • Portuguese (pt)
  • Russian (ru)
  • Slovak (sk)
  • Spanish (es)
  • Ukrainian (uk)

locale

Default: Not set or en if the Beancount render_commas option is set.

This sets the locale that is used to render out numbers. For example, with the locale en_IN the number 1111111.33 will be rendered 11,11,111.33, 1,111,111.33 with locale en, or 1.111.111,33 with locale de.


default-file

Use this option to specify a default file for the editor to open. This option takes no value, the file the custom entry is in will be used as the default. If this option is not specified, Fava opens the main file by default.


interval

Default: month

The default interval that charts and the account reports by interval use. The possible options are day, week, month, quarter, and year.


fiscal-year-end

Default: 12-31

The last day of the fiscal (financial or tax) period for accounting purposes in %m-%d format. Allows for the use of FY2018, FY2018-Q3, fiscal_year and fiscal_quarter in the time filter.

Examples are:

  • 09-30 - US federal government
  • 06-30 - Australia / NZ
  • 04-05 - UK

See Fiscal Year on WikiPedia for more examples.


insert-entry

Default: Not set.

This option can be used to specify where entries are inserted. The argument to this option should be a regular expression matching account names. This option can be given multiple times. When adding an entry, the account of the entry (for a transaction, the account of the last posting is used) is matched against all insert-entry options and the entry will be inserted before the datewise latest of the matching options. If the entry is a Transaction and no insert-entry option matches the account of the last posting the account of the second to last posting and so on will be tried. If no insert-entry option matches or none is given, the entry will be inserted at the end of the main file.


auto-reload

Default: false

Set this to true to make Fava automatically reload the page whenever a file changes is detected. By default only a notification is shown which you can click to reload the page. If the file change is due to user interaction, e.g., uploading a document or adding a transaction, Fava will always reload the page automatically.


unrealized

Default: Unrealized

The subaccount of the Equity account to post unrealized gains to if the account trees are shown at market value.


journal-show

Default: transaction balance note document custom budget query

The entry types and other elements given in this list will be shown in the Journal report. Supported values are entry type names, as well as well as the special values "metadata" and "postings" that determine the default visibility of the corresponding transaction parts.

All other elements will be hidden and can be toggled using the buttons.


journal-show-transaction

Default: cleared pending

Similarly to the journal-show setting, this determines the transaction types that will be shown in the Journal report. The "transaction types" correspond to the following transaction flags:

  • cleared - *
  • pending - !
  • other - All other transaction flags.

currency-column

Default: 61

This option can be used to configure how posting lines are aligned when saved to file or when using 'Align Amounts' in the editor. Fava tries to align so that the currencies all occur in the given column. Also, Fava will show a vertical line before this column in the editor.


sidebar-show-queries

Default: 5

The maximum number of queries to link to in the sidebar. Set this value to 0 to hide the links altogether.


upcoming-events

Default: 7

Show a notification bubble in the sidebar displaying the number of events less than upcoming-events days away. Set this value to 0 to disable this feature.


show-closed-accounts

Default: false

show-accounts-with-zero-transactions

Default: true

show-accounts-with-zero-balance

Default: true

These three options options specify which accounts (not) to show in the account trees, like on the income statement. Accounts with a non-zero balance will always be shown.


collapse-pattern

Default: Not set

This option is used to specify accounts that will be collapsed in the displayed account trees. The argument to this option is a regular expression matching account names. This option can be specified multiple times.

Collapsing all accounts below a specific depth in the account tree can be accomplished by a regex such as: .*:.*:.* (this example collapses all accounts that are three levels deep).


use-external-editor

Default: false

If true, instead of using the internal editor, the beancount:// URL scheme is used. See the Beancount urlscheme project for details.


account-journal-include-children

Default: true

This determines if the journal in the account report includes entries of sub-accounts.


uptodate-indicator-grey-lookback-days

Default: 60

If there has been no activity in given number of days since the last balance entry, then the grey uptodate-indicator is shown.


import-config

Default: Not set

Path to a Beancount import configuration file. See the [Import]({{ url_for('help_page', page_slug='import') }}) help page for details.


import-dirs

Default: Not set

Set the directories to be scanned by the Beancount import mechanism.

You can’t perform that action at this time.