The DNP_DAPPMANAGER handles the Dappnode core DNPs and any user installed DNPs. It also performs maintenance checks.

• 👤 For user / usage documentation go to the user guide
• 🔧 For developers check the technical documentation
• 💬 For feedback and reporting problems please submit an issue or contact us on Discord

It is an AragonApp whose repo is deployed at this address: 0x0c564ca7b948008fb324268d8baedaeb1bd47bce and whose ENS address is: dappmanager.dnp.dappnode.eth

Getting Started

This repo is a single piece of Dappnode. To install and use Dappnode go to the installation guide.

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

You must have git, docker, and docker-compose in your environment to run this repo. To verify these are installed properly, run the following commands.

git --version
docker --version
docker-compose --version

Go to the installation overview in our documentation for more information.

Installing

1. To get started, clone the project locally.

   $ git clone https://github.com/dappnode/DNP_DAPPMANAGER.git

2. Use node 20 or higher to run the project.

   $ nvm use 20

3. Install yarn globally.

   $ npm install -g yarn

4. Enable corepack and set yarn version berry

   $ corepack enable && yarn set version berry

5. Install the dependencies

   $ yarn

6. Build the project

   $ yarn build

The DNP_DAPPMANAGER expects to be in a Dappnode network to connect to its WAMP module, Ethereum node and IPFS node. If you wish to use a different providers for such services you can edit their urls in the packages/params/src/params.ts file.

Developing

There are 4 different developing modes:

1. Standalone UI: this mode allows developers to have a standalone UI with basic functionality, to develop and test UI elements without connecting to a DAppNode or a mock server. This is a fully static site that will be deployed to Netlify on every PR to speed up the reviewing process of PRs.

Netlify settings:

• Production branch: master
• Other branches: v... (e.g v0.2.41)

Netlify will deploy a static site on every PR against the mentioned PRs

cd packages/admin-ui
yarn mock-standalone

2. Server mock: this mode allows to simulate backend situations, such as cookies and sessions, alerts, or notifications. You should run the UI devserver and a mock backend server with:

cd packages/admin-ui
yarn server-mock

cd packages/admin-ui
yarn mock

3. Actual DAPPMANAGER: this mode will connect to your Dappnode's actual DAPPMANAGER, useful to develop and test functionality OS dependant such as the SSH manager, host password manager, etc. You must be connected to your Dappnode via VPN or WiFi.

cd packages/admin-ui
yarn start

Note: This mode is not working a the moment since cross-domain cookies are not enabled.

4. Docker real-time development (recommended).

SSH into your Dappnode and clone this repo:

git clone https://github.com/dappnode/DNP_DAPPMANAGER

Open the directory where you cloned the repo using VS Code SSH extension (optional, but recommended)

Force remove Dappmanager container:

docker rm -f DAppNodeCore-dappmanager.dnp.dappnode.eth

Build and start dev Dappmanager:

docker-compose -f docker-compose-dev.yml up -d --build

After this, you will be able to access the dappmanager through http://my.dappnode/

Note: To switch back to production Dappmanager, you will have to remove this container and run:

docker-compose -f /usr/src/dappnode/DNCORE/docker-compose-dappmanager.yml up -d

Distributing

Now, generate a tar.xz image (get the xz library).

$ docker build --rm -f build/Dockerfile -t dappmanager.dnp.dappnode.eth:dev build
$ docker save dappmanager.dnp.dappnode.eth:dev | xz -9 > dappmanager.dnp.dappnode.eth_x.y.z.tar.xz

You can download the latest tar.xz version from here releases.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

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

Authors

• Eduardo Antuña Díez - Initial work - eduadiez
• Pablo Mendez - pablomendez
• DAppLion - dapplion

See also the list of contributors who participated in this project.

License

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

References

git

docker

docker-compose