Skip to content

Commit 9b85f8b

Browse files
authored
Merge pull request #93 from Roasbeef/doc-updates
docs: update docs, mention new minimum Go version
2 parents 27ccd58 + d191681 commit 9b85f8b

File tree

1 file changed

+12
-15
lines changed

1 file changed

+12
-15
lines changed

README.md

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,20 @@
1-
# Lightning Service Authentication Token (LSAT) proxy
1+
# L402 (Lightning HTTP 402) API Key proxy
22

33
Aperture is your portal to the Lightning-Native Web. Aperture is used in
44
production today by [Lightning Loop](https://lightning.engineering/loop), a
55
non-custodial on/off ramp for the Lightning Network.
66

77
Aperture is a HTTP 402 reverse proxy that supports proxying requests for gRPC
8-
(HTTP/2) and REST (HTTP/1 and HTTP/2) backends using the [LSAT Protocol
9-
Standard](https://lsat.tech/). LSAT stands for: Lightning Service
10-
Authentication Token. They combine HTTP 402, macaroons, and the Lightning
11-
Network to create a new standard for authentication and paid services on the
12-
web.
13-
14-
LSATs are a new standard protocol for authentication and paid APIs developed by
15-
Lightning Labs. LSATs can serve both as authentication, as well as a payment
16-
mechanism (one can view it as a ticket) for paid APIs. In order to obtain a
17-
token, we require the user to pay us over Lightning in order to obtain a
18-
preimage, which itself is a cryptographic component of the final LSAT token
8+
(HTTP/2) and REST (HTTP/1 and HTTP/2) backends using the [L402 Protocol
9+
Standard](https://lsat.tech/). L402 is short for: the Lightning HTTP 402
10+
protocol. L402 combines HTTP 402, macaroons, and the Lightning Network to
11+
create a new standard for authentication and paid services on the web.
12+
13+
L402 is a new standard protocol for authentication and paid APIs developed by
14+
Lightning Labs. L402 API keys can serve both as authentication, as well as a
15+
payment mechanism (one can view it as a ticket) for paid APIs. In order to
16+
obtain a token, we require the user to pay us over Lightning in order to obtain
17+
a preimage, which itself is a cryptographic component of the final L402 token
1918

2019
The implementation of the authentication token is chosen to be macaroons, as
2120
they allow us to package attributes and capabilities along with the token. This
@@ -32,7 +31,7 @@ services and APIs.
3231

3332
**aperture**
3433

35-
* Compilation requires go `1.13.x` or later.
34+
* Compilation requires go `1.19.x` or later.
3635
* To build `aperture` in the current directory, run `make build` and then copy the
3736
file `./aperture` from the local directory to the server.
3837
* To build and install `aperture` directly on the machine it will be used, run the
@@ -49,5 +48,3 @@ services and APIs.
4948
compare with `sample-conf.yaml`.
5049
* Start aperture without any command line parameters (`./aperture`), all configuration
5150
is done in the `~/.aperture/aperture.yaml` file.
52-
53-
```

0 commit comments

Comments
 (0)