YunoHost-Apps/duniter_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/duniter_ynh.git synced 2024-09-03 18:26:35 +02:00
Code Issues Activity Actions

[enh] rework readme:

Browse source 
- set the app at 'working' state.
- explain install step:
 - dedicated domain name, admin user.
 - how to access webadmin, cesium.
- add upgrade explaination.
- add tutorial link.
This commit is contained in:
Moul 2017-02-21 12:44:26 +01:00
parent 07fa4fab81
commit d10fbdc255
1 changed files with 18 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -4,30 +4,36 @@
- [YunoHost project](https://yunohost.org) - [YunoHost project](https://yunohost.org)
- Works on Debian Jessie 64 bits and ARM - Works on Debian Jessie 64 bits and ARM
- 200Mo free RAM is necessary - 200Mo free RAM is necessary
- The package state is **working**.
## Install ## Install
- You will need to use a dedicated domain name as the app is installed on root path. For instance, use `duniter.domain.tld`.
- Web admin can only be installed on root path for now. - An admin user will be asked to access the web admin.
Use a domain name like `duniter.domain.tld` for instance. - Cesium wallet webapp could be set as public. It is accessible at `duniter.domain.tld/cesium`.
See [#18](https://github.com/duniter/duniter_ynh/issues/18) for more details. - Web interface is accessible at `duniter.domain.tld/webui`.
- The API is accessible at `duniter.domain.tld/`.
```bash ```bash
sudo yunohost app install https://github.com/duniter/duniter_ynh sudo yunohost app install https://github.com/duniter/duniter_ynh
``` ```
## Package state ## Upgrade
The package is **in progress**. The app is not on the list of official apps of YunoHost repository.
Currently, it: You will have to upgrade manually with following command:
- Install Duniter ≥ 0.30.0 ```bash
sudo yunohost app upgrade duniter -u https://github.com/duniter/duniter_ynh
```
## What the package do?
Currently, it:
- Install Duniter
- Configure - Configure
- Synchronize - Synchronize
- Start - Start
## Usage ## 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)
- Graphical interface to manage the node is accessible at `https://duniter.domain.tld/webui`.
- The API is accessible at `https://duniter.domain.tld/`.
## License ## License
This package and the Duniter software are under GNU GPL v.3. This package and the Duniter software are under GNU GPL v.3.