docs: add .example.env.local configuration file and update installation instructions in README
This commit is contained in:
@@ -0,0 +1,14 @@
|
|||||||
|
# Primary Config
|
||||||
|
RED_IMAGE_API_KEY=0123456789abcdefg # Your RED API Key, with torrent permission zone enabled
|
||||||
|
QUI_CLIENT_PROXY=http://192.168.1.10:7476/proxy/0000abcd # QUI Client Proxy URL
|
||||||
|
OUTPUT_DIR="/media/location/outout" # Output directory (Seed location)
|
||||||
|
WATCH_DIR="/media/location/input" # Input directory (Searches this directory for new content)
|
||||||
|
TIDAL_CLIENT_ID="0123456789abcdefg" # Personal TIDAL Client ID
|
||||||
|
TIDAL_CLIENT_SECRET="0123456789abcdefg" # Personal TIDAL Client Secret
|
||||||
|
|
||||||
|
# General Program Options
|
||||||
|
GENERATE_MONO_SPECTROGRAMS=true # Disable to generate stereo spectrograms
|
||||||
|
NEXT_PUBLIC_SHOW_SYSTEM_LOG=false # Show a debug logs in the UI
|
||||||
|
DELETE_GENERATED_TORRENTS=true # Also delete the generated torrent files upon source file deletion
|
||||||
|
NEXT_PUBLIC_DELETE_HOLD_TIME_MS=500 # Time in milliseconds to hold the delete button before it triggers
|
||||||
|
NEXT_PUBLIC_SHOW_TRACK_BITRATE=false # Show individual track bitrate in the UI
|
||||||
@@ -4,13 +4,17 @@ A TIDAL upload formatter and quality control tool for uploading to RED.
|
|||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
1. Clone reposity and edit default config values in `.env.local.example`, then rename it to `.env.local`.
|
1. Clone reposity and edit default config values in `.example.env.local`, then rename it to `.env.local`.
|
||||||
|
|
||||||
2. Install dependencies, build, and run the app:
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://git.tgcomplete.com/anon28410/crossfade.git
|
git clone https://git.tgcomplete.com/anon28410/crossfade.git
|
||||||
cd crossfade
|
cd crossfade
|
||||||
|
cp .example.env.local .env.local
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Install dependencies, build, and run the app:
|
||||||
|
|
||||||
|
```bash
|
||||||
npm install
|
npm install
|
||||||
npm run build
|
npm run build
|
||||||
npm run start
|
npm run start
|
||||||
|
|||||||
Reference in New Issue
Block a user