Merge pull request #8 into master
ef0c8a5markdown: update repo domain to gitea.evergreencrypto.co (Aaron Fiore)661c089README: update repo domain to gitea.evergreencrypto.co (Aaron Fiore)
This commit was merged in pull request #8.
This commit is contained in:
@@ -18,7 +18,7 @@
|
|||||||
|
|
||||||
<div align="center">
|
<div align="center">
|
||||||
|
|
||||||
[<img src="assets/branding/png/docker-finance.png" height=75% width=75% align="center" />](https://gitea.com/EvergreenCrypto/docker-finance "docker-finance")
|
[<img src="assets/branding/png/docker-finance.png" height=75% width=75% align="center" />](https://gitea.evergreencrypto.co/EvergreenCrypto/docker-finance "docker-finance")
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|||||||
@@ -16,7 +16,7 @@
|
|||||||
[//]: # (You should have received a copy of the GNU General Public License)
|
[//]: # (You should have received a copy of the GNU General Public License)
|
||||||
[//]: # (along with this program. If not, see <https://www.gnu.org/licenses/>.)
|
[//]: # (along with this program. If not, see <https://www.gnu.org/licenses/>.)
|
||||||
|
|
||||||
# [<img src="../assets/branding/png/dfi.png" height=10% width=10% />](https://gitea.com/EvergreenCrypto/docker-finance "docker-finance")
|
# [<img src="../assets/branding/png/dfi.png" height=10% width=10% />](https://gitea.evergreencrypto.co/EvergreenCrypto/docker-finance "docker-finance")
|
||||||
|
|
||||||
- **[How do I connect?](#how-do-i-connect)**
|
- **[How do I connect?](#how-do-i-connect)**
|
||||||
* [`#docker-finance:matrix.org`](#docker-financematrixorg)
|
* [`#docker-finance:matrix.org`](#docker-financematrixorg)
|
||||||
|
|||||||
@@ -16,7 +16,7 @@
|
|||||||
[//]: # (You should have received a copy of the GNU General Public License)
|
[//]: # (You should have received a copy of the GNU General Public License)
|
||||||
[//]: # (along with this program. If not, see <https://www.gnu.org/licenses/>.)
|
[//]: # (along with this program. If not, see <https://www.gnu.org/licenses/>.)
|
||||||
|
|
||||||
# [<img src="../assets/branding/png/dfi.png" height=10% width=10%/>](https://gitea.com/EvergreenCrypto/docker-finance "docker-finance")
|
# [<img src="../assets/branding/png/dfi.png" height=10% width=10%/>](https://gitea.evergreencrypto.co/EvergreenCrypto/docker-finance "docker-finance")
|
||||||
|
|
||||||
- **[How do I contribute?](#how-do-i-contribute)**
|
- **[How do I contribute?](#how-do-i-contribute)**
|
||||||
* [Donate](#donate)
|
* [Donate](#donate)
|
||||||
@@ -34,7 +34,7 @@ Your input while using docker-finance is [valuable and appreciated](How-do-I-con
|
|||||||
|
|
||||||
#### Dependencies
|
#### 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.
|
If you like docker-finance, please consider donating to the [wonderful projects](https://gitea.evergreencrypto.co/EvergreenCrypto/docker-finance/src/branch/master/client/docker-finance.yaml) that it relies upon.
|
||||||
|
|
||||||
### Development
|
### Development
|
||||||
|
|
||||||
@@ -47,7 +47,7 @@ When developing with the [`finance` image](What-does-it-do.md#image-finance), yo
|
|||||||
* Developer mockup CSVs can be found in the `mockup` directories within the hledger-flow section of the docker-finance repository
|
* 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
|
* 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.
|
When developing non-code documentation, please work with the [dfi-docs](https://gitea.evergreencrypto.co/EvergreenCrypto/dfi-docs) repository.
|
||||||
|
|
||||||
#### Plugins
|
#### Plugins
|
||||||
|
|
||||||
@@ -64,7 +64,7 @@ Upon client `gen`, a client-side directory layout is generated. This layout cons
|
|||||||
**WARNING: don't change the parent client-side directory layout** (although, you can add subdirectories):
|
**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}`
|
- 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)).
|
This client-side "custom" layout somewhat mirrors the repository's plugins layout (see [`client/plugins`](https://gitea.evergreencrypto.co/EvergreenCrypto/docker-finance/src/branch/master/client/plugins) and [`container/plugins`](https://gitea.evergreencrypto.co/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()`.
|
For more information, see the example plugins and help usage of each module, e.g.; `plugins help` or `help()`.
|
||||||
|
|
||||||
@@ -84,7 +84,7 @@ Before sending a pull request:
|
|||||||
- [PHP](https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/blob/master/doc/ruleSets/PSR12.rst)
|
- [PHP](https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/blob/master/doc/ruleSets/PSR12.rst)
|
||||||
4. If you can, please document the code in Doxygen style where applicable and run `doxygen gen` to see your code documentation.
|
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.
|
Any non-code documentation should go into the [dfi-docs](https://gitea.evergreencrypto.co/EvergreenCrypto/dfi-docs) repository.
|
||||||
|
|
||||||
#### CI using self hosted `gitea` with `act_runner`
|
#### CI using self hosted `gitea` with `act_runner`
|
||||||
|
|
||||||
|
|||||||
@@ -16,7 +16,7 @@
|
|||||||
[//]: # (You should have received a copy of the GNU General Public License)
|
[//]: # (You should have received a copy of the GNU General Public License)
|
||||||
[//]: # (along with this program. If not, see <https://www.gnu.org/licenses/>.)
|
[//]: # (along with this program. If not, see <https://www.gnu.org/licenses/>.)
|
||||||
|
|
||||||
# [<img src="../assets/branding/png/dfi.png" height=10% width=10%/>](https://gitea.com/EvergreenCrypto/docker-finance "docker-finance")
|
# [<img src="../assets/branding/png/dfi.png" height=10% width=10%/>](https://gitea.evergreencrypto.co/EvergreenCrypto/docker-finance "docker-finance")
|
||||||
|
|
||||||
- **[How do I get started?](#how-do-i-get-started)**
|
- **[How do I get started?](#how-do-i-get-started)**
|
||||||
* [Installation](#installation)
|
* [Installation](#installation)
|
||||||
@@ -69,7 +69,7 @@ docker-finance *should* work out-of-the-box on any modern Linux system. For exam
|
|||||||
echo "FATAL: docker-finance repo not found" >&2
|
echo "FATAL: docker-finance repo not found" >&2
|
||||||
fi
|
fi
|
||||||
else
|
else
|
||||||
if ! git clone https://gitea.com/EvergreenCrypto/docker-finance; then
|
if ! git clone https://gitea.evergreencrypto.co/EvergreenCrypto/docker-finance; then
|
||||||
echo "FATAL: docker-finance repo not cloned" >&2
|
echo "FATAL: docker-finance repo not cloned" >&2
|
||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
@@ -91,7 +91,7 @@ docker-finance *should* work out-of-the-box on any modern Linux system. For exam
|
|||||||
|
|
||||||
5. Prepare your client (host) shell environment:
|
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):
|
Install convenience aliases and command completion to your shell environment (see [install.bash](https://gitea.evergreencrypto.co/EvergreenCrypto/docker-finance/src/branch/master/client/install.bash) for details):
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
./docker-finance/client/install.bash && source ~/.bashrc
|
./docker-finance/client/install.bash && source ~/.bashrc
|
||||||
@@ -221,7 +221,7 @@ The client (host) configuration file:
|
|||||||
- client/container configurations can be stored on shared NFS/CIFS or related network storage (with applicable user permissions)
|
- 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)
|
- 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
|
- 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
|
- default template variables can be found in [gen.bash](https://gitea.evergreencrypto.co/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)).
|
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)).
|
||||||
|
|
||||||
@@ -393,7 +393,7 @@ The client (host) custom Dockerfile:
|
|||||||
- allows you to append any Dockerfile command to a generated build
|
- allows you to append any Dockerfile command to a generated build
|
||||||
- is located in the `${DOCKER_FINANCE_CLIENT_CONF}/client/Dockerfiles/` directory
|
- 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
|
- 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)
|
- default generated templates can be found [here](https://gitea.evergreencrypto.co/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)).
|
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)).
|
||||||
|
|
||||||
@@ -409,7 +409,7 @@ The client/container shell script (Superscript) is a bind-mounted (by directory)
|
|||||||
|
|
||||||
See the in-file comments for further documentation:
|
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)
|
- [superscript.bash.in](https://gitea.evergreencrypto.co/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)).
|
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)).
|
||||||
|
|
||||||
@@ -427,7 +427,7 @@ By default, this file will contain user aliases for all container commands. Thes
|
|||||||
|
|
||||||
See the in-file comments for further documentation:
|
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)
|
- [subscript.bash.in](https://gitea.evergreencrypto.co/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)).
|
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)).
|
||||||
|
|
||||||
@@ -437,7 +437,7 @@ The source of all remote API fetching configurations (exchanges, blockchains, ma
|
|||||||
|
|
||||||
See the in-file comments for further documentation:
|
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)
|
- [fetch.yaml.in](https://gitea.evergreencrypto.co/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)).
|
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)).
|
||||||
|
|
||||||
@@ -447,7 +447,7 @@ The source of all custom metadata information (typically used to store cryptocur
|
|||||||
|
|
||||||
See the in-file comments for further documentation:
|
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)
|
- [meta.csv.in](https://gitea.evergreencrypto.co/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)).
|
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)).
|
||||||
|
|
||||||
|
|||||||
@@ -16,7 +16,7 @@
|
|||||||
[//]: # (You should have received a copy of the GNU General Public License)
|
[//]: # (You should have received a copy of the GNU General Public License)
|
||||||
[//]: # (along with this program. If not, see <https://www.gnu.org/licenses/>.)
|
[//]: # (along with this program. If not, see <https://www.gnu.org/licenses/>.)
|
||||||
|
|
||||||
# [<img src="../assets/branding/png/dfi.png" height=10% width=10%/>](https://gitea.com/EvergreenCrypto/docker-finance "docker-finance")
|
# [<img src="../assets/branding/png/dfi.png" height=10% width=10%/>](https://gitea.evergreencrypto.co/EvergreenCrypto/docker-finance "docker-finance")
|
||||||
|
|
||||||
- **[How do I use it?](#how-do-i-use-it)**
|
- **[How do I use it?](#how-do-i-use-it)**
|
||||||
* [Mostly-Unified CLI](#mostly-unified-cli)
|
* [Mostly-Unified CLI](#mostly-unified-cli)
|
||||||
|
|||||||
@@ -16,7 +16,7 @@
|
|||||||
[//]: # (You should have received a copy of the GNU General Public License)
|
[//]: # (You should have received a copy of the GNU General Public License)
|
||||||
[//]: # (along with this program. If not, see <https://www.gnu.org/licenses/>.)
|
[//]: # (along with this program. If not, see <https://www.gnu.org/licenses/>.)
|
||||||
|
|
||||||
# [<img src="../assets/branding/png/dfi.png" height=10% width=10%/>](https://gitea.com/EvergreenCrypto/docker-finance "docker-finance")
|
# [<img src="../assets/branding/png/dfi.png" height=10% width=10%/>](https://gitea.evergreencrypto.co/EvergreenCrypto/docker-finance "docker-finance")
|
||||||
|
|
||||||
- **[What does it do?](#what-does-it-do)**
|
- **[What does it do?](#what-does-it-do)**
|
||||||
* [Highlights](#highlights)
|
* [Highlights](#highlights)
|
||||||
|
|||||||
@@ -16,7 +16,7 @@
|
|||||||
[//]: # (You should have received a copy of the GNU General Public License)
|
[//]: # (You should have received a copy of the GNU General Public License)
|
||||||
[//]: # (along with this program. If not, see <https://www.gnu.org/licenses/>.)
|
[//]: # (along with this program. If not, see <https://www.gnu.org/licenses/>.)
|
||||||
|
|
||||||
# [<img src="../assets/branding/png/dfi.png" height=10% width=10%/>](https://gitea.com/EvergreenCrypto/docker-finance "docker-finance")
|
# [<img src="../assets/branding/png/dfi.png" height=10% width=10%/>](https://gitea.evergreencrypto.co/EvergreenCrypto/docker-finance "docker-finance")
|
||||||
|
|
||||||
- **[What is supported?](#what-is-supported)**
|
- **[What is supported?](#what-is-supported)**
|
||||||
* [CeFi (centralized custodians)](#cefi)
|
* [CeFi (centralized custodians)](#cefi)
|
||||||
|
|||||||
@@ -16,7 +16,7 @@
|
|||||||
[//]: # (You should have received a copy of the GNU General Public License)
|
[//]: # (You should have received a copy of the GNU General Public License)
|
||||||
[//]: # (along with this program. If not, see <https://www.gnu.org/licenses/>.)
|
[//]: # (along with this program. If not, see <https://www.gnu.org/licenses/>.)
|
||||||
|
|
||||||
# [<img src="../assets/branding/png/dfi.png" height=10% width=10%/>](https://gitea.com/EvergreenCrypto/docker-finance "docker-finance")
|
# [<img src="../assets/branding/png/dfi.png" height=10% width=10%/>](https://gitea.evergreencrypto.co/EvergreenCrypto/docker-finance "docker-finance")
|
||||||
|
|
||||||
- **[Where is the legalese?](#where-is-the-legalese)**
|
- **[Where is the legalese?](#where-is-the-legalese)**
|
||||||
* [License and Disclaimer](#license-and-disclaimer)
|
* [License and Disclaimer](#license-and-disclaimer)
|
||||||
|
|||||||
Reference in New Issue
Block a user