Skip to content
Klutch.sh Docs

Deploying an OSSTranslate App

Introduction

OSSTranslate is an open-source translation platform built on Node.js that lets teams run self-hosted translation workflows with glossaries and API integrations. Deploying OSSTranslate with a Dockerfile on Klutch.sh provides reproducible builds, managed secrets, and persistent storage for user data and logs—all configured from klutch.sh/app. This guide covers installation, repository prep, a production-ready Dockerfile, deployment steps, Nixpacks overrides, sample API usage, and production tips.

Prerequisites

  • A Klutch.sh account (sign up)
  • A GitHub repository containing your OSSTranslate code and Dockerfile (GitHub is the only supported git source)
  • Database (PostgreSQL recommended) deployed as a Klutch.sh TCP app on port 8000, connecting on 5432
  • Optional API keys for external translation providers

For onboarding, see the Quick Start.

Architecture and ports

  • OSSTranslate serves HTTP on internal port 3000; choose HTTP traffic.
  • Persistent storage is recommended for uploads/logs; database runs externally.

Repository layout

osstranslate/
├── Dockerfile              # Must be at repo root for auto-detection
├── package.json
├── pnpm-lock.yaml          # or yarn.lock / package-lock.json
├── .env.example            # Template only; no secrets
└── README.md

Keep secrets out of Git; store them in Klutch.sh environment variables.

Installation (local) and starter commands

Validate locally before pushing to GitHub:

Terminal window
pnpm install
pnpm build
pnpm start -- --port 3000

Optional helper start.sh:

#!/usr/bin/env bash
set -euo pipefail
exec pnpm start -- --port "${PORT:-3000}"

Make it executable with chmod +x start.sh.

Dockerfile for OSSTranslate (production-ready)

Place this Dockerfile at the repo root; Klutch.sh auto-detects it (no Docker selection in the UI):

FROM node:18-alpine AS build
WORKDIR /app


COPY package.json pnpm-lock.yaml* yarn.lock* package-lock.json* ./
RUN corepack enable
RUN pnpm install --frozen-lockfile


COPY . .
RUN pnpm build


FROM node:18-alpine
WORKDIR /app
ENV NODE_ENV=production PORT=3000


COPY --from=build /app /app
RUN corepack enable && pnpm install --prod --frozen-lockfile


EXPOSE 3000
CMD ["pnpm", "start", "--", "--port", "3000"]

Notes:

  • Add build tools (apk add --no-cache python3 make g++) if native modules are needed.
  • Keep any upload or log directories writable and mount them as volumes.

Environment variables (Klutch.sh)

Set these in Klutch.sh before deploying:

  • NODE_ENV=production
  • PORT=3000
  • APP_BASE_URL=https://example-app.klutch.sh
  • DATABASE_URL=postgres://<user>:<password>@<host>:5432/<db>
  • UPLOAD_DIR=/app/uploads
  • Optional provider keys: TRANSLATION_API_KEY, GLOSSARY_BUCKET, etc.

If you deploy without the Dockerfile and need Nixpacks overrides:

  • NIXPACKS_BUILD_CMD=pnpm install --frozen-lockfile && pnpm build
  • NIXPACKS_START_CMD=pnpm start -- --port 3000
  • NIXPACKS_NODE_VERSION=18

Attach persistent volumes

In Klutch.sh storage settings, add mount paths and sizes (no names required):

  • /app/uploads — user uploads, glossaries, and export files.
  • /app/logs — optional if you store logs locally.

Ensure these paths are writable inside the container.

Deploy OSSTranslate on Klutch.sh (Dockerfile workflow)

  1. Push your repository—with the Dockerfile at the root—to GitHub.
  2. Open klutch.sh/app, create a project, and add an app.
  3. Select HTTP traffic and set the internal port to 3000.
  4. Add the environment variables above, including database URL and any provider API keys.
  5. Attach persistent volumes for /app/uploads (and /app/logs if used) sized for your storage needs.
  6. Deploy. Your OSSTranslate instance will be reachable at https://example-app.klutch.sh; attach a custom domain if desired.

Sample API usage

Submit a translation request (example endpoint):

Terminal window
curl -X POST "https://example-app.klutch.sh/api/translate" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <token>" \
  -d '{"text":"Hello world","sourceLang":"en","targetLang":"es"}'

Health checks and production tips

  • Add an HTTP probe to /health or / for readiness.
  • Enforce HTTPS at the edge; forward internally to port 3000.
  • Use Postgres for production; keep DB creds and API keys in Klutch.sh secrets and rotate them regularly.
  • Monitor storage usage on /app/uploads; resize before it fills.
  • Pin image and dependency versions; test upgrades in staging before production.

OSSTranslate on Klutch.sh combines reproducible Docker builds with managed secrets, persistent storage, and flexible HTTP/TCP routing. With the Dockerfile at the repo root, port 3000 configured, and your database connected, you can deliver reliable translation workflows without extra YAML or workflow overhead.