[{"_1":2,"_155":-5,"_156":-5},"loaderData",{"_3":4,"_13":14,"_21":22,"_134":135},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11,"_20":11},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_23":24,"_25":-5,"_26":11,"_27":11,"_28":29,"_30":31,"_32":-5,"_33":11,"_34":35,"_84":-5,"_85":86,"_125":-5,"_126":11,"_127":17,"_128":11,"_129":-5,"_130":11,"_131":-5,"_132":133},"canonicalUrl","https://hub.docker.com/r/funkypenguin/cardano-node/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","funkypenguin","reponame","cardano-node","cloudBuildSource","isAutobuildsAvailable","repo",{"_36":37,"_38":39,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":51,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":70,"_75":11,"_76":77,"_81":29,"_82":83},"categories",[],"content_types",[40],"image","date_registered","2020-07-29T23:08:14.451819Z","description","An automated build of the cardano node, intended for use in creating a stake pool","is_private","last_updated","2020-08-05T21:36:00.502829Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[52],"application/vnd.docker.container.image.v1+json","name","pull_count",4009,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# Running a Cardano Node\r\n\r\nFrom the official [cardano-node setup](https://docs.cardano.org/projects/cardano-node/en/latest/) tutorials from IOHK.\r\nThe container downloads and builds the [cardano-node](https://github.com/input-output-hk/cardano-node.git).\r\nIt can start either a block-producing node or a relay node, or both, and connect to the cardano network. By default it will connect to the test network, you can run on other networks using the CARDANO_NETWORK environment variable, See the [Environment variables](#environment) section.\r\nIf you want to run a stake pool, the block-producing container can take all the required steps to set up and register the stake pool.\r\n\r\n\r\n## Steps in Running a Stake Pool\r\n\r\n### The easy way\r\n\r\n1. Upload your stake-pool metadata json file ([See example](#metadata-example)) to a host so it is accessible to the public. For example as a [github gist](https://gist.github.com/).\r\n2. Start a relay node and make it connect to the block-producing node. See the [relay node example](#relay-example).\r\n3. Start a block-producing node with the `--staking` argument and `CREATE_STAKEPOOL=\"True\"` environment variable, and make it connect to the relay node. See the [block-producing node example](#producing-example)\r\n4. Wait for the block-producing node to setup and register your pool.\r\n5. Fund your payment address generated and displayed in Step 4 to finalize the registration.\r\n6. Backup and remove the `cold-keys` directory from the `config` directory of the block-producing node.\r\n\r\nThe docker-compose file `examples/mc4-docker-compose.yaml` will run these 2 containers automatically.\r\nUse the command `docker-compose -f mc4-docker-compose.yaml up` to start them.\r\n\r\n**Warning:** These examples are ONLY for demonstration. The examples will run the nodes on the same server, using the `host` network, and connects to eachother using the localhost IP-address. This is not recommended. It is recommended to run the nodes on seperate servers and connect them using their public or local network IP-addresses. The idea is to keep the block-producing node completely locked off from anything other than the relay node. The block-producing node will also initialize and register the stake pool automatically, which is better to do on a seperate node, to keep the `cold-keys` directory away from the online nodes.\r\n\r\n\r\n#### Renewing KES keys and certificates\r\n\r\nTo renew your KES keys and certificates you have to run the `generate_operational_certificate` command in the block-producing container.\r\nThe status window in the block-producing container will tell you when you have to generate new keys.\r\n\r\n1. Start the command-line interface in the block-producing container containing the `cold-keys` directory. See `examples/mc4-producing-cli.sh`.\r\n2. Run the `generate_operational_certificate` command and wait for it to complete.\r\n3. Restart the block-producing container.\r\n\r\n\r\n#### relay node on mainnet-candidate4 \r\n\r\nSee `examples/mc4-relay1.sh`.\r\n\r\n```\r\ndocker run -it --rm \\\r\n --network=host \\\r\n --name mc4-relay1 \\\r\n -e PUID=$(id -u) \\\r\n -e PGID=$(id -u) \\\r\n -e NODE_PORT=\"3001\" \\\r\n -e NODE_NAME=\"mc4-relay1\" \\\r\n -e NODE_RELAY=\"True\" \\\r\n -e NODE_TOPOLOGY=\"127.0.0.1:3000/1\" \\\r\n -e CARDANO_NETWORK=\"mc4\" \\\r\n -e EKG_PORT=\"12789\" \\\r\n -e PROMETHEUS_PORT=\"12799\" \\\r\n -e PROMETHEUS_HOST=\"127.0.0.1\" \\\r\n -e HOST_ADDR=\"0.0.0.0\" \\\r\n -v $PWD/config/local/:/config/ \\\r\n arrakis/cardano-node:latest --start\r\n```\r\n\r\n\r\n#### block-producing node on mainnet-candidate4 \r\n\r\nThis will initialize and register the stakepool, and start the block-producing node.\r\n\r\nSee `examples/mc4-producing.sh`.\r\n\r\n```\r\ndocker run -it --rm \\\r\n --network=host \\\r\n --name mc4-producing \\\r\n -e PUID=$(id -u) \\\r\n -e PGID=$(id -u) \\\r\n -e NODE_PORT=\"3000\" \\\r\n -e NODE_NAME=\"mc4-block-producing\" \\\r\n -e NODE_TOPOLOGY=\"127.0.0.1:3001/1\" \\\r\n -e NODE_RELAY=\"False\" \\\r\n -e CARDANO_NETWORK=\"mc4\" \\\r\n -e EKG_PORT=\"12788\" \\\r\n -e PROMETHEUS_PORT=\"12798\" \\\r\n -e PROMETHEUS_HOST=\"127.0.0.1\" \\\r\n -e HOST_ADDR=\"127.0.0.1\" \\\r\n -e POOL_PLEDGE=\"100000000000\" \\\r\n -e POOL_COST=\"1000000000\" \\\r\n -e POOL_MARGIN=\"0.05\" \\\r\n -e CREATE_STAKEPOOL=\"True\" \\\r\n -e METADATA_URL=\"https://gist.githubusercontent.com/abracadaniel/58dfa2cfe0f986c7f445deb151ed1b49/raw/4bb8155af7be65d7e9869f0923c7ce778c75368b/metadata.json\" \\\r\n -e PUBLIC_RELAY_IP=\"PUBLIC\" \\\r\n -v $PWD/config/local/:/config/ \\\r\n arrakis/cardano-node:latest --start --staking\r\n```\r\n\r\n\r\n### Best practice\r\n\r\nThis is an example on how to run your staking pool more securely, by keeping your `cold-keys` away from the online block-producing node.\r\n\r\nFor this setup you will need 3 hosts.\r\n`host1` for running the relay node.\r\n`host2` host for running the block-producing node.\r\n`host3` host for generating and registering all the keys, addresses and certificates and storing the cold-keys for refreshing the KES keys and certificates. This can be a host you are running locally, with all incoming traffic completely shut off.\r\n\r\n1. Upload your stake-pool metadata json file ([See example](#metadata-example)) to a host so it is accessible to the public. For example as a [github gist](https://gist.github.com/).\r\n2. Start a relay node on `host1` and make it connect to the block-producing node on `host2`. See the [relay node example](#relay-example2).\r\n3. Start a block-producing node on `host3`, with the `--staking` argument and `CREATE_STAKEPOOL=\"True\"` environment variable, and make it connect to the relay node on `host1`. See the [registration node example](#registration-example2).\r\n4. Fund your payment address generated and displayed in Step 3 to finalize the registration.\r\n5. Wait for the block-producing node on `host3` to setup and register your pool.\r\n6. Copy the `config/staking` directory, excluding the `cold-keys` directory, from the block-producing node on `host3` to the `config/staking` directory on `host2`.\r\n7. Start a block-producing node on `host2`, with the `--staking` argument, and make it connect to the relay node on `host1`. See the [block-producing node example](#producing-example2).\r\n8. Create Firewall rules for your block-producing node on `host3` to only accept incoming traffic from your relay node on `host1`.\r\n\r\n\r\n#### Renewing KES keys and certificates\r\n\r\nTo renew your KES keys and certificates you have to run the `generate_operational_certificate` command in the registration container on `host3`\r\nThe status window in the block-producing container will tell you when you have to generate new keys.\r\n\r\n1. Start the command-line interface in the registration container containing the `cold-keys` directory, on `host3`. Using `docker exec -it main-registration bash`.\r\n2. Run the `generate_operational_certificate` command and wait for it to complete.\r\n3. Copy the `config/staking/pool-keys/` directory on `host3` to the `config/staking/pool-keys/` directory on `host2`\r\n4. Restart the block-producing container on `host2`.\r\n\r\n\r\n#### relay node on mainnet \r\n\r\nStep 1. Run on `host1`. See `examples/main-relay1.sh`.\r\n\r\n```\r\ndocker run -it --rm \\\r\n --name main-relay1 \\\r\n -p 3000:3000 \\\r\n -p 12798:12798 \\\r\n -e PUID=$(id -u) \\\r\n -e PGID=$(id -u) \\\r\n -e NODE_PORT=\"3000\" \\\r\n -e NODE_NAME=\"relay1\" \\\r\n -e NODE_TOPOLOGY=\":3000/1\" \\\r\n -e NODE_RELAY=\"True\" \\\r\n -e CARDANO_NETWORK=\"main\" \\\r\n -e PROMETHEUS_PORT=\"12798\" \\\r\n -v $PWD/config/:/config/ \\\r\n arrakis/cardano-node:latest --start\r\n```\r\n\r\n\r\n#### registration node on mainnet \r\n\r\nStep 2. Run on `host3`. See `examples/main-registration.sh`.\r\n\r\n```\r\ndocker run -it --rm \\\r\n --name main-registration \\\r\n -p 3000:3000 \\\r\n -p 12798:12798 \\\r\n -e PUID=$(id -u) \\\r\n -e PGID=$(id -u) \\\r\n -e NODE_PORT=\"3000\" \\\r\n -e NODE_NAME=\"registration\" \\\r\n -e NODE_TOPOLOGY=\":3000/1\" \\\r\n -e CARDANO_NETWORK=\"main\" \\\r\n -e CREATE_STAKEPOOL=\"True\" \\\r\n -e POOL_PLEDGE=\"100000000000\" \\\r\n -e POOL_COST=\"1000000000\" \\\r\n -e POOL_MARGIN=\"0.05\" \\\r\n -e METADATA_URL=\"\" \\\r\n -v $PWD/config/:/config/ \\\r\n arrakis/cardano-node:latest --start --staking\r\n```\r\n\r\n\r\n#### block-producing node on mainnet \r\n\r\nStep 5. Run on `host2`. See `examples/main-producing.sh`.\r\n\r\n```\r\ndocker run -it --rm \\\r\n --name main-producing \\\r\n -p 3000:3000 \\\r\n -p 12798:12798 \\\r\n -e PUID=$(id -u) \\\r\n -e PGID=$(id -u) \\\r\n -e NODE_PORT=\"3000\" \\\r\n -e NODE_NAME=\"block-producing\" \\\r\n -e NODE_TOPOLOGY=\":3000/1\" \\\r\n -e CARDANO_NETWORK=\"main\" \\\r\n -e PROMETHEUS_PORT=\"12798\" \\\r\n -v $PWD/config/:/config/ \\\r\n arrakis/cardano-node:latest --start --staking\r\n```\r\n\r\n#### Monitoring\r\nIf you want to monitor your nodes using prometheus across different hosts, you can set the environment variable `PROMETHEUS_HOST=0.0.0.0`. This makes the Prometheus service accessible to other hosts. So you can for example run a Prometheus+Grafana service on your relay node, scraping data from the block-producing and relay nodes.\r\nIf you do this, it is EXTREMELY important that you set up a Firewall rule ONLY allowing traffic from your relay nodes host on the Prometheus port, otherwise everyone will be able to monitor your node.\r\n\r\n## Metadata example \r\n\r\nThe `examples/metadata.json` file is the file that holds metadata about your pool.\r\n\r\nIt looks like the following, and has to be upload to a host so it is accessible to the public via. an URL.\r\nYou can for example upload it as a [github gist](https://gist.github.com).\r\n\r\n```\r\n{\r\n \"name\": \"Example Pool\",\r\n \"description\": \"Cardano stakepool example\",\r\n \"ticker\": \"TEST\",\r\n \"homepage\": \"https://github.com/abracadaniel/cardano-node-docker\"\r\n}\r\n```\r\n\r\n\r\n## Arguments\r\n\r\nYou can pass the following arguments to the start up script.\r\n\r\n| Argument | Function |\r\n| :-- | -- |\r\n| --start | Start node. |\r\n| --staking | Start as a staking node (Requires the `--start` argument) |\r\n| --cli | Start command-line interface. |\r\n| --update | Update the node software. |\r\n| --init_config | Initialize config. |\r\n| --help | see this message. |\r\n\r\n\r\n## Environment variables \r\n\r\nYou can pass the following environment variables to the container.\r\n\r\n| Variable | Function |\r\n| :-- | -- |\r\n| PUID | User ID of user running the container |\r\n| PGID | Group ID of user running the container |\r\n| NODE_PORT | Port of node. Default: 3000. |\r\n| NODE_NAME | Name of node. Default: node1. |\r\n| NODE_TOPOLOGY | Topology of the node. Should be comma separated for each individual node to add, on the form: \\:\\/\\. So for example: 127.0.0.1:3001/1,127.0.0.1:3002/1. |\r\n| NODE_RELAY | Set to True if default IOHK relay should be added to the network topology. Default: False. |\r\n| HOST_ADDR | Set cardano-node host address. Defaults to public IP address. |\r\n| CARDANO_NETWORK | Carano network to use (main, test, pioneer). Default: main. |\r\n| EKG_PORT | Port of EKG monitoring. Default: 12788. |\r\n| PROMETHEUS_HOST | Host of Prometheus monitoring. Default: 127.0.0.1. |\r\n| PROMETHEUS_PORT | Port of Prometheus monitoring. Default: 12798. |\r\n| RESOLVE_HOSTNAMES | Resolve topology hostnames to IP-addresses. Default: False. |\r\n| REPLACE_EXISTING_CONFIG | Reset and replace existing configs. Default: False. |\r\n| CREATE_STAKEPOOL | Initializes Stake Pool keys, addresses and certificates, and sends them to the blockchain, when starting as a stakepool, if it is not already initialized. Default: False |\r\n| POOL_PLEDGE | Pledge (lovelace). Default: 100000000000 |\r\n| POOL_COST | Operational costs per epoch (lovelace). Default: 10000000000 |\r\n| POOL_MARGIN | Operator margin. Default: 0.05 |\r\n| METADATA_URL | URL for file containing stake pool metadata information. See \\`examples/metadata.json\\` for examle. The file be uploaded to an URL accessible to public. |\r\n| PUBLIC_RELAY_IP | Public IP address of Relay node.

Values:
\\
TOPOLOGY: Use first entry of the topology.
PUBLIC: Use public IP of node.
Default: TOPOLOGY. |\r\n\r\n\r\n## Commands\r\n\r\nThese commands can be run from the command-line interface of the container.\r\n\r\n| Command | Description |\r\n| create_stakepool | Take all the steps to initialize and register the stakepool from scratch. |\r\n| generate_stake_address | Generate payment and stake keys and addresses. |\r\n| generate_registration_certificates | Generates stakepool registration certificates. |\r\n| generate_operational_certificates | Generates stakepool cold-keys, and VRF and KES keys, and the node certificates. |\r\n| register_stake_address | Registers your stake address in the blockchain. |\r\n| register_stake_pool | Registers your stake pool in the blockchain. |\r\n| sync_status | Display node synchronization status. |\r\n\r\n\r\n## Supported Networks\r\n\r\nUse the CARDANO_NETWORK environment variable to change this.\r\nThe latest supported networks can be found at [https://hydra.iohk.io/job/Cardano/cardano-node/cardano-deployment/latest-finished/download/1/index.html](https://hydra.iohk.io/job/Cardano/cardano-node/cardano-deployment/latest-finished/download/1/index.html)\r\n\r\n| Network | CARDANO_NETWORK value |\r\n| :-- | -- |\r\n| mainnet | main |\r\n| mainnet-candidate4 | mc4 |\r\n\r\n\r\n## Ports\r\n\r\n| Port | Function |\r\n| :-- | -- |\r\n| 3000 | Default port cardano-node. |\r\n| 12798 | Default port for Prometheus monitoring. |\r\n\r\n\r\n## Volumes\r\n\r\n| Volume | Function |\r\n| :-- | -- |\r\n| /config | Specify a folder to store the configuration and database of the nodes, for persistent data. |\r\n\r\n\r\n## Example scripts\r\n\r\nUse these example scripts to see how the nodes can be started. \r\n\r\n| Script | Description |\r\n| :-- | -- |\r\n| mc4-docker-compose.yaml | docker compose file for running relay node and block-producing node locally on mainnet-candidate4, and initialize and register the stakepool |\r\n| mc4-relay1.sh | Run relay node locally on mainnet-candidate4. |\r\n| mc4-producing.sh | Run block-producing node locally on mainnet-candidate4 and initialize and register the it as a stakepool. |\r\n| main-relay1.sh | Run relay node locally on mainnet. |\r\n| main-producing.sh | Run block-producing node on mainnet. |\r\n| main-registration.sh | Run block-producing node on mainnet and initialize and register the it as a stakepool. |\r\n\r\n\r\n## Building locally\r\n\r\nIf you want to make local modifications to these images for development purposes or just to customize the logic.\r\n\r\n```\r\ngit clone https://github.com/abracadaniel/cardano-node-docker.git\r\ncd cardano-node-docker\r\n./build.sh\r\n```\r\n\r\n\r\n## Thank you\r\n\r\nI hope you will find this useful. If you like the work please consider delegating to my pool:\r\n`[ARRA1] Arrakis (c65ca06828caa8fc9b0bb015af93ef71685544c6ed2abbb7c59b0e62)`\r\n\r\nor donating a few ADA to:\r\n`addr1qyfdc9rkw2njpevpene998w93uyghftspnv6muxkwt82tyyjn4up3dddmmul3a5p98996dyd5nhn2mwthwce6rjrp0espmglvg`","has_starred","hub_user","immutable_tags_settings",{"_71":11,"_72":73},"enabled","rules",[74],".*","is_automated","permissions",{"_78":17,"_79":11,"_80":11},"read","write","admin","user","storage_size",3374216460,"orgData","recentTags",[87],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":96,"_46":114,"_115":90,"_116":29,"_117":52,"_53":118,"_119":120,"_121":105,"_122":114,"_123":62,"_124":17},"content_type","creator",240341,"full_size",255509407,"id",111070017,"images",[97],{"_98":99,"_100":101,"_102":103,"_104":105,"_106":107,"_108":109,"_110":103,"_111":-5,"_112":92,"_59":62,"_113":-5},"architecture","amd64","digest","sha256:847e27fcdb5550f20825c56133972e82a95c28ec6d7bfc529ecc51de660839a1","features","","last_pulled","2026-09-23T06:41:11.006629679Z","last_pushed","2020-08-05T21:36:01Z","os","linux","os_features","os_version","size","variant","2020-08-05T21:36:00.170785Z","last_updater","last_updater_username","media_type","latest","repository",9545962,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_34":136,"_143":144,"_132":153,"_154":11},{"_36":137,"_38":138,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":139,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":140,"_75":11,"_76":142,"_81":29,"_82":83},[],[40],[52],{"_71":11,"_72":141},[74],{"_78":17,"_79":11,"_80":11},"tags",{"_145":60,"_146":-5,"_147":-5,"_148":149},"count","next","previous","results",[150],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":151,"_46":114,"_115":90,"_116":29,"_117":52,"_53":118,"_119":120,"_121":105,"_122":114,"_123":62,"_124":17},[152],{"_98":99,"_100":101,"_102":103,"_104":105,"_106":107,"_108":109,"_110":103,"_111":-5,"_112":92,"_59":62,"_113":-5},[],"canDeleteTags","actionData","errors"]

funkypenguin/cardano-node

Tags for funkypenguin/cardano-node