kjanat/articulate-parser
1
0
Fork 0
mirror of https://github.com/kjanat/articulate-parser.git synced 2026-01-16 07:02:09 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
71d14290487db1fabe8f64afadf98553674946b8
articulate-parser/DOCKER.md
Kaj Kowalski b7f23b2387 Add Docker support and GitHub Container Registry CI workflow (#3) 
* Add comprehensive Docker support with multi-stage builds
* Set up GitHub Container Registry integration
* Enhance CI/CD workflows with Docker build and push capabilities
* Add --help and --version flags to main application
* Update documentation with Docker usage examples
* Implement security best practices for container deployment
2025-05-28 23:04:43 +02:00

2.2 KiB
Raw Blame History

Articulate Parser - Docker

A powerful command-line tool for parsing and processing articulate data files, now available as a lightweight Docker container.

Quick Start

Pull from GitHub Container Registry

docker pull ghcr.io/kjanat/articulate-parser:latest

Run with Articulate Rise URL

docker run --rm -v $(pwd):/data ghcr.io/kjanat/articulate-parser:latest https://rise.articulate.com/share/N_APNg40Vr2CSH2xNz-ZLATM5kNviDIO#/ markdown /data/output.md

Run with local files

docker run --rm -v $(pwd):/data ghcr.io/kjanat/articulate-parser:latest /data/input.json markdown /data/output.md

Usage

Basic File Processing

# Process from Articulate Rise URL
docker run --rm -v $(pwd):/data ghcr.io/kjanat/articulate-parser:latest https://rise.articulate.com/share/N_APNg40Vr2CSH2xNz-ZLATM5kNviDIO#/ markdown /data/output.md

# Process a local JSON file
docker run --rm -v $(pwd):/data ghcr.io/kjanat/articulate-parser:latest /data/document.json markdown /data/output.md

# Process with specific format and output
docker run --rm -v $(pwd):/data ghcr.io/kjanat/articulate-parser:latest /data/input.json docx /data/output.docx

Display Help and Version

# Show help information
docker run --rm ghcr.io/kjanat/articulate-parser:latest --help

# Show version
docker run --rm ghcr.io/kjanat/articulate-parser:latest --version

Available Tags

  • latest - Latest stable release
  • v1.x.x - Specific version tags
  • main - Latest development build

Image Details

  • Base Image: scratch (minimal attack surface)
  • Architecture: Multi-arch support (amd64, arm64)
  • Size: < 10MB (optimized binary)
  • Security: Runs as non-root user
  • Features: SBOM and provenance attestation included

Development

Local Build

docker build -t articulate-parser .

Docker Compose

docker-compose up --build

Repository