@liebstoeckel/present-relay 0.3.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +373 -0
- package/README.md +84 -0
- package/package.json +58 -0
- package/src/addressing.ts +37 -0
- package/src/auth.ts +28 -0
- package/src/cli.ts +111 -0
- package/src/grant.ts +63 -0
- package/src/index.ts +3 -0
- package/src/metrics.ts +152 -0
- package/src/relay-server.ts +546 -0
- package/src/tracing.ts +86 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,373 @@
|
|
|
1
|
+
Mozilla Public License Version 2.0
|
|
2
|
+
==================================
|
|
3
|
+
|
|
4
|
+
1. Definitions
|
|
5
|
+
--------------
|
|
6
|
+
|
|
7
|
+
1.1. "Contributor"
|
|
8
|
+
means each individual or legal entity that creates, contributes to
|
|
9
|
+
the creation of, or owns Covered Software.
|
|
10
|
+
|
|
11
|
+
1.2. "Contributor Version"
|
|
12
|
+
means the combination of the Contributions of others (if any) used
|
|
13
|
+
by a Contributor and that particular Contributor's Contribution.
|
|
14
|
+
|
|
15
|
+
1.3. "Contribution"
|
|
16
|
+
means Covered Software of a particular Contributor.
|
|
17
|
+
|
|
18
|
+
1.4. "Covered Software"
|
|
19
|
+
means Source Code Form to which the initial Contributor has attached
|
|
20
|
+
the notice in Exhibit A, the Executable Form of such Source Code
|
|
21
|
+
Form, and Modifications of such Source Code Form, in each case
|
|
22
|
+
including portions thereof.
|
|
23
|
+
|
|
24
|
+
1.5. "Incompatible With Secondary Licenses"
|
|
25
|
+
means
|
|
26
|
+
|
|
27
|
+
(a) that the initial Contributor has attached the notice described
|
|
28
|
+
in Exhibit B to the Covered Software; or
|
|
29
|
+
|
|
30
|
+
(b) that the Covered Software was made available under the terms of
|
|
31
|
+
version 1.1 or earlier of the License, but not also under the
|
|
32
|
+
terms of a Secondary License.
|
|
33
|
+
|
|
34
|
+
1.6. "Executable Form"
|
|
35
|
+
means any form of the work other than Source Code Form.
|
|
36
|
+
|
|
37
|
+
1.7. "Larger Work"
|
|
38
|
+
means a work that combines Covered Software with other material, in
|
|
39
|
+
a separate file or files, that is not Covered Software.
|
|
40
|
+
|
|
41
|
+
1.8. "License"
|
|
42
|
+
means this document.
|
|
43
|
+
|
|
44
|
+
1.9. "Licensable"
|
|
45
|
+
means having the right to grant, to the maximum extent possible,
|
|
46
|
+
whether at the time of the initial grant or subsequently, any and
|
|
47
|
+
all of the rights conveyed by this License.
|
|
48
|
+
|
|
49
|
+
1.10. "Modifications"
|
|
50
|
+
means any of the following:
|
|
51
|
+
|
|
52
|
+
(a) any file in Source Code Form that results from an addition to,
|
|
53
|
+
deletion from, or modification of the contents of Covered
|
|
54
|
+
Software; or
|
|
55
|
+
|
|
56
|
+
(b) any new file in Source Code Form that contains any Covered
|
|
57
|
+
Software.
|
|
58
|
+
|
|
59
|
+
1.11. "Patent Claims" of a Contributor
|
|
60
|
+
means any patent claim(s), including without limitation, method,
|
|
61
|
+
process, and apparatus claims, in any patent Licensable by such
|
|
62
|
+
Contributor that would be infringed, but for the grant of the
|
|
63
|
+
License, by the making, using, selling, offering for sale, having
|
|
64
|
+
made, import, or transfer of either its Contributions or its
|
|
65
|
+
Contributor Version.
|
|
66
|
+
|
|
67
|
+
1.12. "Secondary License"
|
|
68
|
+
means either the GNU General Public License, Version 2.0, the GNU
|
|
69
|
+
Lesser General Public License, Version 2.1, the GNU Affero General
|
|
70
|
+
Public License, Version 3.0, or any later versions of those
|
|
71
|
+
licenses.
|
|
72
|
+
|
|
73
|
+
1.13. "Source Code Form"
|
|
74
|
+
means the form of the work preferred for making modifications.
|
|
75
|
+
|
|
76
|
+
1.14. "You" (or "Your")
|
|
77
|
+
means an individual or a legal entity exercising rights under this
|
|
78
|
+
License. For legal entities, "You" includes any entity that
|
|
79
|
+
controls, is controlled by, or is under common control with You. For
|
|
80
|
+
purposes of this definition, "control" means (a) the power, direct
|
|
81
|
+
or indirect, to cause the direction or management of such entity,
|
|
82
|
+
whether by contract or otherwise, or (b) ownership of more than
|
|
83
|
+
fifty percent (50%) of the outstanding shares or beneficial
|
|
84
|
+
ownership of such entity.
|
|
85
|
+
|
|
86
|
+
2. License Grants and Conditions
|
|
87
|
+
--------------------------------
|
|
88
|
+
|
|
89
|
+
2.1. Grants
|
|
90
|
+
|
|
91
|
+
Each Contributor hereby grants You a world-wide, royalty-free,
|
|
92
|
+
non-exclusive license:
|
|
93
|
+
|
|
94
|
+
(a) under intellectual property rights (other than patent or trademark)
|
|
95
|
+
Licensable by such Contributor to use, reproduce, make available,
|
|
96
|
+
modify, display, perform, distribute, and otherwise exploit its
|
|
97
|
+
Contributions, either on an unmodified basis, with Modifications, or
|
|
98
|
+
as part of a Larger Work; and
|
|
99
|
+
|
|
100
|
+
(b) under Patent Claims of such Contributor to make, use, sell, offer
|
|
101
|
+
for sale, have made, import, and otherwise transfer either its
|
|
102
|
+
Contributions or its Contributor Version.
|
|
103
|
+
|
|
104
|
+
2.2. Effective Date
|
|
105
|
+
|
|
106
|
+
The licenses granted in Section 2.1 with respect to any Contribution
|
|
107
|
+
become effective for each Contribution on the date the Contributor first
|
|
108
|
+
distributes such Contribution.
|
|
109
|
+
|
|
110
|
+
2.3. Limitations on Grant Scope
|
|
111
|
+
|
|
112
|
+
The licenses granted in this Section 2 are the only rights granted under
|
|
113
|
+
this License. No additional rights or licenses will be implied from the
|
|
114
|
+
distribution or licensing of Covered Software under this License.
|
|
115
|
+
Notwithstanding Section 2.1(b) above, no patent license is granted by a
|
|
116
|
+
Contributor:
|
|
117
|
+
|
|
118
|
+
(a) for any code that a Contributor has removed from Covered Software;
|
|
119
|
+
or
|
|
120
|
+
|
|
121
|
+
(b) for infringements caused by: (i) Your and any other third party's
|
|
122
|
+
modifications of Covered Software, or (ii) the combination of its
|
|
123
|
+
Contributions with other software (except as part of its Contributor
|
|
124
|
+
Version); or
|
|
125
|
+
|
|
126
|
+
(c) under Patent Claims infringed by Covered Software in the absence of
|
|
127
|
+
its Contributions.
|
|
128
|
+
|
|
129
|
+
This License does not grant any rights in the trademarks, service marks,
|
|
130
|
+
or logos of any Contributor (except as may be necessary to comply with
|
|
131
|
+
the notice requirements in Section 3.4).
|
|
132
|
+
|
|
133
|
+
2.4. Subsequent Licenses
|
|
134
|
+
|
|
135
|
+
No Contributor makes additional grants as a result of Your choice to
|
|
136
|
+
distribute the Covered Software under a subsequent version of this
|
|
137
|
+
License (see Section 10.2) or under the terms of a Secondary License (if
|
|
138
|
+
permitted under the terms of Section 3.3).
|
|
139
|
+
|
|
140
|
+
2.5. Representation
|
|
141
|
+
|
|
142
|
+
Each Contributor represents that the Contributor believes its
|
|
143
|
+
Contributions are its original creation(s) or it has sufficient rights
|
|
144
|
+
to grant the rights to its Contributions conveyed by this License.
|
|
145
|
+
|
|
146
|
+
2.6. Fair Use
|
|
147
|
+
|
|
148
|
+
This License is not intended to limit any rights You have under
|
|
149
|
+
applicable copyright doctrines of fair use, fair dealing, or other
|
|
150
|
+
equivalents.
|
|
151
|
+
|
|
152
|
+
2.7. Conditions
|
|
153
|
+
|
|
154
|
+
Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
|
|
155
|
+
in Section 2.1.
|
|
156
|
+
|
|
157
|
+
3. Responsibilities
|
|
158
|
+
-------------------
|
|
159
|
+
|
|
160
|
+
3.1. Distribution of Source Form
|
|
161
|
+
|
|
162
|
+
All distribution of Covered Software in Source Code Form, including any
|
|
163
|
+
Modifications that You create or to which You contribute, must be under
|
|
164
|
+
the terms of this License. You must inform recipients that the Source
|
|
165
|
+
Code Form of the Covered Software is governed by the terms of this
|
|
166
|
+
License, and how they can obtain a copy of this License. You may not
|
|
167
|
+
attempt to alter or restrict the recipients' rights in the Source Code
|
|
168
|
+
Form.
|
|
169
|
+
|
|
170
|
+
3.2. Distribution of Executable Form
|
|
171
|
+
|
|
172
|
+
If You distribute Covered Software in Executable Form then:
|
|
173
|
+
|
|
174
|
+
(a) such Covered Software must also be made available in Source Code
|
|
175
|
+
Form, as described in Section 3.1, and You must inform recipients of
|
|
176
|
+
the Executable Form how they can obtain a copy of such Source Code
|
|
177
|
+
Form by reasonable means in a timely manner, at a charge no more
|
|
178
|
+
than the cost of distribution to the recipient; and
|
|
179
|
+
|
|
180
|
+
(b) You may distribute such Executable Form under the terms of this
|
|
181
|
+
License, or sublicense it under different terms, provided that the
|
|
182
|
+
license for the Executable Form does not attempt to limit or alter
|
|
183
|
+
the recipients' rights in the Source Code Form under this License.
|
|
184
|
+
|
|
185
|
+
3.3. Distribution of a Larger Work
|
|
186
|
+
|
|
187
|
+
You may create and distribute a Larger Work under terms of Your choice,
|
|
188
|
+
provided that You also comply with the requirements of this License for
|
|
189
|
+
the Covered Software. If the Larger Work is a combination of Covered
|
|
190
|
+
Software with a work governed by one or more Secondary Licenses, and the
|
|
191
|
+
Covered Software is not Incompatible With Secondary Licenses, this
|
|
192
|
+
License permits You to additionally distribute such Covered Software
|
|
193
|
+
under the terms of such Secondary License(s), so that the recipient of
|
|
194
|
+
the Larger Work may, at their option, further distribute the Covered
|
|
195
|
+
Software under the terms of either this License or such Secondary
|
|
196
|
+
License(s).
|
|
197
|
+
|
|
198
|
+
3.4. Notices
|
|
199
|
+
|
|
200
|
+
You may not remove or alter the substance of any license notices
|
|
201
|
+
(including copyright notices, patent notices, disclaimers of warranty,
|
|
202
|
+
or limitations of liability) contained within the Source Code Form of
|
|
203
|
+
the Covered Software, except that You may alter any license notices to
|
|
204
|
+
the extent required to remedy known factual inaccuracies.
|
|
205
|
+
|
|
206
|
+
3.5. Application of Additional Terms
|
|
207
|
+
|
|
208
|
+
You may choose to offer, and to charge a fee for, warranty, support,
|
|
209
|
+
indemnity or liability obligations to one or more recipients of Covered
|
|
210
|
+
Software. However, You may do so only on Your own behalf, and not on
|
|
211
|
+
behalf of any Contributor. You must make it absolutely clear that any
|
|
212
|
+
such warranty, support, indemnity, or liability obligation is offered by
|
|
213
|
+
You alone, and You hereby agree to indemnify every Contributor for any
|
|
214
|
+
liability incurred by such Contributor as a result of warranty, support,
|
|
215
|
+
indemnity or liability terms You offer. You may include additional
|
|
216
|
+
disclaimers of warranty and limitations of liability specific to any
|
|
217
|
+
jurisdiction.
|
|
218
|
+
|
|
219
|
+
4. Inability to Comply Due to Statute or Regulation
|
|
220
|
+
---------------------------------------------------
|
|
221
|
+
|
|
222
|
+
If it is impossible for You to comply with any of the terms of this
|
|
223
|
+
License with respect to some or all of the Covered Software due to
|
|
224
|
+
statute, judicial order, or regulation then You must: (a) comply with
|
|
225
|
+
the terms of this License to the maximum extent possible; and (b)
|
|
226
|
+
describe the limitations and the code they affect. Such description must
|
|
227
|
+
be placed in a text file included with all distributions of the Covered
|
|
228
|
+
Software under this License. Except to the extent prohibited by statute
|
|
229
|
+
or regulation, such description must be sufficiently detailed for a
|
|
230
|
+
recipient of ordinary skill to be able to understand it.
|
|
231
|
+
|
|
232
|
+
5. Termination
|
|
233
|
+
--------------
|
|
234
|
+
|
|
235
|
+
5.1. The rights granted under this License will terminate automatically
|
|
236
|
+
if You fail to comply with any of its terms. However, if You become
|
|
237
|
+
compliant, then the rights granted under this License from a particular
|
|
238
|
+
Contributor are reinstated (a) provisionally, unless and until such
|
|
239
|
+
Contributor explicitly and finally terminates Your grants, and (b) on an
|
|
240
|
+
ongoing basis, if such Contributor fails to notify You of the
|
|
241
|
+
non-compliance by some reasonable means prior to 60 days after You have
|
|
242
|
+
come back into compliance. Moreover, Your grants from a particular
|
|
243
|
+
Contributor are reinstated on an ongoing basis if such Contributor
|
|
244
|
+
notifies You of the non-compliance by some reasonable means, this is the
|
|
245
|
+
first time You have received notice of non-compliance with this License
|
|
246
|
+
from such Contributor, and You become compliant prior to 30 days after
|
|
247
|
+
Your receipt of the notice.
|
|
248
|
+
|
|
249
|
+
5.2. If You initiate litigation against any entity by asserting a patent
|
|
250
|
+
infringement claim (excluding declaratory judgment actions,
|
|
251
|
+
counter-claims, and cross-claims) alleging that a Contributor Version
|
|
252
|
+
directly or indirectly infringes any patent, then the rights granted to
|
|
253
|
+
You by any and all Contributors for the Covered Software under Section
|
|
254
|
+
2.1 of this License shall terminate.
|
|
255
|
+
|
|
256
|
+
5.3. In the event of termination under Sections 5.1 or 5.2 above, all
|
|
257
|
+
end user license agreements (excluding distributors and resellers) which
|
|
258
|
+
have been validly granted by You or Your distributors under this License
|
|
259
|
+
prior to termination shall survive termination.
|
|
260
|
+
|
|
261
|
+
************************************************************************
|
|
262
|
+
* *
|
|
263
|
+
* 6. Disclaimer of Warranty *
|
|
264
|
+
* ------------------------- *
|
|
265
|
+
* *
|
|
266
|
+
* Covered Software is provided under this License on an "as is" *
|
|
267
|
+
* basis, without warranty of any kind, either expressed, implied, or *
|
|
268
|
+
* statutory, including, without limitation, warranties that the *
|
|
269
|
+
* Covered Software is free of defects, merchantable, fit for a *
|
|
270
|
+
* particular purpose or non-infringing. The entire risk as to the *
|
|
271
|
+
* quality and performance of the Covered Software is with You. *
|
|
272
|
+
* Should any Covered Software prove defective in any respect, You *
|
|
273
|
+
* (not any Contributor) assume the cost of any necessary servicing, *
|
|
274
|
+
* repair, or correction. This disclaimer of warranty constitutes an *
|
|
275
|
+
* essential part of this License. No use of any Covered Software is *
|
|
276
|
+
* authorized under this License except under this disclaimer. *
|
|
277
|
+
* *
|
|
278
|
+
************************************************************************
|
|
279
|
+
|
|
280
|
+
************************************************************************
|
|
281
|
+
* *
|
|
282
|
+
* 7. Limitation of Liability *
|
|
283
|
+
* -------------------------- *
|
|
284
|
+
* *
|
|
285
|
+
* Under no circumstances and under no legal theory, whether tort *
|
|
286
|
+
* (including negligence), contract, or otherwise, shall any *
|
|
287
|
+
* Contributor, or anyone who distributes Covered Software as *
|
|
288
|
+
* permitted above, be liable to You for any direct, indirect, *
|
|
289
|
+
* special, incidental, or consequential damages of any character *
|
|
290
|
+
* including, without limitation, damages for lost profits, loss of *
|
|
291
|
+
* goodwill, work stoppage, computer failure or malfunction, or any *
|
|
292
|
+
* and all other commercial damages or losses, even if such party *
|
|
293
|
+
* shall have been informed of the possibility of such damages. This *
|
|
294
|
+
* limitation of liability shall not apply to liability for death or *
|
|
295
|
+
* personal injury resulting from such party's negligence to the *
|
|
296
|
+
* extent applicable law prohibits such limitation. Some *
|
|
297
|
+
* jurisdictions do not allow the exclusion or limitation of *
|
|
298
|
+
* incidental or consequential damages, so this exclusion and *
|
|
299
|
+
* limitation may not apply to You. *
|
|
300
|
+
* *
|
|
301
|
+
************************************************************************
|
|
302
|
+
|
|
303
|
+
8. Litigation
|
|
304
|
+
-------------
|
|
305
|
+
|
|
306
|
+
Any litigation relating to this License may be brought only in the
|
|
307
|
+
courts of a jurisdiction where the defendant maintains its principal
|
|
308
|
+
place of business and such litigation shall be governed by laws of that
|
|
309
|
+
jurisdiction, without reference to its conflict-of-law provisions.
|
|
310
|
+
Nothing in this Section shall prevent a party's ability to bring
|
|
311
|
+
cross-claims or counter-claims.
|
|
312
|
+
|
|
313
|
+
9. Miscellaneous
|
|
314
|
+
----------------
|
|
315
|
+
|
|
316
|
+
This License represents the complete agreement concerning the subject
|
|
317
|
+
matter hereof. If any provision of this License is held to be
|
|
318
|
+
unenforceable, such provision shall be reformed only to the extent
|
|
319
|
+
necessary to make it enforceable. Any law or regulation which provides
|
|
320
|
+
that the language of a contract shall be construed against the drafter
|
|
321
|
+
shall not be used to construe this License against a Contributor.
|
|
322
|
+
|
|
323
|
+
10. Versions of the License
|
|
324
|
+
---------------------------
|
|
325
|
+
|
|
326
|
+
10.1. New Versions
|
|
327
|
+
|
|
328
|
+
Mozilla Foundation is the license steward. Except as provided in Section
|
|
329
|
+
10.3, no one other than the license steward has the right to modify or
|
|
330
|
+
publish new versions of this License. Each version will be given a
|
|
331
|
+
distinguishing version number.
|
|
332
|
+
|
|
333
|
+
10.2. Effect of New Versions
|
|
334
|
+
|
|
335
|
+
You may distribute the Covered Software under the terms of the version
|
|
336
|
+
of the License under which You originally received the Covered Software,
|
|
337
|
+
or under the terms of any subsequent version published by the license
|
|
338
|
+
steward.
|
|
339
|
+
|
|
340
|
+
10.3. Modified Versions
|
|
341
|
+
|
|
342
|
+
If you create software not governed by this License, and you want to
|
|
343
|
+
create a new license for such software, you may create and use a
|
|
344
|
+
modified version of this License if you rename the license and remove
|
|
345
|
+
any references to the name of the license steward (except to note that
|
|
346
|
+
such modified license differs from this License).
|
|
347
|
+
|
|
348
|
+
10.4. Distributing Source Code Form that is Incompatible With Secondary
|
|
349
|
+
Licenses
|
|
350
|
+
|
|
351
|
+
If You choose to distribute Source Code Form that is Incompatible With
|
|
352
|
+
Secondary Licenses under the terms of this version of the License, the
|
|
353
|
+
notice described in Exhibit B of this License must be attached.
|
|
354
|
+
|
|
355
|
+
Exhibit A - Source Code Form License Notice
|
|
356
|
+
-------------------------------------------
|
|
357
|
+
|
|
358
|
+
This Source Code Form is subject to the terms of the Mozilla Public
|
|
359
|
+
License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
360
|
+
file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
|
361
|
+
|
|
362
|
+
If it is not possible or desirable to put the notice in a particular
|
|
363
|
+
file, then You may include the notice in a location (such as a LICENSE
|
|
364
|
+
file in a relevant directory) where a recipient would be likely to look
|
|
365
|
+
for such a notice.
|
|
366
|
+
|
|
367
|
+
You may add additional accurate notices of copyright ownership.
|
|
368
|
+
|
|
369
|
+
Exhibit B - "Incompatible With Secondary Licenses" Notice
|
|
370
|
+
---------------------------------------------------------
|
|
371
|
+
|
|
372
|
+
This Source Code Form is "Incompatible With Secondary Licenses", as
|
|
373
|
+
defined by the Mozilla Public License, v. 2.0.
|
package/README.md
ADDED
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
# @liebstoeckel/present-relay
|
|
2
|
+
|
|
3
|
+
> A WAN relay for liebstoeckel live mode. Reach remote audiences without exposing your laptop.
|
|
4
|
+
|
|
5
|
+
Part of [liebstoeckel](https://liebstoeckel.app), a code-first presentation framework. You write decks in MDX and TSX and build them into a single self-contained HTML file with no server or runtime dependencies. The same file works offline, and when you host it the deck runs a live session between the presenter and the audience. Built on Bun, React 19, Motion, and Tailwind v4.
|
|
6
|
+
|
|
7
|
+
> **Status: experimental, pre-1.0.** liebstoeckel is an evolving experiment, not yet production-ready. Before 1.0, breaking changes can land in any release without a major-version bump, so pin an exact version if you depend on it.
|
|
8
|
+
|
|
9
|
+
A stateless bridge you run on a public host. The presenter connects out to it, remote viewers connect in, and frames pass through, so you can present to people off your LAN without opening ports on your machine. The relay never runs deck code. It serves the deck under a locked-down `sandbox` CSP (an opaque origin) and only shuttles sync frames.
|
|
10
|
+
|
|
11
|
+
## Install
|
|
12
|
+
|
|
13
|
+
```sh
|
|
14
|
+
bun add @liebstoeckel/present-relay
|
|
15
|
+
# …or run the relay directly:
|
|
16
|
+
bunx @liebstoeckel/present-relay --tokens "<account-token>"
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Usage
|
|
20
|
+
|
|
21
|
+
```ts
|
|
22
|
+
import { createRelay } from "@liebstoeckel/present-relay";
|
|
23
|
+
|
|
24
|
+
const relay = await createRelay({
|
|
25
|
+
accountTokens: ["s3cret-account-token"], // at least one, required
|
|
26
|
+
publicBaseUrl: "https://relay.example.com", // for wss:// links behind TLS
|
|
27
|
+
});
|
|
28
|
+
|
|
29
|
+
console.log(relay.baseUrl);
|
|
30
|
+
// …later
|
|
31
|
+
await relay.stop();
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Then point the live server at it, for example `liebstoeckel live deck.html --relay <url> --relay-token <token>`.
|
|
35
|
+
|
|
36
|
+
### Self-host with Docker
|
|
37
|
+
|
|
38
|
+
A generic image ships in this package ([`Dockerfile`](./Dockerfile)). It's all env-driven: `PORT`, `PRESENT_RELAY_TOKENS` (comma-separated account tokens), and `PRESENT_RELAY_PUBLIC_URL` (your TLS origin, so links come back as `wss://`). Build it from the repo root, where a frozen workspace install resolves the `@liebstoeckel/*` symlinks:
|
|
39
|
+
|
|
40
|
+
```sh
|
|
41
|
+
docker build -f packages/present-relay/Dockerfile -t liebstoeckel-relay .
|
|
42
|
+
docker run -p 8080:8080 \
|
|
43
|
+
-e PRESENT_RELAY_TOKENS="$(openssl rand -hex 24)" \
|
|
44
|
+
-e PRESENT_RELAY_PUBLIC_URL=https://relay.example.com \
|
|
45
|
+
liebstoeckel-relay
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
Terminate TLS at your proxy and forward `/sync/*` as a WebSocket. The image runs as a non-root user on `:8080` and works under a read-only root filesystem.
|
|
49
|
+
|
|
50
|
+
## Exports
|
|
51
|
+
|
|
52
|
+
| Entry | What |
|
|
53
|
+
|---|---|
|
|
54
|
+
| `@liebstoeckel/present-relay` | `createRelay`, the `RelayServer` runtime, auth helpers (`safeEqual`, `matchAccount`, `bearer`), and the `RelayOptions` type |
|
|
55
|
+
| `@liebstoeckel/present-relay/cli` | `runRelay` (powers the `liebstoeckel-relay` bin). Flags: `--port`/`PORT`, `--tokens`/`PRESENT_RELAY_TOKENS`, `--public-url`/`PRESENT_RELAY_PUBLIC_URL` |
|
|
56
|
+
|
|
57
|
+
`createRelay` options: `accountTokens` (required, at least one), `port?`, `hostname?` (`0.0.0.0`), `publicBaseUrl?`, `maxDeckBytes?` (8MB), `maxSessionsPerAccount?` (200), `sessionTtlMs?` (6h), `maxFrameBytes?` (4MB), `keepaliveMs?` (25s). It returns a `RelayServer` with `port`, `baseUrl`, `sessions`, and `stop()`.
|
|
58
|
+
|
|
59
|
+
## Gotchas
|
|
60
|
+
|
|
61
|
+
- Sessions are in-memory and TTL-expiring. The relay holds no deck content at rest and forgets sessions on restart.
|
|
62
|
+
- Terminate TLS at your proxy and pass `--public-url` so the relay hands out `wss://` links.
|
|
63
|
+
- Three token layers gate access: account (who may create sessions), session, and runner.
|
|
64
|
+
|
|
65
|
+
## Architecture
|
|
66
|
+
|
|
67
|
+
A single `Bun.serve` HTTP and WebSocket process that holds many independent sessions in memory. It reuses the `Hub`, `Session`, and token primitives from `live-server`, and adds the multi-tenant, public-facing shell around them.
|
|
68
|
+
|
|
69
|
+
- `relay-server.ts` holds `createRelay`, the whole server. Its routes:
|
|
70
|
+
- `POST /api/sessions` (gated by an account-token `Bearer`) accepts an uploaded deck, enforces the deck-size and per-account session quotas, mints a `Session` plus a privileged `runnerToken`, spins up a per-session `Hub`, and returns the presenter, viewer, and sync URLs with an expiry.
|
|
71
|
+
- `DELETE /api/sessions/:id` is owner-only teardown.
|
|
72
|
+
- `WS /sync/:id?t=<token>` is a token-gated Yjs relay into that session's `Hub`.
|
|
73
|
+
- `GET /s/:id?t=<token>` serves the deck under a locked-down `sandbox allow-scripts allow-popups` CSP (an opaque origin, no `allow-same-origin`; `allow-popups` is only for the presenter `P` pop-out), with `connect-src` pinned to the relay's own ws and http origin. The bootstrap is injected per request.
|
|
74
|
+
- `auth.ts` does constant-time token comparison (`safeEqual` over `timingSafeEqual`), `matchAccount` (which compares all configured tokens with no early-out), and `bearer` header parsing.
|
|
75
|
+
- Each session is in-memory and TTL-expiring (6h by default). A timer calls `dropSession` to destroy the `Hub` and forget its tokens, and nothing is persisted. `originOf` derives public URLs from `publicBaseUrl` or the `x-forwarded-*` headers, since TLS terminates at your proxy.
|
|
76
|
+
- `cli.ts` holds `runRelay`, which powers the `liebstoeckel-relay` bin. It parses `--port`, `--tokens`, and `--public-url` (with env fallbacks), generates a throwaway account token when none is given, and prints the base URL along with how to point `liebstoeckel live` at it.
|
|
77
|
+
|
|
78
|
+
## Links
|
|
79
|
+
|
|
80
|
+
- [Relay guide](https://docs.liebstoeckel.app/guides/relay/) and [live mode](https://docs.liebstoeckel.app/guides/live/)
|
|
81
|
+
- [Homepage](https://liebstoeckel.app)
|
|
82
|
+
- [Source and issues](https://github.com/liebstoeckel/liebstoeckel-app)
|
|
83
|
+
|
|
84
|
+
Licensed under [MPL-2.0](https://github.com/liebstoeckel/liebstoeckel-app/blob/main/LICENSE).
|
package/package.json
ADDED
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@liebstoeckel/present-relay",
|
|
3
|
+
"version": "0.3.5",
|
|
4
|
+
"description": "WAN relay for liebstoeckel live mode, reaching remote audiences without exposing your laptop.",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"liebstoeckel",
|
|
7
|
+
"slides",
|
|
8
|
+
"presentation-slides",
|
|
9
|
+
"ai-agents",
|
|
10
|
+
"ai",
|
|
11
|
+
"skills",
|
|
12
|
+
"relay",
|
|
13
|
+
"yjs",
|
|
14
|
+
"websocket",
|
|
15
|
+
"bun"
|
|
16
|
+
],
|
|
17
|
+
"homepage": "https://liebstoeckel.app",
|
|
18
|
+
"bugs": "https://github.com/liebstoeckel/liebstoeckel-app/issues",
|
|
19
|
+
"repository": {
|
|
20
|
+
"type": "git",
|
|
21
|
+
"url": "git+https://github.com/liebstoeckel/liebstoeckel-app.git",
|
|
22
|
+
"directory": "packages/present-relay"
|
|
23
|
+
},
|
|
24
|
+
"license": "MPL-2.0",
|
|
25
|
+
"author": "Leon Kaucher <contact@liebstoeckel.app>",
|
|
26
|
+
"publishConfig": {
|
|
27
|
+
"access": "public"
|
|
28
|
+
},
|
|
29
|
+
"files": [
|
|
30
|
+
"src",
|
|
31
|
+
"!src/**/*.test.ts",
|
|
32
|
+
"!src/**/*.test.tsx",
|
|
33
|
+
"LICENSE"
|
|
34
|
+
],
|
|
35
|
+
"engines": {
|
|
36
|
+
"bun": ">=1.3"
|
|
37
|
+
},
|
|
38
|
+
"type": "module",
|
|
39
|
+
"bin": {
|
|
40
|
+
"liebstoeckel-relay": "./src/cli.ts"
|
|
41
|
+
},
|
|
42
|
+
"exports": {
|
|
43
|
+
".": "./src/index.ts",
|
|
44
|
+
"./cli": "./src/cli.ts",
|
|
45
|
+
"./grant": "./src/grant.ts"
|
|
46
|
+
},
|
|
47
|
+
"dependencies": {
|
|
48
|
+
"@liebstoeckel/live-server": "^0.3.5",
|
|
49
|
+
"citty": "^0.2.2",
|
|
50
|
+
"@opentelemetry/api": "^1.9.1",
|
|
51
|
+
"@opentelemetry/context-async-hooks": "^2.7.1",
|
|
52
|
+
"@opentelemetry/core": "^2.7.1",
|
|
53
|
+
"@opentelemetry/exporter-trace-otlp-http": "^0.218.0",
|
|
54
|
+
"@opentelemetry/resources": "^2.7.1",
|
|
55
|
+
"@opentelemetry/sdk-trace-base": "^2.7.1",
|
|
56
|
+
"@opentelemetry/semantic-conventions": "^1.41.1"
|
|
57
|
+
}
|
|
58
|
+
}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
// Per-pod public addressing for the relay StatefulSet (ADR 0071 §3 / ticket 0016).
|
|
2
|
+
// Each relay pod owns a live session's Yjs Hub in memory, so the control plane pins a
|
|
3
|
+
// session to one pod and hands audiences a per-pod host (`liebstoeckel-relayNNN…`). A
|
|
4
|
+
// StatefulSet shares a single pod template, so a pod can't be handed a static per-pod
|
|
5
|
+
// PRESENT_RELAY_PUBLIC_URL, instead it derives its OWN base from its ordinal (via the
|
|
6
|
+
// downward-API POD_NAME) plus a host template. Pure + unit-tested; no I/O.
|
|
7
|
+
|
|
8
|
+
/** Extract the StatefulSet ordinal from a pod name (`liebstoeckel-relay-7` → 7). */
|
|
9
|
+
export function podOrdinal(podName: string | undefined): number | null {
|
|
10
|
+
if (!podName) return null;
|
|
11
|
+
const m = podName.match(/-(\d+)$/);
|
|
12
|
+
if (!m) return null;
|
|
13
|
+
const n = Number(m[1]);
|
|
14
|
+
return Number.isInteger(n) && n >= 0 ? n : null;
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
/** Zero-pad an ordinal to the relay's NNN host convention (7 → "007"); never truncates. */
|
|
18
|
+
export function ordinalTag(ordinal: number, width = 3): string {
|
|
19
|
+
return String(ordinal).padStart(width, "0");
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
/**
|
|
23
|
+
* Derive a relay pod's own public base URL from its pod name + a host template.
|
|
24
|
+
* `liebstoeckel-relay-7` + `https://liebstoeckel-relayNNN.example.com`
|
|
25
|
+
* → `https://liebstoeckel-relay007.example.com` (trailing slashes trimmed).
|
|
26
|
+
* Returns undefined when it can't (no pod name / no `NNN` template / unparseable
|
|
27
|
+
* ordinal) so the caller falls back to an explicit PRESENT_RELAY_PUBLIC_URL or the
|
|
28
|
+
* request-derived origin.
|
|
29
|
+
*/
|
|
30
|
+
export function relayPublicBaseFromPod(
|
|
31
|
+
podName: string | undefined,
|
|
32
|
+
template: string | undefined,
|
|
33
|
+
): string | undefined {
|
|
34
|
+
const ord = podOrdinal(podName);
|
|
35
|
+
if (ord === null || !template || !template.includes("NNN")) return undefined;
|
|
36
|
+
return template.replace(/NNN/g, ordinalTag(ord)).replace(/\/+$/, "");
|
|
37
|
+
}
|
package/src/auth.ts
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import { timingSafeEqual } from "node:crypto";
|
|
2
|
+
|
|
3
|
+
/** Constant-time string compare. Length mismatch short-circuits (the length of a
|
|
4
|
+
* token isn't the secret); equal-length inputs are compared without early-out. */
|
|
5
|
+
export function safeEqual(a: string, b: string): boolean {
|
|
6
|
+
const ab = Buffer.from(a, "utf8");
|
|
7
|
+
const bb = Buffer.from(b, "utf8");
|
|
8
|
+
if (ab.length !== bb.length) return false;
|
|
9
|
+
return timingSafeEqual(ab, bb);
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
/** The matching account token, or null. Compares against every configured token
|
|
13
|
+
* (no early return) so timing doesn't reveal which one matched. */
|
|
14
|
+
export function matchAccount(tokens: readonly string[], presented: string | null | undefined): string | null {
|
|
15
|
+
if (!presented) return null;
|
|
16
|
+
let found: string | null = null;
|
|
17
|
+
for (const t of tokens) {
|
|
18
|
+
if (safeEqual(t, presented)) found = t;
|
|
19
|
+
}
|
|
20
|
+
return found;
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
/** Extract a `Authorization: Bearer <token>` value, or null. */
|
|
24
|
+
export function bearer(req: Request): string | null {
|
|
25
|
+
const h = req.headers.get("authorization");
|
|
26
|
+
const m = h?.match(/^Bearer\s+(.+)$/i);
|
|
27
|
+
return m ? m[1]!.trim() : null;
|
|
28
|
+
}
|