-
Notifications
You must be signed in to change notification settings - Fork 13
/
faq.html
3816 lines (3697 loc) · 163 KB
/
faq.html
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
---
title: FAQ
---
<!DOCTYPE html>
<html lang="en" style="height:100%;">
<head>
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-137788272-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag () { dataLayer.push(arguments); }
gtag('js', new Date());
gtag('config', 'UA-137788272-1');
</script>
<title>Arkime FAQ</title>
<!-- Required meta tags always come first -->
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" />
<meta http-equiv="x-ua-compatible" content="ie=edge" />
<meta name="description" content="Frequently asked Arkime questions" />
<!-- facebook open graph tags -->
<meta property="og:url" content="http://arkime.com/faq" />
<meta property="og:description" content="Frequently asked Arkime questions" />
<meta property="og:image" content="http://arkime.com/assets/[email protected]" />
<!-- twitter card tags additive with the og: tags -->
<meta name="twitter:card" content="summary" />
<meta name="twitter:domain" value="arkime.com" />
<meta name="twitter:description" value="Frequently asked Arkime questions" />
<meta name="twitter:image" content="http://arkime.com/assets/[email protected]" />
<meta name="twitter:url" value="http://arkime.com/faq" />
<!-- fontawesome http://fontawesome.io/ -->
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css">
<!-- Bootstrap CSS https://getbootstrap.com/ -->
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css">
<!-- custom index page styles -->
<link rel="stylesheet" type="text/css" href="index.css">
<!-- page functions -->
<script src="index.js"></script>
</head>
<body id="viewport"
class="full-height-body">
<!-- navbar -->
{%- include navbar.html -%}
<!-- toc nav -->
<div class="left-nav d-none d-sm-block">
<div class="nav nav-pills nav-pills-nested pb-3">
<a href="#general"
class="nav-link"
title="General">
General
</a>
<a class="nav-link nested"
href="#why-should-i-use-arkime"
title="Why should I use Arkime?">
Why should I use Arkime?
</a>
<a class="nav-link nested"
href="#how-do-you-pronounce-our-name"
title="How do you pronounce our name?">
How do you pronounce our name?
</a>
<a class="nav-link nested"
href="#upgrading-arkime"
title="Upgrading Arkime">
Upgrading Arkime
</a>
<a class="nav-link nested"
href="#what-oses-are-supported"
title="What OSes are supported?">
What operating systems are supported?
</a>
<a class="nav-link nested"
href="#arkime-is-not-working"
title="Arkime is not working">
Arkime is not working
</a>
<a class="nav-link nested"
href="#how-do-i-reset-arkime"
title="How do I reset Arkime?">
How do I reset Arkime?
</a>
<a class="nav-link nested"
href="#self-signed-ssl-tls-certificates"
title="Self-Signed or Private CA TLS Certificates">
Self-Signed or Private CA SSL/TLS Certificates
</a>
<a class="nav-link nested"
href="#how_do_i_upgrade_to_moloch_1"
title="How do I upgrade to Moloch 1.x">
How do I upgrade to Moloch 1.x?
</a>
<a class="nav-link nested"
href="#how_do_i_upgrade_to_moloch_2"
title="How do I upgrade to Moloch 2.x">
How do I upgrade to Moloch 2.x?
</a>
<a class="nav-link nested"
href="#how_do_i_upgrade_to_arkime_3"
title="How do I upgrade to Arkime 3.x">
How do I upgrade to Arkime 3.x?
</a>
<a class="nav-link nested"
href="#how_do_i_upgrade_to_arkime_4"
title="How do I upgrade to Arkime 4.x">
How do I upgrade to Arkime 4.x?
</a>
<a class="nav-link nested"
href="#how_do_i_upgrade_to_arkime_5"
title="How do I upgrade to Arkime 5.x">
How do I upgrade to Arkime 5.x?
</a>
<a href="#elasticsearch"
class="nav-link"
title="OpenSearch/Elasticsearch">
OpenSearch/Elasticsearch
</a>
<a class="nav-link nested"
href="#how-many-elasticsearch-nodes-or-machines-do-i-need"
title="How many OpenSearch/Elasticsearch nodes or machines do I need?">
How many OpenSearch/Elasticsearch nodes or machines do I need?
</a>
<a class="nav-link nested"
href="#data-never-gets-deleted"
title="Data never gets deleted">
Data never gets deleted
</a>
<a class="nav-link nested"
href="#error-dropping-request"
title="ERROR - Dropping request">
ERROR - Dropping request
</a>
<a class="nav-link nested"
href="#when-do-i-add-additional-nodes-why-are-queries-slow"
title="When do I add additional nodes? Why are queries slow?">
When do I add additional nodes? Why are queries slow?
</a>
<a class="nav-link nested"
href="#removing-nodes"
title="Removing nodes">
Removing Nodes
</a>
<a class="nav-link nested"
href="#how-do-i-enable-elasticsearch-replication"
title="How do I enable OpenSearch/Elasticsearch replication?">
How do I enable OpenSearch/Elasticsearch replication?
</a>
<a class="nav-link nested"
href="#how-do-i-upgrade-elasticsearch"
title="How do I upgrade OpenSearch/Elasticsearch?">
How do I upgrade OpenSearch/Elasticsearch?
</a>
<a class="nav-link nested"
href="#how-do-i-upgrade-to-es-8-x"
title="How do I upgrade to Elasticsearch 8.x?">
How do I upgrade to Elasticsearch 8.x?
</a>
<a class="nav-link nested"
href="#how-do-i-upgrade-to-es-7-x"
title="How do I upgrade to Elasticsearch 7.x?">
How do I upgrade to Elasticsearch 7.x?
</a>
<a class="nav-link nested"
href="#how-do-i-upgrade-to-es-6-x"
title="How do I upgrade to Elasticsearch 6.x?">
How do I upgrade to Elasticsearch 6.x?
</a>
<a class="nav-link nested"
href="#how_do_i_upgrade_to_es_5x"
title="How do I upgrade to Elasticsearch 5.x?">
How do I upgrade to Elasticsearch 5.x?
</a>
<a class="nav-link nested"
href="#version-conflict"
title="version conflict, current version [N] is higher or equal to the one provided [M]">
version conflict, current version [N] is higher or equal to the one provided [M]
</a>
<a class="nav-link nested"
href="#recommended-elasticsearch-settings"
title="Recommended OpenSearch/Elasticsearch Settings">
Recommended OpenSearch/Elasticsearch Settings
</a>
<a class="nav-link nested"
href="#ilm"
title="Using ILM/ISM with Arkime">
Using ILM/ISM with Arkime
</a>
<a href="#capture"
class="nav-link"
title="Capture">
Capture
</a>
<a class="nav-link nested"
href="#what-kind-of-capture-machines-should-we-buy"
title="What kind of capture machines should we buy?">
What kind of capture machines should I buy?
</a>
<a class="nav-link nested"
href="#what-kind-of-network-packet-broker-should-we-buy"
title="What kind of Network Packet Broker should we buy?">
What kind of Network Packet Broker should I buy?
</a>
<a class="nav-link nested"
href="#what-kind-of-packet-capture-speeds-can-arkime-capture-handle"
title="What kind of packet capture speeds can arkime-capture handle?">
What kind of packet capture speeds can arkime-capture handle?
</a>
<a class="nav-link nested"
href="#arkime_requires_full_packet_captures_error"
title="Arkime requires full packet captures error">
Arkime requires full packet captures error
</a>
<a class="nav-link nested"
href="#why-am-i-dropping-packets"
title="Why am I dropping packets? (and Disk Q issues)">
Why am I dropping packets? (and Disk Q issues)
</a>
<a class="nav-link nested"
href="#how-do-i-import-existing-pcaps"
title="How do I import existing PCAPs?">
How do I import existing PCAPs?
</a>
<a class="nav-link nested"
href="#how-do-i-monitor-multiple-interfaces"
title="How do I monitor multiple interfaces?">
How do I monitor multiple interfaces?
</a>
<a class="nav-link nested"
href="#arkime-capture-crashes"
title="Arkime capture crashes">
Arkime capture crashes
</a>
<a class="nav-link nested"
href="#error-pcap-open-failed"
title="ERROR - pcap open failed">
ERROR - pcap open failed
</a>
<a class="nav-link nested"
href="#how-to-reduce-amount-of-traffic-pcap"
title="How to reduce amount of traffic/PCAP?">
How do I reduce the amount of traffic/PCAP?
</a>
<a class="nav-link nested"
href="#life-of-a-packet"
title="Life of a packet">
Life of a Packet
</a>
<a class="nav-link nested"
href="#pcap-deletion"
title="PCAP Deletion">
PCAP Deletion
</a>
<a class="nav-link nested"
href="#dontsavebpfs-doesn-t-work"
title="dontSaveBPFs doesn't work">
dontSaveBPFs doesn't work
</a>
<a class="nav-link nested"
href="#zero-byte-pcap-files"
title="Zero or missing bytes PCAP files">
Zero or missing bytes PCAP files
</a>
<a class="nav-link nested"
href="#can-i-virtualize-arkime-with-kvm-using-openvswitch"
title="Can I virtualize Arkime with KVM using OpenVswitch?">
Can I virtualize Arkime with KVM using OpenVswitch?
</a>
<a class="nav-link nested"
href="#maxmind"
title="Installing MaxMind Geo free database files">
Installing MaxMind Geo Free Database Files
</a>
<a class="nav-link nested"
href="#loglines"
title="What do these log lines mean">
What do these log lines mean?
</a>
<a href="#viewer"
class="nav-link"
title="Viewer">
Viewer
</a>
<a class="nav-link nested"
href="#where-do-i-learn-more-about-the-expressions-available"
title="Where do I learn more about the expressions available?">
Where do I learn more about the expressions available?
</a>
<a class="nav-link nested"
href="#exported-pcap-files-are-corrupt-sometimes-session-detail-fails"
title="Exported PCAP files are corrupt, sometimes session detail fails">
Exported PCAP files are corrupt; sometimes session detail fails
</a>
<a class="nav-link nested"
href="#map-counts-are-wrong"
title="Map counts are wrong">
Map counts are wrong
</a>
<a class="nav-link nested"
href="#what-browsers-are-supported"
title="What browsers are supported?">
What browsers are supported?
</a>
<a class="nav-link nested"
href="#error-getaddrinfo-eaddrinfo"
title="Error: getaddrinfo EADDRINFO">
Error: getaddrinfo EADDRINFO
</a>
<a class="nav-link nested"
href="#how-do-i-proxy-arkime-using-apache"
title="How do I proxy Arkime using Apache">
How do I proxy Arkime using Apache?
</a>
<a class="nav-link nested"
href="#i-still-get-prompted-for-password-after-setting-up-apache-auth"
title="I still get prompted for password after setting up Apache auth">
I still get prompted for my password after setting up Apache auth
</a>
<a class="nav-link nested"
href="#how-do-i-search-multiple-arkime-clusters"
title="How do I search multiple Arkime clusters">
How do I search multiple Arkime clusters?
</a>
<a class="nav-link nested"
href="#how-do-i-use-self-signed-ssl-tls-certificates-with-multies"
title="How do I use self-signed or Private CA TLS Certificates with MultiES?">
How do I use self-signed or Private CA TLS Certificates with MultiES?
</a>
<a class="nav-link nested"
href="#how-do-i-reset-my-password"
title="How do I reset my password?">
How do I reset my password?
</a>
<a class="nav-link nested"
href="#error-couldn-t-connect-to-remote-viewer-only-displaying-spi-data"
title="Error: Couldn't connect to remote viewer, only displaying SPI data">
Error: Couldn't connect to remote viewer, only displaying SPI data
</a>
<a class="nav-link nested"
href="#compiled-against-a-different-node-js-version-error"
title="Compiled against a different Node.js version error">
Compiled against a different Node.js version error
</a>
<a class="nav-link nested"
href="#change-viewer-port"
title="How do I change the port viewer listens on?">
How do I change the port viewer listens on?
</a>
<a class="nav-link nested"
href="#hunts-not-working"
title="Hunts not working">
Hunts not working
</a>
<a href="#cont3xt"
class="nav-link"
title="Cont3xt">
Cont3xt
</a>
<a class="nav-link nested"
href="#cont3xt-is-not-working"
title="Cont3xt is not working">
Cont3xt is not working
</a>
<a href="#parliament"
class="nav-link"
title="Parliament">
Parliament
</a>
<a class="nav-link nested"
href="#sample-apache-config"
title="Sample Apache Config">
Sample Apache Configuration
</a>
<a href="#wise"
class="nav-link"
title="WISE">
WISE
</a>
<a class="nav-link nested"
href="#wise-is-not-working"
title="WISE is not working">
WISE is not working
</a>
<a href="#arkimeweb"
class="nav-link"
title="arkime.com">
arkime.com
</a>
<a class="nav-link nested"
href="#how-can-i-contribute"
title="How can I contribute">
How can I contribute?
</a>
</div>
</div> <!-- /toc nav -->
<!-- toc expand/collapse -->
<div class="collapse-btn d-none d-sm-block"
onclick="toggleToc()">
<span class="fa fa-angle-double-left">
</span>
</div> <!-- /toc expand/collapse -->
<!-- faq container -->
<div class="full-height-container">
<!-- faq content -->
<div class="pl-3 pr-3">
<!-- general -->
<h1 id="general"
class="section-header mt-1">
General
<span class="fa fa-link small copy-link cursor-copy"
onclick="copyLink(this, 'faq')">
</span>
</h1>
<span id="why-should-i-use-moloch"></span>
<h3 class="subsection" id="why-should-i-use-arkime">
Why should I use Arkime?
<span class="fa fa-link small copy-link cursor-copy"
onclick="copyLink(this, 'faq')">
</span>
</h3>
<p>
If you're in search of a comprehensive, standalone open-source solution for full packet capture (FPC) and network analysis that includes both metadata parsing and searching capabilities, Arkime stands out as the premier choice.
Full packet capture systems are indispensable tools for network and security analysts, offering an unfiltered view of network activities and enabling a detailed analysis of events from a network perspective.
As an open-source platform, Arkime affords its users total control over both deployment and <a href="/architecture">architecture</a>, ensuring that you can tailor the system to meet your specific requirements.
While there are <a href="otherfpc">other FPC systems</a> available, Arkime's unique blend of features and open-source accessibility makes it a standout solution for those needing detailed and actionable network insights.
</p>
<span id="why-change-our-name"></span>
<h3 class="subsection" id="how-do-you-pronounce-our-name">
How do you pronounce our name?
<span class="fa fa-link small copy-link cursor-copy"
onclick="copyLink(this, 'faq')">
</span>
</h3>
<p>
<a class="cursor-pointer"
title="Click to play pronunciation"
data-toggle="tooltip"
onclick="play()">
(/ɑːrkɪˈmi/)
<span class="fa fa-volume-up mr-2"></span>
<audio id="audio" src="assets/arkime_short.m4a" type="audio/mpeg"></audio></a>
Read more about why we changed our name <a href="arkimeetus">here</a>.
</p>
<span id="upgrading-moloch"></span>
<h3 class="subsection"id="upgrading-arkime">
Upgrading Arkime
<span class="fa fa-link small copy-link cursor-copy"
onclick="copyLink(this, 'faq')">
</span>
</h3>
<p>
Upgrading Arkime is a sequential process that requires installing each major version in the order outlined in the table below.
This step-by-step approach ensures that your system transitions smoothly between versions without missing critical updates or features.
If you find that your current version of Arkime is not explicitly mentioned in the chart, it is recommended to upgrade to the immediately higher version listed.
By following this method, you can sequentially upgrade through the major releases until your system is up-to-date.
Typically, transitioning between versions requires the execution of the <code>db.pl</code> upgrade script.
This script is designed to update your database schemas and configurations to be compatible with the newer version of Arkime.
Unless specified otherwise in the upgrade documentation, running this script should be the only additional step needed to complete the upgrade process.
</p>
<table class="table table-sm table-bordered">
<thead>
<tr>
<th>
Name
</th>
<th>
Version
</th>
<th>
Min Version to<br>Upgrade From
</th>
<th>
OpenSearch<br>Versions
</th>
<th>
Elasticsearch<br>Versions
</th>
<th>
Special Instructions
</th>
<th>
Notes
</th>
</tr>
</thead>
<tbody>
<tr>
<th>
Arkime
</th>
<td>
5.0+
</td>
<td>
4.3.2+ (4.6.0 recommended)
</td>
<td>
1.0.0+ (2.10+ recommended)
</td>
<td>
7.10+, 8+ (7.17+, 8.10+ recommended)
</td>
<td>
<a href="#how_do_i_upgrade_to_arkime_5"> Arkime 5.x instructions </a>
</td>
<td>
</td>
</tr>
<tr>
<th>
Arkime
</th>
<td>
4.0+
</td>
<td>
3.3.0+ (3.4.0 recommended)
</td>
<td>
1.0.0+ (2.3+ recommended)
</td>
<td>
7.10+, 8+
</td>
<td>
<a href="#how_do_i_upgrade_to_arkime_4"> Arkime 4.x instructions </a>
</td>
<td>
</td>
</tr>
<tr>
<th>
Arkime
</th>
<td>
3.0+
</td>
<td>
2.4.0
</td>
<td>
1.0.0+ (2.3 recommended)
</td>
<td>
7.10+, not 8.x
</td>
<td>
<a href="#how_do_i_upgrade_to_arkime_3"> Arkime 3.x instructions </a>
</td>
<td>
</td>
</tr>
<tr>
<th>
Arkime
</th>
<td>
2.7+
</td>
<td>
2.0.0
</td>
<td>
N/A
</td>
<td>
7.4+ (7.9.0+ recommended, 7.7.0 broken)
</td>
<td>
<a href="#how-do-i-upgrade-to-es-7-x">Elasticsearch 7 instructions </a>
</td>
<td>
</td>
</tr>
<tr>
<th>
Moloch
</th>
<td>
2.2+
</td>
<td>
1.7.0 (1.8.0 recommended)
</td>
<td>
N/A
</td>
<td>
6.8.2+ (6.8.6+ recommended), 7.1+ (7.8.0+ recommended, 7.7.0 broken)
</td>
<td>
<a href="#how_do_i_upgrade_to_moloch_2"> Moloch 2.x instructions </a>
</td>
<td>
Must already be on 6.8.x or 7.1+ before upgrading to 2.2
</td>
</tr>
<tr>
<th>
Moloch
</th>
<td>
2.0, 2.1
</td>
<td>
1.7.0 (1.8.0 recommended)
</td>
<td>
N/A
</td>
<td>
6.7, 6.8, 7.1+
</td>
<td>
<a href="#how_do_i_upgrade_to_moloch_2"> Moloch 2.x instructions </a>
</td>
<td>
Must already be on Elasticsearch 6.7 or 6.8 (Elasticsearch <a href="https://www.elastic.co/downloads/past-releases/elasticsearch-oss-6-8-6">6.8.6</a> recommended) before upgrading to 2.0
</td>
</tr>
<tr>
<th>
Moloch
</th>
<td>
1.8
</td>
<td>
1.0.0 (1.1.x recommended)
</td>
<td>
N/A
</td>
<td>
5.x or 6.x
</td>
<td>
<a href="#how-do-i-upgrade-to-es-6-x">
Elasticsearch 6 instructions
</a>
</td>
<td>
Must have finished the 1.x reindexing; stop captures for best results
</td>
</tr>
<tr>
<th>
Moloch
</th>
<td>
1.1.1
</td>
<td>
0.20.2 (0.50.1 recommended)
</td>
<td>
N/A
</td>
<td>
5.x or 6.x (new only)
</td>
<td>
<a href="#how_do_i_upgrade_to_moloch_1">
Instructions
</a>
</td>
<td>
Must be on Elasticsearch 5 already
</td>
</tr>
<tr>
<th>
Moloch
</th>
<td>
0.20.2
</td>
<td>
0.18.1 (0.20.2 recommended)
</td>
<td>
N/A
</td>
<td>
2.4, 5.x
</td>
<td>
<a href="#how_do_i_upgrade_to_es_5x">
Elasticsearch 5 instructions
</a>
</td>
<td></td>
</tr>
</tbody>
</table>
<h3 class="subsection"id="what-oses-are-supported">
What operating systems are supported?
<span class="fa fa-link small copy-link cursor-copy"
onclick="copyLink(this, 'faq')">
</span>
</h3>
<p>
Arkime is pre packaged to support a wide range of operating systems, available on the <a href="https://github.com/arkime/arkime/releases">downloads page</a>.
The Arkime development team predominantly works with the EL 8 build, opting between the pcap and afpacket readers based on the specific needs of each deployment.
You are encouraged to use the afpacket reader whenever possible to achieve the best capture performance.
While a substantial portion of our development efforts takes place on macOS, leveraging the Homebrew package manager, it's important to note that this environment has not been vetted in a production setting. :)
It's also worth mentioning that Arkime has phased out support for 32-bit machines, consequently, the software is incompatible with many lower-powered devices.
Furthermore, our support is currently limited to LTS versions of Ubuntu, due to potential library compatibility issues with non-LTS releases.
<p>
The following operating systems distributions and versions are supported directly:
</p>
<ul>
<li>
Amazon Linux 2 and 2023
</li>
<li>
Arch
</li>
<li>
Debian 12
</li>
<li>
EL 8 and 9
</li>
<li>
Ubuntu 20.04, 22.04, 24.04
</li>
</ul>
<span id="moloch-is-not-working"></span>
<span id="checklist"></span>
<h3 class="subsection"id="arkime-is-not-working">
Arkime is not working
<span class="fa fa-link small copy-link cursor-copy"
onclick="copyLink(this, 'faq')">
</span>
</h3>
<p>
Here is the common checklist to perform when diagnosing a problem with Arkime (replace /opt/arkime with /data/moloch for Moloch builds):
</p>
<ol>
<li>
Check that OpenSearch/Elasticsearch is running and GREEN by using the curl command <code>curl http://localhost:9200/_cat/health</code>
on the machine running OpenSearch/Elasticsearch.
An Unauthorized response probably means that you need user:pass in all OpenSearch/Elasticsearch URLs or that you are using the wrong URL.
</li>
<li>
Check that the db has been initialized with the
<code>/opt/arkime/db/db.pl http://elasticsearch.hostname:9200 info</code> command. You should see information about the database version and number of sessions.
</li>
<li>
Check that viewer is reachable by visiting
<code>http://arkime-viewer.hostname:8005</code>
from your browser.
<ol type="a">
<li>
If it doesn't render, looks strange, or warns of an old browser, use a newer
<a href="#what-browsers-are-supported">
supported browser.
</a>
</li>
<li>
If the browser can't connect and you are sure viewer.js is running, verify there are no firewalls blocking access between your browser and the viewer host.
</li>
<li>
Make sure <a href="/settings#viewhost"><code>viewHost=localhost</code></a> is NOT set in the config.ini file. Test that <code>curl http://IP:8005</code> works from the host viewer is running on.
</li>
</ol>
</li>
<li>
Check for errors in <code>/opt/arkime/logs/viewer.log</code> and that viewer is running with the <code>pgrep -lf viewer</code> command. If the UI looks strange or isn't working, <code>viewer.log</code> will usually have information about what is wrong.
</li>
<li>
Check for errors in <code>/opt/arkime/logs/capture.log</code> and that capture is running with the <code>pgrep -lf capture</code> command. If packets aren't being processed or other metadata generation issues, <code>capture.log</code> will usually have information about what is wrong and links to the FAQ on how to fix.
</li>
<li>
To check that the stats page shows the capture nodes you are expecting, visit
<code>http://arkime-viewer.hostname:8005/stats?statsTab=1</code> in your browser.
<ol type="a">
<li>
If the packets being received for any node is low, that node is having issues, please check its <code>capture.log</code>
</li>
<li>
If the timestamp for any node is over 5 seconds old, that node is having issues, please check its <code>capture.log</code>
</li>
<li>
If the Disk Q or ES Q for any node is above 50, that node is having issues, please check its <code>capture.log</code>
</li>
</ol>
</li>
<li>
Disable any <a href="/settings#bpf"><code>bpf=</code></a> in <code>/opt/arkime/etc/config.ini</code>. If that fixes the issue, read the
<a href="#dontsavebpfs-doesn-t-work">BPF FAQ answer</a>.
</li>
<li>
If the browser has "Oh no, Arkime is empty! There is no
data to search." but the stats tab shows packets are being captured:
<ol type="a">
<li>
Arkime in live capture mode only writes records when a session has ended. It may take
several minutes for a session to show up after a fresh start. See
<code>/opt/arkime/etc/config.ini</code> to shorten the timeouts.
</li>
<li>
OpenSearch/Elasticsearch will only refresh the indices once a minute with the default Arkime configuration.
Force a refresh with the <code>curl http://elasticsearch.hostname:9200/_refresh</code> command.
</li>
<li>
Verify that your time frame for search covers the data (try switching to ALL).
</li>
<li>
Check that you don't have a view set.
</li>
<li>
Check that your user doesn't have a forced expression set. You might need to ask your Arkime admin.
</li>
</ol>
</li>
<li>
If you are having packet capture issues, restart <code>capture</code> after turning on debugging,
either add <code>--debug</code> to the start line or add <code>debug=1</code> in the <code>[default]</code> section of your config.ini file.
You can add multiple <code>--debug</code> options or set <code>debug=</code> to a larger number to get even more information.
Capture will print out the configuration settings it is using; verify that they are what you expect.
</li>
<li>
If you are having issues viewing packets that were captured, restart viewer after turning on debugging,
either add <code>--debug</code> to the start line or add <code>debug=1</code> in the <code>[default]</code> section of your config.ini file.
You can add multiple <code>--debug</code> options or set <code>debug=</code> to a larger number to get even more information.
Viewer will print out the configuration settings it is using; verify that they are what you expect.
<ol type="a">
<li>
Make sure the plugins and parsers directories are correctly set
in <code>/opt/arkime/etc/config.ini</code> and readable by the
viewer process.
</li>
</ol>
</li>
<li>
Check the output of the following: <pre><code>grep moloch_packet_log /opt/arkime/logs/capture.log | tail</code></pre>
Verify that the packets number is greater than 0. If not, then no packets were processed.
Verify that the first pstats number is greater than 0. If not, Arkime didn't know how to decode any packets.
</li>
</ol>
<span id="how-do-i-reset-moloch"></span>
<h3 class="subsection"id="how-do-i-reset-arkime">
How do I reset Arkime?
<span class="fa fa-link small copy-link cursor-copy"
onclick="copyLink(this, 'faq')">
</span>
</h3>
<ol>
<li>
Leave OpenSearch/Elasticsearch running.
</li>
<li>
Shut down all running viewer or capture processes so that no new data is
recorded.
</li>
<li>
To delete all the SPI data stored in OpenSearch/Elasticsearch, use the
<code>db.pl</code> script with either the <code>init</code> or
<code>wipe</code> commands. The only difference between the two
commands is that <code>wipe</code> leaves the
added users so that they don't need to be re-added.
<pre><code>/opt/arkime/db/db.pl http://ESHOST:9200 wipe</code></pre>
</li>
<li>
Delete the PCAP files. The PCAP files are stored on the file system in
raw format. You need to do this on <strong>all</strong> of the capture
machines.
<pre><code>/bin/rm -f /opt/arkime/raw/*</code></pre>
</li>
</ol>
<span id="insecure"></span>
<h3 class="subsection" id="self-signed-ssl-tls-certificates">
Self-Signed or Private CA TLS Certificates
<span class="fa fa-link small copy-link cursor-copy"
onclick="copyLink(this, 'faq')">
</span>
</h3>
<p>
The core Arkime team advises against the use of self-signed certificates, despite their technical feasibility.
Instead, we encourage leveraging the financial benefits derived from using Arkime over commercial full packet capture solutions to invest in legitimate certificates.
The cost of wildcard certificates has decreased significantly, making them an affordable option.
Alternatively, free certificates from Let's Encrypt represent a viable option.
While members of the Arkime Slack workspace may offer assistance, the core development team typically refers queries back to this guidance.
It's important to note that private CA certificates face similar challenges and require analogous solutions as those encountered with self-signed certificates.
</p>
<p>
One of the simplest methods to bypass the hurdles associated with self-signed certificates involves adding them to your operating system's list of recognized certificates or chains.
The process for doing so varies widely across different OS distributions and versions, making a quick internet search the most efficient strategy to find specific instructions.
It may be necessary to register the certificate across multiple trust stores due to the varied certificate validation locations utilized by node (for the viewer), curl (for capture), and perl (for db.pl).
The Viewer component of Arkime includes a <code>caTrustFile</code> option, a feature introduced by contributors to the project.
Since version 4.2.0, all components of Arkime are designed to support the <code>caTrustFile</code> configuration.
</p>
<p>
An alternative, though less secure option, involves disabling certificate verification entirely.
Key components such as Capture, Viewer, arkime_add_user.sh, and db.pl accept the <code>--insecure</code> flag to bypass certificate checks.
This flag must be appended to the startup commands for both capture and viewer services.
In newer versions of Arkime this can be done by
<pre><code>
cp /opt/arkime/etc/env.sample /opt/arkime/etc/capture.env
echo 'OPTIONS="--insecure"' >> /opt/arkime/etc/capture.env
cp /opt/arkime/etc/env.sample /opt/arkime/etc/viewer.env
echo 'OPTIONS="--insecure"' >> /opt/arkime/etc/viewer.env
</code></pre>
You can edit /opt/arkime/etc/capture.env and /opt/arkime/etc/viewer.env to add other options.
We recommend using env files instead of editing the systemd files since they may get overwritten by new installs.
</p>
<h3 class="subsection"id="how_do_i_upgrade_to_moloch_1">
How do I upgrade to Moloch 1.x?
<span class="fa fa-link small copy-link cursor-copy"
onclick="copyLink(this, 'faq')">
</span>
</h3>
<p>
Moloch 1.x has some large changes and updates that will require all
session data to be reindexed. The reindexing is done in the background
AFTER upgrading, so there is little downtime. Large changes in 1.0 include the following:
</p>
<ul>
<li>
All the field names have been renamed, and analyzed fields have been
removed.
</li>
<li>
Country codes are being changed from three characters to two characters.
</li>
<li>
Tags will NOT be migrated if added before 0.14.1.
</li>
<li>
The data for http.hasheader and email.hasheader will NOT migrate.
</li>
<li>
IPv6 is fully supported and uses the OpenSearch/Elasticsearch <code>ip</code> type.
</li>
</ul>
<p>
If you have any special parsers, taggers, plugins, or WISE sources, you may
need to change configurations.
</p>
<ul>
<li>
All db fields will need -term removed, or capture won't start and will
warn you.
</li>
</ul>
<p>To upgrade:</p>
<ul>
<li>
First make sure you are using Elasticsearch 5.5.x (5.6 recommended) and Moloch
0.20.2 or 0.50.x before continuing. Upgrade to those versions first!
</li>
<li>
Download 1.1.1 from the
<a href="downloads">
downloads page.
</a>
</li>
<li>
Shut down all capture, viewer, and WISE processes.
</li>
<li>
Install Moloch 1.1.1.
</li>
<li>
Run <code>/data/moloch/bin/moloch_update_geo.sh</code> on all capture
nodes that will download the new mmdb style maxmind files.
</li>
<li>
Run <code>db.pl http://ESHOST:9200 upgrade</code> once.
</li>
<li>
Start WISE, then capture, then viewers.
Especially watch the capture.log file for any warnings/errors.
</li>
<li>
Verify that NEW data is being collected and is showing up in viewer.