Add accent color, email subjects, MD+DOCX outputs, update README
This commit is contained in:
@@ -29,11 +29,16 @@ For more information: https://apstrom.ca
|
||||
- Jobs are queued and processed in the background (Celery + Redis).
|
||||
- Emails:
|
||||
- Immediate confirmation with queue position.
|
||||
- Final transcript (TXT + JSON) when ready.
|
||||
- Final transcript (MD + JSON) when ready.
|
||||
- Summary as MD file (if requested).
|
||||
- Error notification if processing fails.
|
||||
- File formats:
|
||||
- Transcript: .md and .docx
|
||||
- Summary (if requested): .md and .docx
|
||||
- Full structured output: .json
|
||||
- Customizable branding:
|
||||
- Web GUI title, logo, and email logo via environment variables.
|
||||
- Web GUI title, logo, and accent color via environment variables.
|
||||
- Email logo, accent color, and subject lines via environment variables.
|
||||
- CLI and Python API:
|
||||
- Simple command-line interface.
|
||||
- Drop-in Scraibe class for integration into other tools.
|
||||
@@ -74,6 +79,7 @@ Run the container with your LocalAI and summarizer endpoints:
|
||||
-e WEBUI_TITLE="Your Transcription Service" \
|
||||
-e WEBUI_LOGO_URL="https://your-domain.com/logo.png" \
|
||||
-e EMAIL_LOGO_URL="https://your-domain.com/logo.png" \
|
||||
-e EMAIL_ACCENT_COLOR="#7C6DA0" \
|
||||
scraibe:latest
|
||||
|
||||
Then open: http://<host>:7860
|
||||
@@ -195,6 +201,14 @@ Web GUI and branding:
|
||||
- URL of the logo displayed in the web GUI header.
|
||||
- Example: https://your-domain.com/logo.png
|
||||
|
||||
Accent color (UI and emails):
|
||||
|
||||
- EMAIL_ACCENT_COLOR:
|
||||
- Accent color used in:
|
||||
- Web GUI buttons and accents
|
||||
- Email headings, links, and email addresses
|
||||
- Default: #7C6DA0
|
||||
|
||||
Async processing (Celery + Redis):
|
||||
|
||||
- CELERY_BROKER_URL:
|
||||
@@ -227,6 +241,30 @@ Email configuration:
|
||||
- EMAIL_CSS_PATH:
|
||||
- Path to the CSS used in emails (default: /app/src/misc/mail_style.css).
|
||||
|
||||
Email subject lines (customizable):
|
||||
|
||||
- EMAIL_SUBJECT_UPLOAD:
|
||||
- Subject for upload confirmation email.
|
||||
- Default: "ScrAIbe: Your transcription request has been received"
|
||||
- EMAIL_SUBJECT_SUCCESS:
|
||||
- Subject for transcript-ready email.
|
||||
- Default: "ScrAIbe: Your transcript is ready"
|
||||
- EMAIL_SUBJECT_ERROR:
|
||||
- Subject for error notification email.
|
||||
- Default: "ScrAIbe: Error with your transcription request"
|
||||
|
||||
Output files (async web GUI):
|
||||
|
||||
When a job completes, the user receives:
|
||||
- Transcript:
|
||||
- .md file
|
||||
- .docx file
|
||||
- Summary (if requested):
|
||||
- .md file
|
||||
- .docx file
|
||||
- JSON:
|
||||
- Structured transcript with diarization and metadata
|
||||
|
||||
All of these can also be overridden from the CLI when needed (e.g., --localai-api-url, --summarizer-api-url).
|
||||
|
||||
## Dependencies
|
||||
@@ -240,6 +278,7 @@ Core runtime dependencies:
|
||||
- gradio
|
||||
- celery[redis]
|
||||
- redis
|
||||
- python-docx
|
||||
- ffmpeg (for audio preprocessing)
|
||||
|
||||
No local Whisper, PyTorch, or Pyannote models are required.
|
||||
|
||||
Reference in New Issue
Block a user