Low-latency AT Protocol interaction indexer.
add README and LICENSE
Aly Raffauf
(Jul 3, 2026, 12:27 PM EDT)
fd0c66a9
18ceacb6
+770
+651
LICENSE.md
+651
LICENSE.md
···
1
+
GNU Affero General Public License
2
+
=================================
3
+
4
+
_Version 3, 19 November 2007_
5
+
_Copyright © 2007 Free Software Foundation, Inc. <<http://fsf.org/>>_
6
+
7
+
Everyone is permitted to copy and distribute verbatim copies
8
+
of this license document, but changing it is not allowed.
9
+
10
+
## Preamble
11
+
12
+
The GNU Affero General Public License is a free, copyleft license for
13
+
software and other kinds of works, specifically designed to ensure
14
+
cooperation with the community in the case of network server software.
15
+
16
+
The licenses for most software and other practical works are designed
17
+
to take away your freedom to share and change the works. By contrast,
18
+
our General Public Licenses are intended to guarantee your freedom to
19
+
share and change all versions of a program--to make sure it remains free
20
+
software for all its users.
21
+
22
+
When we speak of free software, we are referring to freedom, not
23
+
price. Our General Public Licenses are designed to make sure that you
24
+
have the freedom to distribute copies of free software (and charge for
25
+
them if you wish), that you receive source code or can get it if you
26
+
want it, that you can change the software or use pieces of it in new
27
+
free programs, and that you know you can do these things.
28
+
29
+
Developers that use our General Public Licenses protect your rights
30
+
with two steps: **(1)** assert copyright on the software, and **(2)** offer
31
+
you this License which gives you legal permission to copy, distribute
32
+
and/or modify the software.
33
+
34
+
A secondary benefit of defending all users' freedom is that
35
+
improvements made in alternate versions of the program, if they
36
+
receive widespread use, become available for other developers to
37
+
incorporate. Many developers of free software are heartened and
38
+
encouraged by the resulting cooperation. However, in the case of
39
+
software used on network servers, this result may fail to come about.
40
+
The GNU General Public License permits making a modified version and
41
+
letting the public access it on a server without ever releasing its
42
+
source code to the public.
43
+
44
+
The GNU Affero General Public License is designed specifically to
45
+
ensure that, in such cases, the modified source code becomes available
46
+
to the community. It requires the operator of a network server to
47
+
provide the source code of the modified version running there to the
48
+
users of that server. Therefore, public use of a modified version, on
49
+
a publicly accessible server, gives the public access to the source
50
+
code of the modified version.
51
+
52
+
An older license, called the Affero General Public License and
53
+
published by Affero, was designed to accomplish similar goals. This is
54
+
a different license, not a version of the Affero GPL, but Affero has
55
+
released a new version of the Affero GPL which permits relicensing under
56
+
this license.
57
+
58
+
The precise terms and conditions for copying, distribution and
59
+
modification follow.
60
+
61
+
## TERMS AND CONDITIONS
62
+
63
+
### 0. Definitions
64
+
65
+
“This License” refers to version 3 of the GNU Affero General Public License.
66
+
67
+
“Copyright” also means copyright-like laws that apply to other kinds of
68
+
works, such as semiconductor masks.
69
+
70
+
“The Program” refers to any copyrightable work licensed under this
71
+
License. Each licensee is addressed as “you”. “Licensees” and
72
+
“recipients” may be individuals or organizations.
73
+
74
+
To “modify” a work means to copy from or adapt all or part of the work
75
+
in a fashion requiring copyright permission, other than the making of an
76
+
exact copy. The resulting work is called a “modified version” of the
77
+
earlier work or a work “based on” the earlier work.
78
+
79
+
A “covered work” means either the unmodified Program or a work based
80
+
on the Program.
81
+
82
+
To “propagate” a work means to do anything with it that, without
83
+
permission, would make you directly or secondarily liable for
84
+
infringement under applicable copyright law, except executing it on a
85
+
computer or modifying a private copy. Propagation includes copying,
86
+
distribution (with or without modification), making available to the
87
+
public, and in some countries other activities as well.
88
+
89
+
To “convey” a work means any kind of propagation that enables other
90
+
parties to make or receive copies. Mere interaction with a user through
91
+
a computer network, with no transfer of a copy, is not conveying.
92
+
93
+
An interactive user interface displays “Appropriate Legal Notices”
94
+
to the extent that it includes a convenient and prominently visible
95
+
feature that **(1)** displays an appropriate copyright notice, and **(2)**
96
+
tells the user that there is no warranty for the work (except to the
97
+
extent that warranties are provided), that licensees may convey the
98
+
work under this License, and how to view a copy of this License. If
99
+
the interface presents a list of user commands or options, such as a
100
+
menu, a prominent item in the list meets this criterion.
101
+
102
+
### 1. Source Code
103
+
104
+
The “source code” for a work means the preferred form of the work
105
+
for making modifications to it. “Object code” means any non-source
106
+
form of a work.
107
+
108
+
A “Standard Interface” means an interface that either is an official
109
+
standard defined by a recognized standards body, or, in the case of
110
+
interfaces specified for a particular programming language, one that
111
+
is widely used among developers working in that language.
112
+
113
+
The “System Libraries” of an executable work include anything, other
114
+
than the work as a whole, that **(a)** is included in the normal form of
115
+
packaging a Major Component, but which is not part of that Major
116
+
Component, and **(b)** serves only to enable use of the work with that
117
+
Major Component, or to implement a Standard Interface for which an
118
+
implementation is available to the public in source code form. A
119
+
“Major Component”, in this context, means a major essential component
120
+
(kernel, window system, and so on) of the specific operating system
121
+
(if any) on which the executable work runs, or a compiler used to
122
+
produce the work, or an object code interpreter used to run it.
123
+
124
+
The “Corresponding Source” for a work in object code form means all
125
+
the source code needed to generate, install, and (for an executable
126
+
work) run the object code and to modify the work, including scripts to
127
+
control those activities. However, it does not include the work's
128
+
System Libraries, or general-purpose tools or generally available free
129
+
programs which are used unmodified in performing those activities but
130
+
which are not part of the work. For example, Corresponding Source
131
+
includes interface definition files associated with source files for
132
+
the work, and the source code for shared libraries and dynamically
133
+
linked subprograms that the work is specifically designed to require,
134
+
such as by intimate data communication or control flow between those
135
+
subprograms and other parts of the work.
136
+
137
+
The Corresponding Source need not include anything that users
138
+
can regenerate automatically from other parts of the Corresponding
139
+
Source.
140
+
141
+
The Corresponding Source for a work in source code form is that
142
+
same work.
143
+
144
+
### 2. Basic Permissions
145
+
146
+
All rights granted under this License are granted for the term of
147
+
copyright on the Program, and are irrevocable provided the stated
148
+
conditions are met. This License explicitly affirms your unlimited
149
+
permission to run the unmodified Program. The output from running a
150
+
covered work is covered by this License only if the output, given its
151
+
content, constitutes a covered work. This License acknowledges your
152
+
rights of fair use or other equivalent, as provided by copyright law.
153
+
154
+
You may make, run and propagate covered works that you do not
155
+
convey, without conditions so long as your license otherwise remains
156
+
in force. You may convey covered works to others for the sole purpose
157
+
of having them make modifications exclusively for you, or provide you
158
+
with facilities for running those works, provided that you comply with
159
+
the terms of this License in conveying all material for which you do
160
+
not control copyright. Those thus making or running the covered works
161
+
for you must do so exclusively on your behalf, under your direction
162
+
and control, on terms that prohibit them from making any copies of
163
+
your copyrighted material outside their relationship with you.
164
+
165
+
Conveying under any other circumstances is permitted solely under
166
+
the conditions stated below. Sublicensing is not allowed; section 10
167
+
makes it unnecessary.
168
+
169
+
### 3. Protecting Users' Legal Rights From Anti-Circumvention Law
170
+
171
+
No covered work shall be deemed part of an effective technological
172
+
measure under any applicable law fulfilling obligations under article
173
+
11 of the WIPO copyright treaty adopted on 20 December 1996, or
174
+
similar laws prohibiting or restricting circumvention of such
175
+
measures.
176
+
177
+
When you convey a covered work, you waive any legal power to forbid
178
+
circumvention of technological measures to the extent such circumvention
179
+
is effected by exercising rights under this License with respect to
180
+
the covered work, and you disclaim any intention to limit operation or
181
+
modification of the work as a means of enforcing, against the work's
182
+
users, your or third parties' legal rights to forbid circumvention of
183
+
technological measures.
184
+
185
+
### 4. Conveying Verbatim Copies
186
+
187
+
You may convey verbatim copies of the Program's source code as you
188
+
receive it, in any medium, provided that you conspicuously and
189
+
appropriately publish on each copy an appropriate copyright notice;
190
+
keep intact all notices stating that this License and any
191
+
non-permissive terms added in accord with section 7 apply to the code;
192
+
keep intact all notices of the absence of any warranty; and give all
193
+
recipients a copy of this License along with the Program.
194
+
195
+
You may charge any price or no price for each copy that you convey,
196
+
and you may offer support or warranty protection for a fee.
197
+
198
+
### 5. Conveying Modified Source Versions
199
+
200
+
You may convey a work based on the Program, or the modifications to
201
+
produce it from the Program, in the form of source code under the
202
+
terms of section 4, provided that you also meet all of these conditions:
203
+
204
+
* **a)** The work must carry prominent notices stating that you modified
205
+
it, and giving a relevant date.
206
+
* **b)** The work must carry prominent notices stating that it is
207
+
released under this License and any conditions added under section 7.
208
+
This requirement modifies the requirement in section 4 to
209
+
“keep intact all notices”.
210
+
* **c)** You must license the entire work, as a whole, under this
211
+
License to anyone who comes into possession of a copy. This
212
+
License will therefore apply, along with any applicable section 7
213
+
additional terms, to the whole of the work, and all its parts,
214
+
regardless of how they are packaged. This License gives no
215
+
permission to license the work in any other way, but it does not
216
+
invalidate such permission if you have separately received it.
217
+
* **d)** If the work has interactive user interfaces, each must display
218
+
Appropriate Legal Notices; however, if the Program has interactive
219
+
interfaces that do not display Appropriate Legal Notices, your
220
+
work need not make them do so.
221
+
222
+
A compilation of a covered work with other separate and independent
223
+
works, which are not by their nature extensions of the covered work,
224
+
and which are not combined with it such as to form a larger program,
225
+
in or on a volume of a storage or distribution medium, is called an
226
+
“aggregate” if the compilation and its resulting copyright are not
227
+
used to limit the access or legal rights of the compilation's users
228
+
beyond what the individual works permit. Inclusion of a covered work
229
+
in an aggregate does not cause this License to apply to the other
230
+
parts of the aggregate.
231
+
232
+
### 6. Conveying Non-Source Forms
233
+
234
+
You may convey a covered work in object code form under the terms
235
+
of sections 4 and 5, provided that you also convey the
236
+
machine-readable Corresponding Source under the terms of this License,
237
+
in one of these ways:
238
+
239
+
* **a)** Convey the object code in, or embodied in, a physical product
240
+
(including a physical distribution medium), accompanied by the
241
+
Corresponding Source fixed on a durable physical medium
242
+
customarily used for software interchange.
243
+
* **b)** Convey the object code in, or embodied in, a physical product
244
+
(including a physical distribution medium), accompanied by a
245
+
written offer, valid for at least three years and valid for as
246
+
long as you offer spare parts or customer support for that product
247
+
model, to give anyone who possesses the object code either **(1)** a
248
+
copy of the Corresponding Source for all the software in the
249
+
product that is covered by this License, on a durable physical
250
+
medium customarily used for software interchange, for a price no
251
+
more than your reasonable cost of physically performing this
252
+
conveying of source, or **(2)** access to copy the
253
+
Corresponding Source from a network server at no charge.
254
+
* **c)** Convey individual copies of the object code with a copy of the
255
+
written offer to provide the Corresponding Source. This
256
+
alternative is allowed only occasionally and noncommercially, and
257
+
only if you received the object code with such an offer, in accord
258
+
with subsection 6b.
259
+
* **d)** Convey the object code by offering access from a designated
260
+
place (gratis or for a charge), and offer equivalent access to the
261
+
Corresponding Source in the same way through the same place at no
262
+
further charge. You need not require recipients to copy the
263
+
Corresponding Source along with the object code. If the place to
264
+
copy the object code is a network server, the Corresponding Source
265
+
may be on a different server (operated by you or a third party)
266
+
that supports equivalent copying facilities, provided you maintain
267
+
clear directions next to the object code saying where to find the
268
+
Corresponding Source. Regardless of what server hosts the
269
+
Corresponding Source, you remain obligated to ensure that it is
270
+
available for as long as needed to satisfy these requirements.
271
+
* **e)** Convey the object code using peer-to-peer transmission, provided
272
+
you inform other peers where the object code and Corresponding
273
+
Source of the work are being offered to the general public at no
274
+
charge under subsection 6d.
275
+
276
+
A separable portion of the object code, whose source code is excluded
277
+
from the Corresponding Source as a System Library, need not be
278
+
included in conveying the object code work.
279
+
280
+
A “User Product” is either **(1)** a “consumer product”, which means any
281
+
tangible personal property which is normally used for personal, family,
282
+
or household purposes, or **(2)** anything designed or sold for incorporation
283
+
into a dwelling. In determining whether a product is a consumer product,
284
+
doubtful cases shall be resolved in favor of coverage. For a particular
285
+
product received by a particular user, “normally used” refers to a
286
+
typical or common use of that class of product, regardless of the status
287
+
of the particular user or of the way in which the particular user
288
+
actually uses, or expects or is expected to use, the product. A product
289
+
is a consumer product regardless of whether the product has substantial
290
+
commercial, industrial or non-consumer uses, unless such uses represent
291
+
the only significant mode of use of the product.
292
+
293
+
“Installation Information” for a User Product means any methods,
294
+
procedures, authorization keys, or other information required to install
295
+
and execute modified versions of a covered work in that User Product from
296
+
a modified version of its Corresponding Source. The information must
297
+
suffice to ensure that the continued functioning of the modified object
298
+
code is in no case prevented or interfered with solely because
299
+
modification has been made.
300
+
301
+
If you convey an object code work under this section in, or with, or
302
+
specifically for use in, a User Product, and the conveying occurs as
303
+
part of a transaction in which the right of possession and use of the
304
+
User Product is transferred to the recipient in perpetuity or for a
305
+
fixed term (regardless of how the transaction is characterized), the
306
+
Corresponding Source conveyed under this section must be accompanied
307
+
by the Installation Information. But this requirement does not apply
308
+
if neither you nor any third party retains the ability to install
309
+
modified object code on the User Product (for example, the work has
310
+
been installed in ROM).
311
+
312
+
The requirement to provide Installation Information does not include a
313
+
requirement to continue to provide support service, warranty, or updates
314
+
for a work that has been modified or installed by the recipient, or for
315
+
the User Product in which it has been modified or installed. Access to a
316
+
network may be denied when the modification itself materially and
317
+
adversely affects the operation of the network or violates the rules and
318
+
protocols for communication across the network.
319
+
320
+
Corresponding Source conveyed, and Installation Information provided,
321
+
in accord with this section must be in a format that is publicly
322
+
documented (and with an implementation available to the public in
323
+
source code form), and must require no special password or key for
324
+
unpacking, reading or copying.
325
+
326
+
### 7. Additional Terms
327
+
328
+
“Additional permissions” are terms that supplement the terms of this
329
+
License by making exceptions from one or more of its conditions.
330
+
Additional permissions that are applicable to the entire Program shall
331
+
be treated as though they were included in this License, to the extent
332
+
that they are valid under applicable law. If additional permissions
333
+
apply only to part of the Program, that part may be used separately
334
+
under those permissions, but the entire Program remains governed by
335
+
this License without regard to the additional permissions.
336
+
337
+
When you convey a copy of a covered work, you may at your option
338
+
remove any additional permissions from that copy, or from any part of
339
+
it. (Additional permissions may be written to require their own
340
+
removal in certain cases when you modify the work.) You may place
341
+
additional permissions on material, added by you to a covered work,
342
+
for which you have or can give appropriate copyright permission.
343
+
344
+
Notwithstanding any other provision of this License, for material you
345
+
add to a covered work, you may (if authorized by the copyright holders of
346
+
that material) supplement the terms of this License with terms:
347
+
348
+
* **a)** Disclaiming warranty or limiting liability differently from the
349
+
terms of sections 15 and 16 of this License; or
350
+
* **b)** Requiring preservation of specified reasonable legal notices or
351
+
author attributions in that material or in the Appropriate Legal
352
+
Notices displayed by works containing it; or
353
+
* **c)** Prohibiting misrepresentation of the origin of that material, or
354
+
requiring that modified versions of such material be marked in
355
+
reasonable ways as different from the original version; or
356
+
* **d)** Limiting the use for publicity purposes of names of licensors or
357
+
authors of the material; or
358
+
* **e)** Declining to grant rights under trademark law for use of some
359
+
trade names, trademarks, or service marks; or
360
+
* **f)** Requiring indemnification of licensors and authors of that
361
+
material by anyone who conveys the material (or modified versions of
362
+
it) with contractual assumptions of liability to the recipient, for
363
+
any liability that these contractual assumptions directly impose on
364
+
those licensors and authors.
365
+
366
+
All other non-permissive additional terms are considered “further
367
+
restrictions” within the meaning of section 10. If the Program as you
368
+
received it, or any part of it, contains a notice stating that it is
369
+
governed by this License along with a term that is a further
370
+
restriction, you may remove that term. If a license document contains
371
+
a further restriction but permits relicensing or conveying under this
372
+
License, you may add to a covered work material governed by the terms
373
+
of that license document, provided that the further restriction does
374
+
not survive such relicensing or conveying.
375
+
376
+
If you add terms to a covered work in accord with this section, you
377
+
must place, in the relevant source files, a statement of the
378
+
additional terms that apply to those files, or a notice indicating
379
+
where to find the applicable terms.
380
+
381
+
Additional terms, permissive or non-permissive, may be stated in the
382
+
form of a separately written license, or stated as exceptions;
383
+
the above requirements apply either way.
384
+
385
+
### 8. Termination
386
+
387
+
You may not propagate or modify a covered work except as expressly
388
+
provided under this License. Any attempt otherwise to propagate or
389
+
modify it is void, and will automatically terminate your rights under
390
+
this License (including any patent licenses granted under the third
391
+
paragraph of section 11).
392
+
393
+
However, if you cease all violation of this License, then your
394
+
license from a particular copyright holder is reinstated **(a)**
395
+
provisionally, unless and until the copyright holder explicitly and
396
+
finally terminates your license, and **(b)** permanently, if the copyright
397
+
holder fails to notify you of the violation by some reasonable means
398
+
prior to 60 days after the cessation.
399
+
400
+
Moreover, your license from a particular copyright holder is
401
+
reinstated permanently if the copyright holder notifies you of the
402
+
violation by some reasonable means, this is the first time you have
403
+
received notice of violation of this License (for any work) from that
404
+
copyright holder, and you cure the violation prior to 30 days after
405
+
your receipt of the notice.
406
+
407
+
Termination of your rights under this section does not terminate the
408
+
licenses of parties who have received copies or rights from you under
409
+
this License. If your rights have been terminated and not permanently
410
+
reinstated, you do not qualify to receive new licenses for the same
411
+
material under section 10.
412
+
413
+
### 9. Acceptance Not Required for Having Copies
414
+
415
+
You are not required to accept this License in order to receive or
416
+
run a copy of the Program. Ancillary propagation of a covered work
417
+
occurring solely as a consequence of using peer-to-peer transmission
418
+
to receive a copy likewise does not require acceptance. However,
419
+
nothing other than this License grants you permission to propagate or
420
+
modify any covered work. These actions infringe copyright if you do
421
+
not accept this License. Therefore, by modifying or propagating a
422
+
covered work, you indicate your acceptance of this License to do so.
423
+
424
+
### 10. Automatic Licensing of Downstream Recipients
425
+
426
+
Each time you convey a covered work, the recipient automatically
427
+
receives a license from the original licensors, to run, modify and
428
+
propagate that work, subject to this License. You are not responsible
429
+
for enforcing compliance by third parties with this License.
430
+
431
+
An “entity transaction” is a transaction transferring control of an
432
+
organization, or substantially all assets of one, or subdividing an
433
+
organization, or merging organizations. If propagation of a covered
434
+
work results from an entity transaction, each party to that
435
+
transaction who receives a copy of the work also receives whatever
436
+
licenses to the work the party's predecessor in interest had or could
437
+
give under the previous paragraph, plus a right to possession of the
438
+
Corresponding Source of the work from the predecessor in interest, if
439
+
the predecessor has it or can get it with reasonable efforts.
440
+
441
+
You may not impose any further restrictions on the exercise of the
442
+
rights granted or affirmed under this License. For example, you may
443
+
not impose a license fee, royalty, or other charge for exercise of
444
+
rights granted under this License, and you may not initiate litigation
445
+
(including a cross-claim or counterclaim in a lawsuit) alleging that
446
+
any patent claim is infringed by making, using, selling, offering for
447
+
sale, or importing the Program or any portion of it.
448
+
449
+
### 11. Patents
450
+
451
+
A “contributor” is a copyright holder who authorizes use under this
452
+
License of the Program or a work on which the Program is based. The
453
+
work thus licensed is called the contributor's “contributor version”.
454
+
455
+
A contributor's “essential patent claims” are all patent claims
456
+
owned or controlled by the contributor, whether already acquired or
457
+
hereafter acquired, that would be infringed by some manner, permitted
458
+
by this License, of making, using, or selling its contributor version,
459
+
but do not include claims that would be infringed only as a
460
+
consequence of further modification of the contributor version. For
461
+
purposes of this definition, “control” includes the right to grant
462
+
patent sublicenses in a manner consistent with the requirements of
463
+
this License.
464
+
465
+
Each contributor grants you a non-exclusive, worldwide, royalty-free
466
+
patent license under the contributor's essential patent claims, to
467
+
make, use, sell, offer for sale, import and otherwise run, modify and
468
+
propagate the contents of its contributor version.
469
+
470
+
In the following three paragraphs, a “patent license” is any express
471
+
agreement or commitment, however denominated, not to enforce a patent
472
+
(such as an express permission to practice a patent or covenant not to
473
+
sue for patent infringement). To “grant” such a patent license to a
474
+
party means to make such an agreement or commitment not to enforce a
475
+
patent against the party.
476
+
477
+
If you convey a covered work, knowingly relying on a patent license,
478
+
and the Corresponding Source of the work is not available for anyone
479
+
to copy, free of charge and under the terms of this License, through a
480
+
publicly available network server or other readily accessible means,
481
+
then you must either **(1)** cause the Corresponding Source to be so
482
+
available, or **(2)** arrange to deprive yourself of the benefit of the
483
+
patent license for this particular work, or **(3)** arrange, in a manner
484
+
consistent with the requirements of this License, to extend the patent
485
+
license to downstream recipients. “Knowingly relying” means you have
486
+
actual knowledge that, but for the patent license, your conveying the
487
+
covered work in a country, or your recipient's use of the covered work
488
+
in a country, would infringe one or more identifiable patents in that
489
+
country that you have reason to believe are valid.
490
+
491
+
If, pursuant to or in connection with a single transaction or
492
+
arrangement, you convey, or propagate by procuring conveyance of, a
493
+
covered work, and grant a patent license to some of the parties
494
+
receiving the covered work authorizing them to use, propagate, modify
495
+
or convey a specific copy of the covered work, then the patent license
496
+
you grant is automatically extended to all recipients of the covered
497
+
work and works based on it.
498
+
499
+
A patent license is “discriminatory” if it does not include within
500
+
the scope of its coverage, prohibits the exercise of, or is
501
+
conditioned on the non-exercise of one or more of the rights that are
502
+
specifically granted under this License. You may not convey a covered
503
+
work if you are a party to an arrangement with a third party that is
504
+
in the business of distributing software, under which you make payment
505
+
to the third party based on the extent of your activity of conveying
506
+
the work, and under which the third party grants, to any of the
507
+
parties who would receive the covered work from you, a discriminatory
508
+
patent license **(a)** in connection with copies of the covered work
509
+
conveyed by you (or copies made from those copies), or **(b)** primarily
510
+
for and in connection with specific products or compilations that
511
+
contain the covered work, unless you entered into that arrangement,
512
+
or that patent license was granted, prior to 28 March 2007.
513
+
514
+
Nothing in this License shall be construed as excluding or limiting
515
+
any implied license or other defenses to infringement that may
516
+
otherwise be available to you under applicable patent law.
517
+
518
+
### 12. No Surrender of Others' Freedom
519
+
520
+
If conditions are imposed on you (whether by court order, agreement or
521
+
otherwise) that contradict the conditions of this License, they do not
522
+
excuse you from the conditions of this License. If you cannot convey a
523
+
covered work so as to satisfy simultaneously your obligations under this
524
+
License and any other pertinent obligations, then as a consequence you may
525
+
not convey it at all. For example, if you agree to terms that obligate you
526
+
to collect a royalty for further conveying from those to whom you convey
527
+
the Program, the only way you could satisfy both those terms and this
528
+
License would be to refrain entirely from conveying the Program.
529
+
530
+
### 13. Remote Network Interaction; Use with the GNU General Public License
531
+
532
+
Notwithstanding any other provision of this License, if you modify the
533
+
Program, your modified version must prominently offer all users
534
+
interacting with it remotely through a computer network (if your version
535
+
supports such interaction) an opportunity to receive the Corresponding
536
+
Source of your version by providing access to the Corresponding Source
537
+
from a network server at no charge, through some standard or customary
538
+
means of facilitating copying of software. This Corresponding Source
539
+
shall include the Corresponding Source for any work covered by version 3
540
+
of the GNU General Public License that is incorporated pursuant to the
541
+
following paragraph.
542
+
543
+
Notwithstanding any other provision of this License, you have
544
+
permission to link or combine any covered work with a work licensed
545
+
under version 3 of the GNU General Public License into a single
546
+
combined work, and to convey the resulting work. The terms of this
547
+
License will continue to apply to the part which is the covered work,
548
+
but the work with which it is combined will remain governed by version
549
+
3 of the GNU General Public License.
550
+
551
+
### 14. Revised Versions of this License
552
+
553
+
The Free Software Foundation may publish revised and/or new versions of
554
+
the GNU Affero General Public License from time to time. Such new versions
555
+
will be similar in spirit to the present version, but may differ in detail to
556
+
address new problems or concerns.
557
+
558
+
Each version is given a distinguishing version number. If the
559
+
Program specifies that a certain numbered version of the GNU Affero General
560
+
Public License “or any later version” applies to it, you have the
561
+
option of following the terms and conditions either of that numbered
562
+
version or of any later version published by the Free Software
563
+
Foundation. If the Program does not specify a version number of the
564
+
GNU Affero General Public License, you may choose any version ever published
565
+
by the Free Software Foundation.
566
+
567
+
If the Program specifies that a proxy can decide which future
568
+
versions of the GNU Affero General Public License can be used, that proxy's
569
+
public statement of acceptance of a version permanently authorizes you
570
+
to choose that version for the Program.
571
+
572
+
Later license versions may give you additional or different
573
+
permissions. However, no additional obligations are imposed on any
574
+
author or copyright holder as a result of your choosing to follow a
575
+
later version.
576
+
577
+
### 15. Disclaimer of Warranty
578
+
579
+
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
580
+
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
581
+
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY
582
+
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
583
+
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
584
+
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
585
+
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
586
+
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
587
+
588
+
### 16. Limitation of Liability
589
+
590
+
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
591
+
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
592
+
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
593
+
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
594
+
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
595
+
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
596
+
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
597
+
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
598
+
SUCH DAMAGES.
599
+
600
+
### 17. Interpretation of Sections 15 and 16
601
+
602
+
If the disclaimer of warranty and limitation of liability provided
603
+
above cannot be given local legal effect according to their terms,
604
+
reviewing courts shall apply local law that most closely approximates
605
+
an absolute waiver of all civil liability in connection with the
606
+
Program, unless a warranty or assumption of liability accompanies a
607
+
copy of the Program in return for a fee.
608
+
609
+
_END OF TERMS AND CONDITIONS_
610
+
611
+
## How to Apply These Terms to Your New Programs
612
+
613
+
If you develop a new program, and you want it to be of the greatest
614
+
possible use to the public, the best way to achieve this is to make it
615
+
free software which everyone can redistribute and change under these terms.
616
+
617
+
To do so, attach the following notices to the program. It is safest
618
+
to attach them to the start of each source file to most effectively
619
+
state the exclusion of warranty; and each file should have at least
620
+
the “copyright” line and a pointer to where the full notice is found.
621
+
622
+
<one line to give the program's name and a brief idea of what it does.>
623
+
Copyright (C) <year> <name of author>
624
+
625
+
This program is free software: you can redistribute it and/or modify
626
+
it under the terms of the GNU Affero General Public License as published by
627
+
the Free Software Foundation, either version 3 of the License, or
628
+
(at your option) any later version.
629
+
630
+
This program is distributed in the hope that it will be useful,
631
+
but WITHOUT ANY WARRANTY; without even the implied warranty of
632
+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
633
+
GNU Affero General Public License for more details.
634
+
635
+
You should have received a copy of the GNU Affero General Public License
636
+
along with this program. If not, see <http://www.gnu.org/licenses/>.
637
+
638
+
Also add information on how to contact you by electronic and paper mail.
639
+
640
+
If your software can interact with users remotely through a computer
641
+
network, you should also make sure that it provides a way for users to
642
+
get its source. For example, if your program is a web application, its
643
+
interface could display a “Source” link that leads users to an archive
644
+
of the code. There are many ways you could offer source, and different
645
+
solutions will be better for different programs; see section 13 for the
646
+
specific requirements.
647
+
648
+
You should also get your employer (if you work as a programmer) or school,
649
+
if any, to sign a “copyright disclaimer” for the program, if necessary.
650
+
For more information on this, and how to apply and follow the GNU AGPL, see
651
+
<<http://www.gnu.org/licenses/>>.
+119
README.md
+119
README.md
···
1
+
# Asterism
2
+
3
+
Asterism is an [AT Protocol](https://atproto.com) link index that consumes events from across the network. At its core, Asterism is a drop-in replacement for [Constellation](https://constellation.microcosm.blue/), and implements a compatible API. It is intended for app developers that want to own their own stack without rewriting their apps.
4
+
5
+
Constellation is vital community infrastructure, and many ATProto apps have been built on its back, including my own, [atbbs.xyz](https://atbbs.xyz/). It can be run on a Raspberry Pi with modest storage requirements, thanks in part to its dependency on Jetstream, which provides a nice, reasonable JSON stream for events.
6
+
7
+
Asterism, meanwhile, consumes cryptographically verifiable events directly from the Firehose, and filters them by the collection of your choice. There's no Jetstream in the middle, meaning fewer moving parts. And while Asterism has significant bandwidth requirements, the filtered index is significantly smaller and scales with your application, not with the network.
8
+
9
+
> **Early stage.** Functional but *very* incomplete. APIs may change, backfill is rudimentary, and several features are not yet implemented. See [Roadmap](#roadmap).
10
+
11
+
## What it does
12
+
13
+
Asterism connects directly to the relay Firehose (`com.atproto.sync.subscribeRepos`), decodes each repo commit's CAR-framed CBOR blocks itself, and recursively walks each record for link references (strong refs, AT-URIs, DIDs, URLs). Links are stored keyed by target, source collection, and field path. On startup it backfills existing repos for your configured collections so the index is useful immediately.
14
+
15
+
This matters for two reasons:
16
+
17
+
**Sovereignty** — One fewer dependency and one fewer hop. You're reading straight from the relay, not downstream of someone else's stream processor.
18
+
19
+
**Verifiability** — Firehose commits carry signed MST proofs; Jetstream strips them and re-serializes as plain JSON. Asterism verifies each record against its repo's signed commit instead of trusting an upstream re-encoding.
20
+
21
+
```
22
+
Relay ──► Jetstream ──► Constellation (preprocessed events)
23
+
Relay ──► Asterism (raw commits, filter locally)
24
+
```
25
+
26
+
## Quick start
27
+
28
+
**Requirements:** Go 1.26+
29
+
30
+
The typical deployment indexes only the collections your app queries:
31
+
32
+
```bash
33
+
go run ./cmd/asterism/ -collections sh.tangled.graph.follow,sh.tangled.repo.issue,sh.tangled.feed.comment
34
+
```
35
+
36
+
This connects to the relay Firehose, backfills existing repos for those collections in the background, stores links in an sqlite database at `asterism.db`, and serves the query API on `:8081`.
37
+
38
+
To index all collections (Constellation-equivalent scope, not recommended for sovereign deployments):
39
+
40
+
```bash
41
+
go run ./cmd/asterism/
42
+
```
43
+
44
+
## API
45
+
46
+
Asterism implements three endpoints from the [microcosm links XRPC namespace](https://constellation.microcosm.blue/):
47
+
48
+
### `GET /xrpc/blue.microcosm.links.getBacklinksCount`
49
+
50
+
Count records linking to a subject from a specific collection and field path.
51
+
52
+
```bash
53
+
curl 'http://localhost:8081/xrpc/blue.microcosm.links.getBacklinksCount\
54
+
?subject=at%3A%2F%2Fdid%3Aplc%3Aexample%2Fapp.bsky.feed.post%2F3juxgle5hpk2z\
55
+
&source=app.bsky.feed.like%3Asubject.uri'
56
+
```
57
+
58
+
Response: `{"total": 42}`
59
+
60
+
### `GET /xrpc/blue.microcosm.links.getBacklinkDids`
61
+
62
+
List distinct DIDs that have records linking to a subject. Paginated.
63
+
64
+
| Parameter | Description |
65
+
|---|---|
66
+
| `subject` | Target AT-URI, DID, or URL (required) |
67
+
| `source` | Collection and field path, e.g. `app.bsky.feed.like:subject.uri` (required) |
68
+
| `limit` | Page size, 1–1000 (default 100) |
69
+
| `cursor` | Pagination cursor from previous response |
70
+
71
+
Response: `{"total": 42, "linking_dids": ["did:plc:..."], "cursor": "..."}`
72
+
73
+
### `GET /xrpc/blue.microcosm.links.getBacklinks`
74
+
75
+
List source records linking to a subject. Paginated.
76
+
77
+
| Parameter | Description |
78
+
|---|---|
79
+
| `subject` | Target AT-URI, DID, or URL (required) |
80
+
| `source` | Collection and field path (required) |
81
+
| `did` | Filter to specific actor DIDs (repeatable) |
82
+
| `limit` | Page size, 1–1000 (default 100) |
83
+
| `reverse` | Return links in ascending order (default false) |
84
+
| `cursor` | Pagination cursor from previous response |
85
+
86
+
Response: `{"total": 42, "records": [{"did": "...", "collection": "...", "rkey": "..."}], "cursor": "..."}`
87
+
88
+
Records identify the linking record by DID, collection, and rkey. Clients must hydrate display data separately (via AppView, PDS, etc.).
89
+
90
+
## Roadmap
91
+
92
+
**Near term**
93
+
94
+
- [ ] `blue.microcosm.links.getManyToMany` endpoint (Constellation parity)
95
+
- [ ] Configurable listen address, database path, and relay URL
96
+
- [ ] Account deletion and deactivation handling
97
+
- [ ] Graceful shutdown and Firehose reconnect
98
+
99
+
**Medium term**
100
+
101
+
- [ ] Robust automatic backfill with checkpoint/resume (survive restarts mid-backfill)
102
+
- [ ] Backfill progress reporting
103
+
- [ ] Metrics and health endpoints
104
+
105
+
**Longer term**
106
+
107
+
- [ ] Deployment guides (Docker, single-binary production setup)
108
+
- [ ] Pluggable storage backends for larger indexes
109
+
- [ ] Horizontal read scaling
110
+
111
+
## Related projects
112
+
113
+
- [Constellation](https://constellation.microcosm.blue/) — The reference backlink index from [microcosm.blue](https://www.microcosm.blue/)
114
+
- [Spacedust](https://www.microcosm.blue/) — Real-time link stream filtered by target
115
+
- [indigo](https://github.com/bluesky-social/indigo) — Go ATProto library used for Firehose, repo, and identity handling
116
+
117
+
## License
118
+
119
+
TBD