oxen-io
/
lokinet-control-panel
mirror of https://github.com/oxen-io/lokinet-control-panel.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update readme to reflect v0.2.0 changes

This commit is contained in:
Stephen Shelton 2020-03-24 13:33:11 -06:00
parent a37d454df0
commit df8421c642
No known key found for this signature in database
GPG Key ID: 09082714F73FAA22
1 changed files with 22 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -4,6 +4,8 @@
This repository contains a cross-platform GUI for controlling and observing stats from a locally-running `lokinet`. See also [loki-network](https://github.com/loki-project/loki-network).
There is also an option (`Bootstrap Client from Web`) in the system tray's context menu (except when compiled with `SYSTEMD=true`, as is the case in the Debian packages). This will download a bootstrap file which will allow the `lokinet` client to join the lokinet network.
### Building
To build, you'll need a handful of `Qt` packages available. On `Ubuntu` or similar, you can install these with:
@ -17,15 +19,30 @@ Then build and run:
```bash
mkdir build
cd build
qmake ../lokicp.pro "CONFIG+=debug"
qmake "CONFIG+=debug" ..
make
./lokicp
./lokinet-gui
```
### Systemd
The app can be compiled to support `systemd` for starting and stopping `lokinet`. To enable this, invoke `qmake` with `SYSTEMD=true`.
Note that interactions with systemd may require privilege escalation, which is handled through `polkit`. A graphical polkit backend must be running for this to work.
### Usage
The app starts running in the background with access available through the system tray. Click on the system tray icon to interact with the app.
By default, the app starts running in the background with access available through the system tray. Click on the system tray icon to interact with the app.
### Status
Additionally, the following command-line arguments are supported:
```
--no-hide
Prevents the window from being hidden automatically when it loses focus. Also adds normal window chroming.
--no-tray
Implies --no-hide, and additionally removes the system tray. Closing the window exits the app.
```
This app is under heavy development. While the basic layout of the UI is established, the data is currently hard-coded.