mynode/README.md

180 lines
8.8 KiB
Markdown
Raw Permalink Normal View History

2023-12-01 22:06:57 +00:00
[![MyNode](https://mynodebtc.github.io/images/logo.png)](https://github.com/mynodebtc/mynode)
2021-02-17 05:30:37 +00:00
[![Version](https://img.shields.io/github/v/tag/mynodebtc/mynode?label=version&color=green)](https://github.com/mynodebtc/mynode/tag)
[![Community Chat](https://img.shields.io/badge/community%20chat-telegram-blue)](https://t.me/mynode_btc)
[![Twitter](https://img.shields.io/twitter/follow/mynodebtc?style=social)](https://twitter.com/mynodebtc)
2022-08-20 03:19:50 +00:00
# Bitcoin, Lightning, and more!
2023-12-01 22:06:57 +00:00
MyNode aims to be the easiest way to run a dedicated, easy to use, Bitcoin Node and Lightning Wallet!
2022-08-20 03:19:50 +00:00
We combine the best open source software with our interface, management, and support so you can easily, privately, and securely use Bitcoin and Lightning.
2019-06-16 02:40:06 +00:00
Website: https://mynodebtc.com
2019-09-25 03:13:05 +00:00
2021-02-17 05:30:37 +00:00
## User Interface
2022-08-22 23:10:21 +00:00
<img src="images/ui_dual_mode.png" width="600">
2019-06-16 02:40:06 +00:00
## Overview
2023-12-01 22:06:57 +00:00
MyNode is a platform that provides uptime, reliability, ease-of-use and a huge variety of applications! By integrating a number of Bitcoin-related open source projects, it provides access to Bitcoin and Lightning along with a number of other features.
2019-06-16 02:40:06 +00:00
2023-12-01 22:06:57 +00:00
By running Bitcoin and Lightning on your MyNode device, you maintain all the security and privacy originally intended in the Bitcoin protocol. Your transactions are verified by your local node, removing the need to trust online 3rd parties for spending or verifying funds.
2019-06-16 02:40:06 +00:00
2023-12-01 22:06:57 +00:00
## MyNode Premium
MyNode offers premium support, simplified upgrades and more! If you are running MyNode Community Edition and want one-click upgrades or you want to purchase a supported, high quality device, please visit mynodebtc.com.
2019-06-16 02:40:06 +00:00
2019-06-16 03:05:16 +00:00
Upgrade now or purchase a device at:<br/>
2019-07-23 16:13:35 +00:00
https://mynodebtc.com/order_now
2019-06-16 02:46:37 +00:00
<b>Devices - Model One and Model Two</b>
2019-06-16 03:05:16 +00:00
<br/>
2022-12-29 04:29:13 +00:00
<img src="images/devices.png" width="600">
2019-06-16 03:05:16 +00:00
2019-06-16 03:12:26 +00:00
## Features
2023-12-01 22:06:57 +00:00
Each MyNode device comes with a number of wonderful features.
2019-06-16 03:12:26 +00:00
2022-08-22 23:01:28 +00:00
<img src="images/app_icons.png" width="600">
2022-08-22 22:34:00 +00:00
<!--
2021-05-21 03:57:57 +00:00
- Bitcoin Node
- Lightning Node
- Electrum Server
- BTCPay Server
- RTL (Ride the Lightning) - Lightning Wallet
- Specter Desktop
2021-05-21 03:57:57 +00:00
- Thunderhub
- BTC RPC Explorer
2021-12-29 18:53:46 +00:00
- Mempool - Mempool local visualizer for the Bitcoin blockchain
2021-05-21 03:57:57 +00:00
- LND Hub - Lightning Wallet Server
- Lndmanage
- Lightning Loop - A Non-Custodial Off/On Chain Bridge
- Lightning Pool - A Non-Custodial auction for liquidity where bids are kept private and trades clear periodically
2021-12-29 18:53:46 +00:00
- Lightning Terminal
- LNBits
2021-05-21 03:57:57 +00:00
- Caravan
2021-12-29 18:53:46 +00:00
- Warden Terminal
- PyBlock
- Lndmanage
- Tor
2021-12-29 18:53:46 +00:00
- JoininBox / JoinMarket
2021-05-21 03:57:57 +00:00
- LND Connect - Generate QR Codes for connecting wallets
2020-02-14 00:50:50 +00:00
- Virtual Machine support (OVA file: VirtualBox, VMWare)
2021-05-21 03:57:57 +00:00
- VPN for Remote Access
2019-06-16 03:12:26 +00:00
- Bitcoin CLI
- QuickSync - Quickly sync Bitcoin blockchain
- LN Channel Backup
2021-05-21 03:57:57 +00:00
- Docker support (containers inside: Netdata Monitor, Glances, WebSSH2 (Linux Terminal), BTCPay Server)
- Simple UI / Web Interface
2019-12-11 02:32:25 +00:00
- Dark Mode interface
2019-06-16 03:12:26 +00:00
- Dedicated hardware keeps you constantly and securely connected!
2022-08-22 22:34:00 +00:00
-->
2019-06-16 03:12:26 +00:00
2023-12-01 22:06:57 +00:00
## Running MyNode
You can run MyNode on your own device in just a few easy steps!
2019-06-18 02:34:38 +00:00
1. Download an Image
2019-08-17 02:16:38 +00:00
* [Downloads](https://mynodebtc.com/download)
2019-06-18 02:34:38 +00:00
2. Flash Image onto SD Card
2019-07-23 16:11:59 +00:00
* Download [Etcher](https://www.balena.io/etcher/)
2019-06-18 02:37:11 +00:00
* Flash Downloaded Image
3. Insert SD Card, connect ethernet cable to router, and Boot your Device
2022-08-20 02:48:28 +00:00
4. Attach External Drive to Device
2019-08-13 03:29:53 +00:00
* 1TB+ Required
5. Visit http://mynode.local/ or http://ip_of_device/
2022-08-20 03:19:50 +00:00
## Supported Devices
2022-08-22 23:01:28 +00:00
We currently have images for the following devices available for download.
2022-08-20 03:19:50 +00:00
- Raspberry Pi 4
- RockPro64
- Rock Pi 4
- PCs and Servers
- Virtual Machine Support (VirtualBox, VMWare)
2023-12-01 22:06:57 +00:00
## Upgrading your MyNode
Once you are running MyNode, you can easily [update the software](https://mynodebtc.github.io/device/upgrading-device.html) yourself!
2022-08-20 02:48:28 +00:00
2023-12-01 22:06:57 +00:00
## Developing for MyNode
2022-08-22 22:32:19 +00:00
2023-12-01 22:06:57 +00:00
### Developing the MyNode Platform
2022-08-20 02:48:28 +00:00
See the [development guide](https://github.com/mynodebtc/mynode/blob/master/doc/development.md).
2023-12-01 22:06:57 +00:00
### Adding new Applications to MyNode
To develop and add new applications to MyNode, check out the [Software Development Kit (SDK)](https://github.com/mynodebtc/mynode_sdk).
2022-08-20 02:48:28 +00:00
## Install on Existing System (beta)
To setup a new device on a supported platform that is already running Linux (Raspi4, RockPi 4, RockPro64, PC, ...), you can run two simple commands.
2022-08-01 02:12:23 +00:00
2023-02-01 01:03:56 +00:00
First, install Debian - last tested with the Debian 10.11 (Buster) images.
2022-08-01 02:12:23 +00:00
Second, login and run these two commands.
```
2023-08-12 16:23:10 +00:00
wget https://raw.githubusercontent.com/mynodebtc/mynode/latest_release/setup/setup_device.sh -O mynode_setup.sh
sudo bash ./mynode_setup.sh online
```
2023-12-01 22:06:57 +00:00
Once the script successfully completed, reboot and you will be running MyNode!
2019-06-16 03:22:41 +00:00
## Screenshots
2022-08-22 23:21:14 +00:00
<img src="images/ui.png" width="600">
2022-08-22 23:20:47 +00:00
--------------------
2021-06-17 04:52:48 +00:00
<img src="images/2.png" width="600">
2019-07-23 19:17:39 +00:00
--------------------
2021-06-17 04:52:48 +00:00
<img src="images/3.png" width="600">
2019-07-23 19:17:39 +00:00
--------------------
2021-06-17 04:52:48 +00:00
2022-08-22 23:32:50 +00:00
<img src="images/marketplace.png" width="600">
2021-06-17 04:52:48 +00:00
2019-07-23 19:17:39 +00:00
--------------------
2021-06-17 04:52:48 +00:00
<img src="images/6.png" width="600">
2019-06-16 03:22:41 +00:00
2019-06-16 03:27:55 +00:00
## What is Bitcoin?
Bitcoin is a unique form of digital money that enables users to send money over the Internet securely without the need for banks or other 3rd parties. This enables anyone with Internet access the ability to participate in the global economy no matter where they live - anywhere from rural Africa to Venezuela to Antarctica to space!
Bitcoin is also unique in that it is deflationary and only has a finite amount of Bitcoin that will ever exist - 21 million. This is similar to land or other valuable natural resources that are limited in their supply. This limited supply is based on computer software algorithms built into the Bitcoin protocol. No person, company, or government can change that limit. This makes Bitcoin valuable to many people who want to save money.
2021-07-18 21:18:35 +00:00
The Lightning Network is another layer on top of Bitcoin, speeding up the rate at which Bitcoin can be sent. Bitcoin transactions are very secure, but can take time to fully confirm. The Lightning Network allows people to send Bitcoin back and forth without the need to wait for each transaction to be included in a Bitcoin block.
2019-06-16 03:27:55 +00:00
There is much more to Bitcoin and the Lighting Network than is mentioned here. For more information, start with these links.
<a href="https://www.upfolio.com/ultimate-bitcoin-guide">Ultimate Bitcoin Guide</a>
<a href="https://medium.freecodecamp.org/explain-bitcoin-like-im-five-73b4257ac833">Explain Bitcoin Like Im Five</a>
<a href="https://www.lopp.net/bitcoin-information.html">Bitcoin Information</a>
## Security
2023-12-01 22:06:57 +00:00
There are many reasons to run a Bitcoin Node. It helps keep the Bitcoin network secure and reduces the trust you are giving others when using 3rd party Bitcoin Explorers or Bitcoin Light Wallet servers. They can track you or give you false information, reducing your security and privacy. A “full node”, like the Bitcoin node running on your MyNode device, personally validates all blocks in the Bitcoin blockchain making sure your Bitcoin transactions and Lightning network use is built on the strongest, most trusted foundation possible.
2019-06-16 03:27:55 +00:00
2023-12-01 22:06:57 +00:00
By using MyNode for your Lightning Wallet, Bitcoin Wallet, and Block Explorer, you no longer have to trust others to give you the correct information! This increases your security when protecting your valuable assets.
2019-06-16 03:27:55 +00:00
2023-12-01 22:06:57 +00:00
Please note, MyNode is not responsible for any lost funds while using your device. We have taken significant measures to protect your assets by securing MyNode, but lightning wallets are meant to be online and used for spending where risks are greater. Please do your own research into Bitcoin and the Lightning Network before investing in cryptocurrency.
2019-06-16 03:27:55 +00:00
For long term storage of cryptocurrency assets, please consider using a hardware wallet, like a Ledger or Trezor.
2020-01-20 14:59:44 +00:00
## Community
2023-12-01 22:06:57 +00:00
MyNode has a wonderful, helpful community that assists with development and support. It would be impossible to run this project without their involvement and support! The effort they put in to make this, and all Bitcoin projects, a success is truly appreciated.
2021-07-18 21:18:35 +00:00
## Bounties
2023-12-01 22:06:57 +00:00
It takes a lot of work to add new features and maintain MyNode. In order to provide desired features, improve documentation, and help provide the best product possible, some new features and improvements have bounties associsated with them. If anyone in the community would like to implement improvements, they can claim the bounty.
2021-07-18 21:18:35 +00:00
[Bounty List](https://github.com/mynodebtc/mynode/blob/master/doc/bounties.md)
2020-01-20 14:59:44 +00:00
## License
2023-12-01 22:06:57 +00:00
The primary MyNode License is a variation of CC BY-NC-ND 4.0 with some modifications in Section 9.
2023-12-01 22:06:57 +00:00
This license applies to the MyNode platform, but each application likely has its own license and code to integrate each application to MyNode uses the LGPL v3.0. Code to add applications can be stored under `./rootfs/standard/usr/share/mynode_apps/` and uses the License file at `./rootfs/standard/usr/share/mynode_apps/LICENSE.md`.
2021-07-18 21:18:35 +00:00
## Responsible Disclosure
Found any critical bugs or vulnerabilities? Please send us an email at admin@mynodebtc.com. Thanks!