Update README.md

This commit is contained in:
McCloudS
2024-03-24 20:02:08 -06:00
committed by GitHub
parent a1e2a44a63
commit f193567276

View File

@@ -1,7 +1,11 @@
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/donate/?hosted_button_id=SU4QQP6LH5PF6)
![image](https://github.com/McCloudS/subgen/assets/64094529/99d8e81c-bce9-4850-b7c3-5c9f8f1495db)
<details>
<summary>Updates:</summary>
24 Mar 2024: Added a 'webui' to configure environment variables. You can use this instead of manually editing the script or using Environment Variables in your OS or Docker (if you want). The config will prioritize OS Env Variables, then the .env file, then the defaults. You can access it at `http://subgen:9000/`
23 Mar 2024: Added `CUSTOM_REGROUP` to try to 'clean up' subtitles a bit.
22 Mar 2024: Added LRC capability via see: `'LRC_FOR_AUDIO_FILES' | True | Will generate LRC (instead of SRT) files for filetypes: '.mp3', '.flac', '.wav', '.alac', '.ape', '.ogg', '.wma', '.m4a', '.m4b', '.aac', '.aiff' |`
@@ -65,6 +69,10 @@ Honestly, I built this for me, but saw the utility in other people maybe using i
## Install/Setup
You can now configure all environment variables via `http://subgen:9000/` (fill in your appropriate IP and port). You can still use Docker variables or OS Env Variables if you prefer. A small snapshot of it below:
![image](https://github.com/McCloudS/subgen/assets/64094529/02d6ed2a-5319-4991-858c-10f9baa77e82)
### Standalone/Without Docker
Install python3 and ffmpeg ~~and run `pip3 install numpy stable-ts fastapi requests faster-whisper uvicorn python-multipart python-ffmpeg whisper transformers optimum accelerate watchdog`~~. Then run it: `python3 launcher.py -u -i -s`. You need to have matching paths relative to your Plex server/folders, or use USE_PATH_MAPPING. Paths are not needed if you are only using Bazarr.