-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcatalogizer-tutorial.html
More file actions
1186 lines (1011 loc) · 43 KB
/
catalogizer-tutorial.html
File metadata and controls
1186 lines (1011 loc) · 43 KB
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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Catalogizer Complete Setup and Usage Tutorial</title>
<style>
body {
font-family: 'Segoe UI', Tahoma, Geneva, Verdana, sans-serif;
line-height: 1.6;
color: #333;
max-width: 1200px;
margin: 0 auto;
padding: 20px;
background-color: #f8f9fa;
}
.header {
background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
color: white;
padding: 40px;
text-align: center;
border-radius: 10px;
margin-bottom: 30px;
box-shadow: 0 4px 6px rgba(0,0,0,0.1);
}
.header h1 {
margin: 0;
font-size: 2.5em;
font-weight: 300;
}
.header p {
margin: 10px 0 0 0;
font-size: 1.2em;
opacity: 0.9;
}
.toc {
background: white;
padding: 30px;
border-radius: 10px;
margin-bottom: 30px;
box-shadow: 0 2px 4px rgba(0,0,0,0.1);
}
.toc h2 {
color: #667eea;
border-bottom: 2px solid #667eea;
padding-bottom: 10px;
}
.toc ul {
list-style: none;
padding: 0;
}
.toc li {
margin: 10px 0;
padding-left: 20px;
position: relative;
}
.toc li:before {
content: "▶";
color: #667eea;
position: absolute;
left: 0;
}
.section {
background: white;
padding: 30px;
margin-bottom: 30px;
border-radius: 10px;
box-shadow: 0 2px 4px rgba(0,0,0,0.1);
page-break-inside: avoid;
}
.section h2 {
color: #667eea;
border-bottom: 2px solid #667eea;
padding-bottom: 10px;
margin-top: 0;
}
.section h3 {
color: #764ba2;
margin-top: 30px;
}
.step {
background: #f8f9fa;
border-left: 4px solid #667eea;
padding: 20px;
margin: 20px 0;
border-radius: 0 5px 5px 0;
}
.step-number {
background: #667eea;
color: white;
display: inline-block;
width: 30px;
height: 30px;
border-radius: 50%;
text-align: center;
line-height: 30px;
font-weight: bold;
margin-right: 15px;
}
.code-block {
background: #2d3748;
color: #e2e8f0;
padding: 20px;
border-radius: 5px;
margin: 20px 0;
overflow-x: auto;
font-family: 'Courier New', monospace;
font-size: 14px;
}
.code-block.inline {
display: inline-block;
padding: 2px 6px;
background: #edf2f7;
color: #2d3748;
border-radius: 3px;
font-size: 13px;
}
.screenshot-placeholder {
background: #f7fafc;
border: 2px dashed #cbd5e0;
border-radius: 5px;
padding: 40px;
text-align: center;
margin: 20px 0;
color: #718096;
}
.screenshot-placeholder strong {
color: #4a5568;
}
.warning {
background: #fff5f5;
border-left: 4px solid #e53e3e;
padding: 20px;
margin: 20px 0;
border-radius: 0 5px 5px 0;
}
.info {
background: #ebf8ff;
border-left: 4px solid #3182ce;
padding: 20px;
margin: 20px 0;
border-radius: 0 5px 5px 0;
}
.success {
background: #f0fff4;
border-left: 4px solid #38a169;
padding: 20px;
margin: 20px 0;
border-radius: 0 5px 5px 0;
}
.component-grid {
display: grid;
grid-template-columns: repeat(auto-fit, minmax(300px, 1fr));
gap: 20px;
margin: 20px 0;
}
.component-card {
background: #f8f9fa;
padding: 20px;
border-radius: 8px;
border: 1px solid #e9ecef;
}
.component-card h4 {
color: #667eea;
margin-top: 0;
}
.footer {
text-align: center;
padding: 30px;
color: #718096;
border-top: 1px solid #e9ecef;
margin-top: 50px;
}
@media print {
body {
background: white;
max-width: none;
margin: 0;
padding: 20px;
}
.section {
page-break-inside: avoid;
break-inside: avoid;
}
.step {
page-break-inside: avoid;
break-inside: avoid;
}
.header, .toc, .section {
box-shadow: none;
border: 1px solid #e9ecef;
}
.code-block {
background: #f8f9fa !important;
color: #2d3748 !important;
border: 1px solid #e9ecef;
}
}
@media (max-width: 768px) {
.header {
padding: 20px;
}
.header h1 {
font-size: 2em;
}
.section {
padding: 20px;
}
.component-grid {
grid-template-columns: 1fr;
}
}
</style>
</head>
<body>
<div class="header">
<h1>🎬 Catalogizer</h1>
<p>Complete Setup and Usage Tutorial for Advanced Media Collection Management</p>
</div>
<div class="toc">
<h2>📋 Table of Contents</h2>
<ul>
<li><a href="#overview">System Overview</a></li>
<li><a href="#tutorials">Step-by-Step Tutorials</a></li>
<li><a href="#prerequisites">Prerequisites</a></li>
<li><a href="#quick-start">Quick Start</a></li>
<li><a href="#backend-setup">Backend API Setup</a></li>
<li><a href="#frontend-setup">Web Frontend Setup</a></li>
<li><a href="#installer-wizard">Installation Wizard</a></li>
<li><a href="#desktop-app">Desktop Application</a></li>
<li><a href="#android-app">Android Application</a></li>
<li><a href="#android-tv">Android TV Application</a></li>
<li><a href="#api-client">API Client Library</a></li>
<li><a href="#configuration">Configuration</a></li>
<li><a href="#usage">Using Catalogizer</a></li>
<li><a href="#deployment">Production Deployment</a></li>
<li><a href="#troubleshooting">Troubleshooting</a></li>
<li><a href="#support">Support & Resources</a></li>
</ul>
</div>
<div id="overview" class="section">
<h2>🏗️ System Overview</h2>
<p>Catalogizer is a comprehensive media collection management system that automatically detects, categorizes, and organizes your media files across multiple storage protocols including SMB, FTP, NFS, WebDAV, and local filesystems. It provides real-time monitoring, advanced analytics, and multiple client interfaces for managing your entire media library.</p>
<div class="component-grid">
<div class="component-card">
<h4>🎯 Core Features</h4>
<ul>
<li>Automated media detection (50+ types)</li>
<li>Multi-protocol support (SMB, FTP, NFS, WebDAV, Local)</li>
<li>Protocol resilience with offline caching</li>
<li>Subtitle management & translation</li>
<li>Advanced analytics & quality analysis</li>
<li>JWT-based secure authentication</li>
<li>External metadata integration (TMDB, IMDB, Spotify, Steam)</li>
<li>PDF conversion & advanced reporting</li>
<li>Favorites export/import (JSON, CSV)</li>
<li>Cloud storage sync (S3, GCS)</li>
</ul>
</div>
<div class="component-card">
<h4>🛠️ Components</h4>
<ul>
<li><strong>catalog-api</strong>: Go REST API server</li>
<li><strong>catalog-web</strong>: React web interface</li>
<li><strong>installer-wizard</strong>: Desktop setup tool</li>
<li><strong>catalogizer-desktop</strong>: Cross-platform desktop app</li>
<li><strong>catalogizer-android</strong>: Mobile Android app</li>
<li><strong>catalogizer-androidtv</strong>: Android TV app</li>
<li><strong>catalogizer-api-client</strong>: TypeScript API client</li>
</ul>
</div>
<div class="component-card">
<h4>🏛️ Architecture</h4>
<ul>
<li>Go backend with Gin framework</li>
<li>React TypeScript frontend</li>
<li>SQLCipher encrypted database</li>
<li>WebSocket real-time updates</li>
<li>Circuit breaker pattern</li>
<li>Microservices-inspired design</li>
</ul>
</div>
</div>
<div class="info">
<strong>💡 Pro Tip:</strong> Start with the Installation Wizard for the easiest setup experience, or use Docker Compose for a complete development environment.
</div>
</div>
<div id="tutorials" class="section">
<h2>📚 Step-by-Step Tutorials</h2>
<p>New to Catalogizer? Start with these focused tutorials to get up and running quickly.</p>
<div class="component-grid">
<div class="component-card">
<h4>🚀 <a href="docs/tutorials/QUICK_START.md">Quick Start Guide</a></h4>
<p>Install via Docker, create an admin account, connect your first storage source, and browse your catalog in 10 minutes.</p>
</div>
<div class="component-card">
<h4>🔌 <a href="docs/tutorials/CONNECT_SMB_SHARE.md">Connect an SMB Share</a></h4>
<p>Configure an SMB network share, test the connection, scan for media, and verify results in your catalog.</p>
</div>
<div class="component-card">
<h4>🎬 <a href="docs/tutorials/SUBTITLE_MANAGEMENT.md">Subtitle Management</a></h4>
<p>Search subtitles across providers, download and sync, translate to other languages, and upload custom files.</p>
</div>
<div class="component-card">
<h4>📊 <a href="docs/tutorials/SETUP_MONITORING.md">Set Up Monitoring</a></h4>
<p>Enable Prometheus and Grafana, explore pre-built dashboards, and create custom alerts.</p>
</div>
<div class="component-card">
<h4>📱 <a href="docs/tutorials/MOBILE_SETUP.md">Mobile Setup</a></h4>
<p>Install the Android app, connect to your server, and configure offline mode for on-the-go access.</p>
</div>
</div>
<div class="info">
<strong>📖 Full Documentation:</strong> Visit the <a href="docs/website/DOCUMENTATION.md">Documentation Hub</a> for comprehensive guides organized by audience (users, admins, developers). See the <a href="docs/website/FEATURES.md">Features page</a> for a complete feature overview, or the <a href="docs/website/DOWNLOAD.md">Download page</a> for all installation options.
</div>
</div>
<div id="prerequisites" class="section">
<h2>📋 Prerequisites</h2>
<p>Before setting up Catalogizer, ensure your system meets these requirements:</p>
<h3>System Requirements</h3>
<div class="component-grid">
<div class="component-card">
<h4>🖥️ Development</h4>
<ul>
<li>Go 1.21+ (backend)</li>
<li>Node.js 18+ (frontend/clients)</li>
<li>SQLCipher (database)</li>
<li>Git (version control)</li>
<li>4GB RAM minimum</li>
</ul>
</div>
<div class="component-card">
<h4>🏭 Production</h4>
<ul>
<li>2 CPU cores minimum</li>
<li>4GB RAM minimum</li>
<li>20GB storage minimum</li>
<li>100 Mbps network</li>
<li>Linux/Windows/macOS</li>
</ul>
</div>
<div class="component-card">
<h4>🔧 Optional Tools</h4>
<ul>
<li>Docker & Docker Compose</li>
<li>Android Studio (Android dev)</li>
<li>Rust & Tauri CLI (desktop)</li>
<li>PostgreSQL (production DB)</li>
<li>Nginx (reverse proxy)</li>
</ul>
</div>
</div>
<h3>Network Requirements</h3>
<ul>
<li><strong>SMB Access:</strong> Network access to SMB/CIFS shares (ports 139, 445)</li>
<li><strong>FTP Access:</strong> FTP/FTPS connectivity (port 21 plus passive ports)</li>
<li><strong>NFS Access:</strong> NFS service and exports configured</li>
<li><strong>WebDAV Access:</strong> HTTP/HTTPS connectivity to WebDAV endpoints</li>
<li><strong>Internet Access:</strong> For external metadata APIs (TMDB, IMDB, MusicBrainz, Spotify, Steam)</li>
<li><strong>Firewall:</strong> Open ports 8080 (API), 5173 (dev web), 80/443 (production), 9090 (Prometheus), 3001 (Grafana)</li>
</ul>
<div class="warning">
<strong>⚠️ Important:</strong> Ensure your storage sources are accessible and you have read permissions. The system will monitor these sources continuously. See the <a href="docs/tutorials/CONNECT_SMB_SHARE.md">SMB tutorial</a> for connection testing steps.
</div>
</div>
<div id="quick-start" class="section">
<h2>🚀 Quick Start</h2>
<p>Get Catalogizer running quickly using Docker Compose for development:</p>
<div class="step">
<span class="step-number">1</span>
<strong>Clone the Repository</strong>
<div class="code-block">git clone https://github.com/your-org/Catalogizer.git
cd Catalogizer</div>
</div>
<div class="step">
<span class="step-number">2</span>
<strong>Start Development Environment</strong>
<div class="code-block">docker-compose up -d</div>
</div>
<div class="step">
<span class="step-number">3</span>
<strong>Access the Application</strong>
<ul>
<li><strong>Web Interface:</strong> <a href="http://localhost:3000">http://localhost:3000</a></li>
<li><strong>API Documentation:</strong> <a href="http://localhost:8080/swagger">http://localhost:8080/swagger</a></li>
<li><strong>API Health:</strong> <a href="http://localhost:8080/health">http://localhost:8080/health</a></li>
</ul>
</div>
<div class="screenshot-placeholder">
<strong>📸 Screenshot Placeholder:</strong><br>
Catalogizer web interface dashboard showing media overview, recent additions, and system status
</div>
<div class="success">
<strong>✅ Success!</strong> You now have a working Catalogizer instance. Continue reading for detailed setup of individual components.
</div>
</div>
<div id="backend-setup" class="section">
<h2>⚙️ Backend API Setup</h2>
<p>The Go-based REST API server handles media detection, SMB monitoring, and provides the core functionality.</p>
<h3>Manual Setup</h3>
<div class="step">
<span class="step-number">1</span>
<strong>Navigate to API Directory</strong>
<div class="code-block">cd catalog-api</div>
</div>
<div class="step">
<span class="step-number">2</span>
<strong>Install Go Dependencies</strong>
<div class="code-block">go mod tidy</div>
</div>
<div class="step">
<span class="step-number">3</span>
<strong>Configure Environment</strong>
<div class="code-block">cp .env.example .env
# Edit .env with your settings</div>
<p><strong>Key Configuration:</strong></p>
<div class="code-block"># Database
DB_PATH=./data/catalogizer.db
DB_ENCRYPTION_KEY=your-32-character-encryption-key
# Server
PORT=8080
HOST=127.0.0.1
GIN_MODE=debug
# JWT Authentication
JWT_SECRET=your-jwt-secret-key
JWT_EXPIRY_HOURS=24
# SMB Sources
SMB_SOURCES=smb://server1/media,smb://server2/videos
SMB_USERNAME=your-username
SMB_PASSWORD=your-password</div>
</div>
<div class="step">
<span class="step-number">4</span>
<strong>Initialize Database</strong>
<div class="code-block">go run cmd/migrate/main.go</div>
</div>
<div class="step">
<span class="step-number">5</span>
<strong>Start the API Server</strong>
<div class="code-block">go run cmd/server/main.go</div>
</div>
<h3>Production Setup</h3>
<div class="step">
<span class="step-number">1</span>
<strong>Build Production Binary</strong>
<div class="code-block">CGO_ENABLED=1 go build -o catalogizer cmd/server/main.go</div>
</div>
<div class="step">
<span class="step-number">2</span>
<strong>Create System Service</strong>
<div class="code-block">sudo cp catalogizer /usr/local/bin/
sudo useradd -r -s /bin/false catalogizer
sudo mkdir -p /var/lib/catalogizer
sudo chown catalogizer:catalogizer /var/lib/catalogizer</div>
</div>
<div class="step">
<span class="step-number">3</span>
<strong>Create systemd Service</strong>
<p>Create <code class="code-block inline">/etc/systemd/system/catalogizer-api.service</code>:</p>
<div class="code-block">[Unit]
Description=Catalogizer API Server
After=network.target
[Service]
Type=simple
User=catalogizer
Group=catalogizer
WorkingDirectory=/var/lib/catalogizer
ExecStart=/usr/local/bin/catalogizer
Restart=always
RestartSec=5
[Install]
WantedBy=multi-user.target</div>
</div>
<div class="step">
<span class="step-number">4</span>
<strong>Enable and Start Service</strong>
<div class="code-block">sudo systemctl enable catalogizer-api
sudo systemctl start catalogizer-api
sudo systemctl status catalogizer-api</div>
</div>
<div class="info">
<strong>🔍 Verification:</strong> Check API health at <code class="code-block inline">http://localhost:8080/health</code>
</div>
</div>
<div id="frontend-setup" class="section">
<h2>🌐 Web Frontend Setup</h2>
<p>The React TypeScript web interface provides a modern, responsive UI for managing your media collection.</p>
<div class="step">
<span class="step-number">1</span>
<strong>Navigate to Web Directory</strong>
<div class="code-block">cd catalog-web</div>
</div>
<div class="step">
<span class="step-number">2</span>
<strong>Install Dependencies</strong>
<div class="code-block">npm install</div>
</div>
<div class="step">
<span class="step-number">3</span>
<strong>Configure Environment</strong>
<div class="code-block">cp .env.example .env.local</div>
<p>Edit <code class="code-block inline">.env.local</code>:</p>
<div class="code-block"># API Configuration
VITE_API_BASE_URL=http://localhost:8080
VITE_WS_URL=ws://localhost:8080/ws
# Feature Flags
VITE_ENABLE_ANALYTICS=true
VITE_ENABLE_REALTIME=true
VITE_ENABLE_EXTERNAL_METADATA=true</div>
</div>
<div class="step">
<span class="step-number">4</span>
<strong>Start Development Server</strong>
<div class="code-block">npm run dev</div>
<p>Access at: <a href="http://localhost:3000">http://localhost:3000</a></p>
</div>
<h3>Production Build</h3>
<div class="step">
<span class="step-number">1</span>
<strong>Build for Production</strong>
<div class="code-block">npm run build</div>
</div>
<div class="step">
<span class="step-number">2</span>
<strong>Serve with Nginx</strong>
<p>Create <code class="code-block inline">/etc/nginx/sites-available/catalogizer</code>:</p>
<div class="code-block">server {
listen 80;
server_name your-domain.com;
root /var/www/catalogizer;
index index.html;
location / {
try_files $uri $uri/ /index.html;
}
location /api {
proxy_pass http://127.0.0.1:8080;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
}
}</div>
</div>
<div class="screenshot-placeholder">
<strong>📸 Screenshot Placeholder:</strong><br>
Catalogizer web interface login screen with modern design and responsive layout
</div>
</div>
<div id="installer-wizard" class="section">
<h2>🧙 Installation Wizard</h2>
<p>The desktop installation wizard provides an intuitive interface for configuring SMB sources and setting up Catalogizer.</p>
<div class="step">
<span class="step-number">1</span>
<strong>Navigate to Wizard Directory</strong>
<div class="code-block">cd installer-wizard</div>
</div>
<div class="step">
<span class="step-number">2</span>
<strong>Install Dependencies</strong>
<div class="code-block">npm install</div>
</div>
<div class="step">
<span class="step-number">3</span>
<strong>Start Development</strong>
<div class="code-block">npm run tauri dev</div>
</div>
<div class="step">
<span class="step-number">4</span>
<strong>Build for Distribution</strong>
<div class="code-block">npm run tauri build</div>
</div>
<h3>Wizard Workflow</h3>
<ol>
<li><strong>Welcome Screen:</strong> Introduction and system requirements check</li>
<li><strong>Network Discovery:</strong> Automatic scanning for SMB devices</li>
<li><strong>SMB Configuration:</strong> Visual setup of network shares</li>
<li><strong>Connection Testing:</strong> Real-time validation of SMB credentials</li>
<li><strong>Summary & Export:</strong> Review configuration and save settings</li>
</ol>
<div class="screenshot-placeholder">
<strong>📸 Screenshot Placeholder:</strong><br>
Installation wizard network discovery screen showing detected SMB devices and connection status
</div>
<div class="info">
<strong>🎯 Best For:</strong> First-time setup and SMB configuration. The wizard generates JSON configuration files compatible with the main Catalogizer system.
</div>
</div>
<div id="desktop-app" class="section">
<h2>💻 Desktop Application</h2>
<p>Cross-platform desktop application built with Tauri and React, providing native performance and system integration.</p>
<div class="step">
<span class="step-number">1</span>
<strong>Navigate to Desktop Directory</strong>
<div class="code-block">cd catalogizer-desktop</div>
</div>
<div class="step">
<span class="step-number">2</span>
<strong>Install Dependencies</strong>
<div class="code-block">npm install</div>
</div>
<div class="step">
<span class="step-number">3</span>
<strong>Configure API Connection</strong>
<div class="code-block">cp .env.example .env
# Set VITE_API_BASE_URL to your API server</div>
</div>
<div class="step">
<span class="step-number">4</span>
<strong>Start Development</strong>
<div class="code-block">npm run tauri dev</div>
</div>
<div class="step">
<span class="step-number">5</span>
<strong>Build for Production</strong>
<div class="code-block">npm run tauri build</div>
</div>
<h3>Platform-Specific Builds</h3>
<div class="code-block"># Windows
npm run tauri build -- --target x86_64-pc-windows-msvc
# macOS
npm run tauri build -- --target x86_64-apple-darwin
# Linux
npm run tauri build -- --target x86_64-unknown-linux-gnu</div>
<div class="screenshot-placeholder">
<strong>📸 Screenshot Placeholder:</strong><br>
Desktop application main interface showing media browser, search, and system tray integration
</div>
</div>
<div id="android-app" class="section">
<h2>📱 Android Application</h2>
<p>Modern Android app with MVVM architecture, offline support, and material design.</p>
<div class="step">
<span class="step-number">1</span>
<strong>Navigate to Android Directory</strong>
<div class="code-block">cd catalogizer-android</div>
</div>
<div class="step">
<span class="step-number">2</span>
<strong>Open in Android Studio</strong>
<p>Launch Android Studio and open the project directory.</p>
</div>
<div class="step">
<span class="step-number">3</span>
<strong>Configure API Endpoint</strong>
<p>Update <code class="code-block inline">app/build.gradle</code> or create environment configuration.</p>
</div>
<div class="step">
<span class="step-number">4</span>
<strong>Build and Run</strong>
<div class="code-block">./gradlew assembleDebug
./gradlew installDebug</div>
</div>
<h3>Key Features</h3>
<ul>
<li><strong>MVVM Architecture:</strong> Clean separation of concerns</li>
<li><strong>Offline Support:</strong> Room database with automatic sync</li>
<li><strong>Material Design 3:</strong> Modern Android UI components</li>
<li><strong>Manual DI:</strong> Custom dependency injection container</li>
</ul>
<div class="screenshot-placeholder">
<strong>📸 Screenshot Placeholder:</strong><br>
Android app media browsing interface with material design components and offline indicators
</div>
</div>
<div id="android-tv" class="section">
<h2>📺 Android TV Application</h2>
<p>Leanback UI optimized for Android TV with D-pad navigation and voice search.</p>
<div class="step">
<span class="step-number">1</span>
<strong>Navigate to Android TV Directory</strong>
<div class="code-block">cd catalogizer-androidtv</div>
</div>
<div class="step">
<span class="step-number">2</span>
<strong>Build and Install</strong>
<div class="code-block">./gradlew assembleDebug
./gradlew installDebug</div>
</div>
<h3>TV-Specific Features</h3>
<ul>
<li><strong>Leanback UI:</strong> TV-optimized interface</li>
<li><strong>D-pad Navigation:</strong> Full remote control support</li>
<li><strong>Voice Search:</strong> Google Assistant integration</li>
<li><strong>Recommendations:</strong> Android TV recommendations API</li>
</ul>
<div class="screenshot-placeholder">
<strong>📸 Screenshot Placeholder:</strong><br>
Android TV interface showing media grid with focus indicators and remote navigation
</div>
</div>
<div id="api-client" class="section">
<h2>🔧 API Client Library</h2>
<p>TypeScript API client library for integrating with Catalogizer from other applications.</p>
<div class="step">
<span class="step-number">1</span>
<strong>Navigate to API Client Directory</strong>
<div class="code-block">cd catalogizer-api-client</div>
</div>
<div class="step">
<span class="step-number">2</span>
<strong>Install Dependencies</strong>
<div class="code-block">npm install</div>
</div>
<div class="step">
<span class="step-number">3</span>
<strong>Build the Library</strong>
<div class="code-block">npm run build</div>
</div>
<div class="step">
<span class="step-number">4</span>
<strong>Publish or Use Locally</strong>
<div class="code-block"># Publish to npm
npm publish
# Or use locally
npm link</div>
</div>
<h3>Usage Example</h3>
<div class="code-block">import { CatalogizerClient } from '@catalogizer/api-client';
const client = new CatalogizerClient({
baseURL: 'http://localhost:8080',
apiKey: 'your-api-key'
});
// Search media
const results = await client.media.search({
query: 'The Matrix',
type: 'movie'
});
// Get media details
const media = await client.media.getById('123');</div>
</div>
<div id="configuration" class="section">
<h2>⚙️ Configuration</h2>
<p>Comprehensive configuration guide for all Catalogizer components.</p>
<h3>Backend Configuration</h3>
<div class="code-block"># .env file for catalog-api
# Database Configuration
DB_PATH=/var/lib/catalogizer/catalogizer.db
DB_ENCRYPTION_KEY=your-32-character-encryption-key-here
# Server Configuration
PORT=8080
HOST=0.0.0.0
GIN_MODE=release
# JWT Configuration
JWT_SECRET=your-production-jwt-secret-key-here
JWT_EXPIRY_HOURS=24
REFRESH_TOKEN_EXPIRY_HOURS=168
# SMB Configuration
SMB_SOURCES=smb://server1/media,smb://server2/backup
SMB_USERNAME=media_user
SMB_PASSWORD=secure_password
SMB_DOMAIN=your-domain
# SMB Resilience Configuration
SMB_RETRY_ATTEMPTS=5
SMB_RETRY_DELAY_SECONDS=30
SMB_HEALTH_CHECK_INTERVAL=60
SMB_CONNECTION_TIMEOUT=30
SMB_OFFLINE_CACHE_SIZE=10000
# External API Keys
TMDB_API_KEY=your-tmdb-api-key
SPOTIFY_CLIENT_ID=your-spotify-client-id
SPOTIFY_CLIENT_SECRET=your-spotify-client-secret
STEAM_API_KEY=your-steam-api-key
# Monitoring Configuration
WATCH_INTERVAL_SECONDS=30
MAX_CONCURRENT_ANALYSIS=10
ANALYSIS_TIMEOUT_MINUTES=15
# Logging
LOG_LEVEL=info
LOG_FILE=/var/log/catalogizer/catalogizer.log</div>
<h3>Frontend Configuration</h3>
<div class="code-block"># .env.local for catalog-web
# API Configuration
VITE_API_BASE_URL=http://localhost:8080
VITE_WS_URL=ws://localhost:8080/ws
# Feature Flags
VITE_ENABLE_ANALYTICS=true
VITE_ENABLE_REALTIME=true
VITE_ENABLE_EXTERNAL_METADATA=true
VITE_ENABLE_OFFLINE_MODE=true</div>
<h3>SMB Source Configuration</h3>
<p>SMB sources can be configured via environment variables or the installation wizard:</p>
<div class="code-block">SMB_SOURCES=smb://server1/media/Movies,smb://server1/media/TVShows,smb://server2/backup</div>
<div class="warning">
<strong>🔐 Security Note:</strong> Never commit API keys or passwords to version control. Use environment variables or secure secret management.
</div>
</div>
<div id="usage" class="section">
<h2>🎬 Using Catalogizer</h2>
<p>Complete guide to using Catalogizer once it's set up.</p>
<h3>Web Interface Usage</h3>
<div class="step">
<span class="step-number">1</span>
<strong>Access the Web Interface</strong>
<p>Open <a href="http://localhost:3000">http://localhost:3000</a> in your browser.</p>
</div>
<div class="step">
<span class="step-number">2</span>
<strong>Login</strong>
<p>Use default credentials: <code class="code-block inline">admin</code> / <code class="code-block inline">admin</code></p>
</div>
<div class="step">
<span class="step-number">3</span>
<strong>Explore Your Media</strong>
<ul>
<li><strong>Dashboard:</strong> Overview of your media collection</li>
<li><strong>Browse:</strong> Navigate through categorized media</li>
<li><strong>Search:</strong> Find specific movies, shows, or files</li>
<li><strong>Analytics:</strong> View collection statistics and trends</li>
</ul>
</div>
<div class="screenshot-placeholder">
<strong>📸 Screenshot Placeholder:</strong><br>
Catalogizer dashboard showing media statistics, recent additions, and system health indicators
</div>
<h3>Media Management</h3>
<h4>Browsing Media</h4>
<ul>
<li><strong>Categories:</strong> Movies, TV Shows, Music, Games, Software</li>
<li><strong>Filters:</strong> Quality, year, genre, rating</li>
<li><strong>Sorting:</strong> Name, date added, rating, file size</li>
<li><strong>Views:</strong> Grid, list, and detail views</li>
</ul>
<h4>Search Functionality</h4>
<ul>
<li><strong>Full-text search:</strong> Search across titles, descriptions, and metadata</li>
<li><strong>Advanced filters:</strong> Combine multiple criteria</li>
<li><strong>Real-time results:</strong> Instant search as you type</li>
</ul>
<h3>Real-time Features</h3>
<ul>
<li><strong>Live Updates:</strong> Automatic refresh when new media is detected</li>
<li><strong>Connection Status:</strong> Visual indicators for SMB source health</li>
<li><strong>Progress Tracking:</strong> Media analysis progress bars</li>
</ul>
<h3>Analytics and Reporting</h3>
<ul>
<li><strong>Collection Overview:</strong> Total files, storage usage, quality distribution</li>
<li><strong>Growth Trends:</strong> Media addition over time</li>
<li><strong>Quality Analysis:</strong> Resolution, codec, and bitrate statistics</li>
<li><strong>Source Monitoring:</strong> SMB connection status and reliability</li>
</ul>
<div class="screenshot-placeholder">
<strong>📸 Screenshot Placeholder:</strong><br>
Analytics dashboard showing media collection growth charts and quality distribution graphs
</div>
</div>
<div id="deployment" class="section">
<h2>🚀 Production Deployment</h2>
<p>Deploy Catalogizer to production with high availability and monitoring.</p>
<h3>Docker Deployment</h3>
<div class="step">
<span class="step-number">1</span>
<strong>Use Docker Compose</strong>
<div class="code-block">cd deployment
docker-compose -f docker-compose.prod.yml up -d</div>
</div>
<div class="step">
<span class="step-number">2</span>
<strong>Configure Environment</strong>