Add documentation

.gitignore

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

README.md

@@ -6,16 +6,77 @@ Collection of Dockerfiles created to build & pack various tools.
 <br>
 
 <!-- TOC -->
-- [1. Tools](#1-tools)
-    - [1.1. Bandwhich](#11-bandwhich)
+- [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
 
-## 1.1. Bandwhich
+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
 
-Source: https://github.com/imsnif/bandwhich
+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

@@ -1,9 +1,22 @@
-#!/bin/sh
+#!/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
@@ -12,3 +25,7 @@ source ${utils_path}/prepare.sh
 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

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

scripts/utils/build-ownarch.sh

@@ -1,8 +1,7 @@
 #!/bin/bash
-TAG=${TAG:-"${TAG_PREFIX}${NAME}"}
-EXTRA_ARGS=${EXTRA_ARGS:-"$@"}
 
 docker build \
+--tag $TAG:latest \
 --tag $TAG:$VERSION \
 $EXTRA_ARGS \
-.
+"$WORKDIR"

scripts/utils/prepare.sh

@@ -1,24 +1,33 @@
-#!/bin/sh
+#!/bin/bash
 
 # --- VARIABLES ---
 # Load variables
-source $PWD/info.env
+source $WORKDIR/info.env
 
 # Check if certain vars are overwritten, set them if missing
 if [ "${NAME}" = "" ]; then
-    NAME="$(basename $PWD)"
+    NAME="$(basename $WORKDIR)"
 fi
 export NAME
 printf "Name: ${NAME}\n"
 
+repositoryFolder="$WORKDIR/.build/repository"
 
 # --- SOURCES ---
-alias git="git -C .build/repository"
 # Get sources locally
-if ! [ -d .build/repository ]; then
-    git clone "${GIT_REPOSITORY}" .build/repository
-else
-    git checkout -  # Checkout previous branch in case GIT_CHECKOUT was different
+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
 

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

@@ -4,16 +4,14 @@ WORKDIR /app
 
 
 # ---- Build ----
-FROM rust:alpine AS build
+FROM rust:1.65.0-slim AS build
 WORKDIR /build
 # Install packages
-RUN apk add --no-cache make libc-dev build-base
+RUN apt update && apt install -y make
 # Copy sources
 ADD .build/repository/ .
-# Update dependencies
-RUN cargo update
-# Compile
-RUN TARGET="release" make
+# Update dependencies and Compile
+RUN cargo update && TARGET="release" make
 
 
 # ---- Release ----
@@ -21,4 +19,4 @@ FROM base AS release
 # Copy build-target
 COPY --from=build /build/target/release/bandwhich .
 
-CMD ["./bandwhich"]
+ENTRYPOINT ["./bandwhich"]