docker-finance | modern accounting for the power-user

Dedicated to Michael Morgan: a beautiful, beautiful soul.

---

Internal signing keys:

  Aaron Fiore (sole author)

    - 518A22F85BEFD32BCC99C48603F90C4F35E0213E
    - 31ECA5C347A0CC0815EDE730A3EACCFCDA7E685E
    - C8187C585CB07A4DA81CC0F37318B50EBE9C0DA8

Internal repositories (rebased from):

  Staging:

    $ git log -n1 --pretty=format:"%H"
    c8e0cd66f6c89fa7b3c62f72fb524a4cc454b7b6

    $ git rev-list --max-parents=0 HEAD
    ac3863b8c234755855f1aea3a07a853122decdf2

  Private:

    $ git log -n1 --pretty=format:"%H"
    69bb3591eaa2990a9637832bb484690e00c4f926

    $ git rev-list --max-parents=0 HEAD
    a5c1cc9fb593c4cf09bc0adfef6cb6d2964511ae

client/Dockerfiles/dev-tools/Dockerfile.dev-tools.in

@@ -0,0 +1,95 @@
+# docker-finance | modern accounting for the power-user
+#
+# Copyright (C) 2021-2024 Aaron Fiore (Founder, Evergreen Crypto LLC)
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+FROM ubuntu:rolling
+
+#
+# System
+#
+
+RUN groupadd -r wheel
+
+# `dev-tools` user
+RUN useradd -m -s /bin/bash @DOCKER_FINANCE_USER@ -u @DOCKER_FINANCE_UID@
+RUN gpasswd -a @DOCKER_FINANCE_USER@ wheel
+
+# System-level user for building (won't pollute user-level UID space)
+RUN useradd -m -s /bin/bash -r builder && gpasswd -a builder wheel
+RUN gpasswd -a builder wheel
+
+RUN apt update -y
+
+#
+# `dev-tools` Linters
+#
+
+# Bash
+RUN apt install -y shfmt shellcheck
+
+# C++
+RUN apt install -y clang-format cppcheck cpplint
+
+# PHP
+RUN apt install -y composer
+
+USER @DOCKER_FINANCE_USER@
+WORKDIR /home/@DOCKER_FINANCE_USER@
+
+RUN composer global require -n --dev friendsofphp/php-cs-fixer
+RUN composer global require -n --dev phpstan/phpstan
+
+RUN echo "export PATH=\"\${PATH}:\${HOME}/.composer/vendor/bin\"" | tee -a ~/.bash_aliases
+
+#
+# `finance` dependencies (fetch APIs)
+#
+
+USER root
+RUN apt install -y php php-bcmath php-curl php-gmp
+
+USER builder
+WORKDIR /usr/local/lib/php
+RUN composer require ozdemirburak/json-csv
+RUN composer require codenix-sv/coingecko-api
+RUN composer require ccxt/ccxt
+# "Sunsetted" Coinbase Pro
+RUN composer require mocking-magician/coinbase-pro-sdk
+
+# Allow real-time editing of libraries (useful for debugging)
+USER root
+RUN chown -R :wheel /usr/local/lib/php && chmod g+rwx /usr/local/lib/php
+
+#
+# `dev-tools` misc.
+#
+
+# Doxygen
+RUN apt install -y doxygen graphviz
+
+#
+# Entrypoint
+#
+
+COPY ./entrypoint.bash /entrypoint.bash
+RUN chmod a+rx /entrypoint.bash
+
+USER @DOCKER_FINANCE_USER@
+WORKDIR /home/@DOCKER_FINANCE_USER@
+
+ENTRYPOINT ["/entrypoint.bash"]
+
+# vim: sw=2 sts=2 si ai et

client/Dockerfiles/dev-tools/docker-compose.yml.dev-tools.in

@@ -0,0 +1,56 @@
+# docker-finance | modern accounting for the power-user
+#
+# Copyright (C) 2021-2024 Aaron Fiore (Founder, Evergreen Crypto LLC)
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+version: "3.8"
+services:
+  docker-finance:
+    image: @DOCKER_FINANCE_IMAGE@
+    container_name: @DOCKER_FINANCE_CONTAINER@
+    build: .
+    volumes:
+      #
+      # NOTE: using DOCKER_FINANCE_CLIENT_REPO on both ends because:
+      #
+      #  1. Linter requires a transparent bind-mount from the client
+      #  2. There's no use-case for custom container configurations
+      #
+      - ${DOCKER_FINANCE_CLIENT_REPO}/docker-finance.dox:${DOCKER_FINANCE_CLIENT_REPO}/docker-finance.dox
+      - ${DOCKER_FINANCE_CLIENT_REPO}/client:${DOCKER_FINANCE_CLIENT_REPO}/client
+      - ${DOCKER_FINANCE_CLIENT_REPO}/container:${DOCKER_FINANCE_CLIENT_REPO}/container
+      #- /etc/timezone:/etc/timezone:ro  # TODO: will break on Arch hosts
+      - /etc/localtime:/etc/localtime:ro
+    environment:
+      - DOCKER_FINANCE_CLIENT_REPO=${DOCKER_FINANCE_CLIENT_REPO}
+      - DOCKER_FINANCE_VERSION=${DOCKER_FINANCE_VERSION}
+      - GID=${DOCKER_FINANCE_GID}
+      - UID=${DOCKER_FINANCE_UID}
+    deploy:
+      resources:
+        limits:
+          cpus: ${DOCKER_FINANCE_CPUS}
+          memory: ${DOCKER_FINANCE_MEMORY}
+    restart: on-failure
+    init: true
+    networks:
+      docker-finance:
+
+networks:
+  docker-finance:
+    external: true
+    name: @DOCKER_FINANCE_NETWORK@
+
+# vim: sw=2 sts=2 si ai et

client/Dockerfiles/dev-tools/entrypoint.bash

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+
+# docker-finance | modern accounting for the power-user
+#
+# Copyright (C) 2021-2024 Aaron Fiore (Founder, Evergreen Crypto LLC)
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+# Keep container running
+tail -f /dev/null
+
+exec "$@"