Firefly III#

Firefly III is a money management app.

amd64
arm64
armv7

Information#

Docker Image: !!! LINK TO DOCKER IMAGE/ DOCKER HUB !!!
Current Image Version: latest

SETUP#

Enabling firefly_iii#

Command:#

vlab set firefly_iii.enable True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

firefly_iii
enable: True

Finalising changes:#

run: vlab update_one service=firefly_iii

FIRST RUN#

!!! DEVELOPERS: make sure that you include any information that the user requires to get started, below. !!!
!!! Below are some examples with headings, and with some example instructions !!!

ADMINISTRATOR SETUP#

Navigate to https://False/admin

Create an account with your desired username; as this is the first user, firefly_iii makes this account the administrator.

SMTP/ MAIL#

  1. run vlab decrypt to decrypt the vault.yml file
  2. make some changes

SMTP Settings#

smtp:
host:
port:
user:
pass:
from_email:
from_name:
  1. run vlab update_one service=firefly_iii to complete the changes

ACCESS#

firefly_iii (HTTPS) link: https://firefly_iii.vivumlab.xyz/ firefly_iii (HTTP) link: http://firefly_iii.vivumlab.xyz/

OPTIONS#

HTTPS_ONLY#

Default: False
Options: True/False

Command:#

vlab set firefly_iii.https_only True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

firefly_iii
https_only: True
Finalising changes:#

run: vlab update_one service=firefly_iii

AUTH#

Default: False
Options: True/False

Command:#

vlab set firefly_iii.auth True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

firefly_iii
auth: True
Finalising changes:#

run: vlab update_one service=firefly_iii

DOMAIN#

Default: False
NOTE: include the sitename and top level domain suffix. eg. name.com, site.net

Command:#

vlab set firefly_iii.domain firefly_iii.com

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

firefly_iii
domain: firefly_iii.com
Finalising changes:#

run: vlab update_one service=firefly_iii

SUBDOMAIN#

Default: firefly_iii
NOTE: Periods/ delimiters are not required. eg. 'media' will set the full URL as 'media.vivumlab.xyz'

Command:#

vlab set firefly_iii.subdomain media

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

firefly_iii
subdomain: media
Finalising changes:#

run: vlab update_one service=firefly_iii

VERSION#

Default: latest
NOTE: Ensure that the version exists

Command:#

vlab set firefly_iii.version 2.7

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

firefly_iii
version: 2.7
Finalising changes:#

run: vlab update_one service=firefly_iii

Need more help?#

Further information regarding services can be found.
General Information can be found in the documentation.
Additional assistance can be found on our Contact Us page.