Skip to content

Commit d34cc51

Browse files
authored
Merge pull request #63 from input-output-hk/staging
adding Docker steps
2 parents b1db661 + b3973dc commit d34cc51

File tree

4 files changed

+454
-1
lines changed

4 files changed

+454
-1
lines changed

.env.development

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
GATSBY_IS_STAGING=true

content/02-getting-started/01-installing-the-cardano-node.mdx

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,94 @@ the source code using either of the following:
1717
Once you have installed the node, you need to
1818
[specify the configuration parameters](https://github.com/input-output-hk/cardano-node/blob/master/doc/getting-started/understanding-config-files.md/).
1919

20+
### How to Run the Cardano node and CLI using Docker
21+
There is also a Docker image available that you can use.
22+
23+
#### Setting up Docker
24+
25+
1. Download and install Docker/Docker Desktop from the [Docker site](https://docs.docker.com/get-docker/).
26+
2. If using Windows or Mac, ensure you have allocated enough RAM to Docker (we recommend setting the RAM to 8GB in the Docker Desktop requirements) and start the Docker daemon, as described in the Docker instructions. Note that Docker on Linux, there are no RAM limits for containers by default.
27+
28+
#### Setting up the Cardano node
29+
1. Download the correct `cardano-node` image:
30+
31+
``docker image pull inputoutput/cardano-node:<TAG>``
32+
33+
where `<TAG>` is the tag for the version that you require (e.g. `latest` for the most recent stable version, or `1.27.0` for node version 1.27.0).
34+
35+
2. Create local `data` and `node-ipc` volumes:
36+
37+
```
38+
docker volume create cardano-node-data
39+
docker volume create cardano-node-ipc
40+
```
41+
42+
## Running the Cardano node
43+
44+
1. Run a passive node that is connected to the correct network. For example, for a `mainnet` node:
45+
46+
``docker run -e NETWORK=mainnet -v node-ipc:/ipc -v data:/data inputoutput/cardano-node``
47+
48+
This creates a persistent docker environment for the node, where `/ipc` in the Docker container is connected to the logical `node-ipc`volume, and `/data` is connected to the `data` volume. Note that you should change `NETWORK=mainnet` if you are connecting to a different network (eg a testnet).
49+
50+
You may also run the node with specific parameters:
51+
52+
``docker run -v node-ipc:/ipc -v data:/data inputoutput/cardano-node run --help``
53+
54+
### Passing Explicit Configuration Parameters
55+
If there is no pre-defined network configuration, you will need to download the specified configuration files, copy these to the persistent Docker volume, and pass the parameters on the command line:
56+
57+
``docker run -v node-ipc:/ipc -v data:/data inputoutput/cardano-node run --config ... --topology ... --...``
58+
59+
## Running Cardano CLI commands
60+
You can now run normal Cardano CLI commands, for example,
61+
```
62+
export CLI='docker run -it --entrypoint cardano-cli -e NETWORK=mainnet -e CARDANO_NODE_SOCKET_PATH=/ipc/node.socket -v node-ipc:/ipc inputoutput/cardano-node'
63+
$CLI version
64+
$CLI query tip --mainnet
65+
$CLI transaction build-raw ... --mainnet
66+
```
67+
You need to specify `CARDANO_NODE_SOCKET_PATH` to point to the correct location in the container (`/ipc/node.socket` is the standard location).
68+
69+
## Running a Shell in the Docker Container
70+
To run a shell in the container (so that you can inspect or change settings, for example), use the `bash` or `sh` entry point.
71+
72+
``docker run -it --entrypoint bash -v node-ipc:/ipc -v data:/data inputoutput/cardano-node``
73+
74+
You may now run any commands that you require with full access to the container's file systems.
75+
76+
```
77+
bash-4.4# cd /data/db
78+
bash-4.4# ls
79+
immutable ledger lock protocolMagicId volatile
80+
bash-4.4#
81+
```
82+
83+
Alternatively, you can start the node container with a name:
84+
`docker run --name cardano-node -e NETWORK=mainnet -v cardano-node-ipc:/ipc -v cardano-node-data:/data inputoutput/cardano-node`
85+
86+
In a separate terminal instance, run shell in an existing container:
87+
`docker exec -it cardano-node bash`
88+
89+
## Copying files to/from the Docker Container
90+
To copy files to/from the docker container use `docker cp`.
91+
92+
For example, if the process ID of the running container is `760199bf3561`
93+
94+
```
95+
kh@vulcan:~$ docker ps
96+
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
97+
760199bf3561 inputoutput/cardano-node "/nix/store/p435ajna…" ...
98+
```
99+
100+
Then to copy the `immutable` directory (if you have a cached version), for example, you can:
101+
102+
``docker cp db/immutable 760199bf3561:/data/db/immutable``
103+
104+
You can also mount local directories for use by the container. For example to share the `db` and `node-ipc` directories, you could:
105+
106+
``docker run ---mount type=bind,source="$(pwd)/db/",target=/data/db --mount type=bind,source="$(pwd)/node-ipc",target=/ipc inputoutput/cardano-node ...``
107+
20108
#### Related Topics
21109

22110
- [Using the command line interface](/getting-started/use-cli)
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
title: Daedalus wallet
3+
metaTitle: Daedalus wallet
4+
---
5+
import { OpenInNew } from 'styled-icons/material/OpenInNew'
6+
import { User } from 'styled-icons/boxicons-regular/User'
7+
8+
## Overview
9+
10+
Daedalus wallet is a full-node hierarchical deterministic (HD) desktop wallet for the ada currency. Daedalus comes bundled with a full Cardano node, and it stores the entire history of Cardano blockchain and validates all blocks and transactions for fully trustless and autonomous operation.
11+
12+
### Key features
13+
14+
- Easy installation with one-click setup of bundled Cardano node
15+
- Locally stored wallets and encrypted private keys, not shared with third-party servers
16+
- Trustless operation with locally running full Cardano node which independently validates full transaction history of the blockchain
17+
- Supports Cardano network by participating in Cardano protocol
18+
- Wallet backup and restoration using mnemonics phrases
19+
- Staking Support
20+
- Complete autonomy without reliance on third-party servers and services
21+
- Paper wallet generator for offline storage of funds
22+
23+
### Downloading Daedalus
24+
25+
You should download the Daedalus wallet from our [official website](https://daedaluswallet.io/#download) *only*.
26+
27+
**Notes**:
28+
29+
- Daedalus runs on Windows, Mac, and Linux operating systems.
30+
- After downloading, the wallet will sync with the blockchain to create a local copy of it. Currently, Daedalus (and the blockchain) take up around 6GB of local storage.
31+
32+
> For more information about Daedalus: [visit the dedicated Helpdesk page <OpenInNew className='content-link' />](https://iohk.zendesk.com/hc/en-us/categories/360000877653-Daedalus-Mainnet)
33+

0 commit comments

Comments
 (0)