Skip to content

Commit

Permalink
Updated README/CHANGELOG
Browse files Browse the repository at this point in the history
  • Loading branch information
MathNodes committed Sep 5, 2022
1 parent 421659c commit 27b2ed4
Show file tree
Hide file tree
Showing 4 changed files with 50 additions and 16 deletions.
11 changes: 11 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
CHANGELOG
========================
# v1.0.1 (01/09/2022)
* NEW: .deb package for virtual machine guest OSes
* FIX: Binary release fix for FIAT Gateway

# v1.0.0 (30/8/2022)
* NEW: Fiat Gateway
* CHANGE: Added CryptoCompare API alongside CoinGecko for additional DVPN price in FIAT gateway
* NEW: Automatic DNS resolve configuration for MacOS and Linux. Resolves to cloudflar if host HNS does not work
* FIX: No wallet subscription crash
* FIX: Major/Minor bug fixes for stability

# v0.9.5-beta.1 (20/08/2022)
* NEW: Ping
* FIX: pexpect timeout exception handling
Expand Down
55 changes: 39 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,16 @@ Meile-GUI (may•lah)

Meile dVPN GUI for Linux & OS X Powered by the Sentinel Network - a blockchain decentralized VPN.

# Pre-releases
# Full Version

The new versions come pre-installed with sentinel-cli so there is no requirement to install this separately. There is a also a Mac OS X (M1) port and you can read the readme in that section by switching branches to *osx*
The full version 1.0.0 has been released to GitHub. Branches include **master**, **osx**, **fiat**, **osx-fiat**. The exception is that we did not include the scrtsxx.py which contains credentials for the FIAT gateway. Please navigate the various branches to understand the different interworkings.


# NOTE:
sudo/root privleges is no longer required to run meile-gui on Linux. Thank god. We are working on a fix for this for OS X.
sudo/root privleges is no longer required to run meile-gui on Linux. Thank god. We've used AppleScript to prompt the user for fingerprint or system password thereby removing sudo/root privileges being necessary to run the OS X Meile version. NOTE: The OS X bundle seems to not connect to nodes as of now. Please use the binary as that is in working order.

If you have an older version of Meile on your system, running the following is mandatory to allow newer versions to work:
## Note 2:
If you have an older version (<0.9.5-beta.1) of Meile on your system, running the following is mandatory to allow newer versions to work:

```shell
sudo chown -R user:user /home/user/.meile-gui
Expand All @@ -29,17 +30,17 @@ where `user` is your username on your system.
This just changes the permissions of the meile-gui configuration directory back to a regular user instead of its previous permission as root.

## Mac OS X
Download the latest release [Mac OS X v0.9.3-beta](https://github.com/MathNodes/meile-gui/releases/download/0.9.3-beta/meile-gui-v0.9.3-beta-darwin-M1.zip)
Download the latest release [Mac OS X v1.0.1](https://github.com/MathNodes/meile-gui/releases/download/1.0.1/meile-gui-v1.0.1_darwin_M1)

Run:
```shell
./meile-gui
```

Or double click on the .app bundle
Or double click on the the icon in Finder. No brew install is required for this version as we have bundled wireguard-tools for the M1 release. MacOS (intel) will be following shortly.

### NOTE:
pip install is not currently available for Mac OS X. We are working on bringing this as a separate packages. Also, we are working on bundling wireguard-tools into Meile GUI so we can ease the user's install process.
pip install is not currently available for Mac OS X. We are working on bringing this as a separate packages.


## Debian .deb package
Expand All @@ -49,7 +50,7 @@ The latest version of Meile GUI comes packaged as a Debian archive. Simply downl
and run:

```shell
sudo apt install ./meilegui_0.9.5-beta.1_amd64.deb
sudo apt install -y ./meile-gui-v1.0.1_amd64.deb
```

This release will install wireguard tools (and resolvconf) alongside Meile GUI. To run the application requires root privileges on some machines and we have enforced it within the app.
Expand All @@ -60,12 +61,16 @@ meile-gui

Or goto your panel menu under Internet and there will be a clickable icon.

## Debian Virtual Machine (.deb)

Because there were issues loading certain mesa OpenGL drivers in various Debian Virtual Machines, we have included a separate .deb archive that automatically configures the system to handle the Meile dependencies. Please use this version if you are running a Debian flavor in a virutal machine (VM).

## Installing via pip

Meile dVPN GUI v0.9.3-beta is now available as a pip packages as well. To install, first install wireguard-tools if you don't already have them
Meile dVPN GUI v0.9.3-beta is now available as a pip packages as well. To install, first install wireguard-tools and meile dependencies if you don't already have them

```
sudo apt install wireguard-tools
sudo apt install -y wireguard-tools openresolv mesa-utils libgl1-mesa-glx
```

Then install via pip
Expand All @@ -79,29 +84,47 @@ Upgrade via pip
pip3 install meile-gui --upgrade
```

Because meile-gui enforces users to run as root (due to network device permissions of wireguard) we have enforced this in our releases. To run Meile GUI after pip install do the following:
To run Meile GUI after pip install do the following:

```shell
meile-gui
```

This sets the root user's environment to that of the running user (the user that installed the pip packages.)
### NOTE:

The FIAT gateway is not included in the pip package. This is due to certain credentials needing to remain secret for OPSEC reasons. The pip package will continue to get updated with the FIAT release in bug fixes and feature additions.

## Installing from Binary

```shell
sudo apt install wireguard-tools
sudo apt install -y wireguard-tools openresolv mesa-utils libgl1-mesa-glx
```

After installing wireguard-tools, download the latest pre-release at the [Release](https://github.com/MathNodes/meile-gui/releases) page and extract:
After installing wireguard-tools, download the latest stable release at the [Release](https://github.com/MathNodes/meile-gui/releases) page and extract:

```shell
tar xvjf meile_gui-v0.9.4-beta.4-linux-amd64.tar.bz2
tar xvjf meile-gui-v1.0.1_amd64.tar.bz2
```

Run, test, and enjoy.
Run & enjoy!

Please make comments, suggestions, and issues on the issues page here at GitHub. If you are a GitHub newb, you can join us on our Telegram [MathNodes-Telegram](http://t.me/MathNodes) or our Discord [MathNodes-Discord](https://discord.gg/HQrHXZJHQq) in the Meile channel.

All suggestions are welcome.

# Donations

Because we are working on a small grant with no VC funding, any additional contributions to our developer team is more than certainly welcomed. It will help fund future releases.

## DVPN (Sentinel)

`sent12v8ghhg98e2n0chyje3su4uqlsg75sh4lwcyww`

![dvpn](./img/DVPN.png)

## XMR (Monero)

`87qHJPU5dZGWaWzuoC3My5SgoQSuxh4sHSv1FXRZrQ9XZHWnfC33EX1NLv5HujpVhbPbbF9RcXXD94byT18HonAQ75b9dyR`

![xmr](./img/XMR.png)

Binary file added img/DVPN.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/XMR.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 27b2ed4

Please sign in to comment.