README.md 2.8 KB
Newer Older
1
# Small Web Reference Client (Henry)
Aral Balkan's avatar
Aral Balkan committed
2

Aral Balkan's avatar
Aral Balkan committed
3
Henry is the [Small Web](https://small-tech.org/research-and-development/) Reference Client that’s installed if you do not specify a different one. It implements the essential Small Web client protocols and conventions.
4
5
6
7
8
9
10

In developing Henry, I will be taking as modular an approach as possible so that other clients can easily plug-and-play core functionality (or fork Henry and build their clients on top of it while remaining able to update core small web functionality in their clients just by keeping their dependencies up to date without having to follow updates to Henry itself and cherry picking updates from it.)

## Usage

Henry is not meant to be used directly. It is automatically cloned and used by [Place](https://github.com/small-tech/place) – the Small Web Protocol Server.

Aral Balkan's avatar
Aral Balkan committed
11
## Develop
Aral Balkan's avatar
Aral Balkan committed
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

You can run the client separately from Place during development:

```shell
npm run dev
```

## Build

To create the distribution build Single Page Application ready to be loaded by Place:

```shell
npm run build
```

This will create your build into the `../henry-dist` directory.

(The official distribution build is hosted in the [henry-dist](https://source.small-tech.org/small-web/henry-dist) repository.)

31
32
## Current status

Aral Balkan's avatar
Aral Balkan committed
33
34
35
36
37
  - (Re)generates a person’s key materials from their passphrase.
  - Retrieves a Bernstein token from a small web protocol server (e.g., from the current in-development reference implementation, called Place).
  - Decrypts a Bernstein token using the person’s private key.
  - Makes a public web socket connection to the small web protocol server on initial load.
  - Makes a private web socket connection to the small web protocol server using the decrypted Bernstein token.
Aral Balkan's avatar
Aral Balkan committed
38

39
40
## Note on technology choices

Aral Balkan's avatar
Aral Balkan committed
41
The reference implementation uses [Vite](https://vitejs.dev) and [Svelte](https://svelte.dev) but Small Web clients can be written using any combination of tools as long as they output a static single-page app that conforms to the small web protocols.
Aral Balkan's avatar
Aral Balkan committed
42

Aral Balkan's avatar
Aral Balkan committed
43
44
45
46
## Authentication

Authentication is done using an asymmetrically-encrypted access token we call a Bernstein Token.

Aral Balkan's avatar
Aral Balkan committed
47
For more information, please see [Place](https://github.com/small-tech/place), the very early-stage reference implementation Small Web Protocol Server.
Aral Balkan's avatar
Aral Balkan committed
48
49
50
51
52
53
54
55
56
57
58
59
60
61

## Like this? Fund us!

[Small Technology Foundation](https://small-tech.org) is a tiny, independent not-for-profit.

We exist in part thanks to patronage by people like you. If you share [our vision](https://small-tech.org/about/#small-technology) and want to support our work, please [become a patron or donate to us](https://small-tech.org/fund-us) today and help us continue to exist.

## Copyright

Copyright © 2021-present [Aral Balkan](https://ar.al), [Small Technology Foundation](https://small-tech.org).

## License

[AGPL 3.0](./LICENSE).