EvergreenCrypto/docker-finance
1
1
Fork 1
Code Issues 31 Pull Requests Actions Releases 10 Activity

README: add bash completion to install

Browse Source
This commit is contained in:
Aaron Fiore
2024-08-03 20:05:02 -07:00
parent 646ca3af85
commit ef5eda8ce8
1 changed files with 71 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

93
README.md
View File

@@ -243,6 +243,8 @@ Supported blockchains (independent of wallet type):
### Installation
[//]: # (TODO: move step 3 to installation script, add `dfi` aliases, update README)
`docker-finance` is not your typical Docker image in which you simply pull and containerize, but rather it's an *image-based* accounting system that operates transparently between your client (host) and container; keeping your finances containerized, with all the benefits of containerization.
`docker-finance` *should* work out-of-the-box on any modern Linux system. For example, if your client (host) is Ubuntu, the default installation of `coreutils`, `shells` and `utils` that came with your system will satisfy requirements. However, you'll still need to manually install Docker (see below).
@@ -262,12 +264,36 @@ Supported blockchains (independent of wallet type):
- Safely track your workflow related data (journals, metadata, etc.)
2. Consider using a terminal multiplexer like [tmux](https://github.com/tmux/tmux/wiki) or [screen](https://www.gnu.org/software/screen/) for optimal workflow efficiency
3. **Copy/paste the following into your `bash` shell** (one-time repository clone and client preparation):
3. **Copy/paste the following into your `bash` shell** (client preparation):
```bash
bashrc=~/.bashrc
aliases=~/.bash_aliases
function docker-finance::install()
{
# Environment expectations
_alias="alias docker-finance="
_client="$(pwd)/docker-finance/client"
# Remove previous alias
if grep "^${_alias}" "$aliases" &>/dev/null; then
sed -i "/^${_alias}/d" "$aliases"
unalias docker-finance
fi
# Set new alias
echo "${_alias}'${_client}/docker.bash'" >>"$aliases"
# Set bash completion
_completion="${_client}/src/docker/completion.bash"
if [ ! -f "$_completion" ]; then
echo "WARNING: bash completion not found" >&2
else
if ! grep "^source '${_completion}'" "$aliases" &>/dev/null; then
echo "source '${_completion}'" >>"$aliases"
fi
fi
# Make it so
source "$aliases" && echo "SUCCESS: installation complete"
}
if ! test -f "$bashrc" || ! hash bash &>/dev/null; then
echo "FATAL: unsupported bash installation"
echo "FATAL: unsupported bash installation" >&2
else
if [[ ! -z "$SHELL" && "$SHELL" =~ bash ]]; then
if [ ! -f "$aliases" ]; then
@@ -275,14 +301,31 @@ Supported blockchains (independent of wallet type):
aliases="$bashrc"
fi
fi
if git clone https://gitea.com/EvergreenCrypto/docker-finance; then
if ! grep -E "^alias docker-finance=" "$aliases" &>/dev/null; then
echo "alias docker-finance='$(pwd)/docker-finance/client/docker.bash archlinux/$(whoami):latest'" >>"$aliases"
source "$aliases"
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
else
popd &>/dev/null
docker-finance::install
fi
popd &>/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
else
docker-finance::install
fi
fi
else
echo "FATAL: git not found" >&2
fi
else
echo "FATAL: unsupported bash environment"
echo "FATAL: unsupported bash environment" >&2
fi
fi
```
@@ -300,16 +343,22 @@ Supported blockchains (independent of wallet type):
5. **Generate client/container environment** (see [Environment Generation](#environment-generation) for details):
```bash
docker-finance gen
docker-finance archlinux/${USER}:default gen
```
6. **Build the image and bring up container**:
6. **Build the image**:
```bash
docker-finance build type=default && docker-finance up
docker-finance archlinux/${USER}:default build type=default
```
> See `docker-finance build help` for build options (such as smaller, faster builds)
> See `docker-finance archlinux/${USER}:default build help` for build options (such as smaller, faster builds)
7. **You're inside!** See [How do I use it?](#how-do-i-use-it) for next steps.
7. **Bring up the container**:
```bash
docker-finance archlinux/${USER}:default up
```
> You can use tab completion for all commands available to this built image
8. **You're inside!** See [How do I use it?](#how-do-i-use-it) for next steps.
### Environment Generation
@@ -320,7 +369,7 @@ In terms of configuration, the client (host) has the following files:
2. The [Client (Host) Custom Dockerfile](#client-host-custom-dockerfile) (client only)
3. The [Client/Container Superscript](#clientcontainer-superscript) (client/container)
You'll create these files (and more) when running `docker-finance gen`, as seen below.
You'll create these files (and more) when running client (host) command `gen`, as seen below.
> Tip: client scope can be considered an OOP class which inherits the container as a protected class, with the [Client/Container Superscript](#clientcontainer-superscript) binding them.
@@ -335,13 +384,13 @@ When running `gen`, you'll see the following:
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 `docker-finance edit type=env`
- 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 `docker-finance edit type=build`
- To easily edit this configuration file after `gen` is complete, run client (host) command `edit type=build`
---
@@ -412,7 +461,7 @@ The client (host) configuration file:
- 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](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: `docker-finance edit type=env` (see [Client (Host) Command Format](#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](#client-host-command-format)).
> DOCKER_FINANCE_CLIENT_CONF
@@ -564,7 +613,7 @@ The client (host) custom Dockerfile:
- 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](client/docker-finance.d/client/Dockerfiles)
After `gen` is complete, you can edit this file with the client (host) command: `docker-finance edit type=build` (see [Client (Host) Command Format](#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](#client-host-command-format)).
---
@@ -580,7 +629,7 @@ See the in-file comments for further documentation:
- [superscript.bash.in](client/docker-finance.d/container/shell/superscript.bash.in)
After `gen` is complete, you can edit this file with the client (host) command: `docker-finance edit type=shell` (see [Client (Host) Command Format](#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](#client-host-command-format)).
---
@@ -660,19 +709,19 @@ Where:
For a complete list of commands and usage help:
```bash
${DOCKER_FINANCE_CLIENT_REPO}/client/docker.bash archlinux/$(whoami):latest help
${DOCKER_FINANCE_CLIENT_REPO}/client/docker.bash archlinux/${USER}:default help
```
Or, if the [Installation](#installation) alias was properly created:
```bash
docker-finance help
docker-finance archlinux/${USER}:default help
```
You can also view the help usage of, for example, the `edit` command:
```bash
docker-finance edit help
docker-finance archlinux/${USER}:default edit help
```
---
@@ -865,7 +914,7 @@ Before sending a pull request:
- 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](#mostly-unified-cli), to use a developer version of the `finance` image (not a `dev-tools` image), simply build and tag a new `finance` image with `dev` (or whatever you see fit), and reset the `docker-finance` alias at your discretion.
- Run `DOCKER_FINANCE_DEBUG=true docker-finance <cmd> [args]` to debug *before* the [Client (Host) Configuration File](#client-host-configuration) file is read.
- Run `DOCKER_FINANCE_DEBUG=true docker-finance <platform/user:tag> <cmd> [args]` to debug *before* the [Client (Host) Configuration File](#client-host-configuration) file is read.
- The `.C` files you see in the repository are ROOT.cern macro files, not C-language files.
## How do I connect?