README.md 1.95 KB
Newer Older
1
# Overview
Laurent Peuch's avatar
Laurent Peuch committed
2

3
4
5
The neutrinet application is for Neutrinet members that have an Internet Cube configured and does 2 things:
* It renews the vpn-certificates
* Adds a webpage with genral information about Neutrinet
Laurent Peuch's avatar
Laurent Peuch committed
6
7

# Installation
8
## From the CLI
9

10
First check if you have a list, probably named *neutrinet*, with *https://neutrinet.be/apps.json* as url.
11

12
13
14
```shell
yunohost app listlists
```
15

16
If you don't have the list yet, you can add it using
17

18
19
20
```shell
yunohost app fetchlist --name neutrinet -u https://neutrinet.be/apps.json
```
21

22
Once you have the list, you can install the app using
23

24
25
26
27
28
29
30
31
32
33
34
35
36
37
```shell
yunohost app install neutrinet --debug
```

## Debugging

You can manually run the cron job that attempts to renew the certificates:
```shell
sudo /etc/cron.daily/neutrinet-renew-cert
```

This actually runs the script in `/opt/neutrinet/renew_cert/`:
```shell
cd /opt/neutrinet/renew_cert
HgO's avatar
HgO committed
38
sudo ./renew_cert_cron.sh
39
40
41
42
```

You can increase the verbosity with the option `-v`:
```shell
HgO's avatar
HgO committed
43
sudo ./renew_cert_cron.sh -v
44
```
45

46
# For contributers
ilja's avatar
ilja committed
47
48
49
50
51
## Contributing
* Bugs, feature requests and other issues can be logged on the issue tracker at https://git.domainepublic.net/Neutrinet/neutrinet_ynh/issues
* Merge requests should be submitted at https://git.domainepublic.net/Neutrinet/neutrinet_ynh
* Merge requests should be done to the `develop` branch

52
## Publish a new version of the app
Thomasa Balthazar's avatar
Thomasa Balthazar committed
53

54
55
56
57
* Edit the [manifest](manifest.json) file to bump the version
* Edit the [upgrade](scripts/upgrade) script with the needed upgrades for previous installations
* Test the updated version both for new installs and upgrades and make sure the other scripts ([backup](scripts/backup), [remove](scripts/remove) and [upgrade](scripts/upgrade)) also still work
* In the [apps.json](https://neutrinet.be/apps.json) file you must update the `revision` with the current `sha` on the `master` branch of the package and update the `lastUpdate` field. If you added things to the manifest file, you should add these changes ass well 
Thomasa Balthazar's avatar
Thomasa Balthazar committed
58