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

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

# Installation
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31

## From the web interface

First make sure you have the neutrinet apps list
1. Go to the admin interface on your cube
2. Click *Tools*
3. In the *Advanced* section, click *Applications lists*
4. Check in the Applications lists section if you have *neutrinet*

If you don't have it, under *Custom applications list*, fill in the form with:
1. Name: *neutrinet*
2. URL: *https://neutrinet.be/apps.json*

Then, click on the *Add* button.

Now, we can install the Neutrinet application:
1. Go to the admin interface
2. Click *Applications*
3. Click *Install* button
4. Select *All apps* on the right
5. Search for *neutrinet*
6. Click *Install*
7. Fill in the form (or just keep the defaults) and click *Install* just like you would install any app from the web interface

32
## From the CLI
33

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

36 37 38
```shell
yunohost app listlists
```
39

40
If you don't have the list yet, you can add it using
41

42 43 44
```shell
yunohost app fetchlist --name neutrinet -u https://neutrinet.be/apps.json
```
45

46
Once you have the list, you can install the app using
47

48 49 50 51 52 53 54 55 56 57 58 59 60 61
```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
62
sudo ./renew_cert_cron.sh
63 64 65 66
```

You can increase the verbosity with the option `-v`:
```shell
HgO's avatar
HgO committed
67
sudo ./renew_cert_cron.sh -v
68
```
69

70
# For contributers
ilja's avatar
ilja committed
71 72 73
## 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
74
* Merge requests should be done to the `unstable` branch
ilja's avatar
ilja committed
75

76
## Publish a new version of the app
Thomasa Balthazar's avatar
Thomasa Balthazar committed
77

78 79 80
* 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
81
* In the [apps.json](https://neutrinet.be/apps.json) file you must update the `revision` with the current `sha` on the `stable` 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
82