Installation Instructions

Docker images are continuously built and deployed on dockerhub under specific tags. Using docker provides the fastest and easiest user experience for setting up the Cardano stack. You should prefer this solution over building from sources unless you have really good reasons not to. The following images are available for each component of the Adrestia architecture:

RepositoryTagsDocumentation
inputoutput/cardano-nodemaster, MAJ.MIN.PATCH, latestlink
inputoutput/cardano-db-syncmaster, MAJ.MIN.PATCH, latestlink
inputoutput/cardano-graphqlmaster, MAJ.MIN.PATCH, latestlink
inputoutput/cardano-explorer-apimaster, MAJ.MIN.PATCH, latestlink
inputoutput/cardano-submit-apimaster, MAJ.MIN.PATCH, latestlink
inputoutput/cardano-walletbyron, YYYY.MM.DD-byron, latestlink

Semantic

TagSemantic
latestPoints to the latest stable image for the corresponding component. This is also the tag to which docker defaults when pulling without an explicit tag. These typically points to latest known release which happens at the end of an iteration cycle. Depending on which project / component, the iteration cycle may vary from 1 to 2 weeks.
MAJ.MIN.PATCH or YYYY.MM.DD-byronMust match actual releases of the corresponding component. Refer to each component release notes to know which release tags are available.
masterPoints to the very tip of the development branch. This is therefore not recommended for production but can be useful to try out features before they are officially released.
byronA special tag pointing to the very tip of the development branch on cardano-wallet. cardano-wallet does support both jörmungandr and cardano-node at the same time, but corresponding images are packaged separately. The byron tag therefore points to a version of cardano-wallet compatible with cardano-node in OBFT mode.

Examples

For example, in order to use cardano-node@1.10.0, one can simply run:

docker pull inputoutput/cardano-node:1.10.0

Similarly, one can pull cardano-wallet@v2020-04-07 with:

docker pull inputoutput/cardano-wallet:v2020.4.7-byron

ℹ️ About version compatibility

For version compatibility between components, please refer to compatibility matrix on each component main page (e.g. cardano-wallet#latest-releases).

Docker compose

Some components also provide example setup via docker-compose. Those are useful for a quick start or as a baseline for development. See for example cardano-wallet, cardano-graphql or cardano-rest.

Pre-compiled Artifacts / Building From Sources

In case you prefer using raw binary instead, some components do provide pre-compiled release artifacts for each release. These can be downloaded directly from the github servers, via the UI or using a command-line tool like wget or cURL. For example, one can download a pre-packaged linux binary for cardano-wallet@v2020-04-07 via:

curl -L https://github.com/input-output-hk/cardano-wallet/releases/download/v2020-04-07/cardano-wallet-v2020-04-07-linux64.tar.gz | tar xz

./cardano-wallet-byron-linux64/cardano-wallet --help
The CLI is a proxy to the wallet server, which is required for most commands.
Commands are turned into corresponding API calls, and submitted to an
up-and-running server. Some commands do not require an active server and can be
run offline (e.g. 'mnemonic generate').

[...]

If you feel brave enough and want to compile everything from sources, please refer to each repository’s documentation. As a pre-requisite, you may want to install and configure Nix, stack or cabal depending on your weapon of choice. Build instructions are available on each repository’s main README.

RepositoryReleasesLinuxMacOSWindows
cardano-nodereleases✔️✔️✔️
cardano-db-syncreleases✔️✔️
cardano-submit-apireleases✔️✔️
cardano-explorer-apireleases✔️✔️
cardano-graphqlreleases✔️✔️
cardano-walletreleases✔️✔️✔️