Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #635

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
99 changes: 27 additions & 72 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# DAppNode
# Dappnode

[![Website dappnode.io](https://img.shields.io/badge/Website-dappnode.io-brightgreen.svg)](https://dappnode.io/)
[![Documentation Wiki](https://img.shields.io/badge/Documentation-Wiki-brightgreen.svg)](https://docs.dappnode.io)
Expand All @@ -13,7 +13,7 @@
<br/>
<p align="center">
<a href="https://dappnode.com/">
<img width="800" src="doc/DAppNodeLogoWide-outlined.png">
<img width="800" src="doc/DappnodeLogoWide-outlined.png">
</a>
</p>
<br/>
Expand All @@ -26,30 +26,30 @@

## Infrastructure for the decentralized world

DAppNode is empowering people by creating a simple, transparent system for hosting P2P clients for DApps, Cryptocurrencies, VPNs, IPFS and more
Dappnode is empowering people by creating a simple, transparent system for hosting P2P clients for DApps, Cryptocurrencies, VPNs, IPFS and more

- Read about our purpose and mission on [Our Website](https://dappnode.com/)
- Join our community and find support on [Our Discord](https://discord.gg/dappnode)
- Check out what we are up to on [Our Medium](https://medium.com/dappnode)
- Share your ideas and find how to guides on [Our Forum](https://discourse.dappnode.io/)

## Discover DAppNode
## Discover Dappnode

DAppNode lowers the barrier of entry for non tech-savvy participants. It allows you to deploy, update, and manage P2P clients and nodes without leaving your browser. No terminal or command line interface.
Dappnode lowers the barrier of entry for non tech-savvy participants. It allows you to deploy, update, and manage P2P clients and nodes without leaving your browser. No terminal or command line interface.

<p align="center">
<a href="https://docs.dappnode.io/user/quick-start/Core/installation">
<img width="800" src="doc/DAppNodeAdminUI-demo.png">
</a>
</p>

## Develop with DAppNode
## Develop with Dappnode

DAppNode modular architecture allows any team to or project to publish a dockerized application to the DAppNode packages eco-system. Benefit from an enthusiastic crypto savvy user based and offer a user interface-only experience to lower onboarding friction.
Dappnode modular architecture allows any team to or project to publish a dockerized application to the Dappnode packages eco-system. Benefit from an enthusiastic crypto savvy user based and offer a user interface-only experience to lower onboarding friction.

Check out the [DAppNodeSDK](https://github.com/dappnode/DAppNodeSDK) to learn how to get started.
Check out the [DappnodeSDK](https://github.com/dappnode/DAppNodeSDK) to learn how to get started.

_Note: packages are published to Ethereum mainnet and incur costs. Given the current high gas prices the DAppNode team is willing to subsidize gas costs for packages of great interest to users._
_Note: packages are published to Ethereum mainnet and incur costs. Given the current high gas prices the Dappnode team is willing to subsidize gas costs for packages of great interest to users._

## Packages eco-system

Expand All @@ -61,51 +61,6 @@ The community and core team members have created many useful packages for users.
</a>
</p>

### Champions

Champions are community members that are in charge of maintaining packages: keeping them updated and working. All packages in this list without a champion are actively looking for a champion. Join our [DAppNode Discord **#champion-process**](https://discord.gg/dappnode) to suggest a package to be championed and/or offer to be a champion for a project you care about!

| Package | Champion |
| ---------------------------------------------------------------------------------------- | ---------------- |
| [Avalanche](https://github.com/Colm3na/DAppNodePackage-avalanche) | Wimel |
| [ARTIS-sigma1](https://github.com/lab10-coop/DAppNodePackage-ARTIS-sigma1) | - |
| [Bee](https://github.com/dappnode/DAppNodePackage-bee) | @tropicar |
| [Bitcoin](https://github.com/dappnode/DAppNodePackage-bitcoin) | @Pol-Lanski |
| [Block-explorer](https://github.com/dappnode/DappnodePackage-block-explorer) | - |
| [Cosmos](https://github.com/Colm3na/DAppNodePackage-cosmos) | Wimel |
| [DMS](https://github.com/dappnode/DAppNodePackage-DMS) | @eduadiez |
| [Eth2stats-client](https://github.com/dappnode/DAppNodePackage-eth2stats-client) | - |
| [Ethereum Classic](https://github.com/dappnode/DAppNodePackage-ethereum-classic) | - |
| [Ethereum Optimism](https://github.com/dappnode/DAppNodePackage-ethereum-optimism) | - |
| [Exporter](https://github.com/dappnode/DAppNodePackage-exporter) | @eduadiez |
| [Geth](https://github.com/dappnode/DAppNodePackage-geth) | @pablomendezroyo |
| [Goerli Geth](https://github.com/dappnode/DAppNodePackage-goerli-geth) | @pablomendezroyo |
| [HTTPs Portal](https://github.com/dappnode/DAppNodePackage-https-portal) | @3alpha |
| [Ipfs Cluster](https://github.com/dappnode/DAppNodePackage-ipfs-cluster) | @dapplion |
| [Ipfs Pinner](https://github.com/dappnode/DAppNodePackage-ipfs-pinner) | @dapplion |
| [Kovan](https://github.com/dappnode/DAppNodePackage-kovan) | @pablomendezroyo |
| [LightningNetwork](https://github.com/dappnode/DAppNodePackage-LightningNetwork) | @pablomendezroyo |
| [Matrix](https://github.com/dappnode/DAppNodePackage-matrix) | - |
| [Metrics Tools](https://github.com/dappnode/DAppNodePackage-metrics-tools) | @eduadiez |
| [Monero](https://github.com/dappnode/DAppNodePackage-monero) | @pablomendezroyo |
| [Nethermind](https://github.com/dappnode/DAppNodePackage-nethermind) | @pablomendezroyo |
| [Openethereum](https://github.com/dappnode/DAppNodePackage-openethereum) | @pablomendezroyo |
| [Owncloud](https://github.com/dappnode/DAppNodePackage-owncloud) | @tropicar |
| Polkadot Kusama | - |
| [Prysm](https://github.com/dappnode/DAppNodePackage-prysm) | @pablomendezroyo |
| [Prysm Pyrmont](https://github.com/dappnode/DAppNodePackage-prysm-pyrmont) | @pablomendezroyo |
| [Raiden](https://github.com/dappnode/DAppNodePackage-raiden) | @eduadiez |
| [Raiden Testnet](https://github.com/dappnode/DAppnodePackage-raiden-testnet) | @eduadiez |
| [Rinkeby](https://github.com/dappnode/DAppNodePackage-rinkeby) | @pablomendezroyo |
| [Ropsten](https://github.com/dappnode/DAppNodePackage-ropsten) | @pablomendezroyo |
| [Storj](https://github.com/dappnode/DAppNodePackage-storj) | @pablomendezroyo |
| [Tornado Cash Relayer](https://github.com/dappnode/DAppNodePackage-Tornado-Cash-Relayer) | - |
| [Trustlines](https://github.com/dappnode/DAppNodePackage-trustlines) | - |
| [Turbo-geth](https://github.com/dappnode/DAppNodePackage-turbo-geth) | @gnidan |
| [Vipnode](https://github.com/dappnode/DAppNodePackage-vipnode) | - |
| [Wireguard](https://github.com/dappnode/DAppNodePackage-wireguard) | @3alpha |
| [ZCash](https://github.com/dappnode/DAppNodePackage-zcash) | - |

## Core packages

- [DNP_DAPPMANAGER](https://github.com/dappnode/DNP_DAPPMANAGER)
Expand All @@ -115,23 +70,23 @@ Champions are community members that are in charge of maintaining packages: keep
- [DNP_WIREGUARD](https://github.com/dappnode/DNP_WIREGUARD)
- [DNP_HTTPS](https://github.com/dappnode/DNP_HTTPS)

## Get DAppNode
## Get Dappnode

Get your DAppNode and start contributing to decentralization by running your own nodes.
Get your Dappnode and start contributing to decentralization by running your own nodes.

[Install DAppNode on your host machine](https://docs.dappnode.io/user/quick-start/Core/installation) or buy your DAppNode with all the stuff configured and prepared to be used in [DAppNode shop](https://dappnode.com/en-us/collections/frontpage)
[Install Dappnode on your host machine](https://docs.dappnode.io/user/quick-start/Core/installation) or buy your Dappnode with all the stuff configured and prepared to be used in [Dappnode shop](https://dappnode.com/en-us/collections/frontpage)

### Install DAppNode with ISO
### Install Dappnode with ISO

DAppNode ISO available is in: [latest DAppNode release](https://github.com/dappnode/DAppNode/releases).
Dappnode ISO available is in: [latest Dappnode release](https://github.com/dappnode/DAppNode/releases).

Install DAppNode on your host machine by burning DAppNode ISO to a DVD or creating a bootable USB. Follow the tutorial of your operating system below and come back when you are finished:
Install Dappnode on your host machine by burning Dappnode ISO to a DVD or creating a bootable USB. Follow the tutorial of your operating system below and come back when you are finished:

- [MacOS](https://tutorials.ubuntu.com/tutorial/tutorial-create-a-usb-stick-on-macos)
- [Windows](https://tutorials.ubuntu.com/tutorial/tutorial-create-a-usb-stick-on-windows)
- [Ubuntu](https://tutorials.ubuntu.com/tutorial/tutorial-create-a-usb-stick-on-ubuntu)

**Developers**: DAppNode ISO could be generated following these steps:
**Developers**: Dappnode ISO could be generated following these steps:

```bash
git clone https://github.com/dappnode/DAppNode.git
Expand All @@ -140,47 +95,47 @@ docker compose build
docker compose up
```

DAppNode iso will be generated inside images folder, to verify it:
Dappnode iso will be generated inside images folder, to verify it:

```bash
ls -lrt images/DAppNode-*
```

_Note_: ISO could be generated as unattended/attended by editing the env var available in the docker-compose.yml file

### Install DAppNode with scripts
### Install Dappnode with scripts

Scripts are available in: [latest DAppNode release](https://github.com/dappnode/DAppNode/releases).
Scripts are available in: [latest Dappnode release](https://github.com/dappnode/DAppNode/releases).

DAppNode could be also installed on a host machine with an OS already running on it. DAppNode has been developed and configured to be run on Debian host machines. Therefore, it should work on Debian or Debian based (like Ubuntu) host machines. Minimum recommended Debian version is 11.
Dappnode could be also installed on a host machine with an OS already running on it. Dappnode has been developed and configured to be run on Debian host machines. Therefore, it should work on Debian or Debian based (like Ubuntu) host machines. Minimum recommended Debian version is 11.

**1. Prerequisites**

Before installing DAppNode with the script option, make sure you fulfill the requirements by running the following script:
Before installing Dappnode with the script option, make sure you fulfill the requirements by running the following script:

```bash
sudo wget -O - https://prerequisites.dappnode.io | sudo bash
```

**2. Script installation**

Once you make sure you have the requirements, install DAPpNode with the installation script:
Once you make sure you have the requirements, install Dappnode with the installation script:

```bash
sudo wget -O - https://installer.dappnode.io | sudo bash
```

**3. Uninstall DAppNode**
**3. Uninstall Dappnode**

Uninstall DAppNode from your host machine by running the following command:
Uninstall Dappnode from your host machine by running the following command:

```bash
wget -qO - https://uninstaller.dappnode.io | sudo bash
```

**4. Update DAppNode from scripts**
**4. Update Dappnode from scripts**

To update DAppNode to the latest version using script:
To update Dappnode to the latest version using script:

```bash
sudo wget -O - https://installer.dappnode.io | sudo UPDATE=true bash
Expand Down Expand Up @@ -214,7 +169,7 @@ We use [SemVer](http://semver.org/) for versioning. For the versions available,

## Team members

Members of the [White Hat Group (WHG)](https://motherboard.vice.com/en_us/article/qvp5b3/how-ethereum-coders-hacked-back-to-rescue-dollar208-million-in-ethereum) have spent countless hours bootstrapping and developing DAppNode in 2017. Currently, the project is maintained by a growing multi-disciplinary team:
Members of the [White Hat Group (WHG)](https://motherboard.vice.com/en_us/article/qvp5b3/how-ethereum-coders-hacked-back-to-rescue-dollar208-million-in-ethereum) have spent countless hours bootstrapping and developing Dappnode in 2017. Currently, the project is maintained by a growing multi-disciplinary team:

- **Adviser & Instigator:** Jordi Baylina
- **Project Lead:** Eduadiez
Expand Down
Binary file removed doc/DAppNodeLogoWide-outlined.png
Binary file not shown.
Binary file added doc/DappnodeLogoWide-outlined.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 0 additions & 5 deletions funding.json

This file was deleted.

Loading