From ef8a2a9220e06efc1d64210edbb6bafa1a321f24 Mon Sep 17 00:00:00 2001 From: b <> Date: Wed, 5 Mar 2025 12:17:50 +0000 Subject: [PATCH] copy from sebas repo --- CloudronManifest.json | 22 ++ DESCRIPTION.md | 13 + Dockerfile | 23 ++ LICENSE | 674 ++++++++++++++++++++++++++++++++++++++++++ POSTINSTALL.md | 12 + README.md | 36 +++ chief-config.toml | 18 ++ chief.json | 5 + logo.png | Bin 0 -> 8796 bytes start.sh | 17 ++ strfry.conf | 138 +++++++++ 11 files changed, 958 insertions(+) create mode 100644 CloudronManifest.json create mode 100644 DESCRIPTION.md create mode 100644 Dockerfile create mode 100644 LICENSE create mode 100644 POSTINSTALL.md create mode 100644 README.md create mode 100644 chief-config.toml create mode 100644 chief.json create mode 100644 logo.png create mode 100755 start.sh create mode 100644 strfry.conf diff --git a/CloudronManifest.json b/CloudronManifest.json new file mode 100644 index 0000000..cb3ad61 --- /dev/null +++ b/CloudronManifest.json @@ -0,0 +1,22 @@ +{ + "id": "com.hoytech.strfry", + "title": "strfry", + "author": "hoytech", + "tagline": "a nostr relay", + "version": "0.9.6", + "healthCheckPath": "/", + "httpPort": 7777, + "addons": { + "localstorage": {} + }, + "manifestVersion": 2, + "website": "https://github.com/hoytech/strfry", + "contactEmail": "seb@sebdev.io", + "icon": "logo.png", + "tags": [ + "nostr", + "relay" + ], + "postInstallMessage": "file://POSTINSTALL.md", + "description": "file://DESCRIPTION.md" +} diff --git a/DESCRIPTION.md b/DESCRIPTION.md new file mode 100644 index 0000000..277461e --- /dev/null +++ b/DESCRIPTION.md @@ -0,0 +1,13 @@ +# strfry - a nostr relay + +![strfry logo](docs/strfry.svg) + +strfry is a relay for the [nostr protocol](https://github.com/nostr-protocol/nostr) + +* Supports most applicable NIPs: 1, 2, 4, 9, 11, 12, 15, 16, 20, 22, 28, 33, 40 +* No external database required: All data is stored locally on the filesystem in LMDB +* Hot reloading of config file: No server restart needed for many config param changes +* Zero downtime restarts, for upgrading binary without impacting users +* Websocket compression: permessage-deflate with optional sliding window, when supported by clients +* Built-in support for real-time streaming (up/down/both) events from remote relays, and bulk import/export of events from/to jsonl files +* [negentropy](https://github.com/hoytech/negentropy)-based set reconcilliation for efficient syncing with remote relays diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..d2f4099 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,23 @@ +FROM cloudron/base:4.2.0@sha256:46da2fffb36353ef714f97ae8e962bd2c212ca091108d768ba473078319a47f4 + +RUN apt update && apt install -y --no-install-recommends \ + liblmdb0 libflatbuffers1 libsecp256k1-0 libb2-1 libzstd1 \ + && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p /app/code /app/pkg +WORKDIR /app/code + +ARG STRFRY_VERSION=v0.9.6 +ARG CHIEF_VERSION=v1.0.0 + +RUN wget https://github.com/sebdeveloper6952/strfry/releases/download/${STRFRY_VERSION}/strfry +RUN wget https://github.com/sebdeveloper6952/chief/releases/download/${CHIEF_VERSION}/chief + +COPY start.sh start.sh +RUN chmod +x start.sh strfry chief + +COPY strfry.conf /app/pkg/strfry.conf +COPY chief-config.toml /etc/chief/config.toml +COPY chief.json /app/pkg/chief.json + +CMD [ "/app/code/start.sh" ] diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/POSTINSTALL.md b/POSTINSTALL.md new file mode 100644 index 0000000..8f00204 --- /dev/null +++ b/POSTINSTALL.md @@ -0,0 +1,12 @@ +By default the relay will accept events from any pubkey and any kind. + +If you want to apply a policy, apply the following modifications using the File Manager. + +1. Update the `writePolicy` section of the `strfry.conf` file to read like this: +``` +writePolicy { + plugin = "/app/code/chief" +} +``` +2. Update the `chief.json` file with your desired policy. For examples of policies please refer to [this url](https://github.com/0xtrr/chief/blob/master/docs/examples/example-data.json). +3. Restart the app to apply the changes. diff --git a/README.md b/README.md new file mode 100644 index 0000000..6592cea --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# strfry-cloudron + +[strfry - a nostr relay](https://github.com/hoytech/strfry) packaged to run as a [cloudron](https://www.cloudron.io/)app. Supports event policies through the [chief plugin](https://github.com/0xtrr/chief/tree/master). + +The app is [not yet in the Cloudron App Store](https://forum.cloudron.io/topic/12056/strfry-a-nostr-relay) so for now you have to use the Cloudron CLI to install. + +### Prerequisites +Install the [Cloudron CLI](https://docs.cloudron.io/packaging/cli/) - `npm install -g cloudron` + +### Installing + +**Authenticate the CLI with your Cloudron instance** +``` +cloudron login your.instance.com +``` + +**Clone the project and change into it** +``` +git clone https://github.com/sebdeveloper6952/strfry-cloudron.git +cd strfry-cloudron +``` + +**Install the app** + +Requires the latest package version hash from [this page](https://github.com/sebdeveloper6952/strfry-cloudron/pkgs/container/strfry-cloudron) +``` +cloudron install --image ghcr.io/sebdeveloper6952/strfry-cloudron: +cloudron install --image ghcr.io/sebdeveloper6952/strfry-cloudron:sha256-1440e0d1c812504ab707515fb174b8d8dfc403bfd1398107c20df50311031f2b -l artclock-relay.nostrdev.com +``` + +For example: +``` +cloudron install --image ghcr.io/sebdeveloper6952/strfry-cloudron:d7593aea5ac40baa84ef27cd78cca218c0fdf195 +``` + +You will then be prompted for a location - so put the domain, eg `strfry.yourdomain.com` diff --git a/chief-config.toml b/chief-config.toml new file mode 100644 index 0000000..7ed4a8d --- /dev/null +++ b/chief-config.toml @@ -0,0 +1,18 @@ +datasource_mode = "JSON" + +[filters] +public_key = true +public_key_filter_mode = "Whitelist" +kind = true +kind_filter_mode = "Blacklist" +word = false + +[database] +host = "" +port = "" +user = "" +password = "" +dbname = "" + +[json] +file_path = "/app/data/chief.json" diff --git a/chief.json b/chief.json new file mode 100644 index 0000000..9c30264 --- /dev/null +++ b/chief.json @@ -0,0 +1,5 @@ +{ + "pubkeys": [], + "kinds": [], + "words": [] +} diff --git a/logo.png b/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..17f94469a84161528408ede5d3bf7e6d4d927fd8 GIT binary patch literal 8796 zcmV-iBBR}jP)pF8FWQhbW?9;ba!ELWdL_~cP?peYja~^aAhuUa%Y?FJQ@H1AOJ~3 zK~#90?VWd=RMpwXzt3zhv;{$mV1y7wKtxnDYQU~BMl6`n!Pu3Uyw(_7ib>QoyC?_( zYLNGhy`rdyq9D>lSwvA#>AP&-ot-)FA7>VJm)YI9ckZ2gXXboApZUPfobv3>%-~TYrH|^P~f4+Po-X(Vn{qjMB+hjB0fR% zzhipri-;5g&j1CHXLfmLjllzqh}cCW6PO2dZ=prH?29}G9Mb6LGOr9Vc!LoU`}~I1 zh2mI5G7@EsCx}c1E^PK}i5I3Ayu*ly9YhX5Z>F|Jdthh+tnmhsqk+4lyka(1(+ndb z_V_nY7(=@=+&07$L^`8y<+7u^YBpBW3?m{|5jhd*tj0;_hFX{oH8Wgh@1obkA)uQ zGnHnD$!yjJB1OO^AU}>#YJi?7m0WQpB7J}rKt~I`@=>bVC5sF`#9TGn=2yfgAON|* zI0tM=9C{yQ4%P$&%x5a?FmHHk=r7Wh4vluPL*pchTZnxhq%r0*m1dYXymfv~%buB5 z8Hh-7qzBNsVsEzD+kB?d4D*J!&QyoTyWZjPoJa2g&7p07kd`o?sWij9;VmI@7|!Pe z`6(g;9UjwZ9t94FqkpDTh8U6qBO)y`$%Qe6eN!p=2a!vGbK@Mv>PD;~$uUQ~(a;;J zn*ld!s3_oAlv?7#*!B?_04yc`lc?b+^`Qe68IlCE5{b?!xFaB-S0jH%L|hu*IwHBi zQ^YSI0I3$WY-j@`BGDP|^7zN%uOr`kfWZ!pWhcJKki-}fX^u!c^wF-{+=WQbwwt+( z$l1UZ4vuJ6B58&Zk$pJ}XO{JC(E)fok}1p^w1`bd-(oq1S&5_>Mnv}IX9=9^6yU}L z&bJpWUQYmB93Hu)5*mgS#fV5_^r=ju^P=8?$SDb)6W|8mL>I>G=fao?Ve8iMxRQwt9}X+~X))^B9s6BO-foM?`*&Ufd72-1F~^lezf3dH(K%G}bV z2}VRT*1z7ZA?S*=&7(-{E%G}8FW4#!E;0zar!f}+LmK^TT|}(+FeD`=m7ON`vy)gD zjlPv>j{UDyU$hU&DJWGJQx6>*^C*yIdA7mmLK%(eflivZDdtg5BQeLxh6FHo+z;Dl zW#?a#9mp6K4uw7|s|-CdY2KPGU^1H#@yXbZQz7j6!1J`6B=ACDgYD60qSWM=T8dl^ z+-rG;0(5$!9#LNVD=^>EXa}Oy*OqNC_=Y>~kielEhuqkuFne-dmh>fZgC498eZ94! z?r-PKSox5-oq;|$nFC`qt!EjHuPW~(M6PYKl}Io2j)rwEBf5Zqo!hZQ2QwNRWai`} zh7aF5bV;vH*|+9pNk1Cx8)ju@^y%I{_qL}d4mr-OL`2TR>h-lH+FFGGY(qQOhi%Ui z2F^jL7g}r~G8Y(QdF1}UY+80lD+f*nLNSl{97>&I*$#uJ%$$69$BqGcuxtD5lQM*^ zt+g$wtY2tWA~49Yk(;@e7dD$73V#th$*zuu=MnAMeSu6}D z`ss}|4h9};@{Gv&*r}h}j@WDcSzkrDo%Gre2h%PcmjCQUL+9{@&LnjzET3%K3mzI4pYRUfCj zvzasbLplS!ZS*@8r~~ed{A-UaU@l;91M>>3=QukNc*atXUm@~u(*7vWTc%w)EURlU zbjN|63npX*?3F7CDYbojdGL*jn)1uX&RJgu#$)vdj*N0x9DUD1=K=d8u-^74_L2Y% z!1`?%X#d_$KuOF!4n-dhzhPrGg9FT;GU%+nc{z6$7UT@TMot+e)aB%IgQ|E-S>2PL9kk+)w>_x#@o-9a5$WT|C<7cABLnRce+uw#;AM2_ zZ?`y#_#%c*#j1#$fk=OpDvo1TLyWvVa%AR?-X*v8?$mC4PNp1aXN<67+qUxB_ji@a zC6niUvc08t>Fu#9vJ@vGcwfi)x^Ew$BY|6d>*8bv@uh1H1EYX%E%kaBr7n+SRznOt zJ?^lRIjLl4wipqKmky4M5*yb6JApR0 zx>{fu&R2vv9PKBw(o(NW5cwBMec`Y*X~FzShfVll*X*0~vvX|Sx+o|wtqQK#RUVu) zX6~vllJO%nEy;T;*bvc zGObsqyrEVD(<&e?R-RzLaC2ju_=X^cImMEuJ!eQ?OBv_u6=iPzTLXJ zW?_9r{pAN%d!u(1tl-uv1hm(y^&BYz+~Zo^ z;S}NNiG#=V%i#U)9dfUT#1gs0KKqpo|D`P z&TNTV&!z4RXQ2H@UWuV?Pxk)R+~O4A5#Sq3y^aSi0Oq-1QBpJO7lZnCX`lJnfkk;k zMa0%kb4@V3VOv@4eHYAH`ERG~YfSR2L`3@0w9xfrMB;JWc1A?Jl;LZM?YFoP_uuIN zIxmTJ?lLJ9_cHC$VOh^kIsDGP`{%#Yr7&lN9RUd`wrwe|dvbG0$xyci1d>HWbn>8? zG~Iy+0RN0*)Z`bD4nSLOTY2czhl$`!^s2`ieSrUQ+?FI{{**yy_08nt?j3Wkw{`0x z)RflLulRCD?WmtWx_oRysJ`1IhluFC{~t$r{)9+MKsz{dIP2BzOao`rdi2j3==6t) zAOn4JWStukdmDzSz?|^|x<7yM5&zq>W5KM#oXkPk2-U9*s^V{U)c$ozw~vn)H~SN( z10`C;{~oI%U4buX`K$01FaV`$ERMStCz3S(3p-g&o#jh(?yzWOD4xWPQspfZLl4&3$oZtZi%XJ-TsvNJ|lv290r?fW~*f!`gk?kEz3|6DYQ93u9r6(=F{#tuHY_K@X6)R-H|G)H zh`2|IpKa(BKx60SKjBRcx;k{B2)eIF6Oo?_fDs7mKyY??=H(d zHv)%P-sAEyeu%Vn6F={XT!yvPLIC);1rJDPRwB;qtT;n^_Lho@wHlvW2? zQd+)d+UQ{&{(I5kbNUwLzt|~1^T&1sq%Nd3e!IKofwf=lKFW^*0)AbI=t4|iV=qW< z3QDyeT%`R@>TQg@FaL+VauIG(0bGJEBH^_|`7U%ed+X&ecB6BS>~z|sL@|HTVG}wR zX5XBjo#Bf}TQ~8mh@1^PXS4TiU=T`eYGwQa^w%wZUI4l~GLmzAhb~Ix2mXZBgw74z zg;F;-YmECeMA~-D%d{P7TU8e--d<66$LN_WpK{zl7x1fy%t5ESvCGRS)$)Q~?}|Hf zm3s|cyvh)rFVS12)<0%dKtGiF-f5HEpdr$>OFMr?+PaDVL`26?Y$bj_%NtPYt`_F# zj=o;U&s!umr${m~6}!o%lOiAM(-Q}e=~|F|eL-&KAZ+Y2DkT*q)xniJN`se;e|qH_ z7ff^&KZ?jXIFpt*44i{fFGQK62Ud$6w8VQjRn0eb`4Am{ZJj#w-iU9GGaJ(oY1_FV z+jgXFbuj$-*0Q<>E}XUEey8nA6n^v*In|+Y0>E5EPDiQc*THBG;?~K=2uLg(g)a1I zJsDy)+8g;=hb`I%(Toj)kOr*F6X^RhCem!0{-VYOvjW$^W#;i{{q z%=$c0H4k0Ek4L;GIXG53;0;8Y?~gdM{7Phg)nrD{`y%$Z7!k+QVT(wPh+Hfp%SGgS zw8Tw`rDMepcfZ)HL(Ua;1VlkiX;tvU4LfUo`twJZPnec#f<+TrAFmvTUQ^~d8Z!3`#TpBkEcnFc_A~{-}c>|qEu$Ug?q4SN{ zV=5w+zqBHfAtFbJ$n7Gs4EP>hy6Xa>Z-);T?L*We9dZNbqJNv135Ubmx0Kh;|6)t! z@CzPa@sCsz5b)bdB)$^Uv2ZpzQJ@oLpyDmSnSPv)-9(5z(5r_wH{3;^yq$rTtdp^J z)7c)q68@~E1~tL3g?C-ml~#w=>@KVO&FHzS+$y%}IeuG-3`xKo`8ZWL$<~%y8gmfw zTqdFhS2kL0+#n+Fp-hC_^HqJK;x^qxBpkXGmv-sx7MyzrHIwVgLVa~7|Nf6!q*_M40qqgD7=lnp!JFJS{3@X z=1!%Q_1NSTCAC%}*RnUF_A(%P6aB=KZXMf;WbjScu0o8ATdI|EM2if9nG}4F` zo_`UzS}Ch9m=i5)pe&_wFXl*K64Bx9x51|%DP5)o^m-dA8vb`C)2$hy26;wKS_Jr-d^9J6Et_nowa^B}=J#<6Qy|E+Oxo z3NnemEJv#GhSvrpBYqN**a|pzA^s?vB6QlCslewk_UQv05$C*#Bn0(q2!6VRs>j}; zaC$Kr)jCAc5S=n~aSMY*{3If=Wtce7q1lRnX=vB@4`OIP1@CLywuN48RKM{q@{c9t zeON&jsc{3A2o@@((k_hO3H&4?+hS_9pMx{zqce~{4LnTC$G^SNSv&nk2tsQJuKSSc zX>U{TNHG~T$?xpt74y9|AX)K~h-{CkmD8(%05Aq!(qIlc;Jf*n=vVkB8|@BM=~Ai| zEP}h z1rHaKRin(_hQrJ^k-GNrlZeE2J7e`k#VQ%VVUdSd>_C++qw1AKgzsETyES^XVM=AW z#}i%~kj(f=L}FWse2>obkV*^qhSkPWcHh5{!WqTnn$X+@}OpzM87H7Eyc4n{--TMi!auhu2bAr)ZD2wNeb$_yl;;Ya>#Hw8kYwSvlLR}lWq zQ|uoMnbn4257#KAKJnU!RK{O!?*Jl#P7Batj7b=FtcNcj2d2TnCC1Uq5S>{{sYzZN zk?QzQL;yry2Tp19Ot=Epy#m|rgRbwv!OH(>lMUYTE^vwouyY?j-p&9l4MML?5L^y< zH$%5#I0XGL7~0}1;Cv$>iNQA_A|e6caNuO%C+LhJeo2pPNFGXnGnG=YWy&+eji(|a zBAwC4xhDfZ!}x3%;-doisZuJ|l4J%4NVtfI$f3Yl>|JsAEh~s2IjIKDR!YTEip=03 zt%}IBONV7;mxX#}WQC`4uKb-;WZ_iYNp+)L|^ORBxy*4Br z+2?fTnbF7QRb`c54EzEZ#@>}eP=uvQF{iAgX2#Voudi)!P?3SaPl0PO$%hT@QV0A( zDfM5k4M|s;h{zLT2cN8znu)aNNZ!C#0i`C4e{#)xQ3n-y2{_Y1I}L_tRH0WOuX=4r zIvmCKt9D$))e9+&5a(T22VJ8-&EYI&P24XzV-d*sN> zurQsb0umI|9|IYI?i1&(?mcnt>fRZFP%jbgMwgFjASWXnzNY!0kzl9iUAEnjo)iN= zHUi=wGQaM=<6Mx&8P-FD88zXlH7_-8IBxdZ?}6)|7&qu+rFaV12y)9;{a3ei>+*Nt zLU+tIq$%$Kqm)uRyf(zJ7nwPB;D1nzZuHax6X&kFs3Q2-Sy<2O7@aTN9B|bm0cjN5Q)ry;cu2PDi&tEoVYC7#dR# z`~mp0DKM2BWFqQqkUb(I@Vh(ikk@a!O@)EAKvCqSGNn}L?U5rhzwWvHw^=Ii=$N^y zN@AHrL<)cvKtHE{0Ygf$4w$5rTH>`KhS&*6Sj}kijL7i^77u*jnbD&&lu{w3R7vC! zy6?;%=6u~_$8?nZEr=?fHFnVD&x{_O(bgnNsY>8Hbfl%h&>V$6eL2DiNb(^{DQ1ls z{0ySbZ}!?MCF=fwVkKb}3}*z67MO}^nq5r6os;ISzB#7JM6LwxcglD}O7Jx>*+k$b zFPQ*A)K%GVq=G(;UK=b*rYV4cAkkB?enEET-LX!llzKo!jzdQX8`7J4;9lT1rBsF2 z#u)6gCyIB*_``mb5e~l$928quRUF9Vl<~9Hd}C=sk!;`v;8bg-8d8Ymz-3CQrCu9i zh@U+HbyH@qTvs1dM~ae1X&N8XoH~#PLb>(BtO^J~Bzf)yfT;zNew3gq(H&_7Bz1^d zGGg|`fxSb)z!(vAG;jc*1inGZ;*e6$Onz$hrnn~-=>{ysWN=Rhg6I&4KbW|e)Wg%d zGa}LjcnK3y_Sz7GJ9t`>A#znZ33wwB^X2B|CSn?c=0o5oN~uvsKvElD zRKSaDwmty-%FTIZ&6-8WjvZOFXb}q*EMV2DRfNOFDbit<0kp1Vc^T^D!R_duCAuKx|(1xNO^gA)INbgfP#Vo3JVL#&CMk*Pv5;=e);8b z+v74jfyaUSlv0*`gbb;PuSEnvL~?*@fSb@M7abuZBZC1025|V{hck5OP=*W{LSbQ{ zQ^Q*(91b&l_;9~&^e#dN$jw(u)p%`;!C&}ZL>g;MF_QoQ0o_SNK~#wNl-vSb24p)u zejpH_U%!4FeDJ~a@85sVBay;#;)y3xR#uj<`PyJ7Fb9~Xlxm*s&S2O>(uha{BGM1I z5g3Qg`|2t^di0=IuU<_aJ$v?~sHlieojO_GV`+_1qeii5Q{2wL@lb^>_3j)QXIU^u}b^)?I|iMqGQL7y#DNl6iDjA%diVZa%{2w*s=S7OHi}U}%C7kya3qj%Y#Y4RiLZJE9AkH+ZL&(KO9uHM*czIlAyyS>*p)fbW5=z_-9Q;2WisDX(Ej3jQA!g5rKY S!7iu(0000 First run, copying config files" + cp /app/pkg/strfry.conf /app/data/strfry.conf + cp /app/pkg/chief.json /app/data/chief.json +fi + +echo "==> Changing ownership" +chown -R cloudron:cloudron /app/data + +echo "==> Starting strfry" +exec /usr/local/bin/gosu cloudron:cloudron /app/code/strfry --config /app/data/strfry.conf relay diff --git a/strfry.conf b/strfry.conf new file mode 100644 index 0000000..f3c57f8 --- /dev/null +++ b/strfry.conf @@ -0,0 +1,138 @@ +## +## Default strfry config +## + +# Directory that contains the strfry LMDB database (restart required) +db = "/app/data/lmdb" + +dbParams { + # Maximum number of threads/processes that can simultaneously have LMDB transactions open (restart required) + maxreaders = 256 + + # Size of mmap() to use when loading LMDB (default is 10TB, does *not* correspond to disk-space used) (restart required) + mapsize = 10995116277760 + + # Disables read-ahead when accessing the LMDB mapping. Reduces IO activity when DB size is larger than RAM. (restart required) + noReadAhead = false +} + +events { + # Maximum size of normalised JSON, in bytes + maxEventSize = 65536 + + # Events newer than this will be rejected + rejectEventsNewerThanSeconds = 900 + + # Events older than this will be rejected + rejectEventsOlderThanSeconds = 94608000 + + # Ephemeral events older than this will be rejected + rejectEphemeralEventsOlderThanSeconds = 60 + + # Ephemeral events will be deleted from the DB when older than this + ephemeralEventsLifetimeSeconds = 300 + + # Maximum number of tags allowed + maxNumTags = 2000 + + # Maximum size for tag values, in bytes + maxTagValSize = 1024 +} + +relay { + # Interface to listen on. Use 0.0.0.0 to listen on all interfaces (restart required) + bind = "0.0.0.0" + + # Port to open for the nostr websocket protocol (restart required) + port = 7777 + + # Set OS-limit on maximum number of open files/sockets (if 0, don't attempt to set) (restart required) + nofiles = 1000000 + + # HTTP header that contains the client's real IP, before reverse proxying (ie x-real-ip) (MUST be all lower-case) + realIpHeader = "" + + info { + # NIP-11: Name of this server. Short/descriptive (< 30 characters) + name = "strfry default" + + # NIP-11: Detailed information about relay, free-form + description = "This is a strfry instance." + + # NIP-11: Administrative nostr pubkey, for contact purposes + pubkey = "" + + # NIP-11: Alternative administrative contact (email, website, etc) + contact = "" + } + + # Maximum accepted incoming websocket frame size (should be larger than max event) (restart required) + maxWebsocketPayloadSize = 131072 + + # Websocket-level PING message frequency (should be less than any reverse proxy idle timeouts) (restart required) + autoPingSeconds = 55 + + # If TCP keep-alive should be enabled (detect dropped connections to upstream reverse proxy) + enableTcpKeepalive = false + + # How much uninterrupted CPU time a REQ query should get during its DB scan + queryTimesliceBudgetMicroseconds = 10000 + + # Maximum records that can be returned per filter + maxFilterLimit = 500 + + # Maximum number of subscriptions (concurrent REQs) a connection can have open at any time + maxSubsPerConnection = 20 + + writePolicy { + # If non-empty, path to an executable script that implements the writePolicy plugin logic + plugin = "" + } + + compression { + # Use permessage-deflate compression if supported by client. Reduces bandwidth, but slight increase in CPU (restart required) + enabled = true + + # Maintain a sliding window buffer for each connection. Improves compression, but uses more memory (restart required) + slidingWindow = true + } + + logging { + # Dump all incoming messages + dumpInAll = false + + # Dump all incoming EVENT messages + dumpInEvents = false + + # Dump all incoming REQ/CLOSE messages + dumpInReqs = false + + # Log performance metrics for initial REQ database scans + dbScanPerf = false + + # Log reason for invalid event rejection? Can be disabled to silence excessive logging + invalidEvents = true + } + + numThreads { + # Ingester threads: route incoming requests, validate events/sigs (restart required) + ingester = 3 + + # reqWorker threads: Handle initial DB scan for events (restart required) + reqWorker = 3 + + # reqMonitor threads: Handle filtering of new events (restart required) + reqMonitor = 3 + + # negentropy threads: Handle negentropy protocol messages (restart required) + negentropy = 2 + } + + negentropy { + # Support negentropy protocol messages + enabled = true + + # Maximum records that sync will process before returning an error + maxSyncEvents = 1000000 + } +}