Add documentation

.gitignore

@@ -0,0 +1 @@
+.build/

README.md

@@ -6,11 +6,77 @@ Collection of Dockerfiles created to build & pack various tools.
 <br>
 
 <!-- TOC -->
-- [1. Tools](#1-tools)
+- [1. How to use](#1-how-to-use)
+    - [1.1. CLI](#11-cli)
+- [2. Tools](#2-tools)
+    - [2.1. Bandwhich](#21-bandwhich)
+    - [2.2. auto-editor](#22-auto-editor)
 <!-- /TOC -->
 
 <br>
 
-# 1. Tools
+# 1. How to use
 
-Nothing yet
+Run the build-script `script/build.sh` with the path to the tool you want to build.
+
+<br>
+
+The docker-image will be tagged with `default` and the detected version/commit-hash.
+
+You can add more tags or change the existing tag-naming-scheme using the environment-variable `TAG`.
+
+<br>
+
+## 1.1. CLI
+
+`script/build.sh <toolPath> [extra-args for docker build ..]`
+
+<br>
+
+### 1.1.1. Environment-Variables
+
+Variable    | Description                       | Default
+-|-|-
+`TAG`       | Tag for Docker-building           | `TAGPREFIX` + `NAME`
+`TAGPREFIX` | Set a prefix to the default-tag   | -
+`NAME`      | Change the name used in the tag   | *FolderName*
+
+<br>
+
+# 2. Tools
+
+## 2.1. Bandwhich
+
+### 2.1.1. Source
+>This is a CLI utility for displaying current network utilization by process, connection and remote IP/hostname
+
+https://github.com/imsnif/bandwhich
+
+<br>
+
+### 2.1.2. Example
+```
+docker run -it --net host bandwhich -i eth0
+```
+
+<br>
+
+## 2.2. auto-editor
+
+### 2.2.1. Source
+>Auto-Editor is a command line application for automatically editing video and audio by analyzing a variety of methods, most notably audio loudness.
+
+https://github.com/WyattBlue/auto-editor
+
+<br>
+
+### 2.2.2. Example
+Speed-up silent part of videos:
+```
+docker run -v /home/ruakij/Videos:/video auto-build --no-open --silent-speed 8 --margin 0.2sec "input.webm" -o edited.mp4
+```
+
+<br>
+
+### 2.2.3. Comment
+TODO: Unfortunately the tool requires ffmpeg which is a huge tool and blows up the size of the image. I have to find a way to use a minimized version of it.

scripts/build.sh

@@ -0,0 +1,31 @@
+#!/bin/bash
+
+scriptPath_file=$(dirname "${BASH_SOURCE[0]}")
+scriptPath_folder=$(realpath "${scriptPath_file}")
+utils_path="${scriptPath_folder}/utils"
+
+WORKDIR=${1:-$PWD}
+WORKDIR=$(realpath "$WORKDIR")
+
+# -- VARIABLES --
+# Store original path
+ORIGINALDIR=$PWD
+
+# Get args without path
+EXTRA_ARGS="${@:2}"
+
+TAG=${TAG:-"${TAG_PREFIX}${NAME}"}
+
+
+# Call prepare
+printf "# PREPARE\n"
+source ${utils_path}/prepare.sh
+
+# Call build
+printf "# BUILD\n"
+build_type=${BUILD:-"ownarch"}
+source ${utils_path}/build-${build_type}.sh
+
+
+# Switch back to original path
+cd $ORIGINALDIR

scripts/utils/build-multiarch.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+PLATFORM=${PLATFORM:-"linux/amd64,linux/arm64/v8,linux/arm/v7"}
+
+docker buildx build \
+--platform $PLATFORM \
+--tag $TAG:latest \
+--tag "${TAG}:${VERSION}" \
+$EXTRA_ARGS \
+$WORKDIR

scripts/utils/build-ownarch.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+docker build \
+--tag $TAG:latest \
+--tag $TAG:$VERSION \
+$EXTRA_ARGS \
+"$WORKDIR"

scripts/utils/prepare.sh

@@ -0,0 +1,55 @@
+#!/bin/bash
+
+# --- VARIABLES ---
+# Load variables
+source $WORKDIR/info.env
+
+# Check if certain vars are overwritten, set them if missing
+if [ "${NAME}" = "" ]; then
+    NAME="$(basename $WORKDIR)"
+fi
+export NAME
+printf "Name: ${NAME}\n"
+
+repositoryFolder="$WORKDIR/.build/repository"
+
+# --- SOURCES ---
+# Get sources locally
+if ! [ -d "$repositoryFolder" ]; then
+    git clone "${GIT_REPOSITORY}" "$repositoryFolder"
+    cloned=True
+fi
+
+# Change into repository
+cd "$repositoryFolder"
+
+if [ "$cloned" != True ]; then
+    # Checkout default-branch in case GIT_CHECKOUT was different    
+    defaultBranch=$(git symbolic-ref refs/remotes/origin/HEAD | sed 's@^refs/remotes/origin/@@')
+    git checkout "${defaultBranch}"     
+
+    git pull        # Get changes
+fi
+
+# Checkout when set
+if [ "$GIT_CHECKOUT" != "" ]; then
+    # Handle special directives
+    if [ "$GIT_CHECKOUT" = "latest-tag" ]; then
+        GIT_CHECKOUT=$(git describe --tags `git rev-list --tags --max-count=1`)     # Get latest tag
+    fi
+
+    git checkout $GIT_CHECKOUT
+fi
+
+
+# --- VERSION ---
+# Get current version to build
+VERSION=$(git describe --tags --long)
+if [ $? -ne 0 ]; then
+    VERSION=$(git rev-parse HEAD)
+fi
+export VERSION
+printf "Version: ${VERSION}\n"
+
+TAG=${TAG:-"${TAG_PREFIX}${NAME}"}
+printf "> ${TAG}\n"

tools/auto-editor/Dockerfile

@@ -0,0 +1,24 @@
+# ---- Base ----
+FROM python:slim AS base
+#ENV PYTHONDONTWRITEBYTECODE=1
+WORKDIR /app
+# Install packages
+RUN apt update && apt install -y ffmpeg && rm -rf /var/lib/apt/lists/*
+#RUN pip install --no-compile --no-cache-dir ae-ffmpeg
+#COPY .build/repository/ae-ffmpeg/ae_ffmpeg/Darwin-x86_64/* /usr/bin/
+
+# ---- Build ----
+FROM base AS build
+ENV PYTHONDONTWRITEBYTECODE=1
+# Copy sources
+ADD .build/repository/auto_editor auto_editor
+ADD .build/repository/setup.py .
+ADD .build/repository/README.md .
+# Run install
+RUN pip install --no-compile --no-cache-dir -e .
+
+# ---- Release ----
+FROM build AS release
+WORKDIR /videos
+
+ENTRYPOINT ["auto-editor"]

tools/auto-editor/info.env

@@ -0,0 +1,2 @@
+GIT_REPOSITORY=https://github.com/WyattBlue/auto-editor
+TAG=latest-tag

tools/bandwhich/Dockerfile

@@ -0,0 +1,22 @@
+# ---- Base ----
+FROM alpine:3 AS base
+WORKDIR /app
+
+
+# ---- Build ----
+FROM rust:1.65.0-slim AS build
+WORKDIR /build
+# Install packages
+RUN apt update && apt install -y make
+# Copy sources
+ADD .build/repository/ .
+# Update dependencies and Compile
+RUN cargo update && TARGET="release" make
+
+
+# ---- Release ----
+FROM base AS release
+# Copy build-target
+COPY --from=build /build/target/release/bandwhich .
+
+ENTRYPOINT ["./bandwhich"]

tools/bandwhich/info.env

@@ -0,0 +1 @@
+GIT_REPOSITORY=https://github.com/imsnif/bandwhich