commit 845d826f295e5d436b4b6508f79743a5dda4b117 Author: Aaron Fiore Date: Tue Oct 28 16:40:51 2025 -0700 Migrate (and update) docs from 'docker-finance' repo to 'dfi-docs' repo - Moves all documentation to this repository - Updates markdown to reflect latest impl - Updates assets to reflect latest impl * Assets are also now more self-documenting * Adds utility script to create gif examples diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..003a71d --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +gitea-merge.bash diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..496acdb --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,675 @@ +# GNU GENERAL PUBLIC LICENSE + +Version 3, 29 June 2007 + +Copyright (C) 2007 Free Software Foundation, Inc. + + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + +## Preamble + +The GNU General Public License is a free, copyleft license for +software and other kinds of works. + +The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom +to share and change all versions of a program--to make sure it remains +free software for all its users. We, the Free Software Foundation, use +the GNU General Public License for most of our software; it applies +also to any other work released this way by its authors. You can apply +it to your programs, too. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + +To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you +have certain responsibilities if you distribute copies of the +software, or if you modify it: responsibilities to respect the freedom +of others. + +For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + +Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + +For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + +Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the +manufacturer can do so. This is fundamentally incompatible with the +aim of protecting users' freedom to change the software. The +systematic pattern of such abuse occurs in the area of products for +individuals to use, which is precisely where it is most unacceptable. +Therefore, we have designed this version of the GPL to prohibit the +practice for those products. If such problems arise substantially in +other domains, we stand ready to extend this provision to those +domains in future versions of the GPL, as needed to protect the +freedom of users. + +Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish +to avoid the special danger that patents applied to a free program +could make it effectively proprietary. To prevent this, the GPL +assures that patents cannot be used to render the program non-free. + +The precise terms and conditions for copying, distribution and +modification follow. + +## TERMS AND CONDITIONS + +### 0. Definitions. + +"This License" refers to version 3 of the GNU General Public License. + +"Copyright" also means copyright-like laws that apply to other kinds +of works, such as semiconductor masks. + +"The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + +To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of +an exact copy. The resulting work is called a "modified version" of +the earlier work or a work "based on" the earlier work. + +A "covered work" means either the unmodified Program or a work based +on the Program. + +To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + +To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user +through a computer network, with no transfer of a copy, is not +conveying. + +An interactive user interface displays "Appropriate Legal Notices" to +the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +### 1. Source Code. + +The "source code" for a work means the preferred form of the work for +making modifications to it. "Object code" means any non-source form of +a work. + +A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + +The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + +The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + +The Corresponding Source need not include anything that users can +regenerate automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same +work. + +### 2. Basic Permissions. + +All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not convey, +without conditions so long as your license otherwise remains in force. +You may convey covered works to others for the sole purpose of having +them make modifications exclusively for you, or provide you with +facilities for running those works, provided that you comply with the +terms of this License in conveying all material for which you do not +control copyright. Those thus making or running the covered works for +you must do so exclusively on your behalf, under your direction and +control, on terms that prohibit them from making any copies of your +copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under the +conditions stated below. Sublicensing is not allowed; section 10 makes +it unnecessary. + +### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + +No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + +When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such +circumvention is effected by exercising rights under this License with +respect to the covered work, and you disclaim any intention to limit +operation or modification of the work as a means of enforcing, against +the work's users, your or third parties' legal rights to forbid +circumvention of technological measures. + +### 4. Conveying Verbatim Copies. + +You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + +### 5. Conveying Modified Source Versions. + +You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these +conditions: + +- a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. +- b) The work must carry prominent notices stating that it is + released under this License and any conditions added under + section 7. This requirement modifies the requirement in section 4 + to "keep intact all notices". +- c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. +- d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + +A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +### 6. Conveying Non-Source Forms. + +You may convey a covered work in object code form under the terms of +sections 4 and 5, provided that you also convey the machine-readable +Corresponding Source under the terms of this License, in one of these +ways: + +- a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. +- b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the Corresponding + Source from a network server at no charge. +- c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. +- d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. +- e) Convey the object code using peer-to-peer transmission, + provided you inform other peers where the object code and + Corresponding Source of the work are being offered to the general + public at no charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + +A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, +family, or household purposes, or (2) anything designed or sold for +incorporation into a dwelling. In determining whether a product is a +consumer product, doubtful cases shall be resolved in favor of +coverage. For a particular product received by a particular user, +"normally used" refers to a typical or common use of that class of +product, regardless of the status of the particular user or of the way +in which the particular user actually uses, or expects or is expected +to use, the product. A product is a consumer product regardless of +whether the product has substantial commercial, industrial or +non-consumer uses, unless such uses represent the only significant +mode of use of the product. + +"Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to +install and execute modified versions of a covered work in that User +Product from a modified version of its Corresponding Source. The +information must suffice to ensure that the continued functioning of +the modified object code is in no case prevented or interfered with +solely because modification has been made. + +If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + +The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or +updates for a work that has been modified or installed by the +recipient, or for the User Product in which it has been modified or +installed. Access to a network may be denied when the modification +itself materially and adversely affects the operation of the network +or violates the rules and protocols for communication across the +network. + +Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + +### 7. Additional Terms. + +"Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders +of that material) supplement the terms of this License with terms: + +- a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or +- b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or +- c) Prohibiting misrepresentation of the origin of that material, + or requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or +- d) Limiting the use for publicity purposes of names of licensors + or authors of the material; or +- e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or +- f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions + of it) with contractual assumptions of liability to the recipient, + for any liability that these contractual assumptions directly + impose on those licensors and authors. + +All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; the +above requirements apply either way. + +### 8. Termination. + +You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + +However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + +### 9. Acceptance Not Required for Having Copies. + +You are not required to accept this License in order to receive or run +a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + +### 10. Automatic Licensing of Downstream Recipients. + +Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + +An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + +### 11. Patents. + +A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + +A contributor's "essential patent claims" are all patent claims owned +or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + +In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + +If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + +A patent license is "discriminatory" if it does not include within the +scope of its coverage, prohibits the exercise of, or is conditioned on +the non-exercise of one or more of the rights that are specifically +granted under this License. You may not convey a covered work if you +are a party to an arrangement with a third party that is in the +business of distributing software, under which you make payment to the +third party based on the extent of your activity of conveying the +work, and under which the third party grants, to any of the parties +who would receive the covered work from you, a discriminatory patent +license (a) in connection with copies of the covered work conveyed by +you (or copies made from those copies), or (b) primarily for and in +connection with specific products or compilations that contain the +covered work, unless you entered into that arrangement, or that patent +license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + +### 12. No Surrender of Others' Freedom. + +If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under +this License and any other pertinent obligations, then as a +consequence you may not convey it at all. For example, if you agree to +terms that obligate you to collect a royalty for further conveying +from those to whom you convey the Program, the only way you could +satisfy both those terms and this License would be to refrain entirely +from conveying the Program. + +### 13. Use with the GNU Affero General Public License. + +Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + +### 14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions +of the GNU General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in +detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies that a certain numbered version of the GNU General Public +License "or any later version" applies to it, you have the option of +following the terms and conditions either of that numbered version or +of any later version published by the Free Software Foundation. If the +Program does not specify a version number of the GNU General Public +License, you may choose any version ever published by the Free +Software Foundation. + +If the Program specifies that a proxy can decide which future versions +of the GNU General Public License can be used, that proxy's public +statement of acceptance of a version permanently authorizes you to +choose that version for the Program. + +Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + +### 15. Disclaimer of Warranty. + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT +WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR +CORRECTION. + +### 16. Limitation of Liability. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR +CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES +ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT +NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR +LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM +TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER +PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +### 17. Interpretation of Sections 15 and 16. + +If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + +END OF TERMS AND CONDITIONS + +## How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + +To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively state +the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + 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 . + +Also add information on how to contact you by electronic and paper +mail. + +If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands \`show w' and \`show c' should show the +appropriate parts of the General Public License. Of course, your +program's commands might be different; for a GUI interface, you would +use an "about box". + +You should also get your employer (if you work as a programmer) or +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. For more information on this, and how to apply and follow +the GNU GPL, see . + +The GNU General Public License does not permit incorporating your +program into proprietary programs. If your program is a subroutine +library, you may consider it more useful to permit linking proprietary +applications with the library. If this is what you want to do, use the +GNU Lesser General Public License instead of this License. But first, +please read . diff --git a/README.md b/README.md new file mode 100644 index 0000000..53f9c97 --- /dev/null +++ b/README.md @@ -0,0 +1,58 @@ + +[//]: # (docker-finance | modern accounting for the power-user) +[//]: # () +[//]: # (Copyright [C] 2021-2025 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://gitea.com/EvergreenCrypto/docker-finance "docker-finance") + +
+ +
+ + (docker-finance) is a [quasi-"financial operating system"](markdown/What-does-it-do.md) of accounting for [variant ledgers and metadata](markdown/What-is-supported.md). + +After [installing and configuring](markdown/How-do-I-get-started.md), you can [learn how to use `dfi`](markdown/How-do-I-use-it.md). You can also [contribute](markdown/How-do-I-contribute.md) or [reach out](markdown/How-do-I-connect.md) at any time. + +Please, consider the [legalese](markdown/Where-is-the-legalese.md) before using (or copying) this repository. All other documentation can be found [here](markdown). + +
+ +
+ +
+ +[](markdown/What-does-it-do.md#image-finance "image: finance") +[](markdown/What-does-it-do.md#image-dev-tools "image: dev-tools") +[](markdown/What-does-it-do.md#fetch "Fetch prices, remote accounts and blockchain data") +[](markdown/What-does-it-do.md#hledger-suite "hledger-suite") +[](markdown/What-does-it-do.md#meta-w-root-c-analysis "Meta (w/ ROOT C++ analysis)") +[](markdown/What-does-it-do.md#root-cli-w-c-api "ROOT (CLI w/ C++ API)") +[](markdown/What-does-it-do.md#taxes "Tax preparation") +[](markdown/What-does-it-do.md#reports "Financial reports") + +
+ +--- + +
+ +To develop this repository and/or render it locally, you can install [Gitea](https://docs.gitea.com/installation/install-with-docker-rootless). + +
+ +[//]: # (vim: sw=2 sts=2 si ai et) diff --git a/assets/branding/png/dfi.png b/assets/branding/png/dfi.png new file mode 100644 index 0000000..f7d9f16 Binary files /dev/null and b/assets/branding/png/dfi.png differ diff --git a/assets/branding/png/docker-finance.png b/assets/branding/png/docker-finance.png new file mode 100644 index 0000000..ddafb04 Binary files /dev/null and b/assets/branding/png/docker-finance.png differ diff --git a/assets/branding/png/evergreencrypto.png b/assets/branding/png/evergreencrypto.png new file mode 100644 index 0000000..41441ff Binary files /dev/null and b/assets/branding/png/evergreencrypto.png differ diff --git a/assets/contacts/png/matrix.png b/assets/contacts/png/matrix.png new file mode 100644 index 0000000..b53fb71 Binary files /dev/null and b/assets/contacts/png/matrix.png differ diff --git a/assets/examples/gif/all.gif b/assets/examples/gif/all.gif new file mode 100644 index 0000000..59a88e5 Binary files /dev/null and b/assets/examples/gif/all.gif differ diff --git a/assets/examples/gif/client.gif b/assets/examples/gif/client.gif new file mode 100644 index 0000000..204a0f3 Binary files /dev/null and b/assets/examples/gif/client.gif differ diff --git a/assets/examples/gif/dev-tools.gif b/assets/examples/gif/dev-tools.gif new file mode 100644 index 0000000..c12dd0c Binary files /dev/null and b/assets/examples/gif/dev-tools.gif differ diff --git a/assets/examples/gif/fetch.gif b/assets/examples/gif/fetch.gif new file mode 100644 index 0000000..2aa2883 Binary files /dev/null and b/assets/examples/gif/fetch.gif differ diff --git a/assets/examples/gif/hledger-suite.gif b/assets/examples/gif/hledger-suite.gif new file mode 100644 index 0000000..862ce05 Binary files /dev/null and b/assets/examples/gif/hledger-suite.gif differ diff --git a/assets/examples/gif/meta.gif b/assets/examples/gif/meta.gif new file mode 100644 index 0000000..7934bfc Binary files /dev/null and b/assets/examples/gif/meta.gif differ diff --git a/assets/examples/gif/reports.gif b/assets/examples/gif/reports.gif new file mode 100644 index 0000000..bd527b5 Binary files /dev/null and b/assets/examples/gif/reports.gif differ diff --git a/assets/examples/gif/root.gif b/assets/examples/gif/root.gif new file mode 100644 index 0000000..7547a75 Binary files /dev/null and b/assets/examples/gif/root.gif differ diff --git a/assets/examples/gif/taxes.gif b/assets/examples/gif/taxes.gif new file mode 100644 index 0000000..6294a61 Binary files /dev/null and b/assets/examples/gif/taxes.gif differ diff --git a/assets/examples/png/client_00.png b/assets/examples/png/client_00.png new file mode 100644 index 0000000..ab251f2 Binary files /dev/null and b/assets/examples/png/client_00.png differ diff --git a/assets/examples/png/client_01.png b/assets/examples/png/client_01.png new file mode 100644 index 0000000..ae07dcf Binary files /dev/null and b/assets/examples/png/client_01.png differ diff --git a/assets/examples/png/client_02.png b/assets/examples/png/client_02.png new file mode 100644 index 0000000..fe30cb2 Binary files /dev/null and b/assets/examples/png/client_02.png differ diff --git a/assets/examples/png/client_03.png b/assets/examples/png/client_03.png new file mode 100644 index 0000000..0cf1a1b Binary files /dev/null and b/assets/examples/png/client_03.png differ diff --git a/assets/examples/png/client_04.png b/assets/examples/png/client_04.png new file mode 100644 index 0000000..3d5b845 Binary files /dev/null and b/assets/examples/png/client_04.png differ diff --git a/assets/examples/png/client_05.png b/assets/examples/png/client_05.png new file mode 100644 index 0000000..fcefdbe Binary files /dev/null and b/assets/examples/png/client_05.png differ diff --git a/assets/examples/png/client_06.png b/assets/examples/png/client_06.png new file mode 100644 index 0000000..2c766f5 Binary files /dev/null and b/assets/examples/png/client_06.png differ diff --git a/assets/examples/png/client_07.png b/assets/examples/png/client_07.png new file mode 100644 index 0000000..10ad5a4 Binary files /dev/null and b/assets/examples/png/client_07.png differ diff --git a/assets/examples/png/client_08.png b/assets/examples/png/client_08.png new file mode 100644 index 0000000..42d750c Binary files /dev/null and b/assets/examples/png/client_08.png differ diff --git a/assets/examples/png/client_09.png b/assets/examples/png/client_09.png new file mode 100644 index 0000000..9df87b9 Binary files /dev/null and b/assets/examples/png/client_09.png differ diff --git a/assets/examples/png/dev-tools_00.png b/assets/examples/png/dev-tools_00.png new file mode 100644 index 0000000..fed83e7 Binary files /dev/null and b/assets/examples/png/dev-tools_00.png differ diff --git a/assets/examples/png/dev-tools_01.png b/assets/examples/png/dev-tools_01.png new file mode 100644 index 0000000..3d50943 Binary files /dev/null and b/assets/examples/png/dev-tools_01.png differ diff --git a/assets/examples/png/dev-tools_02.png b/assets/examples/png/dev-tools_02.png new file mode 100644 index 0000000..87df61e Binary files /dev/null and b/assets/examples/png/dev-tools_02.png differ diff --git a/assets/examples/png/dev-tools_03.png b/assets/examples/png/dev-tools_03.png new file mode 100644 index 0000000..14d622e Binary files /dev/null and b/assets/examples/png/dev-tools_03.png differ diff --git a/assets/examples/png/dev-tools_04.png b/assets/examples/png/dev-tools_04.png new file mode 100644 index 0000000..8ab427f Binary files /dev/null and b/assets/examples/png/dev-tools_04.png differ diff --git a/assets/examples/png/dev-tools_05.png b/assets/examples/png/dev-tools_05.png new file mode 100644 index 0000000..88ff120 Binary files /dev/null and b/assets/examples/png/dev-tools_05.png differ diff --git a/assets/examples/png/dev-tools_06.png b/assets/examples/png/dev-tools_06.png new file mode 100644 index 0000000..6067cb7 Binary files /dev/null and b/assets/examples/png/dev-tools_06.png differ diff --git a/assets/examples/png/dev-tools_07.png b/assets/examples/png/dev-tools_07.png new file mode 100644 index 0000000..2d1a565 Binary files /dev/null and b/assets/examples/png/dev-tools_07.png differ diff --git a/assets/examples/png/dev-tools_08.png b/assets/examples/png/dev-tools_08.png new file mode 100644 index 0000000..0d6d438 Binary files /dev/null and b/assets/examples/png/dev-tools_08.png differ diff --git a/assets/examples/png/dev-tools_09.png b/assets/examples/png/dev-tools_09.png new file mode 100644 index 0000000..935bba0 Binary files /dev/null and b/assets/examples/png/dev-tools_09.png differ diff --git a/assets/examples/png/fetch_00.png b/assets/examples/png/fetch_00.png new file mode 100644 index 0000000..d48592f Binary files /dev/null and b/assets/examples/png/fetch_00.png differ diff --git a/assets/examples/png/fetch_01.png b/assets/examples/png/fetch_01.png new file mode 100644 index 0000000..78d6ff1 Binary files /dev/null and b/assets/examples/png/fetch_01.png differ diff --git a/assets/examples/png/fetch_02.png b/assets/examples/png/fetch_02.png new file mode 100644 index 0000000..159d6fa Binary files /dev/null and b/assets/examples/png/fetch_02.png differ diff --git a/assets/examples/png/fetch_03.png b/assets/examples/png/fetch_03.png new file mode 100644 index 0000000..0b19fcf Binary files /dev/null and b/assets/examples/png/fetch_03.png differ diff --git a/assets/examples/png/fetch_04.png b/assets/examples/png/fetch_04.png new file mode 100644 index 0000000..7bd2389 Binary files /dev/null and b/assets/examples/png/fetch_04.png differ diff --git a/assets/examples/png/hledger-suite_00.png b/assets/examples/png/hledger-suite_00.png new file mode 100644 index 0000000..cc489f6 Binary files /dev/null and b/assets/examples/png/hledger-suite_00.png differ diff --git a/assets/examples/png/hledger-suite_01.png b/assets/examples/png/hledger-suite_01.png new file mode 100644 index 0000000..4f1dfe7 Binary files /dev/null and b/assets/examples/png/hledger-suite_01.png differ diff --git a/assets/examples/png/hledger-suite_02.png b/assets/examples/png/hledger-suite_02.png new file mode 100644 index 0000000..d6a4eef Binary files /dev/null and b/assets/examples/png/hledger-suite_02.png differ diff --git a/assets/examples/png/hledger-suite_03.png b/assets/examples/png/hledger-suite_03.png new file mode 100644 index 0000000..6290c65 Binary files /dev/null and b/assets/examples/png/hledger-suite_03.png differ diff --git a/assets/examples/png/hledger-suite_04.png b/assets/examples/png/hledger-suite_04.png new file mode 100644 index 0000000..07d8395 Binary files /dev/null and b/assets/examples/png/hledger-suite_04.png differ diff --git a/assets/examples/png/hledger-suite_05.png b/assets/examples/png/hledger-suite_05.png new file mode 100644 index 0000000..4986020 Binary files /dev/null and b/assets/examples/png/hledger-suite_05.png differ diff --git a/assets/examples/png/hledger-suite_06.png b/assets/examples/png/hledger-suite_06.png new file mode 100644 index 0000000..d86801c Binary files /dev/null and b/assets/examples/png/hledger-suite_06.png differ diff --git a/assets/examples/png/hledger-suite_07.png b/assets/examples/png/hledger-suite_07.png new file mode 100644 index 0000000..8de9113 Binary files /dev/null and b/assets/examples/png/hledger-suite_07.png differ diff --git a/assets/examples/png/hledger-suite_08.png b/assets/examples/png/hledger-suite_08.png new file mode 100644 index 0000000..9359ece Binary files /dev/null and b/assets/examples/png/hledger-suite_08.png differ diff --git a/assets/examples/png/hledger-suite_09.png b/assets/examples/png/hledger-suite_09.png new file mode 100644 index 0000000..a680372 Binary files /dev/null and b/assets/examples/png/hledger-suite_09.png differ diff --git a/assets/examples/png/meta_00.png b/assets/examples/png/meta_00.png new file mode 100644 index 0000000..552f392 Binary files /dev/null and b/assets/examples/png/meta_00.png differ diff --git a/assets/examples/png/meta_01.png b/assets/examples/png/meta_01.png new file mode 100644 index 0000000..1272afb Binary files /dev/null and b/assets/examples/png/meta_01.png differ diff --git a/assets/examples/png/meta_02.png b/assets/examples/png/meta_02.png new file mode 100644 index 0000000..9a9d2be Binary files /dev/null and b/assets/examples/png/meta_02.png differ diff --git a/assets/examples/png/meta_03.png b/assets/examples/png/meta_03.png new file mode 100644 index 0000000..1150f1a Binary files /dev/null and b/assets/examples/png/meta_03.png differ diff --git a/assets/examples/png/meta_04.png b/assets/examples/png/meta_04.png new file mode 100644 index 0000000..4f0bc63 Binary files /dev/null and b/assets/examples/png/meta_04.png differ diff --git a/assets/examples/png/reports_00.png b/assets/examples/png/reports_00.png new file mode 100644 index 0000000..b1489f4 Binary files /dev/null and b/assets/examples/png/reports_00.png differ diff --git a/assets/examples/png/reports_01.png b/assets/examples/png/reports_01.png new file mode 100644 index 0000000..844ad36 Binary files /dev/null and b/assets/examples/png/reports_01.png differ diff --git a/assets/examples/png/reports_02.png b/assets/examples/png/reports_02.png new file mode 100644 index 0000000..56906c4 Binary files /dev/null and b/assets/examples/png/reports_02.png differ diff --git a/assets/examples/png/reports_03.png b/assets/examples/png/reports_03.png new file mode 100644 index 0000000..4af84b5 Binary files /dev/null and b/assets/examples/png/reports_03.png differ diff --git a/assets/examples/png/reports_04.png b/assets/examples/png/reports_04.png new file mode 100644 index 0000000..98037b5 Binary files /dev/null and b/assets/examples/png/reports_04.png differ diff --git a/assets/examples/png/root_00.png b/assets/examples/png/root_00.png new file mode 100644 index 0000000..c40368d Binary files /dev/null and b/assets/examples/png/root_00.png differ diff --git a/assets/examples/png/root_01.png b/assets/examples/png/root_01.png new file mode 100644 index 0000000..72a21b4 Binary files /dev/null and b/assets/examples/png/root_01.png differ diff --git a/assets/examples/png/root_02.png b/assets/examples/png/root_02.png new file mode 100644 index 0000000..2ab5ef0 Binary files /dev/null and b/assets/examples/png/root_02.png differ diff --git a/assets/examples/png/root_03.png b/assets/examples/png/root_03.png new file mode 100644 index 0000000..3a091e7 Binary files /dev/null and b/assets/examples/png/root_03.png differ diff --git a/assets/examples/png/root_04.png b/assets/examples/png/root_04.png new file mode 100644 index 0000000..b876774 Binary files /dev/null and b/assets/examples/png/root_04.png differ diff --git a/assets/examples/png/taxes_00.png b/assets/examples/png/taxes_00.png new file mode 100644 index 0000000..4ec716f Binary files /dev/null and b/assets/examples/png/taxes_00.png differ diff --git a/assets/examples/png/taxes_01.png b/assets/examples/png/taxes_01.png new file mode 100644 index 0000000..3836633 Binary files /dev/null and b/assets/examples/png/taxes_01.png differ diff --git a/assets/examples/png/taxes_02.png b/assets/examples/png/taxes_02.png new file mode 100644 index 0000000..e94f75a Binary files /dev/null and b/assets/examples/png/taxes_02.png differ diff --git a/assets/examples/png/taxes_03.png b/assets/examples/png/taxes_03.png new file mode 100644 index 0000000..1526c49 Binary files /dev/null and b/assets/examples/png/taxes_03.png differ diff --git a/assets/examples/png/taxes_04.png b/assets/examples/png/taxes_04.png new file mode 100644 index 0000000..fc31c04 Binary files /dev/null and b/assets/examples/png/taxes_04.png differ diff --git a/markdown/How-do-I-connect.md b/markdown/How-do-I-connect.md new file mode 100644 index 0000000..24443ad --- /dev/null +++ b/markdown/How-do-I-connect.md @@ -0,0 +1,40 @@ + +[//]: # (docker-finance | modern accounting for the power-user) +[//]: # () +[//]: # (Copyright [C] 2021-2025 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://gitea.com/EvergreenCrypto/docker-finance "docker-finance") + +- **[How do I connect?](#how-do-i-connect)** + * [`#docker-finance:matrix.org`](#docker-financematrixorg) + * [Evergreen Crypto LLC](#evergreen-crypto-llc) + +## How do I connect? + +Questions? Comments? Conversation? + +### `#docker-finance:matrix.org` + +Join the [Matrix](https://matrix.to/#/#docker-finance:matrix.org) community. + +[](https://matrix.to/#/#docker-finance:matrix.org "#docker-finance:matrix.org") + +### [](https://evergreencrypto.co "Evergreen Crypto LLC") Evergreen Crypto LLC + +- For general communications, please visit the [contact section of the website](https://evergreencrypto.co/#contact). +- For security-related concerns, please [contact the Founder directly with PGP encrypted email](https://keyserver.ubuntu.com/pks/lookup?op=vindex&search=0x04fb3888ff3eb841). + +[//]: # (vim: sw=2 sts=2 si ai et) diff --git a/markdown/How-do-I-contribute.md b/markdown/How-do-I-contribute.md new file mode 100644 index 0000000..f487f25 --- /dev/null +++ b/markdown/How-do-I-contribute.md @@ -0,0 +1,95 @@ + +[//]: # (docker-finance | modern accounting for the power-user) +[//]: # () +[//]: # (Copyright [C] 2021-2025 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://gitea.com/EvergreenCrypto/docker-finance "docker-finance") + +- **[How do I contribute?](#how-do-i-contribute)** + * [Donate](#donate) + * [Development](#development) + +## How do I contribute? + +There are multiple ways to contribute. All contributions are welcome! + +### Donate + +#### Time + +Your input while using docker-finance is [valuable and appreciated](How-do-I-connect.md). Come, make this project your own! + +#### Dependencies + +If you like docker-finance, please consider donating to the [wonderful projects](https://gitea.com/EvergreenCrypto/docker-finance/src/branch/master/client/docker-finance.yaml) that it relies upon. + +### Development + +Developers: your work won't go unnoticed or unappreciated. [Bounties are also available](How-do-I-connect.md). + +When developing any part of the codebase, you'll greatly benefit from building the [`dev-tools` image](What-does-it-do.md#image-dev-tools). + +When developing with the [`finance` image](What-does-it-do.md#image-finance), you can 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](How-do-I-use-it.md#flow-layout). + * In addition to `dev=on`, run the `confirm=off` and `profile=` arguments to quickly spin-up a new development profile + * Developer mockup CSVs can be found in the `mockup` directories within the hledger-flow section of the docker-finance repository + * Developer mockup CSVs will *intentionally* have multiple years within in a `1-in/year` directory in order to test for year parsing + +When developing non-code documentation, please work with the [dfi-docs](https://gitea.com/EvergreenCrypto/dfi-docs) repository. + +#### 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`) + - `${DOCKER_FINANCE_CLIENT_PLUGINS}/container/{finance,root}` + - Custom plugins that function only container-side (`lib_finance`, `root`) + +**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`](https://gitea.com/EvergreenCrypto/docker-finance/src/branch/master/client/plugins) and [`container/plugins`](https://gitea.com/EvergreenCrypto/docker-finance/src/branch/master/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 `docker` and `finance` that 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 + +Before sending a pull request: + +1. If you created a new file, please run the dev-tools' `license file=/path/to/new/file.ext` command to update the copyright date and author. +2. For any work that can be linted, utilize the dev-tools image (e.g., `dfi dev-tools/${USER}:default linter type=bash,php,c++`). + - See `linter help` for details. +3. As for style guidelines, these are recommended: + - [Bash](https://google.github.io/styleguide/shellguide.html) + - [C++](https://google.github.io/styleguide/cppguide.html) + - [PHP](https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/blob/master/doc/ruleSets/PhpCsFixer.rst) +4. If you can, please document the code in Doxygen style where applicable and run `doxygen gen` to see your code documentation. + +Any non-code documentation should go into the [dfi-docs](https://gitea.com/EvergreenCrypto/dfi-docs) repository. + +#### Notes + +- Regarding client configuration, Docker volumes aren't used because of chicken-or-the-egg problem (among other reasons). docker-finance needs the client environment *before* building the Docker image and spawning the subsequent container (which would rely on volumes). +- As described in [Mostly-Unified CLI](How-do-I-use-it.md#mostly-unified-cli), to use a developer version of any `dfi` image, simply build and tag with any tag name you'd like (e.g., `dfi archlinux/${USER}:dev build type=default`) +- Run `DOCKER_FINANCE_DEBUG=1 dfi [args]` to debug *before* the [Client (Host) Configuration File](How-do-I-get-started.md#client-host-configuration) file is read. +- The `.C` files you see in the repository are ROOT.cern macro files, not C-language files. + +[//]: # (vim: sw=2 sts=2 si ai et) diff --git a/markdown/How-do-I-get-started.md b/markdown/How-do-I-get-started.md new file mode 100644 index 0000000..b9c1810 --- /dev/null +++ b/markdown/How-do-I-get-started.md @@ -0,0 +1,454 @@ + +[//]: # (docker-finance | modern accounting for the power-user) +[//]: # () +[//]: # (Copyright [C] 2021-2025 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://gitea.com/EvergreenCrypto/docker-finance "docker-finance") + +- **[How do I get started?](#how-do-i-get-started)** + * [Installation](#installation) + * [Environment Generation](#environment-generation) + * [Configuration Files](#configuration-files) + +## How do I get started? + +docker-finance (`dfi`) is not your typical Docker image in which you simply pull and containerize. `dfi` is an *image-based* accounting system that operates translucently between your client (host) and container; keeping your finances containerized (with all the benefits of containerization). + +To get started, you'll only need a modern Linux client (host) with a working Docker installation. + +### Installation + +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). + +1. Install required dependencies: + + 1. [Docker Engine](https://docs.docker.com/engine/install/#supported-platforms) ([post-install configuration](https://docs.docker.com/engine/install/linux-postinstall/)) along with [Docker Compose](https://docs.docker.com/compose/install/linux/#install-using-the-repository) and [Docker Buildx](https://github.com/docker/buildx?tab=readme-ov-file#linux-packages) plugins + - Latest stable versions + 2. [GNU Bash](https://www.gnu.org/software/bash/) + - Latest stable version (or at least 5.0.17) + - Installed by *default* on most Linux distributions + 3. [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git/) + - Latest stable version (or at least 2.25.1) + - Only needed for step 3 but should be kept in order to: + - Remain up-to-date with the docker-finance repository + - Safely track your workflow related data (journals, metadata, etc.) + +2. Install optional helpers: + + Although *not* required, consider the following for workflow efficiency: + + - A terminal multiplexer like [tmux](https://github.com/tmux/tmux/wiki) or [screen](https://www.gnu.org/software/screen/) + - A terminal file manager like [mc](https://midnight-commander.org/) (Midnight Commander) + +3. Prepare your repository: + + Before proceeding, change your directory to a *persistent* path that you'll likely keep; as your client (host) shell environment will be aliased/sourced to the path you choose. + + ```bash + 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 + ``` + +4. Verify your repository (recommended): + ```bash + 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 + ``` + +5. Prepare your client (host) shell environment: + + Install convenience aliases and command completion to your shell environment (see [install.bash](https://gitea.com/EvergreenCrypto/docker-finance/src/branch/master/client/install.bash) for details): + + ```bash + ./docker-finance/client/install.bash && source ~/.bashrc + ``` + > - The `dfi` alias of `docker-finance` is 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 `dfi` images and commands + +6. Generate your translucent environment: + + This will create your [client/container environment](#environment-generation) for the given image; as well as your first container profile/subprofile: + + ```bash + dfi archlinux/${USER}:default gen all=all + ``` + > - To regenerate any step in this process, now or in the future, use `gen help` for available options + > - To use the `ubuntu` image instead, replace `archlinux` with `ubuntu` here and for all remaining steps + +7. Build your default `dfi` image: + ```bash + dfi archlinux/${USER}:default build type=default + ``` + > - Use the `build help` command to see available build options (such as smaller, faster builds) + +8. Bring up your container: + ```bash + dfi archlinux/${USER}:default up + ``` + +9. **You're inside!** See [How do I use it?](How-do-I-use-it.md#how-do-i-use-it) for next steps. + +10. (Optional) Developers: on your client (host), you can build and setup the `dev-tools` platform: + ```bash + 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: + 1. The [Client (Host) Configuration File](#client-host-configuration) (client only) + 2. The [Client (Host) Custom Dockerfile](#client-host-custom-dockerfile) (client only) + 3. The [Client (Host) / Container Superscript](#client-host--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 (Host) / Container Superscript](#client-host--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](#client-host-configuration) for details). + + - You can use the generated defaults but make sure your directory layout matches accordingly + - To easily edit this configuration file after `gen` is complete, run client (host) command `edit 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](#client-host-custom-dockerfile) for details). + + - To easily edit this configuration file after `gen` is complete, run client (host) command `edit 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 [Client (Host) / Container Superscript](#client-host--container-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/subprofile` pairing + - all output will be sent to the `${DOCKER_FINANCE_CONTAINER_FLOW}/profiles/profile/subprofile` path + +> *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](#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](#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](#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?](What-is-supported.md#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 of `kernel-machine/platform/tag` + - format consists of `username@hostname` where `username` is your host username and `hostname` is your machine's hostname + - 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=value` and is used by both Docker and docker-finance + - default template variables can be found in [gen.bash](https://gitea.com/EvergreenCrypto/docker-finance/src/branch/master/client/docker-finance.d/client/env/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](How-do-I-use-it.md#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](How-do-I-get-started.md#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@hostname` where `username` is your host username and `hostname` is your machine's hostname + - default generated templates can be found [here](https://gitea.com/EvergreenCrypto/docker-finance/src/branch/master/client/docker-finance.d/client/Dockerfiles) + +After `gen` is complete, you can edit this file with the client (host) command: `edit type=build` (see [Client (Host) Command Format](How-do-I-use-it.md#client-host-command-format)). + +--- + +#### Client (Host) / 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](#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: + + - [superscript.bash.in](https://gitea.com/EvergreenCrypto/docker-finance/src/branch/master/client/docker-finance.d/container/shell/superscript.bash.in) + +After `gen` is complete, you can edit this file with the client (host) command: `edit type=shell` (see [Client (Host) Command Format](How-do-I-use-it.md#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: + + - [subscript.bash.in](https://gitea.com/EvergreenCrypto/docker-finance/src/branch/master/client/docker-finance.d/container/shell/subscript.bash.in) + +After `gen` is complete, from within the container, you can edit this file with: `dfi profile/subprofile edit type=shell` (see [Container Command Format](How-do-I-use-it.md#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: + + - [fetch.yaml.in](https://gitea.com/EvergreenCrypto/docker-finance/src/branch/master/client/docker-finance.d/container/fetch/fetch.yaml.in) + +After `gen` is complete, from within the container, you can edit this file with: `dfi profile/subprofile edit type=fetch` (see [Container Command Format](How-do-I-use-it.md#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)](What-does-it-do.md#meta-w-root-c-analysis). + +See the in-file comments for further documentation: + + - [meta.csv.in](https://gitea.com/EvergreenCrypto/docker-finance/src/branch/master/client/docker-finance.d/container/meta/meta.csv.in) + +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.md#container-command-format)). + +[//]: # (vim: sw=2 sts=2 si ai et) diff --git a/markdown/How-do-I-use-it.md b/markdown/How-do-I-use-it.md new file mode 100644 index 0000000..2d444fc --- /dev/null +++ b/markdown/How-do-I-use-it.md @@ -0,0 +1,204 @@ + +[//]: # (docker-finance | modern accounting for the power-user) +[//]: # () +[//]: # (Copyright [C] 2021-2025 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://gitea.com/EvergreenCrypto/docker-finance "docker-finance") + +- **[How do I use it?](#how-do-i-use-it)** + * [Mostly-Unified CLI](#mostly-unified-cli) + * [Flow Layout](#flow-layout) + * [Caveats & Oddities](#caveats--oddities) + +## How do I use it? + +### Mostly-Unified CLI + +You'll only need the single alias `dfi` when using docker-finance on your client (host) and/or within your container. + +However, this alias can be broken down into the following: + + 1. The client script which handles the client-side (host) system: `docker.bash` (alias `dfi`) + 2. The container script which handles the container-side system: `finance.bash` (alias `dfi`) + +These two scripts can be rationalized by the following format: + +