Skip to content

Commit 381a3b7

Browse files
committed
Update install docs
Signed-off-by: Alex Ellis (OpenFaaS Ltd) <[email protected]>
1 parent 80a0678 commit 381a3b7

File tree

131 files changed

+10064
-5136
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

131 files changed

+10064
-5136
lines changed

.github/workflows/build.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ on:
1010

1111
jobs:
1212
build:
13-
runs-on: actuated-8cpu-12gb
13+
runs-on: actuated-4cpu-12gb
1414
steps:
1515
- uses: actions/checkout@master
1616
with:
1717
fetch-depth: 1
1818
- name: Install Go
1919
uses: actions/setup-go@master
2020
with:
21-
go-version: 1.21.x
21+
go-version: 1.22.x
2222
- name: Make
2323
run: make all

.github/workflows/publish.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,20 @@ on:
77

88
jobs:
99
publish:
10-
runs-on: actuated-8cpu-12gb
10+
runs-on: actuated-4cpu-12gb
1111
steps:
1212
- uses: actions/checkout@master
1313
with:
1414
fetch-depth: 1
1515
- name: Install Go
1616
uses: actions/setup-go@master
1717
with:
18-
go-version: 1.21.x
18+
go-version: 1.22.x
1919
- name: Make
2020
run: make all
2121

2222
- name: Upload release binaries
23-
uses: alexellis/[email protected].0
23+
uses: alexellis/[email protected].1
2424
env:
2525
GITHUB_TOKEN: ${{ github.token }}
2626
with:

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -68,12 +68,20 @@ inletsctl does not automatically delete your exit nodes (read cloud hosts), so y
6868

6969
## Install `inletsctl`
7070

71-
```bash
72-
# Install to local directory (and for Windows users)
73-
curl -sLSf https://inletsctl.inlets.dev | sh
71+
You can download the latest release from the [releases page](https://github.com/inlets/inletsctl/releases) or use [arkade](https://arkade.dev/):
7472

73+
```bash
7574
# Install directly to /usr/local/bin/
76-
curl -sLSf https://inletsctl.inlets.dev | sudo sh
75+
curl -sLSf https://get.arkade.dev | sudo sh
76+
77+
# Install to local directory (for Windows users)
78+
curl -sLSf https://get.arkade.dev | sh
79+
```
80+
81+
The command can install inletsctl initially, and also update it later on:
82+
83+
```bash
84+
arkade get inletsctl
7785
```
7886

7987
Windows users are encouraged to use [git bash](https://git-scm.com/downloads) to install the inletsctl binary.
@@ -110,6 +118,4 @@ type Provisioner interface {
110118

111119
### License
112120

113-
inletsctl is distributed under the MIT license. inlets-pro, which inletsctl uses is licensed under the [inlets-pro End User License Agreement (EULA)](https://github.com/inlets/inlets-pro/blob/master/EULA.md).
114-
115-
[A valid static inlets license or a Gumroad subscription](https://store.openfaas.com/) is required to create tunnel servers with inletsctl.
121+
inletsctl is distributed under the MIT license. inlets-pro, which inletsctl uses is licensed under the [inlets-pro End User License Agreement (EULA)](https://github.com/inlets/inlets-pro/blob/master/EULA.md) and requires [a personal or business subscription](https://store.openfaas.com/).

go.mod

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
module github.com/inlets/inletsctl
22

3-
go 1.21
3+
go 1.22
44

55
require (
66
github.com/alexellis/go-execute/v2 v2.2.1
@@ -9,7 +9,7 @@ require (
99
github.com/linode/linodego v1.27.1
1010
github.com/morikuni/aec v1.0.0
1111
github.com/pkg/errors v0.9.1
12-
github.com/sethvargo/go-password v0.2.0
12+
github.com/sethvargo/go-password v0.3.0
1313
github.com/spf13/cobra v1.8.0
1414
github.com/spf13/pflag v1.0.5
1515
)
@@ -66,11 +66,11 @@ require (
6666
go.opentelemetry.io/otel v1.22.0 // indirect
6767
go.opentelemetry.io/otel/metric v1.22.0 // indirect
6868
go.opentelemetry.io/otel/trace v1.22.0 // indirect
69-
golang.org/x/crypto v0.18.0 // indirect
70-
golang.org/x/net v0.20.0 // indirect
69+
golang.org/x/crypto v0.24.0 // indirect
70+
golang.org/x/net v0.26.0 // indirect
7171
golang.org/x/oauth2 v0.16.0 // indirect
72-
golang.org/x/sys v0.16.0 // indirect
73-
golang.org/x/text v0.14.0 // indirect
72+
golang.org/x/sys v0.21.0 // indirect
73+
golang.org/x/text v0.16.0 // indirect
7474
golang.org/x/time v0.5.0 // indirect
7575
google.golang.org/api v0.157.0 // indirect
7676
google.golang.org/appengine v1.6.8 // indirect

go.sum

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -368,6 +368,8 @@ github.com/scaleway/scaleway-sdk-go v1.0.0-beta.22 h1:wJrcTdddKOI8TFxs8cemnhKP2E
368368
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.22/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg=
369369
github.com/sethvargo/go-password v0.2.0 h1:BTDl4CC/gjf/axHMaDQtw507ogrXLci6XRiLc7i/UHI=
370370
github.com/sethvargo/go-password v0.2.0/go.mod h1:Ym4Mr9JXLBycr02MFuVQ/0JHidNetSgbzutTr3zsYXE=
371+
github.com/sethvargo/go-password v0.3.0 h1:OLFHZ91Z7NiNP3dnaPxLxCDXlb6TBuxFzMvv6bu+Ptw=
372+
github.com/sethvargo/go-password v0.3.0/go.mod h1:p6we8DZ0eyYXof9pon7Cqrw98N4KTaYiadDml1dUEEw=
371373
github.com/sirupsen/logrus v1.2.0/go.mod h1:LxeOpSwHxABJmUn/MG1IvRgCAasNZTLOkJPxbbu5VWo=
372374
github.com/sirupsen/logrus v1.4.2/go.mod h1:tLMulIdttU9McNUspp0xgXVQah82FyeX6MwdIuYE2rE=
373375
github.com/sirupsen/logrus v1.6.0/go.mod h1:7uNnSEd1DgxDLC74fIahvMZmmYsHGZGEOFrfsX/uA88=
@@ -431,6 +433,8 @@ golang.org/x/crypto v0.13.0/go.mod h1:y6Z2r+Rw4iayiXXAIxJIDAJ1zMW4yaTpebo8fPOliY
431433
golang.org/x/crypto v0.14.0/go.mod h1:MVFd36DqK4CsrnJYDkBA3VC4m2GkXAM0PvzMCn4JQf4=
432434
golang.org/x/crypto v0.18.0 h1:PGVlW0xEltQnzFZ55hkuX5+KLyrMYhHld1YHO4AKcdc=
433435
golang.org/x/crypto v0.18.0/go.mod h1:R0j02AL6hcrfOiy9T4ZYp/rcWeMxM3L6QYxlOuEG1mg=
436+
golang.org/x/crypto v0.24.0 h1:mnl8DM0o513X8fdIkmyFE/5hTYxbwYOjDS/+rK6qpRI=
437+
golang.org/x/crypto v0.24.0/go.mod h1:Z1PMYSOR5nyMcyAVAIQSKCDwalqy85Aqn1x3Ws4L5DM=
434438
golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA=
435439
golang.org/x/exp v0.0.0-20190306152737-a1d7652674e8/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA=
436440
golang.org/x/exp v0.0.0-20190510132918-efd6b22b2522/go.mod h1:ZjyILWgesfNpC6sMxTJOJm9Kp84zZh5NQWvqDGG3Qr8=
@@ -511,6 +515,8 @@ golang.org/x/net v0.15.0/go.mod h1:idbUs1IY1+zTqbi8yxTbhexhEEk5ur9LInksu6HrEpk=
511515
golang.org/x/net v0.17.0/go.mod h1:NxSsAGuq816PNPmqtQdLE42eU2Fs7NoRIZrHJAlaCOE=
512516
golang.org/x/net v0.20.0 h1:aCL9BSgETF1k+blQaYUBx9hJ9LOGP3gAVemcZlf1Kpo=
513517
golang.org/x/net v0.20.0/go.mod h1:z8BVo6PvndSri0LbOE3hAn0apkU+1YvI6E70E9jsnvY=
518+
golang.org/x/net v0.26.0 h1:soB7SVo0PWrY4vPW/+ay0jKDNScG2X9wFeYlXIvJsOQ=
519+
golang.org/x/net v0.26.0/go.mod h1:5YKkiSynbBIh3p6iOc/vibscux0x38BZDkn8sCUPxHE=
514520
golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U=
515521
golang.org/x/oauth2 v0.0.0-20190226205417-e64efc72b421/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw=
516522
golang.org/x/oauth2 v0.0.0-20190604053449-0f29369cfe45/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw=
@@ -587,6 +593,8 @@ golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
587593
golang.org/x/sys v0.13.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
588594
golang.org/x/sys v0.16.0 h1:xWw16ngr6ZMtmxDyKyIgsE93KNKz5HKmMa3b8ALHidU=
589595
golang.org/x/sys v0.16.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
596+
golang.org/x/sys v0.21.0 h1:rF+pYz3DAGSQAxAu1CbC7catZg4ebC4UIeIhKxBZvws=
597+
golang.org/x/sys v0.21.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
590598
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
591599
golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
592600
golang.org/x/term v0.1.0/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
@@ -610,6 +618,8 @@ golang.org/x/text v0.13.0 h1:ablQoSUd0tRdKxZewP80B+BaqeKJuVhuRxj/dkrun3k=
610618
golang.org/x/text v0.13.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE=
611619
golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ=
612620
golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
621+
golang.org/x/text v0.16.0 h1:a94ExnEXNtEwYLGJSIUxnWoxoRz/ZcCsV63ROupILh4=
622+
golang.org/x/text v0.16.0/go.mod h1:GhwF1Be+LQoKShO3cGOHzqOgRrGaYc9AvblQOmPVHnI=
613623
golang.org/x/time v0.0.0-20181108054448-85acf8d2951c/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
614624
golang.org/x/time v0.0.0-20190308202827-9d24e82272b4/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
615625
golang.org/x/time v0.0.0-20191024005414-555d28b269f0/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
Binary file not shown.

0 commit comments

Comments
 (0)