diff --git a/Cargo.toml b/Cargo.toml index e61e49c..07ca76e 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -5,9 +5,9 @@ members = ["skald-core", "skald"] [workspace.package] version = "0.0.1" edition = "2024" -license = "MIT" -authors = ["Sulkta"] -repository = "http://127.0.0.1:3001/Sulkta/skald" +license = "AGPL-3.0-or-later" +authors = ["Sulkta "] +repository = "https://git.sulkta.com/Sulkta-OSS/skald" [workspace.dependencies] tokio = { version = "1", features = ["full"] } diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..be3f7b2 --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. diff --git a/README.md b/README.md index 97ae616..1dfdf71 100644 --- a/README.md +++ b/README.md @@ -1,95 +1,39 @@ -# skald +# skald — `engine/kokoro` variant -Long-form story-writer with canon-keeping, sequel continuity, and -(future) self-hosted audiobook narration. Database is the source of -truth — the writer is the tooling. +This branch is the **Kokoro-82M TTS backend** variant of +[skald](https://git.sulkta.com/Sulkta-OSS/skald). It carries +engine-specific tuning for Kokoro that doesn't generalise to the +other backends; everything else tracks `main`. -Named for the Old Norse poets who composed and memorized kings' -sagas across generations. +For the full project — the story-writer, the schema, the narration +pipeline — see `main` and the root `README.md`. -## Status: v0.1 — scaffold +## What's different here -What's wired: +Kokoro-82M is the fast, audiobook-quality narrator. At 82M +parameters it's tiny and quick (~50x real-time on a modest GPU) but +has a couple of rough edges this branch works around in +`engines/kokoro/server.py`: -- Rust workspace (`skald-core` + `skald`) -- Postgres schema for stories, characters, canon facts, chapters, - passages, generation runs, audit findings, tags -- pgvector extension installed for future similarity search -- `skald import-markdown` ingests a story file (chapters + bible) - into the schema -- `skald serve` exposes `/health` and runs migrations on boot -- Single-container deploy: postgres + skald in one image +- **Question prosody** — single `?` reads flat, so interrogatives + get a stronger rising contour applied at synth time. +- **Pacing gaps** — paragraph / scene / breath gap durations tuned + for long-form prose narration. +- **Pronunciation respellings** — Kokoro's phonemizer treats + consecutive capitals as initialisms, so proper-noun respellings + are seeded lowercase-syllabified. -Wired (this commit): +## Usage -- clawdforge Rust SDK vendored at `vendor/clawdforge/` (upstream: - `Sulkta-OSS/clawdforge` `clients/rust/`) -- `skald-core::forge` — three-pass orchestration shell (gen / cleanup / - audit). Prompts are TODO stubs; pipeline plumbing is in place. - -Not yet wired: - -- Web UI (the inbox + browse + queue surface) -- Prompt templates for the three passes (heavy prompt-engineering - work — own session) -- `skald-core::context` — assemble the LLM context blob from DB rows - (bible + characters + parent prose summaries + similarity-matched - passages) -- Embeddings backfill + ivfflat index -- TTS sidecar container + post-render audit chain (see - `docs/tts-pipeline.md`) - -## v0.1 smoke +The Kokoro sidecar speaks the same `POST /synthesize` + `GET +/healthz` contract as the other engines (see `engines/README.md`). +Point skald's `KOKORO_URL` at it and route `kokoro_*` voices to it. ```bash -docker compose -p skald up -d -docker exec skald skald import-markdown \ - --path /seed/coast-down.md \ - --title "The Coast-Down" - -curl http://localhost:7780/health -# → { ok: true, db_ok: true, story_count: 1, ... } +docker compose up -d # skald + postgres +# bring up the Kokoro sidecar from engines/kokoro/ ``` -## Schema (cheat sheet) - -``` -stories → meta + status + parent/root for series -characters → real or fictional, story-scoped -canon_facts → setting, mystery, theme, rule, historical_anchor, hook -chapters → full prose body -chapter_summaries → short summaries for cheap context loading -passages → paragraph-level + embedding vector(1536) -generation_runs → every LLM call logged -audit_findings → canon audit output (severity + area) -tags → arbitrary labels -``` - -## Architecture (v0.1 + the plan) - -``` -┌─────────────────────────────────┐ -│ skald container │ -│ ┌───────────┐ ┌────────────┐ │ -│ │ postgres │ │ skald-rust │ │ -│ │ pgvector │←─│ axum + cli │ │ -│ │ localhost │ │ :7780 │ │ -│ └───────────┘ └─────┬──────┘ │ -└─────────────────────────┼────────┘ - │ HTTP (future) - ↓ - ┌──────────┐ - │clawdforge│ - └─────┬────┘ - ↓ - opus calls -``` - -v1.0+: extract postgres to its own container on db-net. skald -becomes pure stateless rust, connects via `DATABASE_URL`. Migration -is a connection-string change + a network move; the binary doesn't -care where the DB lives. - ## License -MIT. +AGPL-3.0-or-later — see `LICENSE`. diff --git a/compose.yml b/compose.yml index 6feb7b0..d37e4f0 100644 --- a/compose.yml +++ b/compose.yml @@ -1,37 +1,42 @@ -# Standalone compose stack for skald v0.1. Postgres lives in the -# same container — single deployable unit "till we have a real -# working tool" (Sulkta's call, 2026-05-13). +# Standalone compose stack for skald. Postgres lives inside the +# skald container — single deployable unit until the tool stabilises. # -# To deploy on the host: -# sudo mkdir -p /srv/appdata/skald/{pgdata,seed} -# sudo cp .md /srv/appdata/skald/seed/ -# sudo cp skald.env /srv/appdata/secrets/skald.env # POSTGRES_PASSWORD=... -# docker compose -p skald up -d +# Set in .env (or the environment): +# POSTGRES_PASSWORD=... # required +# CLAWDFORGE_URL=http://...:8800 # if running gen / cleanup / audit +# CLAWDFORGE_TOKEN=cf_... +# SKALD_DATA=./pgdata # optional override; defaults to ./pgdata +# SKALD_SEED=./seed # optional override; defaults to ./seed # # To import the first story: -# docker exec skald skald import-markdown \ +# docker compose exec skald skald import-markdown \ # --path /seed/.md \ # --title "" +name: skald services: skald: - image: registry.example.local:5000/skald:latest + build: . + image: skald:latest container_name: skald restart: unless-stopped ports: - "7780:7780" - env_file: - - /srv/appdata/secrets/skald.env + environment: + POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:?POSTGRES_PASSWORD is required} + POSTGRES_USER: ${POSTGRES_USER:-skald} + POSTGRES_DB: ${POSTGRES_DB:-skald} + DATABASE_URL: ${DATABASE_URL:-postgresql://skald:${POSTGRES_PASSWORD}@localhost:5432/skald} + CLAWDFORGE_URL: ${CLAWDFORGE_URL:-} + CLAWDFORGE_TOKEN: ${CLAWDFORGE_TOKEN:-} + SKALD_MODEL: ${SKALD_MODEL:-opus} + F5_TTS_URL: ${F5_TTS_URL:-} + KOKORO_URL: ${KOKORO_URL:-} + TORTOISE_URL: ${TORTOISE_URL:-} + RUST_LOG: ${RUST_LOG:-info} + SKALD_LOG_FORMAT: ${SKALD_LOG_FORMAT:-json} volumes: # Postgres data — persist across container recreates. - - /srv/appdata/skald/pgdata:/var/lib/postgresql/data - # Markdown corpus to import via `docker exec skald skald import-markdown`. - - /srv/appdata/skald/seed:/seed:ro - environment: - RUST_LOG: ${RUST_LOG:-info} - SKALD_LOG_FORMAT: json - labels: - org.sulkta.domain: "sulkta" - org.sulkta.owner: "Sulkta" - org.sulkta.managed-by: "compose" - org.sulkta.role: "skald" + - ${SKALD_DATA:-./pgdata}:/var/lib/postgresql/data + # Markdown corpus to import via `skald import-markdown`. + - ${SKALD_SEED:-./seed}:/seed:ro diff --git a/engines/README.md b/engines/README.md index ff3154e..1baf954 100644 --- a/engines/README.md +++ b/engines/README.md @@ -35,24 +35,23 @@ generalise. Examples: question intonation, paragraph/scene/breath gap durations tuned for af_heart's pacing, notes on how respellings need to be all- lowercase to avoid letter-by-letter spell-out by misaki. -- `engine/tortoise` — GPU exclusivity coordinator (stops F5 + - Kokoro before a Tortoise run since the 2070 Super can't host - all three at once), preset choice ergonomics, character→tortoise- - voice seed assignments. +- `engine/tortoise` — sentence chunking, device selection, and + pitch/rate modulation tuned for Tortoise's audiobook-quality + output. On an 8GB card Tortoise wants the GPU largely to itself, + so run it when the other engines are stopped. -When deploying an engine to the host, the build dir at -`/srv/appdata/<engine>/build/` tracks the engine's branch: +To deploy a tuned engine, check out the engine's branch in the build +dir and `docker compose up -d --build`: ```bash -cd /srv/appdata/kokoro/build git fetch && git checkout engine/kokoro -docker compose -p <name> up -d --build +docker compose up -d --build ``` -## GPU coordination (2070 Super) +## GPU coordination -The 8GB card is the bottleneck. F5 + Kokoro can co-reside (~5GB + -~1GB). Tortoise pushes the budget over and needs the GPU largely -to itself — the `engine/tortoise` branch will carry the script -that stops kokoro + f5 before a tortoise run and restarts them -after. Replace with proper coordination once we have more VRAM. +On an 8GB card F5 + Kokoro can co-reside (~5GB + ~1GB). Tortoise +pushes the budget over and needs the GPU largely to itself — stop +kokoro + f5 before a Tortoise run and restart them after, or give +Tortoise its own card. Proper multi-engine coordination is left to +the deployment once more VRAM is available. diff --git a/engines/f5-tts/Dockerfile b/engines/f5-tts/Dockerfile index fae0af6..f07de8c 100644 --- a/engines/f5-tts/Dockerfile +++ b/engines/f5-tts/Dockerfile @@ -1,9 +1,6 @@ -# Sulkta build of F5-TTS — upstream ghcr.io/swivid/f5-tts:main was -# shipped with torch 2.11/torchaudio 2.4 ABI mismatch on 2026-05-13, -# breaking import torchaudio at boot. We rebuild on a known-good -# pytorch base + pip install f5-tts. -# -# Image tag in localhost-registry: registry.example.local:5000/f5-tts:<ver> +# F5-TTS rebuild on a known-good pytorch base. Upstream +# ghcr.io/swivid/f5-tts:main shipped a torch/torchaudio ABI mismatch +# that broke `import torchaudio` at boot; this image bypasses that. # # License: Apache 2.0 (code) / CC-BY-NC (Emilia-trained weights). # Personal use OK; redistribution gray-area — flagged. @@ -30,12 +27,11 @@ RUN pip install --no-cache-dir 'f5-tts>=1.0.0' # Pre-warm the HF cache directory. RUN mkdir -p /cache/hf /audio /voices -COPY f5_server.py /app/f5_server.py +COPY server.py /app/server.py WORKDIR /app EXPOSE 7860 -# Skald talks to our purpose-built FastAPI server, not Gradio. -# Models load at startup (first request would otherwise pay the -# cold-start cost). uvicorn on :7860 to keep the port stable. -CMD ["uvicorn", "f5_server:app", "--host", "0.0.0.0", "--port", "7860"] +# Purpose-built FastAPI server, not Gradio. Models load at startup +# so the first request doesn't pay the cold-start cost. +CMD ["uvicorn", "server:app", "--host", "0.0.0.0", "--port", "7860"] diff --git a/engines/f5-tts/compose.yml b/engines/f5-tts/compose.yml index 2294531..87aaccb 100644 --- a/engines/f5-tts/compose.yml +++ b/engines/f5-tts/compose.yml @@ -1,19 +1,21 @@ -# F5-TTS standalone stack on the host. +# F5-TTS sidecar. # -# License posture (acknowledged 2026-05-13): code is Apache 2.0, but -# the pretrained model weights are CC-BY-NC (Emilia training data). -# Personal listen is fine; public sharing is a flagged gray area. -# Sulkta's call: ship anyway. +# Code is Apache 2.0; pretrained F5TTS_v1_Base weights are CC-BY-NC +# (Emilia training data). Personal use is fine; redistribution is a +# flagged gray area. # -# Runtime: 8GB GPU is plenty (F5 inference ~4-6GB peak). +# First run downloads ~2GB of model weights from HuggingFace into +# the hf-cache volume; subsequent runs are warm. # -# First-run cost: ~2GB model download from HuggingFace into hf-cache, -# happens on first inference request. Subsequent runs are warm. +# Set in .env (or override): +# F5_HOST_PORT=7792 +# F5_DATA=./data # ${F5_DATA}/hf-cache + voices + audio name: f5-tts services: f5-tts: - image: registry.example.local:5000/f5-tts:0.3 + build: . + image: f5-tts:0.3 container_name: f5-tts restart: unless-stopped deploy: @@ -24,20 +26,11 @@ services: count: all capabilities: [gpu] ports: - - "127.0.0.1:7792:7860" - - "127.0.0.1:7792:7860" + - "${F5_HOST_PORT:-7792}:7860" volumes: - # HF model weights cache — persists ~2GB after first download. - - /srv/appdata/f5-tts/hf-cache:/cache/hf - # Reference voice clips (lj_speech.wav, etc). - - /srv/appdata/f5-tts/voices:/voices:ro - # Rendered audio output — skald writes story narrations here. - - /srv/appdata/f5-tts/audio:/audio + - ${F5_DATA:-./data}/hf-cache:/cache/hf + - ${F5_DATA:-./data}/voices:/voices:ro + - ${F5_DATA:-./data}/audio:/audio environment: HF_HOME: /cache/hf HF_HUB_DISABLE_TELEMETRY: "1" - labels: - org.sulkta.domain: "sulkta" - org.sulkta.owner: "Sulkta" - org.sulkta.managed-by: "compose" - org.sulkta.role: "f5-tts" diff --git a/engines/kokoro/compose.yml b/engines/kokoro/compose.yml index 72687d2..b2c83a8 100644 --- a/engines/kokoro/compose.yml +++ b/engines/kokoro/compose.yml @@ -1,16 +1,18 @@ -# Kokoro-82M TTS stack on the host. +# Kokoro-82M TTS sidecar. # -# Audiobook-quality narrator engine (Apache 2.0 code + weights — -# clean stack vs F5-TTS's CC-BY-NC asterisk). Sibling to f5-tts; -# both share /srv/appdata/f5-tts/audio so skald's audio -# route serves outputs from either engine through the same path. +# Apache 2.0 code AND model weights — clean stack for share/publish. +# Audiobook-quality narrator; F5-TTS stays around for voice-cloning. # -# License: Apache 2.0 top to bottom. Right for share/publish. +# Set in .env (or override): +# KOKORO_HOST_PORT=7794 +# KOKORO_DATA=./data # ${KOKORO_DATA}/hf-cache +# AUDIO_DIR=../f5-tts/data/audio # shared output dir across engines name: kokoro services: kokoro: - image: registry.example.local:5000/kokoro:0.5 + build: . + image: kokoro:0.5 container_name: kokoro restart: unless-stopped deploy: @@ -21,17 +23,10 @@ services: count: all capabilities: [gpu] ports: - - "127.0.0.1:7794:7860" - - "127.0.0.1:7794:7860" + - "${KOKORO_HOST_PORT:-7794}:7860" volumes: - - /srv/appdata/kokoro/hf-cache:/cache/hf - # Shared with f5-tts so skald's /audio route covers both. - - /srv/appdata/f5-tts/audio:/audio + - ${KOKORO_DATA:-./data}/hf-cache:/cache/hf + - ${AUDIO_DIR:-./data/audio}:/audio environment: HF_HOME: /cache/hf HF_HUB_DISABLE_TELEMETRY: "1" - labels: - org.sulkta.domain: "sulkta" - org.sulkta.owner: "Sulkta" - org.sulkta.managed-by: "compose" - org.sulkta.role: "kokoro" diff --git a/engines/kokoro/server.py b/engines/kokoro/server.py index 169cbbd..b0a6f9d 100644 --- a/engines/kokoro/server.py +++ b/engines/kokoro/server.py @@ -113,12 +113,23 @@ def _parse_tag(match: re.Match) -> float: return dur / 1000.0 if unit == "ms" else dur +# [HACK — engine/kokoro] Kokoro-82M has weak question prosody on a +# single `?`. Doubling the question mark to `??` reliably triggers a +# more interrogative rising-pitch contour without changing semantics. +# Skip if already doubled or part of an interrobang. See hacks.md. +_QUESTION_RE = re.compile(r"(?<![?!])\?(?!\?)") + + +def _emphasize_questions(text: str) -> str: + return _QUESTION_RE.sub("??", text) + + def _expand_inline(text: str, voice: str | None) -> list[Node]: """Expand inline [breath]/[pause]/[scene] tags inside a chunk of text that already has a single voice attribution. Voice blocks themselves are handled one level up in split_to_nodes.""" out: list[Node] = [] - text = text.strip() + text = _emphasize_questions(text.strip()) if not text: return out cursor = 0 diff --git a/engines/tortoise/compose.yml b/engines/tortoise/compose.yml index e13b192..6d3a470 100644 --- a/engines/tortoise/compose.yml +++ b/engines/tortoise/compose.yml @@ -1,19 +1,22 @@ -# Tortoise-TTS stack on the host. Audiobook-quality engine with 25+ -# named voices (no cloning). Apache 2.0 top to bottom. +# Tortoise-TTS sidecar. 25+ named voices, no cloning needed. +# Apache 2.0 top to bottom. # -# Slow: ~10x kokoro wall clock at 'standard' preset. Worth it for -# the quality bar. Sulkta's call 2026-05-14: "use higgs (now tortoise) -# and we will only let it use the full gpu for runs" — translated: -# runs are batched, slow is acceptable. +# Slow: ~10x kokoro wall-clock at 'standard' preset. Worth it for the +# quality bar; runs are batched. # -# Co-resides with kokoro on the 2070 Super since tortoise is ~5GB -# and kokoro is ~1GB (8GB total). If OOM hits during a render, -# we'll add a coordination layer to pause kokoro first. +# Co-resides with kokoro on an 8GB card (tortoise ~5GB + kokoro ~1GB). +# OOM during a render: add a coordinator that pauses kokoro first. +# +# Set in .env (or override): +# TORTOISE_HOST_PORT=7795 +# TORTOISE_DATA=./data # ${TORTOISE_DATA}/{hf-cache,models} +# AUDIO_DIR=../f5-tts/data/audio # shared output dir across engines name: tortoise services: tortoise: - image: registry.example.local:5000/tortoise:0.1 + build: . + image: tortoise:0.1 container_name: tortoise restart: unless-stopped deploy: @@ -24,20 +27,12 @@ services: count: all capabilities: [gpu] ports: - - "127.0.0.1:7795:7860" - - "127.0.0.1:7795:7860" + - "${TORTOISE_HOST_PORT:-7795}:7860" volumes: - - /srv/appdata/tortoise/hf-cache:/cache/hf - - /srv/appdata/tortoise/models:/cache/tortoise-models - # Shared audio dir with f5/kokoro so skald serves all engines' - # outputs through the same /audio route. - - /srv/appdata/f5-tts/audio:/audio + - ${TORTOISE_DATA:-./data}/hf-cache:/cache/hf + - ${TORTOISE_DATA:-./data}/models:/cache/tortoise-models + - ${AUDIO_DIR:-./data/audio}:/audio environment: HF_HOME: /cache/hf HF_HUB_DISABLE_TELEMETRY: "1" TORTOISE_MODELS_DIR: /cache/tortoise-models - labels: - org.sulkta.domain: "sulkta" - org.sulkta.owner: "Sulkta" - org.sulkta.managed-by: "compose" - org.sulkta.role: "tortoise-tts" diff --git a/skald/src/web.rs b/skald/src/web.rs index 7608f32..e68a1b3 100644 --- a/skald/src/web.rs +++ b/skald/src/web.rs @@ -592,7 +592,7 @@ fn render_shell(stories: &[StoryRow], current: Option<Uuid>, main: Markup) -> Ma } footer.footbar { span { "skald · v0.3 · written down · " - a href="http://127.0.0.1:3001/Sulkta/skald" { "Sulkta/skald" } + a href="http://127.0.0.1:3001/Sulkta-OSS/skald" { "Sulkta-OSS/skald" } } } } diff --git a/vendor/clawdforge/Cargo.toml b/vendor/clawdforge/Cargo.toml index f8be6fb..6233183 100644 --- a/vendor/clawdforge/Cargo.toml +++ b/vendor/clawdforge/Cargo.toml @@ -2,7 +2,7 @@ name = "clawdforge" version = "0.1.0" edition = "2021" -license = "MIT" +license = "AGPL-3.0-or-later" description = "Async Rust client for the clawdforge HTTP service (a LAN bearer-token-gated wrapper around `claude -p`)." repository = "https://git.sulkta.com/Sulkta-OSS/clawdforge" readme = "README.md" diff --git a/vendor/clawdforge/README.md b/vendor/clawdforge/README.md index a877dd4..8417665 100644 --- a/vendor/clawdforge/README.md +++ b/vendor/clawdforge/README.md @@ -267,4 +267,4 @@ Tests use [`wiremock`](https://docs.rs/wiremock) — no live clawdforge needed. ## License -MIT. +AGPL-3.0-or-later.