Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dappnode/dnp_dappmanager

Dappnode package responsible for providing the Dappnode Package Manager
https://github.com/dappnode/dnp_dappmanager

dapp dappnode ethereum

Last synced: 9 days ago
JSON representation

Dappnode package responsible for providing the Dappnode Package Manager

Host: GitHub
URL: https://github.com/dappnode/dnp_dappmanager
Owner: dappnode
License: gpl-3.0
Created: 2018-03-13T10:35:26.000Z (almost 7 years ago)
Default Branch: develop
Last Pushed: 2023-12-15T11:30:32.000Z (about 1 year ago)
Last Synced: 2023-12-16T11:56:11.407Z (about 1 year ago)
Topics: dapp, dappnode, ethereum
Language: TypeScript
Homepage:
Size: 19.7 MB
Stars: 27
Watchers: 11
Forks: 42
Open Issues: 243
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

[![Website dappnode.com](https://img.shields.io/badge/Website-dappnode.io-brightgreen.svg)](https://dappnode.com/)
[![Documentation Wiki](https://img.shields.io/badge/Documentation-Wiki-brightgreen.svg)](https://docs.dappnode.io)
[![GIVETH Campaign](https://img.shields.io/badge/GIVETH-Campaign-1e083c.svg)](https://giveth.io/project/dappnode)
[![Discord Dappnode](https://img.shields.io/discord/747647430450741309?label=Discord&logo=Discord&style=plastic)](https://discord.gg/dappnode)
[![Twitter Follow](https://img.shields.io/twitter/follow/espadrine.svg?style=social&label=Follow)](https://twitter.dappnode.io)

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

- :bust_in_silhouette: For user / usage documentation go to the [user guide](https://docs.dappnode.io/docs/user/getting-started/choose-your-path)
- :wrench: For developers check the [technical documentation](https://docs.dappnode.io/docs/dev)
- :speech_balloon: For feedback and reporting problems please [submit an issue](https://github.com/dappnode/dappnode/issues/new) or contact us on [Discord](https://discord.gg/dappnode)

It is an AragonApp whose repo is deployed at this address: [0x0c564ca7b948008fb324268d8baedaeb1bd47bce](https://etherscan.io/address/0x0c564ca7b948008fb324268d8baedaeb1bd47bce) and whose ENS address is: [dappmanager.dnp.dappnode.eth](https://etherscan.io/enslookup?q=dappmanager.dnp.dappnode.eth])

## Getting Started

This repo is a single piece of Dappnode. To install and use Dappnode go to the [installation guide](https://docs.dappnode.io/docs/user/install/overview).

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.

```bash
git --version
docker --version
docker-compose --version
```

Go to the [installation overview](https://docs.dappnode.io/docs/user/install/overview) in our documentation for more information.

### Installing

1. To get started, clone the project locally.

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

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

```bash
$ nvm use 20
```

3. Install `yarn` globally.

```bash
$ npm install -g yarn
```

4. Enable corepack and set yarn version berry

```bash
$ corepack enable && yarn set version berry
```

5. Install the dependencies

```bash
$ yarn
```

6. Build the project

```bash
$ 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](packages/params/src/params.ts).

### 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:

```bash
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:

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

Build and start dev Dappmanager:

```bash
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](https://tukaani.org/xz/)).

```bash
$ 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](https://github.com/dappnode/DNP_DAPPMANAGER/releases).

## Contributing

Please read [CONTRIBUTING.md](https://github.com/dappnode) for details on our code of conduct, and the process for submitting pull requests to us.

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/dappnode/DNP_DAPPMANAGER/tags).

## Authors

- **Eduardo Antuña Díez** - _Initial work_ - [eduadiez](https://github.com/eduadiez)
- **Pablo Mendez** - [pablomendez](https://github.com/pablomendezroyo)
- **DAppLion** - [dapplion](https://github.com/dapplion)

See also the list of [contributors](https://github.com/dappnode/DNP_DAPPMANAGER/contributors) who participated in this project.

## License

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

## References

[git](https://git-scm.com/)

[docker](https://www.docker.com/)

[docker-compose](https://docs.docker.com/compose/)

```