ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-11-20 11:45:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
9ba689722f13e481fb1f96c38eb9d612e1efea4b
xrpl-dev-portal/content/tutorials/manage-the-rippled-server/install-rippled.md
Jennifer Hasegawa 9ba689722f first pass for review
2018-10-26 17:01:18 -07:00

18 KiB
Raw Blame History

Install rippled

For production, you can install a rippled instance using Ripple's binary executable for Ubuntu or CentOS/Red Hat.

For development, you can install a rippled instance using Ripple's binary executable for macOS, or you can build and run rippled from source for Ubuntu.

For installation information for other platforms, see the rippled repository.

Minimum System Requirements

A rippled server should run comfortably on commodity hardware, to make it inexpensive to participate in the network. At present, we recommend the following minimum requirements:

  • Operating System:
    • Production: CentOS or RedHat Enterprise Linux (latest release) or Ubuntu (16.04+) supported
    • Development: Mac OS X, Windows (64-bit), or most Linux distributions
  • CPU: 64-bit x86_64, 2+ cores
  • Disk: Minimum 50GB SSD recommended (1000 IOPS, more is better) for the database partition
  • RAM:
    • Testing: 8GB+
    • Production: 32 GB

Amazon EC2's m3.large VM size may be appropriate depending on your workload. A fast network connection is preferable. Any increase in a server's client-handling load increases resources needs.

Tip: For recommendations beyond the minimum requirements, see Capacity Planning.

Installation on Ubuntu with alien

This section assumes that you are using Ubuntu 15.04 or later.

  1. Install yum-utils and alien:

     $ sudo apt-get update
 $ sudo apt-get install yum-utils alien

  2. Install the Ripple RPM repository:

     $ sudo rpm -Uvh https://mirrors.ripple.com/ripple-repo-el7.rpm

  3. Download the rippled software package:

     $ yumdownloader --enablerepo=ripple-stable --releasever=el7 rippled

  4. Verify the signature on the rippled software package:

     $ sudo rpm --import https://mirrors.ripple.com/rpm/RPM-GPG-KEY-ripple-release && rpm -K rippled*.rpm

  5. Install the rippled software package:

     $ sudo alien -i --scripts rippled*.rpm && rm rippled*.rpm

  6. Configure the rippled service to start on system boot:

     $ sudo systemctl enable rippled.service

  7. Start the rippled service

     $ sudo systemctl start rippled.service

For next steps, see Postinstall and Additional Configuration.

Installation on CentOS/Red Hat with yum

This section assumes that you are using CentOS 7 or Red Hat Enterprise Linux 7.

  1. Install the Ripple RPM repository:

     $ sudo rpm -Uvh https://mirrors.ripple.com/ripple-repo-el7.rpm

  2. Install the rippled software package:

     $ sudo yum install --enablerepo=ripple-stable rippled

  3. Configure the rippled service to start on system boot:

     $ sudo systemctl enable rippled.service

  4. Start the rippled service

     $ sudo systemctl start rippled.service

For next steps, see Postinstall and Additional Configuration.

Installation on macOS

At this time, we don't recommend using the macOS platform for rippled production use. For production, consider using the Ubuntu platform, which has received the highest level of quality assurance and testing.

That said, macOS is suitable for many development and testing tasks.

This section assumes that you are using macOS X 10.0 or higher. TODO: okay?

{% set n = cycler(* range(1,99)) %}

{{n.next()}}. Install Xcode.

{{n.next()}}. Install Xcode command line tools. TODO: Comment from Daniel: Installing homebrew removes the need to install xcode command line tools separately. JHA: homebrew lists xcode command line tools as a requirement: https://docs.brew.sh/Installation#requirements. Do we keep or remove this step?

    xcode-select --install

{{n.next()}}. Install Homebrew.

    ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

{{n.next()}}. Update Homebrew.

    brew update

{{n.next()}}. Use Homebrew to install dependencies. TODO: Added boost per Daniel's request: Installing Boost directly is going to frustrate people - brew can do it in one command. I ended up installing Boost with Brew with no issues. Which release to choose? JHA: I did brew install boost and brew installs 1.67.0 in /usr/local/Cellar/boost/1.67.0_1 -- is this okay? If we install Boost via brew, do we no longer have to compile boost: ./bootstrap.sh and ./b2 cxxflags="-std=c++14"? Comment from Daniel: Build issues with Boost not finding lib (boost-context) in my case. JHA: when does this issue come up? How can we help the user avoid or address this issue?

    brew install git cmake pkg-config protobuf openssl ninja boost

{{n.next()}}. Set the BOOST_ROOT environment variable to point to the new directory created by the Homebrew installation of Boost. Put this environment variable in your .bash_profile so it's automatically set when you log in. For example, add the following line to the file. To find your Boost install directory, use brew info boost. TODO: Feedback from Daniel: Have to deal with environment variables. “rc” files is a vague statement. JHA: If you do brew install boost - you still have to set env variables, correct? I did it using .bash_profile and removed references to "rc files" - is this okay? Or do we want to tell users that they can choose to put the env var in the .bashrc file instead of .bash_profile - is there any benefit to saying this?

    export BOOST_ROOT=/usr/local/Cellar/boost/1.67.0_1

{{n.next()}}. Source the file you added the BOOST_ROOT environment variable to. For example:

    source .bashrc

{{n.next()}}. Clone the rippled source code into your desired location and access the rippled directory. TODO: Note from Daniel: Cloning github repo is going to require proper github setup. Should we provide some guidance or references? JHA: What is the proper github setup? I may have set this up a whlie ago and I can't remember the steps that may have been required.

    git clone git@github.com:ripple/rippled.git
    cd rippled

{{n.next()}}. By default, cloning puts you on the develop branch. Use this branch if you are doing development work and want the latest set of untested features.

  If you want the latest stable release, checkout the `master` branch.

    git checkout master

  Or, you can checkout one of the tagged releases listed on [GitHub](https://github.com/ripple/rippled/releases GitHub).

  If you want to test out the latest release candidate, checkout the `release` branch:

    git checkout release

{{n.next()}}. Create your rippled build directory and access it. For example:

    mkdir my_build
    cd my_build

{{n.next()}}. Build rippled. This could take about 5 minutes, depending on your hardware specs.

    cmake -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=Debug ..

  You can set `CMAKE_BUILD_TYPE` to the `Debug` or `Release` build type. All four standard [`CMAKE_BUILD_TYPE`](https://cmake.org/cmake/help/v3.0/variable/CMAKE_BUILD_TYPE.html) values are supported.

{{n.next()}}. Run the build using CMake. This could take about 10 minutes, depending on your hardware specs.

    cmake --build . -- -j 4

  This example uses a `-j` parameter set to `4`, 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 `sysctl -a | grep machdep.cpu | grep core_count` to get your CPU core count. ***TODO: the mac build page in the github repo goes much more in-depth about cmake build options - should we include these here? https://github.com/ripple/rippled/tree/develop/Builds/macos#generate-and-build***

{{n.next()}}. Run unit tests built into the server executable. This could take about 5 minutes, depending on your hardware specs. (optional, but recommended) TODO: We should provide info about what to do if you get failures. What should the user do?

    ./rippled --unittest

{{n.next()}}. Create a copy of the example config file and save it to a location that enables you to run rippled as a non-root user (recommended). TODO: unlike the centos and ubuntu installs on this page, the macos install requires that you manually put rippled.cfg and validator.txt in place. At least that is what I experienced - true?

    mkdir -p ~/.config/ripple
    cd rippled
    cp cfg/rippled-example.cfg ~/.config/ripple/rippled.cfg

{{n.next()}}. Edit rippled.cfg to set necessary file paths. The user you plan to run rippled as must have write permissions to all of the paths you specify here. TODO: this is required at this point in the install b/c if you don't have the permissions set correctly, rippled won't run, correct? It is not that the default values in rippled.cfg are incorrect--there may just be permission issues, is that right? what is the equivalent command in macOS for chown -R rippled:rippled <configured path>? I think we need to add this step to the centos and ubuntu tasks. The config files are placed in the correct directory automatically -- but these values still need to be manually updated, yes?

  * Set the `[node_db]` path to the location where you want to store the ledger database.

  * Set the `[database_path]` 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 `[node_db]` path field.)

  * Set the `[debug_logfile]` to a path where `rippled` can write logging information.

  These are the only configurations required for `rippled` to start up successfully. All other configuration is optional and can be tweaked after you have a working server. For more information, see [Additional Configurations](#additional-configurations).

{{n.next()}}. Copy the example validators.txt file to the same folder as rippled.cfg:

    cp cfg/validators-example.txt ~/.config/ripple/validators.txt

  **Warning:** Ripple has designed a decentralization plan with maximum safety in mind. During the transition, you should not modify the `validators.txt` 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.

{{n.next()}}. Start the rippled service.

    sudo ./rippled

For next steps, see Postinstall and Additional Configuration.

Postinstall

It can take several minutes for rippled to sync with the rest of the network, during which time it outputs warnings about missing ledgers.

Here's an excerpt of what you can expect to see in your terminal: TODO: you'll see this for the macOS install, but not for centos and ubuntu. For centos and ubuntu - is there any benefit to giving the user a command that will display this view? Does such a command exist? Alternatively, for centos and ubuntu - we need to give the user some other way to tell that the service is running - refer them to server states?

    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

TODO: for the future, provide a reference for what the most common and unintuitive messages mean -- esp when signalling possible errors.

Once your rippled has synchronized with the rest of the network, you have a fully functional stock rippled server that you can use for local signing and API access to the XRP Ledger. Use rippled server states to tell whether your rippled server has synchronized with the network.

For information about communicating with your rippled server using the rippled API, see the rippled API reference.

Once you have your stock rippled 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 Run rippled as a Validator.

Additional Configuration

rippled should connect to the XRP Ledger with the default configurations. However, you can change your settings by editing the rippled.cfg file. For recommendations about configuration settings, see Capacity Planning.

The default locations for rippled.cfg are as follows:

  • CentOS/Red Hat with yum: /opt/ripple/etc/

  • Ubuntu with alien: ~/.config/ripple/

  • macOS: ~/.config/ripple/ TODO: Info in rippled-example.cfg points to the wiki to tell folks where to put this file -- need to update rippled-example.cfg to address. Specifically, the section explaining the --conf command line option: https://ripple.com/wiki/Rippled#--conf.3Dpath - the content doesn't exist on the wiki page and we are retiring the wiki.

Changes to the [debug_logfile] or [database_path] sections may require you to give the rippled user and group ownership to your new configured path: TODO: Per notes above, I think we need to add the "Edit rippled.cfg to set necessary file paths." step to centos and ubuntu tasks. Once we do that, we can put this command info in the context of each task.

$ chown -R rippled:rippled <configured path>

Restart rippled for any configuration changes to take effect: TODO: what is the macOS command for this?

$ sudo service rippled restart