Skip to content

Commit 67db2e2

Browse files
committed
Update license and README
Signed-off-by: Alex Ellis (OpenFaaS Ltd) <[email protected]>
1 parent 98d3663 commit 67db2e2

File tree

3 files changed

+34
-1
lines changed

3 files changed

+34
-1
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
inlets-svc.exe
2+
inlets-svc.exe~
23
/bin/**

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2021 inlets
3+
Copyright (c) 2021 OpenFaaS Ltd
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Windows Service management for inlets PRO
2+
3+
## Status
4+
5+
This is an early prototype of a shim to add an inlets PRO HTTP client as a Windows Service, so that it can be started upon reboot, and managed by the system.
6+
7+
Windows Services also allow for restarting of the tunnel process and logging.
8+
9+
## Usage
10+
11+
* Download the binary to C:\windows\
12+
* Create C:\inlets.json (with the contents as per below)
13+
14+
```json
15+
{
16+
"upstreams": ["openfaas.exit.o6s.io=http://127.0.0.1:8080"],
17+
"url": "wss://alex-tunnel.exit.o6s.io",
18+
"license-file": "C:\\license.txt",
19+
"token": "TOKEN-HERE",
20+
"auto-tls": false,
21+
}
22+
```
23+
24+
* Create C:\license.txt (with the inlets PRO license)
25+
* Install the service with `inlets-svc install`
26+
* Start the service with `inlets-svc start`
27+
28+
Check the Event Viewer under Application Logs
29+
30+
## License
31+
32+
MIT

0 commit comments

Comments
 (0)