For rule consistency. Does not affect balances or other functionality.
Looking for a Quickstart? Skip to Installation.
- What does it do?
- What is supported?
- How do I get started?
- How do I use it?
- How do I contribute?
- How do I connect?
- Where is the legalese?
What does it do?
Cryptocurrency, legacy banking, tax preparation, metadata analysis & more!
Overview
docker-finance gives you the power of a privacy-focused, highly uniform system of financial management - but with a modern twist.
Cryptocurrencies & blockchain metadata are unified with legacy finance to create a world of best-practice accounting in a highly flexible, time-tested environment.
Highlights
- Highly granular plaintext accounting
- Visualize your metadata with a high-powered physics framework
- Privacy-aware instance generates (and stores) your visualizations locally
- Interactive C++ interpreter allows complex analysis with efficiency
- Report generation & tax preparation
- Cryptocurrency income from interest and staking
- Cryptocurrency spending and network fees
- Cryptocurrency trading across CeFi & DeFi
- Income statements, balance sheets and more
- Automated data procurement & aggregation into meaningful journals
- Use network APIs to
fetchaccount CSV data or market prices - Manually drop-in your institutions' CSVs (for accounts w/out remote API)
- Import all journals with a single command to create a unified journal
- Enjoy using your client's (host's)
crontabfor the container's suite of commands
- Use network APIs to
- Unique & customizable environments for your individual needs
- Versatile: create unlimited profiles for any number of groups and users
- Flexible: while automation is useful, so is the manual entry framework
- Private: all of your accounts are under your control; not a 3rd party
- Secure: all financial activity is managed within a Docker container
- Anonymous: Tor support is available for all
fetchfunctionality
- Developer-friendly environment that keeps you in the zone
- A plugins framework allows for maximum extensibility
- See the Development section for details
Screenshots
Client (Host)
The docker in docker-finance.
image: finance (docker-finance)
image: dev-tools
Container
The finance in docker-finance.
Fetch
Ledger (command)
Meta (w/ ROOT C++ analysis)
ROOT (CLI w/ C++ API)
Taxes
Reports
Help (suite of commands)
What is supported?
Plaintext accounting gives you the power to manage any number of assets or accounts.
However, for accounts that require fetch/import functionality, only the following are supported:
CeFi
Regularly maintained
Available but requires community maintenance
Available but no longer maintained
- Bittrex (bankrupt [US] / wind down [Global])
- BlockFi (bankrupt)
- Celsius Network (bankrupt)
- Coinbase Pro ("sunsetted")
DeFi
Blockchain explorers / Ecosystems
Supported blockchains (independent of wallet type):
- Algorand (powered by AlgoNode.io)
- Cardano
- Ethereum-based (powered by Etherscan.io APIs)
- Tezos (powered by TzKT API)
Self-hosting
Wallets
Software
Hardware
Web
TradFi
Regularly maintained
Requires community maintenance
NonFi
Cloud Services
Prices
- Cryptocurrency
- Traditional markets
How do I get started?
Installation
docker-finance is not your typical Docker image in which you simply pull and containerize, but rather it's an image-based accounting system that operates transparently between your client (host) and container; keeping your finances containerized, with all the benefits of containerization.
docker-finance should work out-of-the-box on any modern Linux system. For example, if your client (host) is Ubuntu, the default installation of coreutils, shells and utils that came with your system will satisfy requirements. However, you'll still need to manually install Docker (see below).
-
Install dependencies:
- Docker Engine with post-install configuration
- Latest version (or at least
27.1.1)
- Latest version (or at least
- GNU Bash
- Latest version (or at least
5.0.17) - Installed by default on most Linux distributions
- Latest version (or at least
- Git
- Latest version (or at least
2.25.1) - Only needed for step 3 but should be kept in order to:
- Remain up-to-date with future
docker-financeversions - Safely track your workflow related data (journals, metadata, etc.)
- Remain up-to-date with future
- Latest version (or at least
- Docker Engine with post-install configuration
-
Install recommended (optional):
Although not required, consider the following for workflow efficiency:
-
Prepare your repository:
Pick a persistent path that you're likely to keep; your environment will be aliased/sourced to the path you choose.
if hash git &>/dev/null; then if [ -d docker-finance ]; then if pushd docker-finance &>/dev/null; then if ! git pull --tags; then echo "FATAL: docker-finance repo not pulled" >&2 fi popd 1>/dev/null else echo "FATAL: docker-finance repo not found" >&2 fi else if ! git clone https://gitea.com/EvergreenCrypto/docker-finance; then echo "FATAL: docker-finance repo not cloned" >&2 fi fi else echo "FATAL: git not found" >&2 fi -
Verify your repository (optional):
if pushd docker-finance/ 1>/dev/null; then gpg --keyserver hkp://keyserver.ubuntu.com --recv-key 518A22F85BEFD32BCC99C48603F90C4F35E0213E \ && git verify-commit $(git log -n1 --pretty=format:"%H") \ && echo -e "\nSUCCESS: now confirm matching key = 518A22F85BEFD32BCC99C48603F90C4F35E0213E" \ || echo -e "\nFATAL: no key available or possible MITM - do not use!" popd 1>/dev/null fi -
Prepare your shell environment:
The following install convenience aliases and command completion to your shell environment (see install.bash for details).
./docker-finance/client/install.bash && source ~/.bashrc- After your first image is built (step 7), you can use commandline completion for all
docker-financeimages and image-based commands - The
dfialias ofdocker-financeis the recommended alias to use for for all client/container operations
- After your first image is built (step 7), you can use commandline completion for all
-
Generate client/container environment:
The following will generate your Docker-related client/container environment for the default image (see Environment Generation for details):
dfi archlinux/${USER}:default gen all=allTo regenerate any step in this process, now or in the future, use
gen helpfor available options To use theubuntuimage instead, replacearchlinuxwithubuntuhere and for all remaining steps -
Build default
docker-financeimage:dfi archlinux/${USER}:default build type=defaultUse the
build helpcommand for available options (such as smaller, faster builds) -
Bring up container of default
docker-financeimage:dfi archlinux/${USER}:default upYou can use tab completion for all
dfi <platform/user:tag>commands (but only for built images). Seedfi helpfor commands. -
You're inside! See How do I use it? for next steps.
-
(Optional) Developers: on your client (host), build and setup the
dev-toolsplatform:dfi dev-tools/${USER}:default gen all=all && dfi dev-tools/${USER}:default build type=default
Environment Generation
docker-finance's environment consists of two scopes: client and container. The client (host) view is confined to the host while the container view confined to the container (though the client can, at times, view from within the container's perspective).
In terms of configuration, the client (host) has the following files:
- The Client (Host) Configuration File (client only)
- The Client (Host) Custom Dockerfile (client only)
- The Client/Container Superscript (client/container)
You'll create these files (and more) when running client (host) command gen, as seen below.
Tip: client scope can be considered an OOP class which inherits the container as a protected class, with the Client/Container Superscript binding them.
Client Generation
When running gen, you'll see the following:
Client environment file found, backup then generate new one? [Y/n]
Generates the client (host) configuration file (see the Client (Host) Configuration File for details).
- You can use the generated defaults but make sure your directory layout matches accordingly
- To easily edit this configuration file after
genis complete, run client (host) commandedit type=env
Generating new custom (optional) Dockerfile
Generates custom Dockerfile. Do as you wish; install your own container packages, etc. (see the Client (Host) Custom Dockerfile for details).
- To easily edit this configuration file after
genis complete, run client (host) commandedit type=build
Generate joint client/container superscript? [Y/n]
Select 'y' if this is your first-run for the given platform and tag, or if you need to regenerate the file (see Superscript for details).
Container Generation
After the previous client environment is generated, the following will prepare the container environment (everything you'll need while inside docker-finance).
Generate container finance flow (layout and profiles)? [Y/n]
Not limited to hledger-flow data, this option leads to generating the layout and files needed for processing all docker-finance end-user generated data (journals, configurations, etc.).
Although the container environment is a minimum requirement, here you'll have the option to continue generation.
Enter profile name (e.g., family in 'family/alice') Enter subprofile name (e.g., alice in 'family/alice')
Container generation will always be for a specific profile with subprofile, and here is where you input that information. For example, you could have a family profile with subprofiles of various family members or a business profile with subprofiles of all the various businesses you own.
It should be noted that:
- all subsequent questions and container generation will relate to this
profile/subprofilepairing - all output will be sent to the
${DOCKER_FINANCE_CONTAINER_FLOW}/profiles/profile/subprofilepath
Generate subprofile's subscript file? [Y/n]
The container's subprofile's shell script is where all subprofile commands and aliases exist.
This file is generated on a per-subprofile basis and all custom code on a per-subprofile basis should go here (see Subscript for details).
Generate subprofile's fetch configuration file? [Y/n]
The container's fetch configuration is what all remote fetching relies on: prices, exchanges, blockchain explorers; all are configured here (see Fetch for details).
Generate subprofile's financial metadata file? [Y/n]
The container's per-subprofile metadata file.
This file contains all your custom metadata and can edited with the edit and analyzed with the meta or root command (see Meta for details).
Generate subprofile's hledger configuration file? [Y/n]
This configuration file is specific to hledger. See hledger documentation for options.
Generate subprofile's hledger-flow accounts? [Y/n]
The container's hledger-flow accounts to be installed. These are the accounts described in What is supported?.
WARNING: if you plan to use blockchain-based wallets (coinbase-wallet, pera-wallet, ledger, metamask, etc.), you MUST generate their respective chains, as seen during generation (algorand, ethereum-based, tezos, etc).
Configuration Files
Client (Host) Configuration
The client (host) configuration file:
- is located in the
${DOCKER_FINANCE_CLIENT_CONF}/client/env/directory, with subdirectory format ofkernel-machine/platform/tag- format consists of
username@hostnamewhereusernameis your host username andhostnameis your machine's hostname
- format consists of
- client/container configurations can be stored on shared NFS/CIFS or related network storage (with applicable user permissions)
- allows for customizable locations of all container data on any mountable filesystem (as a replacement for Docker Volumes)
- consists solely of variables in the format
DOCKER_FINANCE_VARIABLE=valueand is used by both Docker anddocker-finance - default template variables can be found in gen.bash, as described below
After gen is complete, you can edit this file with the client (host) command: edit type=env (see Client (Host) Command Format).
DOCKER_FINANCE_CLIENT_CONF
Client (host) configuration path. Parent directory for client configuration files.
- Example:
DOCKER_FINANCE_CLIENT_CONF=/home/${USER}/.config/docker-finance.d
DOCKER_FINANCE_CLIENT_FLOW
Client (host) finance-flow path. Parent directory for all profiles and end-user data.
- Example:
DOCKER_FINANCE_CLIENT_FLOW=/net/nfs4/finance-flow
DOCKER_FINANCE_CLIENT_REPO
Client (host) path for the docker-finance code repository (from the host's perspective).
This parent directory is where the client and container directories are located.
- Example:
DOCKER_FINANCE_CLIENT_REPO=/net/nfs4/git/docker-finance
DOCKER_FINANCE_CLIENT_SHARED
Client (host) path for the client/container shared directory.
The bind-mount is used exclusively for non-essential file sharing (custom scripts or any file you wish).
- Example:
DOCKER_FINANCE_CLIENT_SHARED=/mnt/share.d
DOCKER_FINANCE_CLIENT_PLUGINS
Client (host) path for the client/container shared custom plugins.
The bind-mount is used exclusively for user-added plugins not in the repository.
- Example:
DOCKER_FINANCE_CLIENT_PLUGINS=/home/${USER}/Development/dfi_custom-plugins
DOCKER_FINANCE_CONTAINER_CMD
The container's finance command (useful for experimental implementations).
Default: finance.bash (internally aliased to finance and dfi)
- Example:
DOCKER_FINANCE_CONTAINER_CMD=finance.bash
DOCKER_FINANCE_CONTAINER_CONF
The container's configuration path (bind-mounted to client's (host's) configuration path).
- Example:
DOCKER_FINANCE_CONTAINER_CONF=/home/${USER}/.config/docker-finance.d
DOCKER_FINANCE_CONTAINER_EDITOR
The container's default text editor.
- Example:
DOCKER_FINANCE_CONTAINER_EDITOR=vim
DOCKER_FINANCE_CONTAINER_FLOW
The container's finance-flow path from the container's perspective.
This path is bind-mounted to the client's (host's) finance-flow path.
- Example:
DOCKER_FINANCE_CONTAINER_FLOW=/home/${USER}/finance-flow
DOCKER_FINANCE_CONTAINER_REPO
The container's docker-finance code repository path (as viewed from the container).
This path is bind-mounted to the client's (host's) docker-finance/container path.
- Example:
DOCKER_FINANCE_CONTAINER_REPO=/home/${USER}/docker-finance
DOCKER_FINANCE_CONTAINER_SHARED
The container's share.d path, bind-mounted to client's (host's) share.d path.
- Example:
DOCKER_FINANCE_CONTAINER_FLOW=/home/${USER}/share.d
DOCKER_FINANCE_CONTAINER_PLUGINS
The client's custom plugin path (as viewed from the container).
This path is bind-mounted to the client's (host's) ${DOCKER_FINANCE_CLIENT_PLUGINS}/container path.
- Example:
DOCKER_FINANCE_CONTAINER_PLUGINS=/home/${USER}/plugins
DOCKER_FINANCE_CPUS
Docker daemon/container setting: number of CPUs to use.
- Example:
DOCKER_FINANCE_CPUS=2
DOCKER_FINANCE_DEBUG
Enable/disable debugging code paths (i.e., debug logging)
Debug log-levels range from none to most: 0 1 2
- Example:
DOCKER_FINANCE_DEBUG=2
DOCKER_FINANCE_PORT_HLEDGER
hledger-web client-side (host) port
- Example:
DOCKER_FINANCE_PORT_HLEDGER=5000
DOCKER_FINANCE_PORT_ROOT
root client-side (host) port for web interface
- Example:
DOCKER_FINANCE_PORT_ROOT=8080
DOCKER_FINANCE_MEMORY
docker-finance container memory limit (see Docker documentation).
- Example:
5G
DOCKER_FINANCE_GID
Group ID for bind mount. MUST have write permissions to rw bind-mounts.
- Example:
DOCKER_FINANCE_GID=998
DOCKER_FINANCE_UID
User ID for bind mount. MUST have write permissions to rw bind-mounts.
- Example:
DOCKER_FINANCE_UID=1001
DOCKER_FINANCE_USER
docker-finance container user.
Container user's UID/GID SHOULD match DOCKER_FINANCE_UID and DOCKER_FINANCE_GID. This is automatically determined during Environment Generation.
User MUST have write permissions to rw bind-mounts.
- Example:
DOCKER_FINANCE_USER=alice
Client (Host) Custom Dockerfile
The client (host) custom Dockerfile:
- is appended to the final generated Dockerfile
- allows you to append any Dockerfile command to a generated build
- is located in the
${DOCKER_FINANCE_CLIENT_CONF}/client/Dockerfiles/directory- format consists of
username@hostnamewhereusernameis your host username andhostnameis your machine's hostname
- format consists of
- default generated templates can be found here
After gen is complete, you can edit this file with the client (host) command: edit type=build (see Client (Host) Command Format).
Client/Container Superscript
The client/container shell script (Superscript) is a bind-mounted (by directory) script that:
- is the intermediary between client and container
- is unique to each client (host) user (/home/alice, /home/bob, etc.)
- is the glue that ties together all container Subscript
- is generated on a per-client basis: all custom code on a per-client basis should go here
See the in-file comments for further documentation:
After gen is complete, you can edit this file with the client (host) command: edit type=shell (see Client (Host) Command Format).
Container Configurations
These configurations are confined solely to the container.
Subscript
The Subprofile's subscript is unique to each subprofile, for each profile/subprofile within the profiles parent directory.
By default, this file will contain user aliases for all container commands. These aliases are mostly useful for small setups or setups with uniquely named subprofiles among all profiles.
See the in-file comments for further documentation:
After gen is complete, from within the container, you can edit this file with: dfi profile/subprofile edit type=shell (see Container Command Format).
Fetch
The source of all remote API fetching configurations (exchanges, blockchains, market prices). This file is used by both the fetch and edit type=fetch commands.
See the in-file comments for further documentation:
After gen is complete, from within the container, you can edit this file with: dfi profile/subprofile edit type=fetch (see Container Command Format).
Meta
The source of all custom metadata information (typically used to store cryptocurrency metadata information). This file is used by the meta, edit type=meta and root commands, as seen in Meta (w/ ROOT C++ analysis).
See the in-file comments for further documentation:
After gen is complete, from within the container, you can edit this file with: dfi profile/subprofile edit type=meta (see Container Command Format).
How do I use it?
Mostly-Unified CLI
You'll only need to call two different scripts throughout your time using docker-finance:
- The client script which handles the client-side system:
docker.bash - The container script which handles the container-side system:
finance.bash
These two scripts can be rationalized by the following format:
<script> <super/sub> <command> [args]
For example, these Screenshots describe a setup with mockup data where the client (host) user named personal, along with container $DOCKER_FINANCE_USER named personal, engage in client/container activity. The container profile named testprofile and its subprofile named testuser can be described as <super/sub> portion of the format (testprofile/testuser).
It should be noted that, for your convenience:
- command arguments [args] can be arranged in any order
- commandline completion is available for all
<super/sub> command [args](so, save your fingers and tab away)- NOTE: for client, an image must first be built
Client (Host) Command Format
The client (host) command format consists of:
docker.bash <platform/username:tag> <command> [args]
Where:
docker.bashis located in${DOCKER_FINANCE_CLIENT_REPO}/client<platform/username:tag>platformis the image platform (archlinux, ubuntu)usernameis the client (host) username with read/write permissions to the container (see Configuration Files)tagis a custom tag you can use to delineate any number of images that you wish you create (latest,dev, etc.)
<command>is the command to pass todocker.bash[args]are the (optional) arguments to pass to<command>
If the Installation was successful, docker.bash is aliased to docker-finance and dfi (so, either can be used).
For a complete list of commands and usage help (<platform/user:tag> not required):
dfi help
To view the help usage of a specific command, for example; the edit command (<platform/user:tag> is required):
dfi archlinux/${USER}:default edit help
Container Command Format
The container command format consists of:
finance.bash <profile/subprofile> <command> [args]
Where:
finance.bashis located in${DOCKER_FINANCE_CLIENT_REPO}/container<profile/subprofile>profileis the profile, as defined during Environment Generationsubprofileis the subprofile (user), as defined during Environment Generation
<command>is the command to pass tofinance.bash[args]are the (optional) arguments to pass to<command>
By default, finance.bash is aliased to finance and dfi (so, either can be used).
For a complete list of commands (<profile/subprofile> not required):
dfi help
To view the help usage of a specific command, for example; the fetch command (<profile/subprofile> is required):
Assuming <profile/subprofile> is testprofile/testuser:
dfi testprofile/testuser fetch help
Or, use a subprofile alias, as described in Subscript:
testuser_fetch help
Flow Layout
A primary read through of hledger and hledger-flow documentation should bring you up to speed on the essentials.
As for docker-finance specifics, you can create a test profile during Environment Generation to see what your flow's layout should look like.
Note: be sure to select 'y' when asked if this will be a development profile, and then go on to create account(s).
Once inside the container, assuming you created a profile named testprofile and subprofile named testuser, issue the following commands:
finance testprofile/testuser fetch all=price year=all && finance testprofile/testuser import year=2018
Note: for this test profile with developer mockups, you MUST import from
2018as there are accounts that begin from that year
After experimenting with a test profile, you can re-run gen again to create your own normal profile.
Profiles
All profiles/subprofiles are installed into the parent directory ${DOCKER_FINANCE_CONTAINER_FLOW}/profiles.
Peeking inside ${DOCKER_FINANCE_CONTAINER_FLOW}/profiles/profile/subprofile, you'll see the following:
-
all-years.journalanddirectives.journal- These top-level journals are generated by
hledger-flow. Ignore these and use the containereditcommand for all journal editing.
- These top-level journals are generated by
-
docker-finance.d- Location of all
docker-financeconfiguration files (seeedit helpfor details).
- Location of all
-
import- Location of all CSV data and real journals. This is where you'll place CSV files and custom account/subaccount changes (see
edit helpfor details).
- Location of all CSV data and real journals. This is where you'll place CSV files and custom account/subaccount changes (see
-
prices- Location of all market price data, by year, as acquired by
fetch price(seefetch helpfor details).
- Location of all market price data, by year, as acquired by
-
reports- Location of all generated reports, by year, as generated by
reports(seereports helpfor details).
- Location of all generated reports, by year, as generated by
-
taxes- Location of all generated taxes, by year, as generated by
taxes(seetaxes helpfor details).
- Location of all generated taxes, by year, as generated by
Note:
- For manual CSV downloads, place you CSV file into your
${DOCKER_FINANCE_CONTAINER_FLOW}/profiles/profile/subprofile/import/subprofile/account/subaccount/1-in/yeardirectory (replacingyearwith the year of data that the file/data represents). Seeimport helpfor details. - When you want to edit custom settings for an account or a subaccount, use the container
editcommand. See container'sedit helpfor details.
Times
All times related files will reside in ${DOCKER_FINANCE_CONTAINER_FLOW}/times (this includes the timewarrior database).
See the container times help command for details.
Caveats & Oddities
Flow Layout
Your finance-flow directory will contain a symlink called src which links to code that processes your data. Do not delete this symlink.
Prices
Before you try to infer market prices, be sure to fetch prices before you do your first import (or first import of the year). If you do not fetch, the prices journal will not be included within the import and, if you have a previous year of prices, you will unwittingly infer against that previous year instead of your expected year!
Accounts: Trezor
In the "Trezor Suite" app, change your wallet name to your subaccount(s). For example, to delineate between your Trezor One from several Trezor T devices, and to delineate between their separate wallets within every device, follow these steps:
Example, using your #2 Trezor T device and one of its BTC "storage" wallets:
- Change wallet name in app to
t-2:storage-1as it's your Trezor T device #2, 1st bitcoin wallet namedstorage-1(versus your 2nd bitcoin wallet namedstorage-2, etc.) - Export the CSV file to the appropriate directory. It will be in the format of
t_2_storage_1_20230629T230013.csv(timestamp will be different) - Rename the file to
t-2:storage-1_BTC.csv(be sure to append the currency ticker to the file. So,_BTCif bitcoin or_LTCif litecoin, etc).
Note: see Trezor
mockupdata within this repository, for a working example.
docker-finance relies on Amount unit within the file for the actual symbol/currency so, this file naming convention serves at least two purposes:
- This allows you to maintain device continuity by reusing wallet names for different currencies.
- This allows you to export, in the future, to the correct file from the associated hardware wallet because each hardware wallet exports its own unique CSV.
Taxes
- If you have a wallets designated for
SPENDing/GIFTing orINCOME, you can use custom rules to mark all outgoing/incoming transactions as such (ex., using tagstaxed_as:SPEND/taxed_as:GIFT/taxed_as:INCOME/etc.). See implementation for details. - WARNING: all
GIFTINcost-basis must be manually entered from the correspondingGIFTresults/calculations (as gifted from another).- For blockchain-related transactions, you can easily add cost-basis of a gift received (
GIFTIN) by TXID in your custom rules- Example: despite Electrum providing
fiat_value, you'll need to manually enter in your custom rules the correctGIFTvalue (if divergent)
- Example: despite Electrum providing
- For blockchain-related transactions, you can easily add cost-basis of a gift received (
How do I contribute?
Donate
Time
Your input is valuable and appreciated. Come, make this project your own!
Dependencies
To donate to the wonderful projects that docker-finance gratefully depends upon, please donate to them directly:
For other dependencies, please see their individual contributing guidelines.
Development
You'll greatly benefit from building the dev-tools image, as seen in docker-finance help.
Additionally, when developing with the docker-finance image create a development profile with the gen command argument dev=on. From there, you'll have access to mockup CSVs as described in Flow Layout.
- In addition to
dev=on, run theconfirm=offandprofile=arguments to quickly spin-up a new development profile- Developer mockup CSVs can be found in the
mockupdirectories within the hledger-flow section of this repository- Developer mockup CSVs will intentionally have multiple years within in a
1-in/yeardirectory in order to test for year parsing
Plugins
Plugins allow you to use docker-finance public APIs, libraries and environment (client and/or container) to meet your unique needs. These plugins are categorical; as in, there are client-side ("custom") plugins and repository ("repo") plugins. Additionally, there are subcategories such as docker, finance and root (respective to their modules).
Client-side custom plugins allow you to drop-in any code that you write and keep them locally. Repository plugins are plugins that remain within the repository and will require a pull request for any changes to be made. Client-side custom plugins can be used for either client or container modules (see directory layout).
Upon client gen, a client-side directory layout is generated. This layout consists of:
${DOCKER_FINANCE_CLIENT_PLUGINS}/client/docker- Custom plugins that function only client-side (
lib_docker)
- Custom plugins that function only client-side (
${DOCKER_FINANCE_CLIENT_PLUGINS}/container/{finance,root}- Custom plugins that function only container-side (
lib_finance,root)
- Custom plugins that function only container-side (
WARNING: don't change the parent client-side directory layout (although, you can add subdirectories):
- e.g.,
${DOCKER_FINANCE_CLIENT_PLUGINS}/container/finance/my_experimental_plugins/{file1.ext,file2.ext}
This client-side "custom" layout somewhat mirrors the repository's plugins layout (see client/plugins and container/plugins).
For more information, see the example plugins and help usage of each module, e.g.; plugins help or help().
Note: for custom plugins within directory
dockerandfinancethat utilize the shell, any language can be used so long as the file is executable, reads the shell environment and can initiailize their respective libraries (lib_docker,lib_finance).
Pull Request
The following assumes that the command dev-tools has been properly aliased, per docker-finance help.
Before sending a pull request:
- If you created a new file, please run
dev-tools license file=/path/to/new/file.extand update the copyright date and author. - For any work that utilizes Bash/C++/PHP, please run the linter for your respective language (e.g.,
dev-tools linter type=bash).- See
dev-tools linter helpfor details.
- See
- As for style guidelines, these are recommended:
- If you can, please document the code in Doxygen style where applicable and run
dev-tools doxygen gento see your code documentation.
Notes
- Regarding client configuration, Docker volumes aren't used because of chicken-or-the-egg problem (among other reasons).
docker-financeneeds the client environment before building the Docker image and spawning the subsequent container (which would rely on volumes). - As described in Mostly-Unified CLI, to use a developer version of the
financeimage (not adev-toolsimage), simply build and tag a newfinanceimage withdev(or whatever you see fit), and reset thedocker-financealias at your discretion. - Run
DOCKER_FINANCE_DEBUG=true docker-finance <platform/user:tag> <cmd> [args]to debug before the Client (Host) Configuration File file is read. - The
.Cfiles you see in the repository are ROOT.cern macro files, not C-language files.
How do I connect?
#docker-finance:matrix.org
Join the docker-finance Matrix community.
Evergreen Crypto LLC
- For general communications, please visit the contact section of the website.
- For security-related concerns, please contact the Founder directly with PGP encrypted email.
Where is the legalese?
License and Disclaimer
docker-finance:
- is not a Docker product
- is not a Docker trademark
- is not an endorsement of what is supported
- is not a tax-advising product (consult your tax adviser)
- is not a financial-advising product (consult your financial adviser)
- is licensed under the GPLv3 but...
- I highly suggest that you consider refraining from the use of AI modeling against
docker-financeand also refrain from mirroring (or archiving)docker-financeon GitHub, GitLab or any other service that uses AI against its hosted code, until the court make its final ruling on litigation against GitHub/Microsoft and OpenAI (and after any possible appeal).
- I highly suggest that you consider refraining from the use of AI modeling against
























































