├── .dockerignore
├── .env.docker.template
├── .env.template
├── .gitignore
├── Dockerfile
├── LICENSE
├── README.md
├── bin
├── auth-server-example.js
├── server.js
└── worker.js
├── compose.yaml
├── demos
├── auth-express
│ ├── Dockerfile
│ ├── README.md
│ ├── compose.yaml
│ ├── demo.js
│ ├── index.html
│ ├── package-lock.json
│ ├── package.json
│ ├── rollup.config.js
│ └── server.js
└── blocksuite
│ ├── .gitignore
│ ├── README.md
│ ├── client
│ ├── api.js
│ ├── editor.js
│ ├── main.js
│ ├── route.js
│ ├── sync.js
│ └── ui.js
│ ├── index.html
│ ├── package-lock.json
│ ├── package.json
│ ├── rollup.config.js
│ ├── server.js
│ └── tsconfig.json
├── package-lock.json
├── package.json
├── src
├── api.js
├── index.js
├── protocol.js
├── server.js
├── storage.js
├── storage
│ ├── memory.js
│ ├── postgres.js
│ └── s3.js
├── subscriber.js
└── ws.js
├── tests
├── api.tests.js
├── auth.tests.js
├── index.js
├── storage.tests.js
├── utils.js
└── ws.tests.js
└── tsconfig.json
/.dockerignore:
--------------------------------------------------------------------------------
1 | .env
2 | .env.backup*
3 | node_modules
4 | dist
5 |
--------------------------------------------------------------------------------
/.env.docker.template:
--------------------------------------------------------------------------------
1 | # This is a simple configuration to get this running using docker compose.
2 |
3 | REDIS=redis://redis:6379
4 |
5 | S3_ENDPOINT=minio
6 | S3_PORT=9000
7 | S3_SSL=false
8 | S3_ACCESS_KEY=minioadmin
9 | S3_SECRET_KEY=minioadmin
10 |
11 | AUTH_PERM_CALLBACK=http://demo:5173/auth/perm
12 | YDOC_UPDATE_CALLBACK=http://demo:5173/ydoc
13 |
14 | # log everything
15 | LOG=*
16 |
17 | ## Generate the auth tokens with `npx 0ecdsa-generate-keypair --name auth >> .env`
18 |
--------------------------------------------------------------------------------
/.env.template:
--------------------------------------------------------------------------------
1 | ### Redis endpoint
2 | REDIS=redis://localhost:6379
3 | # REDIS_PREFIX=y # by default "y:" is prepended to all used redis keys
4 |
5 | ### y-redis server component
6 | # PORT=3002 # The port that is used for listening for websocket connections
7 |
8 | ### Storage provider
9 | ## Either setup Postgres or S3 to persist data. If S3 is set up, then the
10 | ## postgres config is not used.
11 |
12 | ## S3 configuration for minio (start with `npm run minio`)
13 | S3_ENDPOINT=localhost
14 | S3_PORT=9000
15 | S3_SSL=false
16 | S3_ACCESS_KEY=minioadmin
17 | S3_SECRET_KEY=minioadmin
18 |
19 | ## PostgreSQL connection string format: postgresql://[user[:password]@][netloc][:port][/dbname][?param1=value1&...]
20 | # POSTGRES=postgres://user:pass@localhost/database
21 | # POSTGRES_TESTDB=yredis_tests ## use a different database for testing
22 |
23 | ### Auth signature
24 | ## The auth server authenticates web clients using json-web-tokens (jwt).
25 | ## They are generated and validated using the following json-web-keys (jwk).
26 | ## Generate your own keys by calling: `npx 0ecdsa-generate-keypair --name auth`
27 | ## These keys should be kept secret!
28 | AUTH_PUBLIC_KEY=..
29 | AUTH_PRIVATE_KEY=..
30 |
31 | ### Auth backend
32 | ## This REST endpoint is called to check whether a user has access to a document. It
33 | ## is provided by you. However, there are multiple sample implementations in this
34 | ## repository.
35 | AUTH_PERM_CALLBACK=http://localhost:5173/auth/perm
36 |
37 | ### Optional change callback
38 | ## This REST endpoint is called in regular intervals when a ydoc is changed.
39 | ## Remove this if you don't need it.
40 | YDOC_UPDATE_CALLBACK=http://localhost:5173/ydoc
41 |
42 | ### Logging
43 | ## Configure what you want to log. LOG is a regular expression that is applied
44 | ## to the logged component.
45 | LOG=* # log everything
46 | # LOG="" # no logging
47 | # LOG="^(yjs|@y)" # Supports regexes
48 | # LOG=@y/redis # print all messages generated by y-redis
49 | # LOG=@y/redis/[componentname] - print only messages from a specific y-redis component
50 |
51 | ### Expert configurations
52 | ## For debugging purposes and expert use.
53 | ## Changing these variables can be very dangerous. The default is carefully
54 | ## chosen. Be sure that you know what you are doing!
55 | ##
56 | ## Redis messages exist for at least one minute on the redis stream
57 | # REDIS_MIN_MESSAGE_LIFETIME=60000
58 | ## After this timeout, a worker will pick up a task and clean up a stream.
59 | # REDIS_TASK_DEBOUNCE=10000
60 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | dist
2 | node_modules
3 | tmp
4 | .env
5 | .env.save*
6 | .env.backup*
7 | .DS_Store
8 | .vscode
9 |
--------------------------------------------------------------------------------
/Dockerfile:
--------------------------------------------------------------------------------
1 | # Instructions to build the Docker image
2 | # docker build -t y-redis .
3 |
4 | # Run the worker as follows:
5 | # docker run --env-file ./.env y-redis npm run start:worker
6 |
7 | # Run the server as follows:
8 | # docker run -p 3002:3002 --env-file ./.env y-redis npm run start:server
9 |
10 | # Use an official Node.js runtime as a parent image
11 | # FROM node:20-alpine
12 | FROM node:lts-alpine3.19
13 |
14 | # Install glibc compatibility for alpine
15 | # See more at https://wiki.alpinelinux.org/wiki/Running_glibc_programs
16 | RUN apk add gcompat
17 |
18 | # Set the working directory in the container
19 | WORKDIR /usr/src/app
20 |
21 | # Copy package.json and package-lock.json (if available) to the working directory
22 | COPY package*.json ./
23 |
24 | # Install any dependencies
25 | RUN npm install
26 |
27 | # Bundle your app source inside the Docker image
28 | COPY . .
29 |
30 | # Make port 3002 available to the world outside this container,
31 | # assuming your app runs on port 3002
32 | EXPOSE 3002
33 |
34 | # Removed CMD instruction to allow dynamic command execution at runtime
35 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU AFFERO GENERAL PUBLIC LICENSE
2 | Version 3, 19 November 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU Affero General Public License is a free, copyleft license for
11 | software and other kinds of works, specifically designed to ensure
12 | cooperation with the community in the case of network server software.
13 |
14 | The licenses for most software and other practical works are designed
15 | to take away your freedom to share and change the works. By contrast,
16 | our General Public Licenses are intended to guarantee your freedom to
17 | share and change all versions of a program--to make sure it remains free
18 | software for all its users.
19 |
20 | When we speak of free software, we are referring to freedom, not
21 | price. Our General Public Licenses are designed to make sure that you
22 | have the freedom to distribute copies of free software (and charge for
23 | them if you wish), that you receive source code or can get it if you
24 | want it, that you can change the software or use pieces of it in new
25 | free programs, and that you know you can do these things.
26 |
27 | Developers that use our General Public Licenses protect your rights
28 | with two steps: (1) assert copyright on the software, and (2) offer
29 | you this License which gives you legal permission to copy, distribute
30 | and/or modify the software.
31 |
32 | A secondary benefit of defending all users' freedom is that
33 | improvements made in alternate versions of the program, if they
34 | receive widespread use, become available for other developers to
35 | incorporate. Many developers of free software are heartened and
36 | encouraged by the resulting cooperation. However, in the case of
37 | software used on network servers, this result may fail to come about.
38 | The GNU General Public License permits making a modified version and
39 | letting the public access it on a server without ever releasing its
40 | source code to the public.
41 |
42 | The GNU Affero General Public License is designed specifically to
43 | ensure that, in such cases, the modified source code becomes available
44 | to the community. It requires the operator of a network server to
45 | provide the source code of the modified version running there to the
46 | users of that server. Therefore, public use of a modified version, on
47 | a publicly accessible server, gives the public access to the source
48 | code of the modified version.
49 |
50 | An older license, called the Affero General Public License and
51 | published by Affero, was designed to accomplish similar goals. This is
52 | a different license, not a version of the Affero GPL, but Affero has
53 | released a new version of the Affero GPL which permits relicensing under
54 | this license.
55 |
56 | The precise terms and conditions for copying, distribution and
57 | modification follow.
58 |
59 | TERMS AND CONDITIONS
60 |
61 | 0. Definitions.
62 |
63 | "This License" refers to version 3 of the GNU Affero General Public License.
64 |
65 | "Copyright" also means copyright-like laws that apply to other kinds of
66 | works, such as semiconductor masks.
67 |
68 | "The Program" refers to any copyrightable work licensed under this
69 | License. Each licensee is addressed as "you". "Licensees" and
70 | "recipients" may be individuals or organizations.
71 |
72 | To "modify" a work means to copy from or adapt all or part of the work
73 | in a fashion requiring copyright permission, other than the making of an
74 | exact copy. The resulting work is called a "modified version" of the
75 | earlier work or a work "based on" the earlier work.
76 |
77 | A "covered work" means either the unmodified Program or a work based
78 | on the Program.
79 |
80 | To "propagate" a work means to do anything with it that, without
81 | permission, would make you directly or secondarily liable for
82 | infringement under applicable copyright law, except executing it on a
83 | computer or modifying a private copy. Propagation includes copying,
84 | distribution (with or without modification), making available to the
85 | public, and in some countries other activities as well.
86 |
87 | To "convey" a work means any kind of propagation that enables other
88 | parties to make or receive copies. Mere interaction with a user through
89 | a computer network, with no transfer of a copy, is not conveying.
90 |
91 | An interactive user interface displays "Appropriate Legal Notices"
92 | to the extent that it includes a convenient and prominently visible
93 | feature that (1) displays an appropriate copyright notice, and (2)
94 | tells the user that there is no warranty for the work (except to the
95 | extent that warranties are provided), that licensees may convey the
96 | work under this License, and how to view a copy of this License. If
97 | the interface presents a list of user commands or options, such as a
98 | menu, a prominent item in the list meets this criterion.
99 |
100 | 1. Source Code.
101 |
102 | The "source code" for a work means the preferred form of the work
103 | for making modifications to it. "Object code" means any non-source
104 | form of a work.
105 |
106 | A "Standard Interface" means an interface that either is an official
107 | standard defined by a recognized standards body, or, in the case of
108 | interfaces specified for a particular programming language, one that
109 | is widely used among developers working in that language.
110 |
111 | The "System Libraries" of an executable work include anything, other
112 | than the work as a whole, that (a) is included in the normal form of
113 | packaging a Major Component, but which is not part of that Major
114 | Component, and (b) serves only to enable use of the work with that
115 | Major Component, or to implement a Standard Interface for which an
116 | implementation is available to the public in source code form. A
117 | "Major Component", in this context, means a major essential component
118 | (kernel, window system, and so on) of the specific operating system
119 | (if any) on which the executable work runs, or a compiler used to
120 | produce the work, or an object code interpreter used to run it.
121 |
122 | The "Corresponding Source" for a work in object code form means all
123 | the source code needed to generate, install, and (for an executable
124 | work) run the object code and to modify the work, including scripts to
125 | control those activities. However, it does not include the work's
126 | System Libraries, or general-purpose tools or generally available free
127 | programs which are used unmodified in performing those activities but
128 | which are not part of the work. For example, Corresponding Source
129 | includes interface definition files associated with source files for
130 | the work, and the source code for shared libraries and dynamically
131 | linked subprograms that the work is specifically designed to require,
132 | such as by intimate data communication or control flow between those
133 | subprograms and other parts of the work.
134 |
135 | The Corresponding Source need not include anything that users
136 | can regenerate automatically from other parts of the Corresponding
137 | Source.
138 |
139 | The Corresponding Source for a work in source code form is that
140 | same work.
141 |
142 | 2. Basic Permissions.
143 |
144 | All rights granted under this License are granted for the term of
145 | copyright on the Program, and are irrevocable provided the stated
146 | conditions are met. This License explicitly affirms your unlimited
147 | permission to run the unmodified Program. The output from running a
148 | covered work is covered by this License only if the output, given its
149 | content, constitutes a covered work. This License acknowledges your
150 | rights of fair use or other equivalent, as provided by copyright law.
151 |
152 | You may make, run and propagate covered works that you do not
153 | convey, without conditions so long as your license otherwise remains
154 | in force. You may convey covered works to others for the sole purpose
155 | of having them make modifications exclusively for you, or provide you
156 | with facilities for running those works, provided that you comply with
157 | the terms of this License in conveying all material for which you do
158 | not control copyright. Those thus making or running the covered works
159 | for you must do so exclusively on your behalf, under your direction
160 | and control, on terms that prohibit them from making any copies of
161 | your copyrighted material outside their relationship with you.
162 |
163 | Conveying under any other circumstances is permitted solely under
164 | the conditions stated below. Sublicensing is not allowed; section 10
165 | makes it unnecessary.
166 |
167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
168 |
169 | No covered work shall be deemed part of an effective technological
170 | measure under any applicable law fulfilling obligations under article
171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
172 | similar laws prohibiting or restricting circumvention of such
173 | measures.
174 |
175 | When you convey a covered work, you waive any legal power to forbid
176 | circumvention of technological measures to the extent such circumvention
177 | is effected by exercising rights under this License with respect to
178 | the covered work, and you disclaim any intention to limit operation or
179 | modification of the work as a means of enforcing, against the work's
180 | users, your or third parties' legal rights to forbid circumvention of
181 | technological measures.
182 |
183 | 4. Conveying Verbatim Copies.
184 |
185 | You may convey verbatim copies of the Program's source code as you
186 | receive it, in any medium, provided that you conspicuously and
187 | appropriately publish on each copy an appropriate copyright notice;
188 | keep intact all notices stating that this License and any
189 | non-permissive terms added in accord with section 7 apply to the code;
190 | keep intact all notices of the absence of any warranty; and give all
191 | recipients a copy of this License along with the Program.
192 |
193 | You may charge any price or no price for each copy that you convey,
194 | and you may offer support or warranty protection for a fee.
195 |
196 | 5. Conveying Modified Source Versions.
197 |
198 | You may convey a work based on the Program, or the modifications to
199 | produce it from the Program, in the form of source code under the
200 | terms of section 4, provided that you also meet all of these conditions:
201 |
202 | a) The work must carry prominent notices stating that you modified
203 | it, and giving a relevant date.
204 |
205 | b) The work must carry prominent notices stating that it is
206 | released under this License and any conditions added under section
207 | 7. This requirement modifies the requirement in section 4 to
208 | "keep intact all notices".
209 |
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 |
218 | d) If the work has interactive user interfaces, each must display
219 | Appropriate Legal Notices; however, if the Program has interactive
220 | interfaces that do not display Appropriate Legal Notices, your
221 | work need not make them do so.
222 |
223 | A compilation of a covered work with other separate and independent
224 | works, which are not by their nature extensions of the covered work,
225 | and which are not combined with it such as to form a larger program,
226 | in or on a volume of a storage or distribution medium, is called an
227 | "aggregate" if the compilation and its resulting copyright are not
228 | used to limit the access or legal rights of the compilation's users
229 | beyond what the individual works permit. Inclusion of a covered work
230 | in an aggregate does not cause this License to apply to the other
231 | parts of the aggregate.
232 |
233 | 6. Conveying Non-Source Forms.
234 |
235 | You may convey a covered work in object code form under the terms
236 | of sections 4 and 5, provided that you also convey the
237 | machine-readable Corresponding Source under the terms of this License,
238 | in one of these ways:
239 |
240 | a) Convey the object code in, or embodied in, a physical product
241 | (including a physical distribution medium), accompanied by the
242 | Corresponding Source fixed on a durable physical medium
243 | customarily used for software interchange.
244 |
245 | b) Convey the object code in, or embodied in, a physical product
246 | (including a physical distribution medium), accompanied by a
247 | written offer, valid for at least three years and valid for as
248 | long as you offer spare parts or customer support for that product
249 | model, to give anyone who possesses the object code either (1) a
250 | copy of the Corresponding Source for all the software in the
251 | product that is covered by this License, on a durable physical
252 | medium customarily used for software interchange, for a price no
253 | more than your reasonable cost of physically performing this
254 | conveying of source, or (2) access to copy the
255 | Corresponding Source from a network server at no charge.
256 |
257 | c) Convey individual copies of the object code with a copy of the
258 | written offer to provide the Corresponding Source. This
259 | alternative is allowed only occasionally and noncommercially, and
260 | only if you received the object code with such an offer, in accord
261 | with subsection 6b.
262 |
263 | d) Convey the object code by offering access from a designated
264 | place (gratis or for a charge), and offer equivalent access to the
265 | Corresponding Source in the same way through the same place at no
266 | further charge. You need not require recipients to copy the
267 | Corresponding Source along with the object code. If the place to
268 | copy the object code is a network server, the Corresponding Source
269 | may be on a different server (operated by you or a third party)
270 | that supports equivalent copying facilities, provided you maintain
271 | clear directions next to the object code saying where to find the
272 | Corresponding Source. Regardless of what server hosts the
273 | Corresponding Source, you remain obligated to ensure that it is
274 | available for as long as needed to satisfy these requirements.
275 |
276 | e) Convey the object code using peer-to-peer transmission, provided
277 | you inform other peers where the object code and Corresponding
278 | Source of the work are being offered to the general public at no
279 | charge under subsection 6d.
280 |
281 | A separable portion of the object code, whose source code is excluded
282 | from the Corresponding Source as a System Library, need not be
283 | included in conveying the object code work.
284 |
285 | A "User Product" is either (1) a "consumer product", which means any
286 | tangible personal property which is normally used for personal, family,
287 | or household purposes, or (2) anything designed or sold for incorporation
288 | into a dwelling. In determining whether a product is a consumer product,
289 | doubtful cases shall be resolved in favor of coverage. For a particular
290 | product received by a particular user, "normally used" refers to a
291 | typical or common use of that class of product, regardless of the status
292 | of the particular user or of the way in which the particular user
293 | actually uses, or expects or is expected to use, the product. A product
294 | is a consumer product regardless of whether the product has substantial
295 | commercial, industrial or non-consumer uses, unless such uses represent
296 | the only significant mode of use of the product.
297 |
298 | "Installation Information" for a User Product means any methods,
299 | procedures, authorization keys, or other information required to install
300 | and execute modified versions of a covered work in that User Product from
301 | a modified version of its Corresponding Source. The information must
302 | suffice to ensure that the continued functioning of the modified object
303 | code is in no case prevented or interfered with solely because
304 | modification has been made.
305 |
306 | If you convey an object code work under this section in, or with, or
307 | specifically for use in, a User Product, and the conveying occurs as
308 | part of a transaction in which the right of possession and use of the
309 | User Product is transferred to the recipient in perpetuity or for a
310 | fixed term (regardless of how the transaction is characterized), the
311 | Corresponding Source conveyed under this section must be accompanied
312 | by the Installation Information. But this requirement does not apply
313 | if neither you nor any third party retains the ability to install
314 | modified object code on the User Product (for example, the work has
315 | been installed in ROM).
316 |
317 | The requirement to provide Installation Information does not include a
318 | requirement to continue to provide support service, warranty, or updates
319 | for a work that has been modified or installed by the recipient, or for
320 | the User Product in which it has been modified or installed. Access to a
321 | network may be denied when the modification itself materially and
322 | adversely affects the operation of the network or violates the rules and
323 | protocols for communication across the network.
324 |
325 | Corresponding Source conveyed, and Installation Information provided,
326 | in accord with this section must be in a format that is publicly
327 | documented (and with an implementation available to the public in
328 | source code form), and must require no special password or key for
329 | unpacking, reading or copying.
330 |
331 | 7. Additional Terms.
332 |
333 | "Additional permissions" are terms that supplement the terms of this
334 | License by making exceptions from one or more of its conditions.
335 | Additional permissions that are applicable to the entire Program shall
336 | be treated as though they were included in this License, to the extent
337 | that they are valid under applicable law. If additional permissions
338 | apply only to part of the Program, that part may be used separately
339 | under those permissions, but the entire Program remains governed by
340 | this License without regard to the additional permissions.
341 |
342 | When you convey a copy of a covered work, you may at your option
343 | remove any additional permissions from that copy, or from any part of
344 | it. (Additional permissions may be written to require their own
345 | removal in certain cases when you modify the work.) You may place
346 | additional permissions on material, added by you to a covered work,
347 | for which you have or can give appropriate copyright permission.
348 |
349 | Notwithstanding any other provision of this License, for material you
350 | add to a covered work, you may (if authorized by the copyright holders of
351 | that material) supplement the terms of this License with terms:
352 |
353 | a) Disclaiming warranty or limiting liability differently from the
354 | terms of sections 15 and 16 of this License; or
355 |
356 | b) Requiring preservation of specified reasonable legal notices or
357 | author attributions in that material or in the Appropriate Legal
358 | Notices displayed by works containing it; or
359 |
360 | c) Prohibiting misrepresentation of the origin of that material, or
361 | requiring that modified versions of such material be marked in
362 | reasonable ways as different from the original version; or
363 |
364 | d) Limiting the use for publicity purposes of names of licensors or
365 | authors of the material; or
366 |
367 | e) Declining to grant rights under trademark law for use of some
368 | trade names, trademarks, or service marks; or
369 |
370 | f) Requiring indemnification of licensors and authors of that
371 | material by anyone who conveys the material (or modified versions of
372 | it) with contractual assumptions of liability to the recipient, for
373 | any liability that these contractual assumptions directly impose on
374 | those licensors and authors.
375 |
376 | All other non-permissive additional terms are considered "further
377 | restrictions" within the meaning of section 10. If the Program as you
378 | received it, or any part of it, contains a notice stating that it is
379 | governed by this License along with a term that is a further
380 | restriction, you may remove that term. If a license document contains
381 | a further restriction but permits relicensing or conveying under this
382 | License, you may add to a covered work material governed by the terms
383 | of that license document, provided that the further restriction does
384 | not survive such relicensing or conveying.
385 |
386 | If you add terms to a covered work in accord with this section, you
387 | must place, in the relevant source files, a statement of the
388 | additional terms that apply to those files, or a notice indicating
389 | where to find the applicable terms.
390 |
391 | Additional terms, permissive or non-permissive, may be stated in the
392 | form of a separately written license, or stated as exceptions;
393 | the above requirements apply either way.
394 |
395 | 8. Termination.
396 |
397 | You may not propagate or modify a covered work except as expressly
398 | provided under this License. Any attempt otherwise to propagate or
399 | modify it is void, and will automatically terminate your rights under
400 | this License (including any patent licenses granted under the third
401 | paragraph of section 11).
402 |
403 | However, if you cease all violation of this License, then your
404 | license from a particular copyright holder is reinstated (a)
405 | provisionally, unless and until the copyright holder explicitly and
406 | finally terminates your license, and (b) permanently, if the copyright
407 | holder fails to notify you of the violation by some reasonable means
408 | prior to 60 days after the cessation.
409 |
410 | Moreover, your license from a particular copyright holder is
411 | reinstated permanently if the copyright holder notifies you of the
412 | violation by some reasonable means, this is the first time you have
413 | received notice of violation of this License (for any work) from that
414 | copyright holder, and you cure the violation prior to 30 days after
415 | your receipt of the notice.
416 |
417 | Termination of your rights under this section does not terminate the
418 | licenses of parties who have received copies or rights from you under
419 | this License. If your rights have been terminated and not permanently
420 | reinstated, you do not qualify to receive new licenses for the same
421 | material under section 10.
422 |
423 | 9. Acceptance Not Required for Having Copies.
424 |
425 | You are not required to accept this License in order to receive or
426 | run a copy of the Program. Ancillary propagation of a covered work
427 | occurring solely as a consequence of using peer-to-peer transmission
428 | to receive a copy likewise does not require acceptance. However,
429 | nothing other than this License grants you permission to propagate or
430 | modify any covered work. These actions infringe copyright if you do
431 | not accept this License. Therefore, by modifying or propagating a
432 | covered work, you indicate your acceptance of this License to do so.
433 |
434 | 10. Automatic Licensing of Downstream Recipients.
435 |
436 | Each time you convey a covered work, the recipient automatically
437 | receives a license from the original licensors, to run, modify and
438 | propagate that work, subject to this License. You are not responsible
439 | for enforcing compliance by third parties with this License.
440 |
441 | An "entity transaction" is a transaction transferring control of an
442 | organization, or substantially all assets of one, or subdividing an
443 | organization, or merging organizations. If propagation of a covered
444 | work results from an entity transaction, each party to that
445 | transaction who receives a copy of the work also receives whatever
446 | licenses to the work the party's predecessor in interest had or could
447 | give under the previous paragraph, plus a right to possession of the
448 | Corresponding Source of the work from the predecessor in interest, if
449 | the predecessor has it or can get it with reasonable efforts.
450 |
451 | You may not impose any further restrictions on the exercise of the
452 | rights granted or affirmed under this License. For example, you may
453 | not impose a license fee, royalty, or other charge for exercise of
454 | rights granted under this License, and you may not initiate litigation
455 | (including a cross-claim or counterclaim in a lawsuit) alleging that
456 | any patent claim is infringed by making, using, selling, offering for
457 | sale, or importing the Program or any portion of it.
458 |
459 | 11. Patents.
460 |
461 | A "contributor" is a copyright holder who authorizes use under this
462 | License of the Program or a work on which the Program is based. The
463 | work thus licensed is called the contributor's "contributor version".
464 |
465 | A contributor's "essential patent claims" are all patent claims
466 | owned or controlled by the contributor, whether already acquired or
467 | hereafter acquired, that would be infringed by some manner, permitted
468 | by this License, of making, using, or selling its contributor version,
469 | but do not include claims that would be infringed only as a
470 | consequence of further modification of the contributor version. For
471 | purposes of this definition, "control" includes the right to grant
472 | patent sublicenses in a manner consistent with the requirements of
473 | this License.
474 |
475 | Each contributor grants you a non-exclusive, worldwide, royalty-free
476 | patent license under the contributor's essential patent claims, to
477 | make, use, sell, offer for sale, import and otherwise run, modify and
478 | propagate the contents of its contributor version.
479 |
480 | In the following three paragraphs, a "patent license" is any express
481 | agreement or commitment, however denominated, not to enforce a patent
482 | (such as an express permission to practice a patent or covenant not to
483 | sue for patent infringement). To "grant" such a patent license to a
484 | party means to make such an agreement or commitment not to enforce a
485 | patent against the party.
486 |
487 | If you convey a covered work, knowingly relying on a patent license,
488 | and the Corresponding Source of the work is not available for anyone
489 | to copy, free of charge and under the terms of this License, through a
490 | publicly available network server or other readily accessible means,
491 | then you must either (1) cause the Corresponding Source to be so
492 | available, or (2) arrange to deprive yourself of the benefit of the
493 | patent license for this particular work, or (3) arrange, in a manner
494 | consistent with the requirements of this License, to extend the patent
495 | license to downstream recipients. "Knowingly relying" means you have
496 | actual knowledge that, but for the patent license, your conveying the
497 | covered work in a country, or your recipient's use of the covered work
498 | in a country, would infringe one or more identifiable patents in that
499 | country that you have reason to believe are valid.
500 |
501 | If, pursuant to or in connection with a single transaction or
502 | arrangement, you convey, or propagate by procuring conveyance of, a
503 | covered work, and grant a patent license to some of the parties
504 | receiving the covered work authorizing them to use, propagate, modify
505 | or convey a specific copy of the covered work, then the patent license
506 | you grant is automatically extended to all recipients of the covered
507 | work and works based on it.
508 |
509 | A patent license is "discriminatory" if it does not include within
510 | the scope of its coverage, prohibits the exercise of, or is
511 | conditioned on the non-exercise of one or more of the rights that are
512 | specifically granted under this License. You may not convey a covered
513 | work if you are a party to an arrangement with a third party that is
514 | in the business of distributing software, under which you make payment
515 | to the third party based on the extent of your activity of conveying
516 | the work, and under which the third party grants, to any of the
517 | parties who would receive the covered work from you, a discriminatory
518 | patent license (a) in connection with copies of the covered work
519 | conveyed by you (or copies made from those copies), or (b) primarily
520 | for and in connection with specific products or compilations that
521 | contain the covered work, unless you entered into that arrangement,
522 | or that patent license was granted, prior to 28 March 2007.
523 |
524 | Nothing in this License shall be construed as excluding or limiting
525 | any implied license or other defenses to infringement that may
526 | otherwise be available to you under applicable patent law.
527 |
528 | 12. No Surrender of Others' Freedom.
529 |
530 | If conditions are imposed on you (whether by court order, agreement or
531 | otherwise) that contradict the conditions of this License, they do not
532 | excuse you from the conditions of this License. If you cannot convey a
533 | covered work so as to satisfy simultaneously your obligations under this
534 | License and any other pertinent obligations, then as a consequence you may
535 | not convey it at all. For example, if you agree to terms that obligate you
536 | to collect a royalty for further conveying from those to whom you convey
537 | the Program, the only way you could satisfy both those terms and this
538 | License would be to refrain entirely from conveying the Program.
539 |
540 | 13. Remote Network Interaction; Use with the GNU General Public License.
541 |
542 | Notwithstanding any other provision of this License, if you modify the
543 | Program, your modified version must prominently offer all users
544 | interacting with it remotely through a computer network (if your version
545 | supports such interaction) an opportunity to receive the Corresponding
546 | Source of your version by providing access to the Corresponding Source
547 | from a network server at no charge, through some standard or customary
548 | means of facilitating copying of software. This Corresponding Source
549 | shall include the Corresponding Source for any work covered by version 3
550 | of the GNU General Public License that is incorporated pursuant to the
551 | following paragraph.
552 |
553 | Notwithstanding any other provision of this License, you have
554 | permission to link or combine any covered work with a work licensed
555 | under version 3 of the GNU General Public License into a single
556 | combined work, and to convey the resulting work. The terms of this
557 | License will continue to apply to the part which is the covered work,
558 | but the work with which it is combined will remain governed by version
559 | 3 of the GNU General Public License.
560 |
561 | 14. Revised Versions of this License.
562 |
563 | The Free Software Foundation may publish revised and/or new versions of
564 | the GNU Affero General Public License from time to time. Such new versions
565 | will be similar in spirit to the present version, but may differ in detail to
566 | address new problems or concerns.
567 |
568 | Each version is given a distinguishing version number. If the
569 | Program specifies that a certain numbered version of the GNU Affero General
570 | Public License "or any later version" applies to it, you have the
571 | option of following the terms and conditions either of that numbered
572 | version or of any later version published by the Free Software
573 | Foundation. If the Program does not specify a version number of the
574 | GNU Affero General Public License, you may choose any version ever published
575 | by the Free Software Foundation.
576 |
577 | If the Program specifies that a proxy can decide which future
578 | versions of the GNU Affero General Public License can be used, that proxy's
579 | public statement of acceptance of a version permanently authorizes you
580 | to choose that version for the Program.
581 |
582 | Later license versions may give you additional or different
583 | permissions. However, no additional obligations are imposed on any
584 | author or copyright holder as a result of your choosing to follow a
585 | later version.
586 |
587 | 15. Disclaimer of Warranty.
588 |
589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
597 |
598 | 16. Limitation of Liability.
599 |
600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
608 | SUCH DAMAGES.
609 |
610 | 17. Interpretation of Sections 15 and 16.
611 |
612 | If the disclaimer of warranty and limitation of liability provided
613 | above cannot be given local legal effect according to their terms,
614 | reviewing courts shall apply local law that most closely approximates
615 | an absolute waiver of all civil liability in connection with the
616 | Program, unless a warranty or assumption of liability accompanies a
617 | copy of the Program in return for a fee.
618 |
619 | END OF TERMS AND CONDITIONS
620 |
621 | How to Apply These Terms to Your New Programs
622 |
623 | If you develop a new program, and you want it to be of the greatest
624 | possible use to the public, the best way to achieve this is to make it
625 | free software which everyone can redistribute and change under these terms.
626 |
627 | To do so, attach the following notices to the program. It is safest
628 | to attach them to the start of each source file to most effectively
629 | state the exclusion of warranty; and each file should have at least
630 | the "copyright" line and a pointer to where the full notice is found.
631 |
632 |
633 | Copyright (C)
634 |
635 | This program is free software: you can redistribute it and/or modify
636 | it under the terms of the GNU Affero General Public License as published by
637 | the Free Software Foundation, either version 3 of the License, or
638 | (at your option) any later version.
639 |
640 | This program is distributed in the hope that it will be useful,
641 | but WITHOUT ANY WARRANTY; without even the implied warranty of
642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
643 | GNU Affero General Public License for more details.
644 |
645 | You should have received a copy of the GNU Affero General Public License
646 | along with this program. If not, see .
647 |
648 | Also add information on how to contact you by electronic and paper mail.
649 |
650 | If your software can interact with users remotely through a computer
651 | network, you should also make sure that it provides a way for users to
652 | get its source. For example, if your program is a web application, its
653 | interface could display a "Source" link that leads users to an archive
654 | of the code. There are many ways you could offer source, and different
655 | solutions will be better for different programs; see section 13 for the
656 | specific requirements.
657 |
658 | You should also get your employer (if you work as a programmer) or school,
659 | if any, to sign a "copyright disclaimer" for the program, if necessary.
660 | For more information on this, and how to apply and follow the GNU AGPL, see
661 | .
662 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
2 | # y-redis :tophat:
3 | > y-websocket compatible backend using Redis for scalability. **This is beta
4 | > software!**
5 |
6 | y-redis is an alternative backend for y-websocket. It only requires a redis
7 | instance and a storage provider (S3 or Postgres-compatible).
8 |
9 | * **Memory efficient:** The server doesn't maintain a Y.Doc in-memory. It
10 | streams updates through redis. The Yjs document is only loaded to memory for the
11 | initial sync.
12 | * **Scalable:** You can start as many y-redis instances as you want to handle
13 | a fluctuating number of clients. No coordination is needed.
14 | - **Auth:** y-redis works together with your existing infrastructure to
15 | authenticate clients and check whether a client has read-only / read-write
16 | access to a document.
17 | - **Database agnostic:** You can persist documents in S3-compatible backends, in
18 | Postgres, or implement your own storage provider.
19 |
20 | ### Licensing
21 |
22 | y-redis is dual-licensed (either [AGPL](./LICENSE) or proprietary).
23 |
24 | Please contact me to buy a license if you intend to use y-redis in your
25 | commercial product:
26 |
27 | Otherwise, you may use this software under the terms of the AGPL, which requires
28 | you to publish your source code under the terms of the AGPL too.
29 |
30 | ### Components
31 |
32 | Redis is used as a "cache" and a distribution channel for document updates.
33 | Normal databases are not fast enough for handling real-time updates of
34 | fast-changing applications (e.g. collaborative drawing applications that
35 | generate hundreds of operations per second). Hence a redis-cache for temporary
36 | storage makes sense to distribute documents as fast as possible to all peers.
37 |
38 | A persistent storage (e.g. S3 or Postgres) is used to persist document updates
39 | permanently. You can configure in which intervals you want to persist data from
40 | redis to the persistent storage. You can even implement a custom persistent
41 | storage technology.
42 |
43 | The y-redis **server component** (`/bin/server.js`) is responsible for accepting
44 | websocket-connections and distributing the updates via redis streams. Each
45 | "room" is represented as a redis stream. The server component assembles updates
46 | stored redis and in the persistent storage (e.g. S3 or Postgres) for the initial
47 | sync. After the initial sync, the server doesn't keep any Yjs state in-memory.
48 | You can start as many server components as you need. It makes sense to put the
49 | server component behind a loadbalancer, which can potentially auto-scale the
50 | server component based on CPU or network usage.
51 |
52 | The separate y-redis **worker component** (`/bin/worker.js`) is responsible for
53 | extracting data from the redis cache to a persistent database like S3 or
54 | Postgres. Once the data is persisted, the worker component cleans up stale data
55 | in redis. You can start as many worker components as you need. It is recommended
56 | to run at least one worker, so that the data is eventually persisted. The worker
57 | components coordinate which room needs to be persisted using a separate
58 | worker-queue (see `y:worker` stream in redis).
59 |
60 | You are responsible for providing a REST backend that y-redis will call to check
61 | whether a specific client (authenticated via a JWT token) has access to a
62 | specific room / document. Example servers can be found in
63 | `/bin/auth-server-example.js` and `/demos/auth-express/server.js`.
64 |
65 | ### Missing Features
66 |
67 | I'm looking for sponsors that want to sponsor the following work:
68 |
69 | - Ability to kick out users when permissions on a document changed
70 | - Configurable docker containers for y-redis server & worker
71 | - Helm chart
72 | - More exhaustive logging and reporting of possible issues
73 | - More exhaustive testing
74 | - Better documentation & more documentation for specific use-cases
75 | - Support for Bun and Deno
76 | - Perform expensive tasks (computing sync messages) in separate threads
77 |
78 | If you are interested in sponsoring some of this work, please send a mail to
79 | .
80 |
81 | # Quick Start (docker-compose)
82 |
83 | You can get everything running quickly using
84 | [docker-compose](https://docs.docker.com/compose/). The compose file runs the
85 | following components:
86 |
87 | - redis
88 | - minio as a s3 endpoint
89 | - a single y-redis server
90 | - a single y-redis worker
91 |
92 | This can be a good starting point for your application. If your cloud provider
93 | has a managed s3 service, you should probably use that instead of minio. If you
94 | want to use minio, you need to setup proper volumes and backups.
95 |
96 | The full setup gives insight into more specialized configuration options.
97 |
98 | ```sh
99 | git clone https://github.com/yjs/y-redis.git
100 | cd y-redis
101 | npm i
102 | ```
103 |
104 | ### Setup the environment variables
105 |
106 | ```sh
107 | cp .env.docker.template .env
108 | # generate unique authentication tokens
109 | npx 0ecdsa-generate-keypair --name auth >> .env
110 | ```
111 |
112 | The sample configuration configures s3 using minio.
113 | Have a look at `.env.template` for more configuration options.
114 |
115 | ### Run demo
116 |
117 | ```sh
118 | cd ./demos/auth-express
119 | docker compose up
120 | # open http://localhost:5173 in a browser
121 | ```
122 |
123 | # Full setup
124 |
125 | Components are configured via environment variables. It makes sense to start by
126 | cloning y-redis and getting one of the demos to work.
127 |
128 | Note: If you want to use any of the docker commands, feel free to use podman (a
129 | more modern alternative) instead.
130 |
131 | #### Start a redis instance
132 |
133 | Setup redis on your computer. Follow the [official
134 | documentation](https://redis.io/docs/install/install-redis/). This is
135 | recommended if you want to debug the redis stream.
136 |
137 | Alternatively, simply run redis via docker:
138 |
139 | ```sh
140 | # start the official redis docker container on port 6379
141 | docker run -p 6379:6379 redis
142 | # or `npm run redis`
143 | ```
144 |
145 | #### Start an S3 instance
146 |
147 | Setup an S3-compatible store at your favorite cloud provider.
148 |
149 | Alternatively, simply run a *minio* store as a docker container:
150 |
151 | ```sh
152 | docker run -p 9000:9000 -p 9001:9001 quay.io/minio/minio server /data --console-address \":9001\"
153 | # or `npm run minio`
154 | ```
155 |
156 | This is just a dev setup. Have a look at the minio documentation if you want to
157 | run it in production.
158 |
159 | #### Clone demo
160 |
161 | ```sh
162 | git clone https://github.com/yjs/y-redis.git
163 | cd y-redis
164 | npm i
165 | ```
166 |
167 | All features are configurable using environment variables. For local development
168 | it makes sense to setup a `.env` file, that stores project-specific secrets. Use
169 | `.env.template` as a template to setup environment variables. Make sure to read
170 | the documentation carefully and configure every single variable.
171 |
172 | ```sh
173 | # setup environment variables
174 | cp .env.template .env
175 | nano .env
176 | ```
177 |
178 | Then you can run the different components in separate terminals:
179 |
180 | ```sh
181 | # run the server
182 | npm run start:server
183 | # run a single worker in a separate terminal
184 | npm run start:worker
185 | # start the express server in a separater terminal
186 | cd demos/auth-express
187 | npm i
188 | npm start
189 | ```
190 |
191 | Open [`http://localhost:5173`](http://localhost:5173) in a browser.
192 |
--------------------------------------------------------------------------------
/bin/auth-server-example.js:
--------------------------------------------------------------------------------
1 | import * as uws from 'uws'
2 | import * as jwt from 'lib0/crypto/jwt'
3 | import * as ecdsa from 'lib0/crypto/ecdsa'
4 | import * as json from 'lib0/json'
5 | import * as time from 'lib0/time'
6 | import * as env from 'lib0/environment'
7 | import * as logging from 'lib0/logging'
8 | import * as error from 'lib0/error'
9 | import * as promise from 'lib0/promise'
10 | import * as encoding from 'lib0/encoding'
11 | import * as Y from 'yjs'
12 |
13 | const appName = 'Auth-Server-Example'
14 | const authPrivateKey = await ecdsa.importKeyJwk(json.parse(env.ensureConf('auth-private-key')))
15 | const port = 5173
16 |
17 | const app = uws.App({})
18 |
19 | app.put('/ydoc/:room', async (res, req) => {
20 | let aborted = false
21 | res.onAborted(() => {
22 | aborted = true
23 | })
24 | const room = req.getParameter(0)
25 | const header = req.getHeader('content-type')
26 | // this "encoder" will accumulate the received data until all data arrived
27 | const contentEncoder = encoding.createEncoder()
28 | res.onData((chunk, isLast) => {
29 | encoding.writeUint8Array(contentEncoder, new Uint8Array(chunk))
30 | if (isLast && !aborted) {
31 | const fullContent = encoding.toUint8Array(contentEncoder)
32 | const parts = uws.getParts(fullContent, header)
33 | const ydocUpdateData = parts?.find(part => part.name === 'ydoc')?.data
34 | if (ydocUpdateData == null) {
35 | console.error('Received empty data')
36 | return
37 | }
38 | const ydocUpdate = new Uint8Array(ydocUpdateData)
39 | const ydoc = new Y.Doc()
40 | Y.applyUpdateV2(ydoc, ydocUpdate)
41 | console.log(`Ydoc in room "${room}" updated. New codemirror content: "${ydoc.getText('codemirror')}"`)
42 | res.endWithoutBody()
43 | }
44 | })
45 | })
46 |
47 | // This example server always grants read-write permission to all requests.
48 | // Modify it to your own needs or implement the same API in your own backend!
49 | app.get('/auth/token', async (res, _req) => {
50 | let aborted = false
51 | res.onAborted(() => {
52 | aborted = true
53 | })
54 | const token = await jwt.encodeJwt(authPrivateKey, {
55 | iss: appName,
56 | exp: time.getUnixTime() + 60 * 60 * 1000, // token expires in one hour
57 | yuserid: 'user1'
58 | })
59 | if (aborted) return
60 | res.cork(() => {
61 | res.end(token)
62 | })
63 | })
64 |
65 | app.get('/auth/perm/:room/:userid', async (res, req) => {
66 | const yroom = req.getParameter(0)
67 | const yuserid = req.getParameter(1)
68 | res.end(json.stringify({
69 | yroom,
70 | yaccess: 'rw',
71 | yuserid
72 | }))
73 | })
74 |
75 | /**
76 | * Resolves when the server started.
77 | */
78 | export const authServerStarted = promise.create((resolve, reject) => {
79 | const server = app.listen(port, (token) => {
80 | if (token) {
81 | logging.print(logging.GREEN, `[${appName}] Listening to port ${port}`)
82 | resolve()
83 | } else {
84 | const err = error.create(`[${appName}] Failed to lisen to port ${port}`)
85 | reject(err)
86 | throw err
87 | }
88 | })
89 |
90 | // Gracefully shut down the server when running in Docker
91 | process.on('SIGTERM', shutDown)
92 | process.on('SIGINT', shutDown)
93 |
94 | function shutDown () {
95 | console.log('Received SIGTERM/SIGINT - shutting down')
96 | server.close()
97 | process.exit(0)
98 | }
99 | })
100 |
--------------------------------------------------------------------------------
/bin/server.js:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env node
2 |
3 | import * as number from 'lib0/number'
4 | import * as env from 'lib0/environment'
5 | import * as yredis from '@y/redis'
6 |
7 | const port = number.parseInt(env.getConf('port') || '3002')
8 | const redisPrefix = env.getConf('redis-prefix') || 'y'
9 | const postgresUrl = env.getConf('postgres')
10 | const s3Endpoint = env.getConf('s3-endpoint')
11 | const checkPermCallbackUrl = env.ensureConf('AUTH_PERM_CALLBACK')
12 |
13 | let store
14 | if (s3Endpoint) {
15 | console.log('using s3 store')
16 | const { createS3Storage } = await import('../src/storage/s3.js')
17 | const bucketName = 'ydocs'
18 | store = createS3Storage(bucketName)
19 | try {
20 | // make sure the bucket exists
21 | await store.client.makeBucket(bucketName)
22 | } catch (e) {}
23 | } else if (postgresUrl) {
24 | console.log('using postgres store')
25 | const { createPostgresStorage } = await import('../src/storage/postgres.js')
26 | store = await createPostgresStorage()
27 | } else {
28 | console.log('ATTENTION! using in-memory store')
29 | const { createMemoryStorage } = await import('../src/storage/memory.js')
30 | store = createMemoryStorage()
31 | }
32 |
33 | yredis.createYWebsocketServer({ port, store, checkPermCallbackUrl, redisPrefix })
34 |
--------------------------------------------------------------------------------
/bin/worker.js:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env node
2 |
3 | import * as env from 'lib0/environment'
4 | import * as yredis from '@y/redis'
5 | import * as Y from 'yjs'
6 |
7 | const redisPrefix = env.getConf('redis-prefix') || 'y'
8 | const postgresUrl = env.getConf('postgres')
9 | const s3Endpoint = env.getConf('s3-endpoint')
10 |
11 | let store
12 | if (s3Endpoint) {
13 | console.log('using s3 store')
14 | const { createS3Storage } = await import('../src/storage/s3.js')
15 | const bucketName = 'ydocs'
16 | store = createS3Storage(bucketName)
17 | try {
18 | // make sure the bucket exists
19 | await store.client.makeBucket(bucketName)
20 | } catch (e) {}
21 | } else if (postgresUrl) {
22 | console.log('using postgres store')
23 | const { createPostgresStorage } = await import('../src/storage/postgres.js')
24 | store = await createPostgresStorage()
25 | } else {
26 | console.log('ATTENTION! using in-memory store')
27 | const { createMemoryStorage } = await import('../src/storage/memory.js')
28 | store = createMemoryStorage()
29 | }
30 |
31 | let ydocUpdateCallback = env.getConf('ydoc-update-callback')
32 | if (ydocUpdateCallback != null && ydocUpdateCallback.slice(-1) !== '/') {
33 | ydocUpdateCallback += '/'
34 | }
35 |
36 | /**
37 | * @type {(room: string, ydoc: Y.Doc) => Promise}
38 | */
39 | const updateCallback = async (room, ydoc) => {
40 | if (ydocUpdateCallback != null) {
41 | // call YDOC_UPDATE_CALLBACK here
42 | const formData = new FormData()
43 | // @todo only convert ydoc to updatev2 once
44 | formData.append('ydoc', new Blob([Y.encodeStateAsUpdateV2(ydoc)]))
45 | // @todo should add a timeout to fetch (see fetch signal abortcontroller)
46 | const res = await fetch(new URL(room, ydocUpdateCallback), { body: formData, method: 'PUT' })
47 | if (!res.ok) {
48 | console.error(`Issue sending data to YDOC_UPDATE_CALLBACK. status="${res.status}" statusText="${res.statusText}"`)
49 | }
50 | }
51 | }
52 |
53 | yredis.createWorker(store, redisPrefix, {
54 | updateCallback
55 | })
56 |
--------------------------------------------------------------------------------
/compose.yaml:
--------------------------------------------------------------------------------
1 | services:
2 | server:
3 | build: .
4 | ports:
5 | - "3002:3002"
6 | command: node ./bin/server.js --no-colors
7 | env_file: .env
8 | depends_on:
9 | - minio
10 | - redis
11 | worker:
12 | build: .
13 | command: node ./bin/worker.js --no-colors
14 | env_file: .env
15 | depends_on:
16 | - minio
17 | - redis
18 | redis:
19 | image: redis:alpine
20 | minio:
21 | image: quay.io/minio/minio
22 | ports:
23 | - 9000:9000
24 | - 9001:9001
25 | command: server /data --console-address :9001
26 |
--------------------------------------------------------------------------------
/demos/auth-express/Dockerfile:
--------------------------------------------------------------------------------
1 | # Instructions to build the Docker image
2 | # docker build -t y-redis .
3 |
4 | # Run the worker as follows:
5 | # docker run --env-file ./.env y-redis npm run start:worker
6 |
7 | # Run the server as follows:
8 | # docker run -p 3002:3002 --env-file ./.env y-redis npm run start:server
9 |
10 | # Use an official Node.js runtime as a parent image
11 | # FROM node:20-alpine
12 | FROM node:lts-alpine3.19
13 |
14 | # Install glibc compatibility for alpine
15 | # See more at https://wiki.alpinelinux.org/wiki/Running_glibc_programs
16 | RUN apk add gcompat
17 |
18 | # Set the working directory in the container
19 | WORKDIR /usr/src/app
20 |
21 | # Copy package.json and package-lock.json (if available) to the working directory
22 | COPY package*.json ./
23 |
24 | # Install any dependencies
25 | RUN npm install
26 |
27 | # Bundle your app source inside the Docker image
28 | COPY . .
29 |
30 | # build files
31 | RUN npm run dist
32 |
33 | # Make port 3002 available to the world outside this container,
34 | # assuming your app runs on port 3002
35 | EXPOSE 3002
36 |
37 | # Removed CMD instruction to allow dynamic command execution at runtime
38 | CMD node ./server.js
39 |
--------------------------------------------------------------------------------
/demos/auth-express/README.md:
--------------------------------------------------------------------------------
1 | # Express demo
2 |
3 | This demo shows how you can integrate y-redis in your existing express
4 | application. `./server.js` implements a sample express server.
5 |
6 |
--------------------------------------------------------------------------------
/demos/auth-express/compose.yaml:
--------------------------------------------------------------------------------
1 | include:
2 | - ../../compose.yaml
3 | services:
4 | demo:
5 | build: .
6 | ports:
7 | - 5173:5173
8 | depends_on:
9 | - server
10 | env_file: ../../.env
11 |
--------------------------------------------------------------------------------
/demos/auth-express/demo.js:
--------------------------------------------------------------------------------
1 | /* eslint-env browser */
2 |
3 | import * as Y from 'yjs'
4 | // @ts-ignore
5 | import { yCollab, yUndoManagerKeymap } from 'y-codemirror.next'
6 | import { WebsocketProvider } from 'y-websocket'
7 |
8 | import { EditorView, basicSetup } from 'codemirror'
9 | import { keymap } from '@codemirror/view'
10 | import { javascript } from '@codemirror/lang-javascript'
11 |
12 | import * as random from 'lib0/random'
13 | import { EditorState } from '@codemirror/state'
14 |
15 | export const usercolors = [
16 | { color: '#30bced', light: '#30bced33' },
17 | { color: '#6eeb83', light: '#6eeb8333' },
18 | { color: '#ffbc42', light: '#ffbc4233' },
19 | { color: '#ecd444', light: '#ecd44433' },
20 | { color: '#ee6352', light: '#ee635233' },
21 | { color: '#9ac2c9', light: '#9ac2c933' },
22 | { color: '#8acb88', light: '#8acb8833' },
23 | { color: '#1be7ff', light: '#1be7ff33' }
24 | ]
25 |
26 | export const userColor = usercolors[random.uint32() % usercolors.length]
27 |
28 | const room = 'y-redis-demo-app'
29 |
30 | // request an auth token before trying to connect
31 | const authToken = await fetch(`http://${location.host}/auth/token`).then(request => request.text())
32 |
33 | const ydoc = new Y.Doc()
34 | const provider = new WebsocketProvider('ws://localhost:3002', room, ydoc, { params: { yauth: authToken } })
35 |
36 | // The auth token expires eventually (by default in one hour)
37 | // Periodically pull a new auth token (e.g. every 30 minutes) and update the auth parameter
38 | const _updateAuthToken = async () => {
39 | try {
40 | provider.params.yauth = await fetch(`http://${location.host}/auth/token`).then(request => request.text())
41 | } catch (e) {
42 | setTimeout(_updateAuthToken, 1000) // in case of an error, retry in a second
43 | return
44 | }
45 | setTimeout(_updateAuthToken, 30 * 60 * 60 * 1000) // send a new request in 30 minutes
46 | }
47 | _updateAuthToken()
48 |
49 | const ytext = ydoc.getText('codemirror')
50 |
51 | provider.awareness.setLocalStateField('user', {
52 | name: 'Anonymous ' + Math.floor(Math.random() * 100),
53 | color: userColor.color,
54 | colorLight: userColor.light
55 | })
56 |
57 | const state = EditorState.create({
58 | doc: ytext.toString(),
59 | extensions: [
60 | keymap.of([
61 | ...yUndoManagerKeymap
62 | ]),
63 | basicSetup,
64 | javascript(),
65 | EditorView.lineWrapping,
66 | yCollab(ytext, provider.awareness)
67 | // oneDark
68 | ]
69 | })
70 |
71 | const view = new EditorView({ state, parent: /** @type {HTMLElement} */ (document.querySelector('#editor')) })
72 |
73 | // @ts-ignore
74 | window.example = { provider, ydoc, ytext, view }
75 |
--------------------------------------------------------------------------------
/demos/auth-express/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | Yjs y-redis / CodeMirror6 Demo
6 |
10 |
11 |
12 |
13 |
14 |