stacks-network / stacks-network/docs

Wishlist: Step by step tutorial to run a stacks node (w/o docker) - and/or single click install options #151

Open
#1,712 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
JavaScript
Stars
185
Forks
273
Avg merge
4d 13h
Merged PRs (30d)
4

Description

coping from: https://github.com/stacksgov/sips/issues/151

@314159265359879

Questions like this are asked now and again.

image

I used to run a stacks node on a couple of low-power cleanly installed Windows PC's, https://docs.stacks.co. The previous tutorial would explain the minute steps to install all the dependencies, download the stacks node software and then the command to run it.

That info is no longer available. If you search for "run stacks node" we find:
image
https://docs.stacks.co/docs/nodes-and-miners/run-a-node

  1. Is running it in docker mandatory or can users still take steps to run it on Linux, Windows or MacOS without? If that is still possible I would love to see those step by steps. If not feel free to explain why that is, or why perhaps it is not recommended. We can let users know when we see the questions come up again. @wileyj

  2. I think it would be great if it is super easy for users to install the node software with a single click, is there any chance of that, creating an executable that installs the dependencies and then runs the node?

  3. Users already running a bitcoin node with Umbrel have shown an interest to run a Stacks node alongside on their Raspberry Pi. The Umbrel store has recently added the option to add apps from "community app stores", could the Stacks Foundation run such a store with an option to install the Stacks node?
    image

Sidenote: Perhaps lnswap app can be added in the same store, it wasn't accepted in the official store https://github.com/getumbrel/umbrel/pull/1315#event-9355865771

  1. Running just the follower node on a low-power PC should be okay now. Would that change with the Nakamoto release, when more throughput is expected?
    What about if you want to run it with an API database/server and a local explorer? If even that is possible, those could be add-ons in the Umbrel store, perhaps? In any case, I would love to see guides on how users can independently verify the chain if they want to.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the existing nodes-and-miners/run-a-node documentation and compare it with the older installation steps referenced in the issue. Determine which non-Docker platforms and Raspberry Pi setups are supported, including resource requirements and API or explorer combinations. Done means publishing clear platform guidance or documenting why unsupported installation and Umbrel options are not recommended.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, linux, macos, raspberry-pi
Domain
blockchain, devops, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.