Giter VIP home page Giter VIP logo

dappnodedocs's Introduction

DAppNode

Website dappnode.io Documentation Wiki GIVETH Campaign GitHub All Releases GitPOAP Badge Twitter Follow Discord




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

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.

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.

Check out the 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.

Packages eco-system

The community and core team members have created many useful packages for users. Checkout the package explorer to browse an up-to-date list of all packages and their versions.

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 to suggest a package to be championed and/or offer to be a champion for a project you care about!

Package Champion
Avalanche Wimel
ARTIS-sigma1 -
Bee @tropicar
Bitcoin @Pol-Lanski
Block-explorer -
Cosmos Wimel
DMS @eduadiez
Eth2stats-client -
Ethereum Classic -
Ethereum Optimism -
Exporter @eduadiez
Geth @pablomendezroyo
Goerli Geth @pablomendezroyo
HTTPs Portal @3alpha
Ipfs Cluster @dapplion
Ipfs Pinner @dapplion
Kovan @pablomendezroyo
LightningNetwork @pablomendezroyo
Matrix -
Metrics Tools @eduadiez
Monero @pablomendezroyo
Nethermind @pablomendezroyo
Openethereum @pablomendezroyo
Owncloud @tropicar
Polkadot Kusama -
Prysm @pablomendezroyo
Prysm Pyrmont @pablomendezroyo
Raiden @eduadiez
Raiden Testnet @eduadiez
Rinkeby @pablomendezroyo
Ropsten @pablomendezroyo
Storj @pablomendezroyo
Tornado Cash Relayer -
Trustlines -
Turbo-geth @gnidan
Vipnode -
Wireguard @3alpha
ZCash -

Core packages

Get DAppNode

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

Install DAppNode on your host machine or buy your DAppNode with all the stuff configured and prepared to be used in DAppNode shop

Install DAppNode with ISO

DAppNode ISO available is in: latest DAppNode release.

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:

Developers: DAppNode ISO could be generated following these steps:

git clone https://github.com/dappnode/DAppNode.git
cd DAppNode
docker compose build
docker compose up

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

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

Scripts are available in: latest DAppNode release.

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:

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:

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

3. Uninstall DAppNode

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

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

4. Update DAppNode from scripts

To update DAppNode to the latest version using script:

sudo wget -O - https://installer.dappnode.io | sudo UPDATE=true bash

Releases

Create releases manually with Github actions, the Github action to run is: Pre-release. The requirements are:

  • Introduce the core packages versions
  • There must exist the corresponding core package release for the specified version

The release will contain:

  • Assets:
    • Scripts: dappnode_access_credentials.sh, dappnode_install.sh, dappnode_uninstall.sh, dappnode_install_pre.sh, dappnode_profile.sh
    • ISOs: DAppNode-vX-debian-bullseye-amd64-unattended.iso, DAppNode-vX-debian-bullseye-amd64-unattended.iso
  • Release body:
    • Table with core packages versions
    • Changes section
    • SHASUMs for unattended and attended ISOs
    • Default credentials

Testing with artifacts

Generate ISOs and test them by running the Github action: Artifacts. This action will generate an artifacts with the same assets as the release, useful for testing purposes.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Team members

Members of the White Hat Group (WHG) 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
  • Developer Lead: dapplion
  • Ecosystem Development Pol Lanski
  • Developer: Pablo
  • Developer: Carlos
  • Adviser: Griff Green

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details

Copyright

Copyright © (2018-2023) The DAppNode Association

dappnodedocs's People

Contributors

3alpha avatar alexpeterson91 avatar branciard avatar chuygarcia92 avatar dapplion avatar dappnodedev avatar dappnodedocsbot avatar dependabot[bot] avatar dguerv001 avatar divine-comedian avatar dsimog01 avatar eduadiez avatar franjoespejo avatar haurog avatar igorvasilchikov avatar lodotek avatar lukasschor avatar marketen avatar mateumiralles avatar mgarciate avatar nabsku avatar nixorokish avatar pablomendezroyo avatar pol-lanski avatar scottrepreneur avatar shelpin avatar snider avatar thechim9 avatar tropicar avatar vdo avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

dappnodedocs's Issues

Images appear to be missing on VPS pages

Describe the bug

When opening this page directly:
https://docs.dappnode.io/user-guide/ui/recommended-set-ups/add-vpn-devices/

The images do not show.

From Chrome latest and iOS Safari v15.4

To Reproduce

  1. Click on this link: https://docs.dappnode.io/user-guide/ui/recommended-set-ups/add-vpn-devices/

Expected behaviour

The image should show up correctly.

Screenshots

image

DAppNode version:

  • not relevant -

Additional context

It looks like if you are navigating on the website and coming from another page, the image will show. But if you access the page directly or refresh the page, then the images won't show.

I recommend to use /img/XXXX instead of ../../../img/

You can see from the source that the images src are not consistent. Sometimes it uses ../../../../img and sometimes it uses ../../../img

This image seems to also be impacted:
https://github.com/dappnode/DAppNodeDocs/blob/master/docs/user-guide/ui/access/vpn.md?plain=1#L32

A PR has been created here:
#150

Invalid links for script/ISO on Installation Overview

Describe the bug

Both links to "Installing with a script" and "Installing with an ISO" on the overview page are broken. Links from the menu still work

To Reproduce

  1. Navigate to https://docs.dappnode.io/get-started/installation/custom-hardware/installation/overview/
  2. Click on "Installing with a script" or on "Installing with an ISO"
  3. Page not found error is shown

Expected behavior

Should redirect to the correct pages which work from the menu:

Edit page button redirects to nowhere

Describe the bug

There is an edit page button in the bottom part that redirects to nowhere.

To Reproduce

This button should not be there. People will not edit the docs from UI.

Links missing from doc page

Describe the bug
Missing links.
https://docs.dappnode.io/get-started/user-guide/ui/access/local-proxy
https://docs.dappnode.io/get-started/user-guide/ui/access/vpn#wireguard
https://docs.dappnode.io/get-started/user-guide/ui/access/vpn#openvpn
https://docs.dappnode.io/get-started/user-guide/ui/access/local-proxy

From this page
https://docs.dappnode.io/get-started/installation/custom-hardware/installation/script/

These links are broken.
Local Proxy
Wifi
Wireguard
OpenVPN

To Reproduce

Expected behavior

Doc page should load.

Screenshots

DAppNode version:

  • Package version:
  • OS:
  • Browser

Additional context

New documentation content

Update the content on the new documentation:

  • intro.md Welcome page to documentation
  • get-started section, the introduction

error

Describe the bug

To Reproduce

Expected behavior

Screenshots

DAppNode version:

  • Package version:
  • OS:
  • Browser

Additional context

Update minimum requirements

Describe the bug

See https://discord.com/channels/747647430450741309/755613415677886514/826526779488337931

Someone needs to update the DAppNode Minimum Requirements on this page:
https://dappnode.github.io/DAppNodeDocs/install/
It currently says: "We recommend having at least 4GB RAM (ideally 8GB+) and an SSD hard drive with at least 256GB (add capacity as you like, keep in mind that only Ethereum mainnet is 180GB at press time)." and that is woefully inadequate these days.

Improve way of developing with docker

Currently to develop with the mkdocs repository is needed a wide range of requirements, to speed up this process a docker integration would improve the development process.

Add docs for docker-compose whitelisted keys

Context

When developing a DAppNode package, not all docker-compose keys are supported, there is a parseSafeCompose function in the dappmanagfer that uses whitelisted keys to be used.

Feature request

Consider adding documentation for this whitelisted keys, especially useful for developers.
Take into account this issue dappnode/DNP_DAPPMANAGER#978

How to add ssd in a raspberry

Describe the bug

When a user installs dappnode in raspberry pi and wants to use an SSD, dappnode does not detect it automatically, how to add this SSD is on the documentation in the FAQ sections, but for arm, users are something so basic, it would be a good idea to add this information on the basic installation.

https://docs.dappnode.io

Describe the bug

To Reproduce

Expected behavior

Screenshots

DAppNode version:

  • Package version:
  • OS:
  • Browser

Additional context

​---
​sidebar_position​: ​3
​---

​#​ ​Script Installation

​You can install DAppNode using the installation script. In this case, we recommend you use Ubuntu or Debian as your operating system.

​##​ ​Prerequisites

​Before installing DAppNode, you need to install some prerequisites:

​-​ ​Docker​
​-​ ​Docker-compose​
​-​ ​xz​

​To install all the above prerequisites, execute the command below in the terminal of the machine you want to install DAppNode. If you already have the dependencies installed or you want to install them on your own you can skip this step.

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

​##​ ​Installation

​To install DAppNode, install it executing the next script:

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

​##​ ​Reboot

​To finalize the installation once it has finished completing, reboot your machine:

shutdown -r now

​##​ ​Post-Installation

​Once the installation process has finished, DAppNode will try to automatically prepare the first access to your DAppNode on the next order:

​1.​ ​Local Proxy​
​2.​ ​Wifi​
​3.​ ​Wireguard​
​4.​ ​OpenVPN​

​##​ ​Restore to the latest version from a script

​If you are experiencing any problem or just want to make sure you are running the latest DAppNode versions, execute this command in the DAppNode terminal. This will update the core packages to the latest versions without erasing any data from your volumes.

sudo wget -O - https://installer.dappnode.io | sudo UPDATE=true bash
, , ,

Update the README.md

There is a problem with the dependencies of mkdocs material: ymdown-extensions and markdown. Due to this issue, Pip install the last version of these 2 dependencies, the problem is that version is not compatible with the mkdocs dependencies.

It would be a good idea include in the README.md an easy guide to install. I found the solution on that issue link, it consists of installing the required version which mkdocs-material require avoiding pip install the last and incompatible version.

Document how-to install dappnode ISO attended LVM

Context

Due to the new feature implemented in dappnode to increase the dappnode host filesystem with a storage device, it is necessary to explain how to reinstall dappnode if there was performed a extension whrough LVM

  • In the disk partitions select manual configuration
  • Choose configure LVM
  • Defined all the options available, recommended to delete all LVM

Update the ISO installation guide

The Recommended setup part is outdated. The process now is automatic. Another problems and doubts can appear like:

  • Username/password created by default.
  • Wrong language keyboard configuration.

Describe the solution you'd like
Actualizing the guide with the actual steps you have to follow, inform about de user/password by default.

Issues-Feature

Is your feature request related to a problem? Please describe.

Describe the solution you'd like

Describe alternatives you've considered

Additional context

Setup Telegram bot guide

While the telegram guide to get the bot telegram is ok, we should add a bigger guide with screenshots about the whole process. Then add the link to the UI in the notifications view

bug

Describe the bug

To Reproduce

Expected behavior

Screenshots

DAppNode version:

  • Package version:
  • OS:
  • Browser

Additional context

Broken link on https://docs.dappnode.io/first-steps

Describe the bug
On this link: https://docs.dappnode.io/first-steps
In this line: This configuration can be modified whatever you want. You can find all the information with all the details about this decision in this section.

The word section links to https://docs.dappnode.io/first-steps/first-steps which does not exist.
I think it should link to https://docs.dappnode.io/user-guide/ui/initial-configurations/select-a-client

Add a packages page

It could be a good idea to add a section called "our packages" where we can have an explanation of some packages, what they are or how they work on dappnode. This content would help a lot to the users to understand and follow features how for example the next feature we will release like web3signer + Eth 2.0 client, how it works and what is it and more info.
This content can have more information about more packages.

dap install problem

Describe the bug

To Reproduce

Expected behavior

Screenshots

DAppNode version:

  • Package version:
  • OS:
  • Browser

Additional context

Add content related to basic configuration for DMS package

As long as the DMS package is an important package for the users and the grafana documentation can be overwhelming for users who are not used to working with this kind of program, it could be good to have a dedicated space in the documentation for some grafana configurations.
Some content like this one https://forum.dappnode.io/t/begginer-friendly-install-monitoring-system-on-dappnode-using-dms-package/623
, furthermore, it would be interesting adding more information in order to clarify some behaviour of grafana in dappnode like (dappnode/DAppNodePackage-DMS#30)

Add a more detailed guide about https

Many users have asked about how to expose some endpoints of X package. This is possible to do it manually using the UI, it should be nice to explain this feature in more detail. Currently, we only explain how to use the default ports that are configurated to be exposed.

Custom Hardware link is broken

The "Custom Hardware" link is broken

In the "Custom Hardware" section the "Custom Hardware", https://docs.dappnode.io/get-started/installation/introduction/introduction, link on the "Introduction" page, https://docs.dappnode.io/get-started/installation/introduction, and it yeilds:

"Oh oh... You probably weren't looking for this.
We've changed the documentation to serve you better and we might have broken this link.

If you got here following one of our links, please report the broken link here.

Back to homepage"

Also in the "Arm Hardware" section the "Custom Hardware", https://docs.dappnode.io/get-started/installation/introduction/arm-hardware/hardware-recommendations, yields the same 404 as above.

To Reproduce

  1. Click on https://docs.dappnode.io/get-started/installation/introduction/introduction

or

  1. Click on https://docs.dappnode.io/get-started/installation/introduction/arm-hardware/hardware-recommendations

Expected behavior

Both should go to the real "Custom Hardware" page

Failure to find Installation Guide on the website

Hi, Dappnode community!

I came across your project and was going to install and test it locally when I sadly discovered that the links on your webpage regarding installation instructions (both with script and ISO) are not working

Screenshot 2021-12-16 at 17 32 18

Thank you for your time

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.