Recently Written · git

.env.example (5319 bytes)

 # Copy to .env and edit. Every value has a working localhost default,
 # so an empty .env is a valid config.
 
 # --- alignment -------------------------------------------------------------
 # Which backend does the aligning. See backend/aligner.py to add another.
 SUBPLZ_WEB_ALIGNER=subplz
 # tiny is what upstream recommends for audiobooks: the transcript only needs to
 # be good enough to line up against text you already have.
 SUBPLZ_WEB_MODEL=tiny
 # cpu | cuda
 SUBPLZ_WEB_DEVICE=cpu
 # 0 = use (CPU count - 1)
 SUBPLZ_WEB_THREADS=0
 SUBPLZ_WEB_JOB_TIMEOUT_SECONDS=21600
 
 # --- match check -----------------------------------------------------------
 # Transcribe a few short samples on upload and score them against the book,
 # so a mismatched pair is caught in seconds instead of after a full run.
 SUBPLZ_WEB_MATCH_CHECK=true
 
 # --- video -----------------------------------------------------------------
 # Render a YouTube-ready MP4: cover image + audio + soft subtitle track.
 SUBPLZ_WEB_RENDER_VIDEO=true
 SUBPLZ_WEB_VIDEO_WIDTH=1920
 SUBPLZ_WEB_VIDEO_HEIGHT=1080
 # 1 fps is the minimum YouTube accepts and all a still image needs.
 SUBPLZ_WEB_VIDEO_FPS=1
 # "auto" probes the H.264 encoders this ffmpeg build can actually run.
 # Force one with libx264 / h264_nvenc / h264_amf / h264_qsv / libopenh264.
 SUBPLZ_WEB_VIDEO_ENCODER=auto
 SUBPLZ_WEB_VIDEO_CRF=28
 
 # --- queue -----------------------------------------------------------------
 # memory = run jobs in this process. redis = hand them to worker.py processes.
 SUBPLZ_WEB_QUEUE_BACKEND=memory
 SUBPLZ_WEB_MAX_CONCURRENT_JOBS=1
 # SUBPLZ_WEB_REDIS_URL=redis://localhost:6379/0
 
 # --- storage ---------------------------------------------------------------
 # local = under ./data. s3 = a bucket, with presigned download URLs.
 SUBPLZ_WEB_STORAGE_BACKEND=local
 # SUBPLZ_WEB_S3_BUCKET=subplz-artifacts
 # SUBPLZ_WEB_S3_PREFIX=jobs/
 # SUBPLZ_WEB_DOWNLOAD_URL_TTL_SECONDS=3600
 
 # --- database --------------------------------------------------------------
 # Empty = SQLite under ./data. Set a Postgres URL for the public release.
 # SUBPLZ_WEB_DATABASE_URL=postgresql+psycopg://user:pass@host/subplz
 
 # --- billing ---------------------------------------------------------------
 # Off for localhost: nothing is locked and nothing is for sale.
 # On: a conversion in the visitor's browser stays free, without limit. A
 # conversion on this server's hardware takes one credit.
 SUBPLZ_WEB_BILLING_ENABLED=false
 # True when fast conversion on this server's hardware is on offer. While it is
 # false the page sells nothing, whatever BILLING_ENABLED says.
 SUBPLZ_WEB_CLOUD_ENABLED=false
 # Free credits for conversions on this server, while CLOUD_ENABLED is true.
 # A visitor without a verified email gets FREE_CREDITS_ANONYMOUS. An account
 # with a verified email gets FREE_CREDITS_VERIFIED in all, one more each day
 # (DAILY_FREE_CREDIT, not carried over), and one more for every
 # BOOKS_PER_BONUS_CREDIT books that the server converted for it (0 = off).
 SUBPLZ_WEB_FREE_CREDITS_ANONYMOUS=1
 SUBPLZ_WEB_FREE_CREDITS_VERIFIED=2
 SUBPLZ_WEB_DAILY_FREE_CREDIT=true
 SUBPLZ_WEB_BOOKS_PER_BONUS_CREDIT=2
 # Where customers write to. Shown on /terms.html.
 SUBPLZ_WEB_CONTACT_EMAIL=
 
 # --- accounts & payments ---------------------------------------------------
 # The origin users reach this on. Sign-in links and Stripe return URLs use it.
 # SUBPLZ_WEB_PUBLIC_BASE_URL=https://subread.space
 # Send the identity cookie over HTTPS only. Set true on any public deployment.
 # SUBPLZ_WEB_COOKIE_SECURE=true
 # Shown on the Stripe payment page.
 # SUBPLZ_WEB_SITE_NAME=SubRead
 
 # Stripe. Do not type these into a shell - use tools/set-secret.sh, which
 # prompts with input hidden and keeps them out of your history.
 # SUBPLZ_WEB_STRIPE_SECRET_KEY=
 # SUBPLZ_WEB_STRIPE_WEBHOOK_SECRET=
 
 # Sign-in links go out over SMTP, so any provider works. With no host set,
 # sign-in is unavailable: there would be no safe way to deliver the link.
 # SUBPLZ_WEB_SMTP_HOST=smtp.example.com
 # SUBPLZ_WEB_SMTP_PORT=587
 # SUBPLZ_WEB_SMTP_USER=
 # SUBPLZ_WEB_SMTP_PASSWORD=
 # SUBPLZ_WEB_SMTP_FROM=SubRead <login@subread.space>
 # Development only: return the sign-in link in the API response instead of
 # mailing it. This signs anyone in as any address - never set it in public.
 # SUBPLZ_WEB_DEV_LOGIN_LINKS=true
 # Override the plan catalogue (see backend/pricing.py for the shape).
 # SUBPLZ_WEB_PLANS_JSON=[...]
 
 # --- Subrep Pro --------------------------------------------------------------
 # The key that signs the licences of the Subrep desktop app. Do not type it:
 # make it on the server with tools/subrep_key.py, which also prints the public
 # key for the desktop build. Without it, Subrep Pro is not for sale.
 # SUBPLZ_WEB_SUBREP_LICENSE_KEY=
 
 # --- Google Play (Subrep Play build) ------------------------------------------
 # The path of the JSON key of a service account that can read and consume the
 # orders of Subrep in Play Console. Keep the file outside the checkout, owned by
 # the service user, with mode 600. Do not put the key itself in this file.
 # Without the file, the Play build of Subrep sells no hours.
 # SUBPLZ_WEB_PLAY_SERVICE_ACCOUNT_FILE=/etc/subplz-web/play-service-account.json
 
 # --- uploads ---------------------------------------------------------------
 SUBPLZ_WEB_MAX_UPLOAD_BYTES=2147483648