-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathbuild-run-rippled-macos.html
More file actions
694 lines (590 loc) · 39.7 KB
/
build-run-rippled-macos.html
File metadata and controls
694 lines (590 loc) · 39.7 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
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width">
<title>Build and Run rippled on macOS - XAG Ledger Dev Portal</title>
<!-- favicon -->
<link rel="apple-touch-icon" sizes="180x180" href="assets/favicons/apple-touch-icon.png">
<link rel="icon" type="image/png" sizes="16x16" href="assets/favicons/favicon-16x16.png">
<link rel="icon" type="image/png" sizes="32x32" href="assets/favicons/favicon-32x32.png">
<link rel="manifest" href="assets/favicons/site.webmanifest">
<link rel="shortcut icon" href="favicon.ico">
<meta name="msapplication-TileColor" content="#25A768">
<meta name="msapplication-config" content="assets/favicons/browserconfig.xml">
<meta name="theme-color" content="#25A768">
<!-- jQuery -->
<script src="assets/vendor/jquery-1.11.1.min.js"></script>
<!-- Stylesheet -->
<link href="assets/css/devportal.css" rel="stylesheet" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" />
<!-- syntax highlighting -->
<link rel="stylesheet" href="assets/vendor/docco.min.css" />
<script src="assets/vendor/highlight.min.js"></script>
<!-- expandable code samples -->
<script src="assets/js/expandcode.js"></script>
<!-- multi-code selection tabs -->
<script src="assets/js/multicodetab.js"></script>
<script>
$(document).ready(function() {
$(".multicode").minitabs();
hljs.initHighlighting();
make_code_expandable();
});
</script>
</head>
<body class="xrp-ledger-dev-portal sidebar-primary lang-en ">
<nav class="navbar fixed-top navbar-expand-lg navbar-light bg-white">
<a href="index.html" class="navbar-brand"><img src="assets/img/logo.png" class="logo" height="44" alt="XAG Ledger Dev Portal" /></a>
<button class="navbar-toggler" type="button" data-toggle="slide-collapse" data-target="#navbarHolder" aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div class="collapse navbar-collapse justify-content-end" id="navbarHolder">
<ul class="nav navbar-nav">
<li class="nav-item">
<a class="nav-link" href="dev-tools.html">Dev Tools</a>
</li>
<li class="nav-item">
<a class="nav-link" href="http://xagfans.com/" target="blank">BBS</a>
</li>
</ul><!-- /.navbar-nav -->
<div class="github-edit-wrap">
<a href="https://github.com/xagfans/docs/tutorials/manage-the-rippled-server/installation/build-run-rippled-macos.md" target="_blank" class="github-edit">Edit</a>
</div><!-- /.github-edit -->
<div class="nav navbar-nav language-selector">
<div class="dropdown">
<button class="btn btn-outline-secondary dropdown-toggle" type="button" id="language_selector_header_btn" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
English
</button>
<div class="dropdown-menu" aria-labelledby="language_selector_header_btn">
<a class="dropdown-item" href="/build-run-rippled-macos.html">English</a>
<a class="dropdown-item" href="/cn/build-run-rippled-macos.html">中文</a>
</div><!--/.dropdown-menu-->
</div><!--/.dropdown-->
</div><!--/.language-selector-->
</div><!--/#navbarHolder-->
<div class="menu-overlay"></div>
</nav>
<div class="container-fluid" role="document" id="main_content_wrapper">
<div class="row">
<!-- Right sidebar first so it's at the beginning for mobile layouts -->
<aside class="right-sidebar col-lg-3 order-lg-4 p-0" role="complementary">
<div class="card" id="page-toc-wrapper">
<div class="card-header">
<h4>In this document</h4>
</div>
<ul class="card-body">
<li class="level-1"><a href="#build-and-run-rippled-on-macos">Build and Run rippled on macOS</a></li>
<li class="level-2"><a href="#next-steps">Next Steps</a></li>
<li class="level-3"><a href="#additional-configuration">Additional Configuration</a></li>
<li class="level-3"><a href="#updates">Updates</a></li>
<li class="level-2"><a href="#see-also">See Also</a></li>
</ul>
</div>
</aside>
<!-- main column -->
<main class="main col-md-7 col-lg-6 order-md-3 " role="main" id="main_content_body">
<nav class="breadcrumbs-wrap p-0 p-md-3" aria-label="breadcrumb">
<ul class="breadcrumb bg-white">
<li class="breadcrumb-item"><a href="index.html">Home</a></li>
<li class="active breadcrumb-item"><a href="docs.html">Docs</a></li>
<li class="active breadcrumb-item"><a href="tutorials.html">Tutorials</a></li>
<li class="active breadcrumb-item"><a href="install-rippled.html">Install rippled</a></li>
<li class="active breadcrumb-item">Build and Run rippled on macOS</li>
</ul>
</nav><!--/.breadcrumbs-wrap--> <article class="pt-3 p-md-3">
<div class="content">
<h1 id="build-and-run-rippled-on-macos">Build and Run rippled on macOS</h1>
<p>The macOS platform is not recommended for <a href="the-rippled-server.html"><code>rippled</code></a> production use. For production, consider using the <a href="install-rippled-on-ubuntu-with-alien.html">Ubuntu platform</a>, which has received the highest level of quality assurance and testing.</p>
<p>That said, macOS is suitable for many development and testing tasks. <code>rippled</code> has been tested for use with macOS up to 10.13 High Sierra.</p>
<p>For development purposes, run <code>rippled</code> as a non-admin user, not using <code>sudo</code>.</p>
<ol>
<li>
<p>Install <a class="external-link" href="https://developer.apple.com/download/" target="_blank">Xcode <i aria-hidden="true" class="fa fa-external-link"></i></a>.</p>
</li>
<li>
<p>Install Xcode command line tools.</p>
<pre><code>$ xcode-select --install
</code></pre>
</li>
<li>
<p>Install <a class="external-link" href="https://brew.sh/" target="_blank">Homebrew <i aria-hidden="true" class="fa fa-external-link"></i></a>.</p>
<pre><code>$ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
</code></pre>
</li>
<li>
<p>Update Homebrew.</p>
<pre><code>$ brew update
</code></pre>
</li>
<li>
<p>Use Homebrew to install dependencies.</p>
<pre><code>$ brew install git cmake pkg-config protobuf openssl ninja
</code></pre>
</li>
<li>
<p>Install Boost 1.70.0 or higher. <code>rippled</code> 1.4.0 is compatible with Boost 1.70.0 and higher. The latest version of Boost available in the Homebrew repositories isn't new enough, so you must install Boost manually. (The following examples use Boost 1.71.0, which was the newest version at the time of writing.)</p>
<ol>
<li>
<p>Download <a class="external-link" href="https://dl.bintray.com/boostorg/release/1.71.0/source/boost_1_71_0.tar.bz2" target="_blank">Boost 1.71.0 <i aria-hidden="true" class="fa fa-external-link"></i></a>.</p>
</li>
<li>
<p>Extract it to a folder. Be sure to note the location.</p>
</li>
<li>
<p>In a terminal, run:</p>
<pre><code>cd /LOCATION/OF/YOUR/BOOST/DIRECTORY
./bootstrap.sh
./b2 cxxflags="-std=c++14"
</code></pre>
</li>
</ol>
</li>
<li>
<p>Ensure that your <code>BOOST_ROOT</code> environment points to the directory created by the Boost installation:</p>
<ol>
<li>
<p>To find your Boost directory, use <code>pwd</code> if you installed the Boost manually or use <code>brew --prefix boost</code> if you installed the Boost with Homebrew.</p>
</li>
<li>
<p>Edit below code with your Boost directory location and run to add Boost environment variable to your <code>.bash_profile</code> file so it's automatically set when you log in.</p>
<p>$ echo $"export BOOST_ROOT=/Users/my_user/boost_1_71_0" >> ~/.bash_profile</p>
</li>
</ol>
</li>
<li>
<p>If you updated your <code>.bash_profile</code> file in the previous step, be sure to source it in a new Terminal window. For example:</p>
<pre><code>$ source .bash_profile
</code></pre>
</li>
<li>
<p>Clone the <code>rippled</code> source code into your desired location and access the <code>rippled</code> directory. To do this, you'll need to set up Git (installed earlier using Homebrew) and GitHub. For example, you'll need to create a GitHub account and set up your SSH key. For more information, see <a class="external-link" href="https://help.github.com/articles/set-up-git/" target="_blank">Set up git <i aria-hidden="true" class="fa fa-external-link"></i></a>.</p>
<pre><code>$ git clone git@github.com:ripple/rippled.git
$ cd rippled
</code></pre>
</li>
<li>
<p>By default, cloning puts you on the <code>develop</code> branch. Use this branch if you are doing development work and want the latest set of untested features.</p>
<p>If you want the latest stable release, checkout the <code>master</code> branch.</p>
<pre><code>$ git checkout master
</code></pre>
<p>If you want to test out the latest release candidate, checkout the <code>release</code> branch:</p>
<pre><code>$ git checkout release
</code></pre>
<p>Or, you can checkout one of the tagged releases listed on <a class="external-link" href="https://github.com/ripple/rippled/releases" target="_blank">GitHub <i aria-hidden="true" class="fa fa-external-link"></i></a>.</p>
</li>
<li>
<p>In the <code>rippled</code> directory you just cloned, create your build directory and access it. For example:</p>
<pre><code>$ mkdir my_build
$ cd my_build
</code></pre>
</li>
<li>
<p>Build <code>rippled</code>. This could take about 5 minutes, depending on your hardware specs.</p>
<pre><code>$ cmake -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=Debug ..
</code></pre>
<p>You can set <code>CMAKE_BUILD_TYPE</code> to the <code>Debug</code> or <code>Release</code> build type. All four standard <a class="external-link" href="https://cmake.org/cmake/help/v3.0/variable/CMAKE_BUILD_TYPE.html" target="_blank"><code>CMAKE_BUILD_TYPE</code> <i aria-hidden="true" class="fa fa-external-link"></i></a> values are supported.</p>
</li>
<li>
<p>Run the build using CMake. This could take about 10 minutes, depending on your hardware specs.</p>
<pre><code>$ cmake --build . -- -j 4
</code></pre>
<p class="devportal-callout tip"><strong>Tip:</strong> This example uses a <code>-j</code> parameter set to <code>4</code>, which uses four processes to build in parallel. The best number of processes to use depends on how many CPU cores your hardware has available. Use <code>sysctl -n hw.ncpu</code> to get your CPU core count.</p>
</li>
<li>
<p>Run unit tests built into the server executable. This could take about 5 minutes, depending on your hardware specs. (optional, but recommended)</p>
<pre><code>$ ./rippled --unittest
</code></pre>
</li>
<li>
<p><code>rippled</code> requires the <code>rippled.cfg</code> config file to run. You can find an example config file, <code>rippled-example.cfg</code> in <code>rippled/cfg</code>. Make a copy and save it as <code>rippled.cfg</code> in a location that enables you to run <code>rippled</code> as a non-root user. Access the <code>rippled</code> directory and run:</p>
<pre><code>$ mkdir -p $HOME/.config/ripple
$ cp cfg/rippled-example.cfg $HOME/.config/ripple/rippled.cfg
</code></pre>
</li>
<li>
<p>Edit <code>rippled.cfg</code> to set necessary file paths. The user you plan to run <code>rippled</code> as must have write permissions to all of the paths you specify here.</p>
<ul>
<li>
<p>Set the <code>[node_db]</code> path to the location where you want to store the ledger database.</p>
</li>
<li>
<p>Set the <code>[database_path]</code> to the location where you want to store other database data. (This includes an SQLite database with configuration data, and is typically one level above the <code>[node_db]</code> path field.)</p>
</li>
<li>
<p>Set the <code>[debug_logfile]</code> to a path where <code>rippled</code> can write logging information.</p>
</li>
</ul>
<p>These are the only configurations required for <code>rippled</code> to start up successfully. All other configuration is optional and can be tweaked after you have a working server. For more information, see <a href="#additional-configuration">Additional Configurations</a>.</p>
</li>
<li>
<p><code>rippled</code> requires the <code>validators.txt</code> file to run. You can find an example validators file, <code>validators-example.txt</code>, in <code>rippled/cfg/</code>. Make a copy and save it as <code>validators.txt</code> in the same folder as your <code>rippled.cfg</code> file. Access the <code>rippled</code> directory and run:</p>
<pre><code>$ cp cfg/validators-example.txt $HOME/.config/ripple/validators.txt
</code></pre>
<p class="devportal-callout warning"><strong>Warning:</strong> Ripple has designed a decentralization plan with maximum safety in mind. During the transition, you should not modify the <code>validators.txt</code> file except as recommended by Ripple. Even minor modifications to your validator settings could cause your server to diverge from the rest of the network and report out of date, incomplete, or inaccurate data. Acting on such data can cause you to lose money.</p>
</li>
<li>
<p>Access your build directory, <code>my_build</code> for example, and start the <code>rippled</code> service.</p>
<pre><code>$ ./rippled
</code></pre>
<p>Here's an excerpt of what you can expect to see in your terminal:</p>
</li>
</ol>
<pre><code> 2018-Oct-26 18:21:39.593738 JobQueue:NFO Auto-tuning to 6 validation/transaction/proposal threads.
2018-Oct-26 18:21:39.599634 Amendments:DBG Amendment 4C97EBA926031A7CF7D7B36FDE3ED66DDA5421192D63DE53FFB46E43B9DC8373 is supported.
2018-Oct-26 18:21:39.599874 Amendments:DBG Amendment 6781F8368C4771B83E8B821D88F580202BCB4228075297B19E4FDC5233F1EFDC is supported.
2018-Oct-26 18:21:39.599965 Amendments:DBG Amendment 42426C4D4F1009EE67080A9B7965B44656D7714D104A72F9B4369F97ABF044EE is supported.
2018-Oct-26 18:21:39.600024 Amendments:DBG Amendment 08DE7D96082187F6E6578530258C77FAABABE4C20474BDB82F04B021F1A68647 is supported.
...
2018-Oct-26 18:21:39.603201 OrderBookDB:DBG Advancing from 0 to 3
2018-Oct-26 18:21:39.603291 OrderBookDB:DBG OrderBookDB::update>
2018-Oct-26 18:21:39.603480 OrderBookDB:DBG OrderBookDB::update< 0 books found
2018-Oct-26 18:21:39.649617 ValidatorList:DBG Loading configured trusted validator list publisher keys
2018-Oct-26 18:21:39.649709 ValidatorList:DBG Loaded 0 keys
2018-Oct-26 18:21:39.649798 ValidatorList:DBG Loading configured validator keys
2018-Oct-26 18:21:39.650213 ValidatorList:DBG Loaded 5 entries
2018-Oct-26 18:21:39.650266 ValidatorSite:DBG Loading configured validator list sites
2018-Oct-26 18:21:39.650319 ValidatorSite:DBG Loaded 0 sites
2018-Oct-26 18:21:39.650829 NodeObject:DBG NodeStore.main target size set to 131072
2018-Oct-26 18:21:39.650876 NodeObject:DBG NodeStore.main target age set to 120000000000
2018-Oct-26 18:21:39.650931 TaggedCache:DBG LedgerCache target size set to 256
2018-Oct-26 18:21:39.650981 TaggedCache:DBG LedgerCache target age set to 180000000000
2018-Oct-26 18:21:39.654252 TaggedCache:DBG TreeNodeCache target size set to 512000
2018-Oct-26 18:21:39.654336 TaggedCache:DBG TreeNodeCache target age set to 90000000000
2018-Oct-26 18:21:39.674131 NetworkOPs:NFO Consensus time for #3 with LCL AF8D8984A226AE7099D8A9749B09CE1D84360D5AF9FB86CE2F37500FE1009F9D
2018-Oct-26 18:21:39.674271 ValidatorList:DBG 5 of 5 listed validators eligible for inclusion in the trusted set
2018-Oct-26 18:21:39.674334 ValidatorList:DBG Using quorum of 4 for new set of 5 trusted validators (5 added, 0 removed)
2018-Oct-26 18:21:39.674400 LedgerConsensus:NFO Entering consensus process, watching, synced=no
2018-Oct-26 18:21:39.674475 LedgerConsensus:NFO Consensus mode change before=observing, after=observing
2018-Oct-26 18:21:39.674539 NetworkOPs:DBG Initiating consensus engine
2018-Oct-26 18:21:39.751225 Server:NFO Opened 'port_rpc_admin_local' (ip=127.0.0.1:5005, admin IPs:127.0.0.1, http)
2018-Oct-26 18:21:39.751515 Server:NFO Opened 'port_peer' (ip=0.0.0.0:51235, peer)
2018-Oct-26 18:21:39.751689 Server:NFO Opened 'port_ws_admin_local' (ip=127.0.0.1:6006, admin IPs:127.0.0.1, ws)
2018-Oct-26 18:21:39.751915 Application:FTL Startup RPC:
{
"command" : "log_level",
"severity" : "warning"
}
2018-Oct-26 18:21:39.752079 Application:FTL Result: {}
2018-Oct-26 18:22:33.013409 NetworkOPs:WRN We are not running on the consensus ledger
2018-Oct-26 18:22:33.013875 LedgerConsensus:WRN Need consensus ledger 81804C95ADE119CC874572BAF24DB0C0D240AC58168597951B0CB64C4DA2C628
2018-Oct-26 18:22:33.883648 LedgerConsensus:WRN View of consensus changed during open status=open, mode=wrongLedger
2018-Oct-26 18:22:33.883815 LedgerConsensus:WRN 81804C95ADE119CC874572BAF24DB0C0D240AC58168597951B0CB64C4DA2C628 to 9250C6C8326A48C339E6F99167F4E6BFD0DB00C35518027724D7B376340D21A1
2018-Oct-26 18:22:33.884068 LedgerConsensus:WRN {"accepted":true,"account_hash":"BBA0E7273005D42E5548DD6456E5AD1F7C89B6EDCB01881E1EECD393E8545947","close_flags":0,"close_time":593893350,"close_time_human":"2018-Oct-26 18:22:30.000000","close_time_resolution":30,"closed":true,"hash":"9250C6C8326A48C339E6F99167F4E6BFD0DB00C35518027724D7B376340D21A1","ledger_hash":"9250C6C8326A48C339E6F99167F4E6BFD0DB00C35518027724D7B376340D21A1","ledger_index":"3","parent_close_time":593893290,"parent_hash":"AF8D8984A226AE7099D8A9749B09CE1D84360D5AF9FB86CE2F37500FE1009F9D","seqNum":"3","totalCoins":"100000000000000000","total_coins":"100000000000000000","transaction_hash":"0000000000000000000000000000000000000000000000000000000000000000"}
2018-Oct-26 18:23:03.034119 InboundLedger:WRN Want: D901E53926E68EFDA33172DDAC74E8C767D280B68EE68E3010AB0E3179D07B1C
2018-Oct-26 18:23:03.034334 InboundLedger:WRN Want: 1C01EE79083DE5CE76F3634519D6364C589C4D48631CB9CD10FC2408F87684E2
2018-Oct-26 18:23:03.034560 InboundLedger:WRN Want: 8CFE3912001BDC5B2C4B2691F3C7811B9F3F193E835D293459D80FBF1C4E684E
2018-Oct-26 18:23:03.034750 InboundLedger:WRN Want: 8DFAD21AD3090DE5D6F7592B3821C3DA77A72287705B4CF98DC0F84D5DD2BDF8
</code></pre>
<p>For information about <code>rippled</code> log messages, see <a href="understanding-log-messages.html">Understanding Log Messages</a>.</p>
<h2 id="next-steps">Next Steps</h2>
<p>It can take several minutes for <code>rippled</code> to sync with the rest of the network, during which time it outputs warnings about missing ledgers.</p>
<p>For information about <code>rippled</code> log messages, see <a href="understanding-log-messages.html">Understanding Log Messages</a>.</p>
<p>After your <code>rippled</code> has synchronized with the rest of the network, you have a fully functional stock <code>rippled</code> server that you can use for local signing and API access to the XAG Ledger. Use <a href="rippled-server-states.html"><code>rippled</code> server states</a> to tell whether your <code>rippled</code> server has synchronized with the network. You can use the <a href="get-started-with-the-rippled-api.html#commandline"><code>rippled</code> commandline interface</a> to test this quickly:</p>
<pre><code>$ ./rippled server_info
</code></pre>
<p>For more information about communicating with your <code>rippled</code> server using the rippled APIs, see the <a href="rippled-api.html">rippled API reference</a>.</p>
<p>Once you have your stock <code>rippled</code> server running, you may want to consider running it as a validating server. For information about validating servers and why you might want to run one, see <a href="run-rippled-as-a-validator.html">Run rippled as a Validator</a>.</p>
<p>Having trouble getting your <code>rippled</code> server started? See <a href="server-wont-start.html">rippled Server Won't Start</a>.</p>
<h3 id="additional-configuration">Additional Configuration</h3>
<p><code>rippled</code> should connect to the XAG Ledger with the default configuration. However, you can change your settings by editing the <code>rippled.cfg</code> file. For recommendations about configuration settings, see <a href="capacity-planning.html">Capacity Planning</a>.</p>
<p>The <a href="install-rippled.html">recommended installation</a> uses the config file <code>/etc/opt/ripple/rippled.cfg</code> by default. Other places you can put a config file include <code>$HOME/.config/ripple/rippled.cfg</code> (where <code>$HOME</code> is the home directory of the user running <code>rippled</code>), <code>$HOME/.local/ripple/rippled.cfg</code>, or the current working directory from where you start <code>rippled</code>.<!--_ --></p>
<p>See <a class="external-link" href="https://github.com/ripple/rippled/blob/master/cfg/rippled-example.cfg" target="_blank">the <code>rippled</code> GitHub repository <i aria-hidden="true" class="fa fa-external-link"></i></a> for a description of all configuration options.</p>
<p>You must restart <code>rippled</code> for any configuration changes to take effect:</p>
<ul>
<li>Use Ctrl-C to stop <code>rippled</code>, then start it again:<pre><code>$ ./rippled
</code></pre>
</li>
</ul>
<p>If you change the <code>[debug_logfile]</code> or <code>[database_path]</code> sections, you may need to grant ownership of the new configured path to the user you run <code>rippled</code> as.</p>
<h3 id="updates">Updates</h3>
<p>You must update <code>rippled</code> regularly to remain synced with the rest of the XAG Ledger network. You can subscribe to the <a class="external-link" href="https://groups.google.com/forum/#!forum/ripple-server" target="_blank">rippled Google Group <i aria-hidden="true" class="fa fa-external-link"></i></a> to receive notifications of new <code>rippled</code> releases.</p>
<p>The <code>rippled</code> package includes a script you can use to <a href="update-rippled-automatically-on-linux.html">enable automatic updates on Linux</a>. On other platforms, you must update manually.<!--_ --></p>
<h2 id="see-also">See Also</h2>
<ul>
<li><strong>Concepts:</strong><ul>
<li><a href="the-rippled-server.html">The <code>rippled</code> Server</a></li>
<li><a href="intro-to-consensus.html">Introduction to Consensus</a></li>
</ul>
</li>
<li><strong>Tutorials:</strong><ul>
<li><a href="install-rippled-on-ubuntu.html">Install rippled on Ubuntu Linux</a> - Install a pre-built binary on Ubuntu for production use</li>
<li><a href="configure-rippled.html">Configure rippled</a></li>
<li><a href="troubleshoot-the-rippled-server.html">Troubleshoot rippled</a></li>
<li><a href="get-started-with-the-rippled-api.html">Get Started with the rippled API</a></li>
</ul>
</li>
<li><strong>References:</strong><ul>
<li><a href="rippled-api.html">rippled API Reference</a><ul>
<li><a href="commandline-usage.html"><code>rippled</code> Commandline Usage</a></li>
<li><a href="server_info.html">server_info method</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<!-- -->
<!-- -->
<!-- API object types -->
<!-- -->
<!-- -->
<!-- -->
<!-- rippled release notes links -->
</div>
</article>
</main>
<!-- Left sidebar last so it's at the end for mobile -->
<aside class="sidebar col-md-5 col-lg-3 p-0 order-md-1" role="complementary">
<div class="tree_nav">
<!---->
<div class="sidenav_parent">
<a href="tutorials.html"> Tutorials</a>
</div>
<!---->
<!---->
<div id="sidenav" role="tablist" aria-multiselectable="true">
<!---->
<div class="card">
<div class="card-header" role="tab" id="sidenav_cat_head_2">
<a class="collapsed sidenav_cat_toggler" role="button" data-toggle="collapse" href="#sidenav_collapse_2" aria-expanded="true" aria-controls="sidenav_collapse_2"></a>
<h5 class="card-title">
<a class="sidenav_cat_title" href="get-started.html">Get Started</a>
<!-- <a class="sidenav_cat_title" href="get-started.html">Get Started</a> -->
</h5>
</div><!-- /.card-header -->
<div id="sidenav_collapse_2" class="collapse" role="tabpanel" aria-labelledby="sidenav_cat_head_2">
<div class="card-body">
<ul class="sidebar_pagelist">
<li><a class="nosubcat-page" href="get-started-with-the-rippled-api.html">Get Started with XAG Ledger APIs</a></li>
<li><a class="nosubcat-page" href="set-up-secure-signing.html">Set Up Secure Signing</a></li>
<li><a class="nosubcat-page" href="get-started-with-rippleapi-for-javascript.html">Get Started with RippleAPI for JavaScript</a></li>
<li><a class="nosubcat-page" href="look-up-transaction-results.html">Look Up Transaction Results</a></li>
<li><a class="nosubcat-page" href="monitor-incoming-payments-with-websocket.html">Monitor Incoming Payments with WebSocket</a></li>
</ul>
</div><!-- /.card-body -->
</div><!-- /#sidenav_collapse2 -->
</div><!-- /.card -->
<!---->
<div class="card">
<div class="card-header" role="tab" id="sidenav_cat_head_8">
<a class="collapsed sidenav_cat_toggler" role="button" data-toggle="collapse" href="#sidenav_collapse_8" aria-expanded="true" aria-controls="sidenav_collapse_8"></a>
<h5 class="card-title">
<a class="sidenav_cat_title" href="use-simple-xrp-payments.html">Use Direct XAG Payments</a>
<!-- <a class="sidenav_cat_title" href="use-simple-xrp-payments.html">Use Simple XAG Payments</a> -->
</h5>
</div><!-- /.card-header -->
<div id="sidenav_collapse_8" class="collapse" role="tabpanel" aria-labelledby="sidenav_cat_head_8">
<div class="card-body">
<ul class="sidebar_pagelist">
<li><a class="nosubcat-page" href="send-xag.html">Send XAG</a></li>
<li><a class="nosubcat-page" href="reliable-transaction-submission.html">Reliable Transaction Submission</a></li>
</ul>
</div><!-- /.card-body -->
</div><!-- /#sidenav_collapse8 -->
</div><!-- /.card -->
<!---->
<div class="card">
<div class="card-header" role="tab" id="sidenav_cat_head_12">
<a class="collapsed sidenav_cat_toggler" role="button" data-toggle="collapse" href="#sidenav_collapse_12" aria-expanded="true" aria-controls="sidenav_collapse_12"></a>
<h5 class="card-title">
<a class="sidenav_cat_title" href="manage-account-settings.html">Manage Account Settings</a>
<!-- <a class="sidenav_cat_title" href="manage-account-settings.html">Manage Account Settings</a> -->
</h5>
</div><!-- /.card-header -->
<div id="sidenav_collapse_12" class="collapse" role="tabpanel" aria-labelledby="sidenav_cat_head_12">
<div class="card-body">
<ul class="sidebar_pagelist">
<li><a class="nosubcat-page" href="assign-a-regular-key-pair.html">Assign a Regular Key Pair</a></li>
<li><a class="nosubcat-page" href="change-or-remove-a-regular-key-pair.html">Change or Remove a Regular Key Pair</a></li>
<li><a class="nosubcat-page" href="disable-master-key-pair.html">Disable Master Key Pair</a></li>
<li><a class="nosubcat-page" href="set-up-multi-signing.html">Set Up Multi-Signing</a></li>
<li><a class="nosubcat-page" href="send-a-multi-signed-transaction.html">Send a Multi-Signed Transaction</a></li>
<li><a class="nosubcat-page" href="require-destination-tags.html">Require Destination Tags</a></li>
</ul>
</div><!-- /.card-body -->
</div><!-- /#sidenav_collapse12 -->
</div><!-- /.card -->
<!---->
<div class="card">
<div class="card-header" role="tab" id="sidenav_cat_head_20">
<a class="collapsed sidenav_cat_toggler" role="button" data-toggle="collapse" href="#sidenav_collapse_20" aria-expanded="true" aria-controls="sidenav_collapse_20"></a>
<h5 class="card-title">
<a class="sidenav_cat_title" href="use-specialized-payment-types.html">Use Specialized Payment Types</a>
<!-- <a class="sidenav_cat_title" href="use-specialized-payment-types.html">Use Specialized Payment Types</a> -->
</h5>
</div><!-- /.card-header -->
<!-- /#sidenav_collapse20 -->
</div><!-- /.card -->
<!---->
<div class="card">
<div class="card-header" role="tab" id="sidenav_cat_head_35">
<a class="collapsed sidenav_cat_toggler" role="button" data-toggle="collapse" href="#sidenav_collapse_35" aria-expanded="true" aria-controls="sidenav_collapse_35"></a>
<h5 class="card-title">
<a class="sidenav_cat_title" href="xrp-ledger-businesses.html">XAG Ledger Businesses</a>
<!-- <a class="sidenav_cat_title" href="xrp-ledger-businesses.html">XAG Ledger Businesses</a> -->
</h5>
</div><!-- /.card-header -->
<div id="sidenav_collapse_35" class="collapse" role="tabpanel" aria-labelledby="sidenav_cat_head_35">
<div class="card-body">
<ul class="sidebar_pagelist">
<li><a class="nosubcat-page" href="list-xag-as-an-exchange.html">List XAG as an Exchange</a></li>
<li><a class="nosubcat-page" href="list-your-exchange-on-xag-charts.html">List Your Exchange on XAG Charts</a></li>
</ul>
</div><!-- /.card-body -->
</div><!-- /#sidenav_collapse35 -->
</div><!-- /.card -->
<!---->
<div class="card active">
<div class="card-header" role="tab" id="sidenav_cat_head_39">
<a class="sidenav_cat_toggler" role="button" data-toggle="collapse" href="#sidenav_collapse_39" aria-expanded="true" aria-controls="sidenav_collapse_39"></a>
<h5 class="card-title">
<a class="sidenav_cat_title active-parent" href="manage-the-rippled-server.html">Manage the rippled Server</a>
<!-- <a class="sidenav_cat_title" href="manage-the-rippled-server.html">Manage the rippled Server</a> -->
</h5>
</div><!-- /.card-header -->
<div id="sidenav_collapse_39" class="collapse show" role="tabpanel" aria-labelledby="sidenav_cat_head_39">
<div class="card-body">
<ul class="sidebar_pagelist">
<li><a class="subcat-title active-parent" href="install-rippled.html">Install rippled</a></li>
<li><a class="subpage" href="system-requirements.html">System Requirements</a></li>
<li><a class="subpage" href="install-rippled-on-centos-rhel-with-yum.html">Install on CentOS/Red Hat with yum</a></li>
<li><a class="subpage" href="install-rippled-on-ubuntu.html">Install on Ubuntu or Debian Linux</a></li>
<li><a class="subpage" href="update-rippled-automatically-on-linux.html">Update Automatically on Linux</a></li>
<li><a class="subpage" href="update-rippled-manually-on-centos-rhel.html">Update Manually on CentOS/Red Hat</a></li>
<li><a class="subpage" href="update-rippled-manually-on-ubuntu.html">Update Manually on Ubuntu or Debian</a></li>
<li><a class="subpage" href="build-run-rippled-ubuntu.html">Build and Run rippled on Ubuntu</a></li>
<li><a class="active subpage" href="#main_content_body">Build and Run rippled on macOS</a></li>
<li><a class="subpage" href="capacity-planning.html">Capacity Planning</a></li>
<li><a class="subpage" href="rippled-1-3-migration-instructions.html">rippled v1.3.x Migration Instructions</a></li>
<li><a class="subcat-title" href="configure-rippled.html">Configure rippled</a></li>
<li><a class="subpage" href="run-rippled-as-a-validator.html">Run rippled as a Validator</a></li>
<li><a class="subpage" href="run-rippled-as-a-wallet-server.html">Run rippled as a Wallet Server</a></li>
<li><a class="subpage" href="configure-statsd.html">Configure StatsD</a></li>
<li><a class="subpage" href="connect-your-rippled-to-the-xag-test-net.html">Connect Your rippled to an XAGL Altnet</a></li>
<li><a class="subpage" href="configure-online-deletion.html">Configure Online Deletion</a></li>
<li><a class="subpage" href="configure-advisory-deletion.html">Configure Advisory Deletion</a></li>
<li><a class="subpage" href="configure-history-sharding.html">Configure History Sharding</a></li>
<li><a class="subpage" href="configure-full-history.html">Configure Full History</a></li>
<li><a class="subpage" href="configure-grpc.html">Configure gRPC</a></li>
<li><a class="subpage" href="enable-public-signing.html">Enable Public Signing</a></li>
<li><a class="subcat-title" href="configure-peering.html">Configure Peering</a></li>
<li><a class="subpage" href="cluster-rippled-servers.html">Cluster rippled Servers</a></li>
<li><a class="subpage" href="configure-a-private-server.html">Configure a Private Server</a></li>
<li><a class="subpage" href="configure-the-peer-crawler.html">Configure the Peer Crawler</a></li>
<li><a class="subpage" href="forward-ports-for-peering.html">Forward Ports for Peering</a></li>
<li><a class="subpage" href="manually-connect-to-a-specific-peer.html">Manually Connect to a Specific Peer</a></li>
<li><a class="subpage" href="set-max-number-of-peers.html">Set Maximum Number of Peers</a></li>
<li><a class="subpage" href="use-a-peer-reservation.html">Use a Peer Reservation</a></li>
<li><a class="subcat-title" href="use-stand-alone-mode.html">Test rippled Functionality in Stand-Alone Mode</a></li>
<li><a class="subpage" href="start-a-new-genesis-ledger-in-stand-alone-mode.html">Start a New Genesis Ledger in Stand-Alone Mode</a></li>
<li><a class="subpage" href="load-a-saved-ledger-in-stand-alone-mode.html">Load a Saved Ledger in Stand-Alone Mode</a></li>
<li><a class="subpage" href="advance-the-ledger-in-stand-alone-mode.html">Advance the Ledger in Stand-Alone Mode</a></li>
<li><a class="subcat-title" href="troubleshoot-the-rippled-server.html">Troubleshooting rippled</a></li>
<li><a class="subpage" href="diagnosing-problems.html">Diagnosing Problems with rippled</a></li>
<li><a class="subpage" href="understanding-log-messages.html">Understanding Log Messages</a></li>
<li><a class="subpage" href="server-doesnt-sync.html">rippled Server Doesn't Sync</a></li>
<li><a class="subpage" href="server-wont-start.html">rippled Server Won't Start</a></li>
<li><a class="subpage" href="fix-sqlite-tx-db-page-size-issue.html">Fix SQLite Transaction Database Page Size Issue</a></li>
</ul>
</div><!-- /.card-body -->
</div><!-- /#sidenav_collapse39 -->
</div><!-- /.card -->
</div><!-- /#sidenav -->
</div><!-- /.tree_nav --> </aside>
</div><!--/.row (main layout)-->
</div>
<footer class="xrpl-footer" role="contentinfo">
<section class="container-fluid card-grid card-grid-Nx1">
<div class="card">
<div class="card-header">
<h5><a href="docs.html">Docs</a></h5>
</div><!--/.card-header-->
<div class="card-body">
<div class="children-display">
<ul>
<li class="level-1"><a href="concepts.html">Concepts</a></li>
<li class="level-1"><a href="tutorials.html">Tutorials</a></li>
<li class="level-1"><a href="references.html">References</a></li>
</ul>
</div> </div><!--/.card-body-->
<div class="flag-vertical">01</div>
</div><!--/.card -->
<div class="card">
<div class="card-header">
<h5><a href="use-cases.html">Use Cases</a></h5>
</div><!--/.card-header-->
<div class="card-body">
<div class="children-display">
<ul>
<li class="level-1"><a href="run-a-rippled-validator.html">Run a rippled Validator</a></li>
<li class="level-1"><a href="list-xrp-in-your-exchange.html">List XAG in Your Exchange</a></li>
<li class="level-1"><a href="contribute-code-to-rippled.html">Contribute Code to rippled</a></li>
<li class="level-1"><a href="contribute-code-to-ripple-lib.html">Contribute Code to ripple-lib</a></li>
</ul>
</div> </div><!--/.card-body-->
<div class="flag-vertical">02</div>
</div><!--/.card -->
<div class="card">
<div class="card-header">
<h5><a href="dev-tools.html">Dev Tools</a></h5>
</div><!--/.card-header-->
<div class="card-body">
<div class="children-display">
<ul>
<li class="level-1"><a href="xag-ledger-rpc-tool.html">RPC Tool</a></li>
<li class="level-1"><a href="websocket-api-tool.html">WebSocket API Tool</a></li>
<li class="level-1"><a target="_blank" href="https://scan.xrpgen.com/">XAG Ledger Explorer</a> <i class="fa fa-external-link"></i></li>
</ul>
</div> </div><!--/.card-body-->
<div class="flag-vertical">03</div>
</div><!--/.card -->
<div class="card">
<div class="card-header">
<h5><a href="https://xrpgen.com/" target="_blank">Xrpalike Gene<i class="fa fa-external-link"></i></a></h5>
</div><!--/.card-header-->
<!--/.card-body-->
<div class="flag-vertical">04</div>
</div><!--/.card -->
</section>
<section class="container-fluid p-5 pl-sm-0">
<nav role="navigation" class="d-flex mb-3 language-selector">
<img class="language_selector_icon" src="assets/img/icon-language-selector.svg" width="32" height="40" alt="language selection icon" />
<ul class="nav">
<li class="nav-item">
<a class="nav-link active" href="/build-run-rippled-macos.html"><i class="fa fa-check-circle"></i> English</a>
</li>
<li class="nav-item">
<a class="nav-link" href="/cn/build-run-rippled-macos.html">中文</a>
</li>
</ul>
</nav>
<div class="absolute_bottom_footer">
<span>© XAG Ledger Project 2020</span>
<span><a href="">License</a></span>
</div><!-- /.absolute_bottom_footer -->
</section>
</footer>
<!-- Jump to top button -->
<a href="#main_content_wrapper" class="jump-to-top btn btn-primary btn-lg" role="button" title="Jump to top of page">Top</a>
<script type="text/javascript" src="assets/js/jump-to-top.js"></script>
<!-- Non-blocking resources -->
<!-- Bootstrap JS -->
<script src="assets/vendor/bootstrap.min.js"></script>
<!-- fontawesome icons -->
<link rel="stylesheet" href="assets/vendor/fontawesome/css/font-awesome.min.css" />
<!-- Algolia DocSearch -->
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
<script type="text/javascript"> docsearch({
apiKey: '70de5b9b8ef95460f3c6e04054b325b2',
indexName: 'xrpl',
inputSelector: '#topsearchbar',
algoliaOptions: { 'facetFilters': ["lang:en"] },
debug: false
});
</script>
<script type="application/javascript">
gtag('set', {'content_group1': 'Content Docs'});
</script>
</body>
</html>