Add short info about halo-bridge and gateway, minor fixes (#157)

This commit is contained in:
Michał Leszczyński
2023-04-11 17:53:01 +02:00
committed by GitHub
parent 27fbeeb53c
commit 34760aa720
5 changed files with 18 additions and 6 deletions

View File

@@ -25,7 +25,7 @@ jobs:
draft: true
prerelease: false
body: |
Set of standalone HaLo tools (`halocli`, `halo-bridge`) for desktop computers with PC/SC readers (USB/NFC readers).
Set of standalone HaLo tools: [halocli](https://github.com/arx-research/libhalo/blob/master/docs/desktop-cli.md), [halo-bridge](https://github.com/arx-research/libhalo/blob/master/docs/halo-bridge.md), [halo-gateway](https://github.com/arx-research/libhalo/blob/master/docs/halo-gateway.md).
Release contents:
* `halo-tools-linux-x64.tgz` - Linux x64 build (elf files; tar-gzip compressed)
@@ -187,6 +187,7 @@ jobs:
run: |
chmod +x halocli
chmod +x halo-bridge
chmod +x halo-gateway
tar -pczf halo-tools-linux-x64.tgz halocli halo-bridge halo-gateway
- name: Write certificate file (Windows)
if: matrix.os == 'windows-latest'

View File

@@ -148,9 +148,9 @@ function runHalo(entryMode, args) {
}
if (entryMode === "server") {
console.log('Launching Web Socket Server...');
console.log('Launching HaLo Bridge Server...');
wsCreateServer(args, () => Object.keys(nfc.readers).map(r => nfc.readers[r].name));
console.log('Web Socket Server is listening...');
console.log('HaLo Bridge Server is listening...');
if (!args.nonInteractive) {
open('http://127.0.0.1:' + args.listenPort);

View File

@@ -218,6 +218,8 @@ function createServer(args) {
ws.close(4061, "Unhandled exception.");
}
});
console.log('HaLo Gateway server is listening...');
}
createServer(args);

View File

@@ -1,4 +1,9 @@
(TODO description of halo-bridge)
# HaLo Bridge
(TODO how to connect with halo-bridge from external web app - check HTTPS then fall back to HTTP endpoint,
would give nearly 100% coverage of all systems and browsers)
HaLo Bridge is a special tool dedicated for desktop computers. The tool is provided in a form of native program
for your platform (Windows, Linux, Mac OS). Once you launch HaLo Bridge, it will connect with your physical
USB NFC reader and expose it as a WebSocket Server.
In particular, it means that whenever you will have HaLo Bridge tool running on your computer, any authorized
website will be able to interact directly with your USB NFC reader in order to sign some information with HaLo
tags.

4
docs/halo-gateway.md Normal file
View File

@@ -0,0 +1,4 @@
# HaLo Gateway
HaLo Gateway is a special tool which would allow you to perform HaLo operations straight on your desktop,
using your smartphone as the NFC reader for interaction with HaLo tags.