An implementation of the Spring 83 protocol.
Very much a work-in-progress. This was built in reference to draft-20220616.md@0f63d3d2.
Setup
Requires node.js 16 or greater.
$ npm install
Tools
putnew
To put a single board: putnew host privKeyHex htmlFile
To put path of boards: putnew boardPath hostsCommaSeperated
Operates in two modes: single board PUT or multi-board PUT.
Single-board
Puts a new board with HTML source htmlFile to host with private key (in hex) privKeyHex.
Will insert the required tag, with the appropriate datetime value, if it doesn't exist in the document already.
Multi-board
Expects boardPath to be a directory containing board HTML files named with their full hex public key, and keypair files named according to the canonical pattern. So for example, a path named ./my-boards with the following contents is valid (assuming the keypair files are valid of course):
1b30ed15e51e6faa3afb3605212d8cdb80177dfedc30a0d0939d26ec683e1023.html
977b0a43de51225240128101105f0397cb2cde59801a74c40ad99c69183e0423.html
spring-83-keypair-2022-06-19-1b30ed15e51e.txt
spring-83-keypair-2022-06-19-977b0a43de51.txt
If putnew is then invoked like so:
$ putnew ./my-boards https://bogbody.biz,https://0l0.lol
it will post both boards to both listed hosts.
serve
Runs a Spring-83 server on port specified by environment variable SPRING83_BIND_PORT (or 1783 by default) & binding to SPRING83_BIND_HOST (or 0.0.0.0 by default).
Writes boards into SPRING83_CONTENT_DIR (or ./.content by default).
If Docker is available, can be run simply with docker compose up --build -d: SPRING83_CONTENT_DIR_HOST must be specified to be the host-side path for which SPRING83_CONTENT_DIR will map to internally.
Other environment variables you should set:
SPRING83_FQDN: your fully-qualified domain name (no protocol scheme, e.g.0l0.lol)SPRING83_CONTACT_ADDR: a contact email address for your site
findkey
Update: This script is left in the repo for posterity, but PT's Go keyfinder is much faster and generates canonically-formatted keys as well. It's what I'm using now.
Randomly generates Ed25519 key pairs until one matching the specified format has been found.
If called with --strict, will only return when a key pair is found that is valid this calendar year.
The output format matches the format that Robin's client expects and will be named in the same format.
Interacting
Robin has an impressive demo client available here. His host is running at https://bogbody.biz.
This implementation is running at https://0l0.lol and https://spring83.rkas.net. If you'd like to be listed here, just send mail to [email protected] with your hex public key as the subject, or submit a PR with your key added to public-boards.json.
Other known implementations
| Name | Language | Instance |
|---|---|---|
| davemenninger/exspring83 | elixir | |
| llimllib/springer | golang | |
| motevets/springboard | golang | https://spring83.kindrobot.ca/ |
| pteichman/ahoy | golang | |
| royragsdale/s83 | golang | |
| cellu_cc/so83-gpu (gitlab) | opencl | |
| michael-lazar/lets-dance | python | https://spring83.mozz.us |
5 Sep 22, 2022
9 Aug 29, 2022
326 Jan 4, 2023
4 Oct 14, 2022
0 Apr 23, 2022
3 Feb 22, 2022
11 Nov 17, 2022
34 Dec 14, 2022
16 Oct 17, 2022
351 Dec 30, 2022
8 Oct 14, 2022
36 Dec 26, 2022
11 Jan 1, 2023
17 Dec 27, 2022
3 Sep 3, 2022
1 Oct 11, 2022
3 Dec 15, 2022
11 Dec 14, 2022
14 Nov 13, 2022