Bitcoin Knots for StartOS

This project packages Bitcoin Knots for StartOS.

By using Knots, you’re supporting a version of Bitcoin that prioritizes efficiency, security, and flexibility. With Bitcoin Knots’ enhanced configuration options, you can fine-tune your node to help keep the network clean and resilient, actively reducing unnecessary load from spam or parasitic transactions.

Every node strengthens the Bitcoin network, and your decision to use Bitcoin Knots contributes directly to a more decentralized and spam-resistant ecosystem. Your node not only validates and secures transactions but also sets an example for a more sustainable, user-focused Bitcoin network.

Welcome to the community of Bitcoin Knots users, and thank you for helping Bitcoin grow stronger!

Contributing

We welcome contributions from all!

For non-technical contributors, please use the Issues section above to communicate your desired edits or additions.

For technical contributors, please fork this repository, make your changes according to the instructions below, and open a pull reuqest.

Adding Config Options

To add config options, include the new config options in both scripts/services/getConfig.ts and assets/compat/bitcoin.conf.template, adhering to the syntax and conventions of those files. To view the full list of config options, complete with descriptions and specifications, check out this site.

Dependencies

Install the following system dependencies to build this project by following the instructions on the provided links:

• docker
• docker-buildx
• rust-musl-cross
• yq
• rust
• start-sdk
• make

Cloning

Clone the project locally. Note the submodule link to the original project(s).

git clone https://github.com/Retropex/knots-startos.git
cd knots-startos
git submodule update --init

Building

To build the project for all supported platforms, run the following command:

make

To build the project for a single platform, run:

# for amd64
make x86

or

# for arm64
make arm

Installing (on Start9 server)

Run the following commands to determine successful install:

ℹ️ Change server-name.local to your Start9 server address

start-cli auth login
# Enter your StartOS password
start-cli --host https://server-name.local package install bitcoind.s9pk

If you already have your start-cli config file setup with a default host, you can install simply by running:

make install

Tip: You can also install the bitcoind.s9pk using Sideload Service under the System > Manage section.

Integrations

Our documentation includes guides for integrating Bitcoin with external applications.