mirror of
https://github.com/YunoHost-Apps/duniter_ynh.git
synced 2024-09-03 18:26:35 +02:00
[enh] completely rework and update the readme
This commit is contained in:
parent
9e69e5f06c
commit
54b49ddf16
1 changed files with 20 additions and 28 deletions
48
README.md
48
README.md
|
@ -1,40 +1,32 @@
|
|||
# Duniter package for YunoHost
|
||||
|
||||
- [Duniter project](https://duniter.org)
|
||||
- [YunoHost project](https://yunohost.org)
|
||||
- Works on Debian Jessie 64 bits and ARM
|
||||
- 200Mo free RAM is necessary
|
||||
- The package state is **working**.
|
||||
|
||||
## Install
|
||||
- You will need to use a dedicated domain name as the app is installed on root path. For instance, use `duniter.domain.tld`.
|
||||
- An admin user will be asked to access the web admin.
|
||||
- Cesium wallet webapp could be set as public. It is accessible at `duniter.domain.tld/cesium`.
|
||||
- Web interface is accessible at `duniter.domain.tld/webui`.
|
||||
- The API is accessible at `duniter.domain.tld/`.
|
||||
- After installation, to compute blocks you will have to configure your identity on the node with `duniter wizard key` command or from webadmin using HTTPS.
|
||||
## Requirements
|
||||
- Debian Stretch
|
||||
- YunoHost ≥ 3.0
|
||||
- `x64` or `armlv7` architecture
|
||||
- 200Mo free RAM
|
||||
- A dedicated domain name to install the app on root path. For instance, `duniter.domain.tld`.
|
||||
- A YunoHost user which will have access the web admin.
|
||||
|
||||
## Install and upgrade
|
||||
You shall add the application community list into your instance in order to install it and benefit from upgrades:
|
||||
```bash
|
||||
sudo yunohost app install https://github.com/duniter/duniter_ynh
|
||||
sudo yunohost app fetchlist -n community -u https://app.yunohost.org/community.json
|
||||
sudo yunohost app install duniter
|
||||
sudo yunohost app upgrade duniter
|
||||
```
|
||||
Be carefull when installing applications from the community list.
|
||||
|
||||
## Upgrade
|
||||
The app is not on the list of official apps of YunoHost repository.
|
||||
You will have to upgrade manually with following command:
|
||||
## Configurations
|
||||
- In order to compute blocks you will have to set your member credentials with `duniter wizard key` or from the webadmin.
|
||||
- The BMA API is accessible from `https://duniter.domain.tld/` if enabled.
|
||||
|
||||
```bash
|
||||
sudo yunohost app upgrade duniter -u https://github.com/duniter/duniter_ynh
|
||||
```
|
||||
|
||||
## What the package do?
|
||||
Currently, it:
|
||||
- Install Duniter
|
||||
- Configure
|
||||
- Synchronize
|
||||
- Start
|
||||
|
||||
## Tutorial
|
||||
- [(fr) “Installation d’un nœud Duniter à l’aide de YunoHost”](https://forum.duniter.org/t/installation-d-un-noeud-duniter-a-l-aide-de-yunohost/1420)
|
||||
## Cesium
|
||||
Cesium is a wallet webapp. There is currently two ways to install it:
|
||||
- [With the YunoHost app](https://github.com/YunoHost-Apps/cesium_ynh)
|
||||
- With a Duniter plugin: `duniter plug git+https://github.com/duniter/duniter-ui-cesium.git`
|
||||
|
||||
## License
|
||||
This package and the Duniter software are under GNU AGPL v.3.
|
||||
|
|
Loading…
Reference in a new issue