initial commit

Author: johnpc

.env.example

@@ -0,0 +1,2 @@
+MEDIA_PATH=/path/to/your/media
+TZ=America/New_York  # Adjust timezone as needed

.github/workflows/docker-publish.yml

@@ -0,0 +1,49 @@
+name: Build and Publish Docker Image
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+env:
+  IMAGE_NAME: mrorbitman/subsyncarr
+
+jobs:
+  build-and-push:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Log in to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: mrorbitman
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ${{ env.IMAGE_NAME }}
+          tags: |
+            type=raw,value=latest
+            type=sha,prefix=
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max

.gitignore

@@ -0,0 +1,6 @@
+/node_modules
+/build
+/dist
+/coverage
+.eslintcache
+.env

.husky/pre-commit

@@ -0,0 +1 @@
+npx lint-staged

.prettierignore

@@ -0,0 +1,9 @@
+# Ignore artifacts:
+build
+coverage
+node_modules
+dist
+.gitignore
+.prettierignore
+.husky
+Dockerfile

.prettierrc.js

@@ -0,0 +1,7 @@
+module.exports = {
+  semi: true,
+  trailingComma: 'all',
+  singleQuote: true,
+  printWidth: 120,
+  tabWidth: 2,
+};

Dockerfile

@@ -0,0 +1,63 @@
+# Use Node.js LTS (Long Term Support) as base image
+FROM node:20-bullseye
+
+# Set working directory
+WORKDIR /app
+
+# Install system dependencies including ffmpeg, Python, and cron
+RUN apt-get update && apt-get install -y \
+    ffmpeg \
+    python3 \
+    python3-pip \
+    python3-venv \
+    cron \
+    && rm -rf /var/lib/apt/lists/*
+
+# Install pipx
+RUN python3 -m pip install --user pipx \
+    && python3 -m pipx ensurepath
+
+# Add pipx to PATH
+ENV PATH="/root/.local/bin:$PATH"
+
+# Install ffsubsync and autosubsync using pipx
+RUN pipx install ffsubsync \
+    && pipx install autosubsync
+
+# Copy package.json and package-lock.json (if available)
+COPY package*.json ./
+
+# Install Node.js dependencies while skipping husky installation
+ENV HUSKY=0
+RUN npm install --ignore-scripts
+
+# Copy the rest of your application
+COPY . .
+
+# Build TypeScript
+RUN npm run build
+
+# Create startup script
+RUN echo '#!/bin/bash\n\
+# Add cron job\n\
+echo "0 0 * * * cd /app && /usr/local/bin/node /app/dist/index.js >> /var/log/cron.log 2>&1" > /etc/cron.d/subtitle-sync\n\
+chmod 0644 /etc/cron.d/subtitle-sync\n\
+crontab /etc/cron.d/subtitle-sync\n\
+\n\
+# Start cron\n\
+service cron start\n\
+\n\
+# Run the initial instance of the app\n\
+node dist/index.js\n\
+\n\
+# Keep container running\n\
+tail -f /var/log/cron.log' > /app/startup.sh
+
+# Make startup script executable
+RUN chmod +x /app/startup.sh
+
+# Create log file
+RUN touch /var/log/cron.log
+
+# Use startup script as entrypoint
+CMD ["/app/startup.sh"]

README.md

@@ -0,0 +1,77 @@
+# Subsyncarr
+
+An automated subtitle synchronization tool that runs as a Docker container. It watches a directory for video files with matching subtitles and automatically synchronizes them using both ffsubsync and autosubsync.
+
+## Features
+
+- Automatically scans directory for video files and their corresponding subtitles
+- Uses both ffsubsync and autosubsync for maximum compatibility
+- Runs on a schedule (daily at midnight) and on container startup
+- Supports common video formats (mkv, mp4, avi, mov)
+- Docker-based for easy deployment
+- Generates synchronized subtitle files with `.ffsubsync.srt` and `.autosubsync.srt` extensions
+
+## Quick Start
+
+### Using Docker Compose (Recommended)
+
+#### 1. Create a new directory for your project:
+
+```bash
+mkdir subsyncarr && cd subsyncarr
+```
+
+#### 2. Download the docker-compose.yml and .env.example files:
+
+```bash
+curl -O https://raw.githubusercontent.com/johnpc/subsyncarr/main/docker-compose.yml
+curl -O https://raw.githubusercontent.com/johnpc/subsyncarr/main/.env.example
+```
+
+#### 3. Create your .env file:
+
+```bash
+cp .env.example .env
+```
+
+#### 4. Edit the .env file with your settings:
+
+```bash
+MEDIA_PATH=/path/to/your/media
+TZ=America/New_York  # Adjust to your timezone
+```
+
+#### 5. Start the container:
+
+```bash
+docker-compose up -d
+```
+
+## Configuration
+
+The container is configured to:
+
+- Scan for subtitle files in the mounted directory
+- Run synchronization at container startup
+- Run daily at midnight (configurable via cron)
+- Generate synchronized subtitle versions using different tools (currently ffsubsync and autosubsync)
+
+### Directory Structure
+
+Your media directory should be organized as follows:
+
+/media
+  ├── movie1.mkv
+  ├── movie1.srt
+  ├── movie2.mp4
+  └── movie2.srt
+
+It should follow the naming conventions expected by other services like Bazarr and Jellyfin.
+
+## Logs
+
+View container logs:
+
+```bash
+docker logs -f subsyncarr
+```

babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [['@babel/preset-env', { targets: { node: 'current' } }], '@babel/preset-typescript'],
+};

docker-compose.yaml

@@ -0,0 +1,15 @@
+version: "3.8"
+
+services:
+  subtitle-sync:
+    image: mrorbitman/subsyncarr:latest
+    container_name: subsyncarrsync
+    volumes:
+      - ${MEDIA_PATH:-/path/to/your/media}:/scan_dir
+    restart: unless-stopped
+    environment:
+      - TZ=${TZ:-UTC}
+
+volumes:
+  media:
+    driver: local