auto-m4b/docs/examples/.env.example at main · DarthDobber/auto-m4b · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
# Auto-M4B Environment Configuration Example
#
# Copy this file to .env and customize for your setup.
# Then reference it in docker-compose.yml:
#
#   services:
#     auto-m4b:
#       env_file:
#         - .env

# =============================================================================
# REQUIRED SETTINGS
# =============================================================================

# User and group IDs for file ownership
# Run 'id' command to find your UID/GID
PUID=1000
PGID=1000

# Folder paths
INBOX_FOLDER=/inbox
CONVERTED_FOLDER=/converted
ARCHIVE_FOLDER=/archive
BACKUP_FOLDER=/backup

# =============================================================================
# PERFORMANCE SETTINGS
# =============================================================================

# Number of CPU cores to use for conversion
# Default: All available cores
# Recommendation: Leave 1-2 cores free for system
CPU_CORES=4

# Seconds to wait between inbox scans
# Default: 10
# Lower = more responsive, higher = less CPU overhead
SLEEP_TIME=10

# Seconds to wait after file changes before processing
# Default: 5
# Ensures file transfers are complete
WAIT_TIME=5

# =============================================================================
# AUDIO SETTINGS
# =============================================================================

# Use audio filenames as chapter names
# Default: N
# When enabled, "01 - Chapter One.mp3" becomes chapter "Chapter One"
USE_FILENAMES_AS_CHAPTERS=N

# Recognized audio file extensions
# Default: .mp3,.m4a,.m4b,.wma
# Comma-separated, include the leading dot
AUDIO_EXTS=.mp3,.m4a,.m4b,.wma,.ogg

# =============================================================================
# BEHAVIOR SETTINGS
# =============================================================================

# What to do with original files after successful conversion
# Options: archive, delete, test_do_nothing
# Default: archive
# WARNING: delete is permanent!
ON_COMPLETE=archive

# Overwrite existing M4B files in converted folder
# Default: N
# When N, existing files are skipped
OVERWRITE_EXISTING=N

# Create backup copies before processing
# Default: Y
# Disable to save disk space if you have another backup solution
BACKUP=Y

# Only process books matching this regex pattern
# Default: (none)
# Example: Dresden.*Files
# Note: Backslashes must be escaped: \\
MATCH_FILTER=

# =============================================================================
# BETA FEATURES
# =============================================================================
# These features are experimental and may have issues.
# Test thoroughly before production use!

# Combine multi-disc books into a single M4B
# Default: N
FLATTEN_MULTI_DISC_BOOKS=N

# Process book series as a single unit
# Default: N
CONVERT_SERIES=N

# =============================================================================
# DEVELOPMENT / DEBUG
# =============================================================================

# Enable verbose debug logging
# Default: N
DEBUG=N

# Enable test mode
# Default: N
# Uses .env.test file, changes some defaults
TEST=N

# Disable ASCII cat art in output
# Default: N
NO_CATS=N

# =============================================================================
# ADVANCED SETTINGS
# =============================================================================

# Temporary working directory
# Default: /tmp/auto-m4b
# Recommendation: Use fast storage (SSD/NVMe)
WORKING_FOLDER=/tmp/auto-m4b

# Force use of Docker-based m4b-tool
# Default: Auto-detected
# Usually doesn't need to be set
USE_DOCKER=

# Path to Docker executable
# Default: Auto-detected from PATH
# Only needed if Docker is not in PATH
DOCKER_PATH=

# =============================================================================
# SYSTEM
# =============================================================================

# Timezone
# Default: System timezone
# Examples: America/New_York, Europe/London, Asia/Tokyo
TZ=America/New_York

# Language
# Default: en_US.UTF-8
LANG=en_US.UTF-8