psyb0t/lockbox repository overview

{
  "ffmpeg": "/usr/bin/ffmpeg",
  "ffprobe": "/usr/bin/ffprobe"
}

FROM psyb0t/lockbox

ENV LOCKBOX_USER=myapp

RUN apt-get update && \
    apt-get install -y --no-install-recommends ffmpeg && \
    apt-get clean && rm -rf /var/lib/apt/lists/*

COPY allowed.json /etc/lockbox/allowed.json

docker build -t myapp .
cat ~/.ssh/id_rsa.pub > authorized_keys
mkdir -p work host_keys

docker run -d \
  --name myapp \
  --restart unless-stopped \
  -p 2222:22 \
  -e "LOCKBOX_UID=$(id -u)" \
  -e "LOCKBOX_GID=$(id -g)" \
  -v $(pwd)/authorized_keys:/etc/lockbox/authorized_keys:ro \
  -v $(pwd)/host_keys:/etc/lockbox/host_keys \
  -v $(pwd)/work:/work \
  myapp

ssh -p 2222 myapp@localhost "ffmpeg -version"

# Upload a file
ssh lockbox@host "put input.txt" < input.txt

# Download a file
ssh lockbox@host "get output.txt" > output.txt

# List files
ssh lockbox@host "list-files"
ssh lockbox@host "list-files subdir"

# List files as JSON
ssh lockbox@host "list-files --json"

# Create a directory
ssh lockbox@host "create-dir project1"

# Delete a file
ssh lockbox@host "remove-file input.txt"

# Delete an empty directory
ssh lockbox@host "remove-dir project1"

# Nuke a directory and everything in it
ssh lockbox@host "remove-dir-recursive project1"

# Move/rename a file
ssh lockbox@host "move-file old.txt new.txt"

# Copy a file
ssh lockbox@host "copy-file original.txt backup.txt"

# Get file metadata as JSON
ssh lockbox@host "file-info output.txt"

# Check if a file exists
ssh lockbox@host "file-exists output.txt"

# Get SHA-256 hash
ssh lockbox@host "file-hash output.txt"

# Check disk usage (bytes)
ssh lockbox@host "disk-usage"
ssh lockbox@host "disk-usage subdir"

# Search for files by glob pattern
ssh lockbox@host "search-files **/*.txt"

# Append to an existing file
echo "more data" | ssh lockbox@host "append-file output.txt"

{
  "mytool": "/usr/bin/mytool",
  "another": "/usr/local/bin/another"
}

COPY --chmod=755 10-fontcache.sh /etc/lockbox/entrypoint.d/10-fontcache.sh

ENV LOCKBOX_USER=myapp

curl -fsSL https://raw.githubusercontent.com/psyb0t/docker-lockbox/main/create_installer.sh | bash -s installer.yml > install.sh

name: myapp
image: psyb0t/myapp
repo: psyb0t/docker-myapp

volumes:
  - flag: -d
    env: DATA_DIR
    mount: /data:ro
    default: ./data
    description: Data directory

environment:
  - flag: -w
    env: WORKERS
    container_env: APP_WORKERS
    default: 4
    description: Number of workers
  - flag: --log-level
    env: LOG_LEVEL
    container_env: APP_LOG_LEVEL
    default: info
    description: Log level (debug, info, warn, error)

MYAPP_PORT=2222
MYAPP_DATA_DIR=$MYAPP_HOME/data
MYAPP_WORKERS=4
MYAPP_LOG_LEVEL=info
MYAPP_PROCESSING_UNIT=cpu
MYAPP_GPUS=all
MYAPP_CPUS=0
MYAPP_MEMORY=0
MYAPP_SWAP=0

services:
  myapp:
    image: psyb0t/myapp
    ports:
      - "${MYAPP_PORT:-2222}:22"
    environment:
      - LOCKBOX_UID=${REAL_UID}
      - LOCKBOX_GID=${REAL_GID}
      - APP_WORKERS=${MYAPP_WORKERS:-4}
      - APP_LOG_LEVEL=${MYAPP_LOG_LEVEL:-info}
      - PROCESSING_UNIT=${MYAPP_PROCESSING_UNIT:-cpu}
    volumes:
      - ./authorized_keys:/etc/lockbox/authorized_keys:ro
      - ./host_keys:/etc/lockbox/host_keys
      - ./work:/work
      - ${MYAPP_DATA_DIR:-./data}:/data:ro
    cpus: ${MYAPP_CPUS:-0}
    mem_limit: ${MYAPP_MEMORY:-0}
    memswap_limit: ${MYAPP_MEMSWAP:-0}
    restart: unless-stopped

myapp start -d                                          # start detached (cpu mode)
myapp start -d --processing-unit cuda --gpus 0          # NVIDIA GPU 0
myapp start -d --processing-unit cuda --gpus all        # all NVIDIA GPUs
myapp start -d --processing-unit rocm --gpus 0          # AMD GPU 0
myapp start -d -w 8 --log-level debug                   # 8 workers, debug logging
myapp start -d --port 3333 --cpus 4 --memory 8g         # custom port, resource limits
myapp stop                                              # stop
myapp status                                            # show container status
myapp logs -f                                           # follow logs
myapp upgrade                                           # pull latest image and re-install
myapp uninstall                                         # stop and remove everything

make build
make test    # builds test image and runs integration tests