{"id":24054645,"url":"https://github.com/cardinal-cryptography/aleph-node-runner","last_synced_at":"2025-04-22T21:02:20.085Z","repository":{"id":45388613,"uuid":"491186585","full_name":"Cardinal-Cryptography/aleph-node-runner","owner":"Cardinal-Cryptography","description":null,"archived":false,"fork":false,"pushed_at":"2025-03-24T10:12:10.000Z","size":1225,"stargazers_count":12,"open_issues_count":5,"forks_count":11,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-29T18:41:36.829Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Cardinal-Cryptography.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-05-11T16:17:01.000Z","updated_at":"2025-03-24T10:12:14.000Z","dependencies_parsed_at":"2023-10-03T04:37:42.880Z","dependency_job_id":"c1191b84-6c3c-40d1-97f1-2a4cdde7b3d8","html_url":"https://github.com/Cardinal-Cryptography/aleph-node-runner","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cardinal-Cryptography%2Faleph-node-runner","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cardinal-Cryptography%2Faleph-node-runner/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cardinal-Cryptography%2Faleph-node-runner/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cardinal-Cryptography%2Faleph-node-runner/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Cardinal-Cryptography","download_url":"https://codeload.github.com/Cardinal-Cryptography/aleph-node-runner/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250324681,"owners_count":21411943,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-01-09T03:49:13.613Z","updated_at":"2025-04-22T21:02:19.982Z","avatar_url":"https://github.com/Cardinal-Cryptography.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Aleph Node Runner\n\nA convenience wrapper for running a node, using the Aleph Node docker image under the hood.\n\nNote that this tool always maintains the latest versions for Testnet and Mainnet (and auto-updates itself). **There should never be a reason to have it on anything else than the latest `main` branch commit.**\n\n## Prerequisites\n\nYou will need `docker` and `wget`. If you are using Linux, we recommend that you add your user to the `docker` group so that using `docker` doesn’t require sudo access. You can find the instructions [here](https://docs.docker.com/engine/install/linux-postinstall/).\n\nClone the repo at https://github.com/Cardinal-Cryptography/aleph-node-runner:\n\n```bash\ngit clone [https://github.com/Cardinal-Cryptography/aleph-node](https://github.com/Cardinal-Cryptography/aleph-node-runner)\ncd aleph-node-runner\n```\n\n## Setup and running\n\nOnce inside the `aleph-node-runner` folder, run:\n\n```bash\n./run_node.sh --name \u003cyour_nodes_name\u003e --ip \u003cyour IP\u003e\n```\n\nIt might take quite some time before you actually get the node running: the script will first download required files, including a database snapshot (sized ~100GB). You can alternatively skip this step by providing the `--sync_from_genesis` flag (see the 'Additional Options' section). The script will then run the node for you and you should start seeing some block-related output.\n\n\u003e 💡 The choice of \u003ccode\u003eyour_nodes_name\u003c/code\u003e is entirely up to you but for the sake of more comprehensible logs please try using something unique and memorable.\n\n\u003e 💡 Instead of `--ip`,you can provide a domain by using `--dns`.\n\n## Running as an archivist\n\nThe default is to run the node as a validator. Should you choose to run as an archivist instead, you need to supply the `--archivist` flag:\n\n```bash\n./run_node.sh --archivist --name \u003cyour_nodes_name\u003e\n```\n\n\u003e 💡 To run as an archivist, you will need additional network config [TODO].\n\n## Additional options\n\nThe script allows you to customize the run in several ways, as listed below:\n\n* `--ip`: your public IP (this or `--dns` is required)\n* `--dns`: your public domain address (this or `--ip` is required)\n* `--data_dir`: specify the directory in which all of the chain data will be stored (defaults to `~/.alephzero`)\n* `--mainnet`: join the Aleph Mainnet instead of the default Testnet\n* `--keep_containers`: don't stop or remove existing `aleph-node` containers (by default the script does that to ensure minimal downtime) \n* `--sync_from_genesis`: by providing this option, you're choosing not to download and use a DB snapshot, but rather perform a full sync\n* `--build_only`: the script will only download and setup everything but will not actually run the binary in case you don't want to join the network yet\n* `--archivist`: (as described above) run the node as an archivist instead of a validator\n* `--name`: (as described above) set the name of the node. If you omit this option, one will be generated for you but it's not encouraged.\n* `--version`: manually override the version to run. It can be either a git tag like `r-12.1` or a git short commit hash like `ae34eb4213`.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcardinal-cryptography%2Faleph-node-runner","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcardinal-cryptography%2Faleph-node-runner","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcardinal-cryptography%2Faleph-node-runner/lists"}