diff --git a/LICENSE b/LICENSE new file mode 100644 index 000000000..0ad25db4b --- /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 62815db35..57544aef5 100644 --- a/README.md +++ b/README.md @@ -1,103 +1,121 @@ -# LiveKit - Open source, distributed video/audio rooms based on WebRTC +# LiveKit - Open source, distributed video/audio rooms over WebRTC -## Building +LiveKit is an open source project that provides scalable, multi-user conferencing over WebRTC. It's designed to give you everything you need to build real time video/audio capabilities in your applications. + +## Features + +- Horizontally scalable WebRTC Selective Forwarding Unit (SFU) +- Modern, full-featured [client SDKs](references/client-sdks.md) for JS, iOS, Android +- Built for production - JWT authentication and [server APIs](references/server-apis.md) +- Robust networking & connectivity, over UDP & TCP +- Easy to deploy, a single binary and only three ports to forward. +- Advanced features - simulcasting, selective subscription, moderation APIs. + +## Documentation & Guides + +Docs & Guides at: https://docs.livekit.io + +## SDKs & APIs + +Client SDKs: + +- [Javascript](https://github.com/livekit/client-sdk-js) ([docs](https://docs.livekit.io/client-sdk-js/)) +- [iOS - Swift](https://github.com/livekit/client-sdk-ios) ([docs](https://docs.livekit.io/client-sdk-ios/)) +- [Android - Kotlin](https://github.com/livekit/client-sdk-android) ([docs](https://docs.livekit.io/client-sdk-android/)) + +Server APIs: + +- [Javascript](https://github.com/livekit/server-api-js) ([docs](https://docs.livekit.io/server-api-js/)) +- [Go](https://github.com/livekit/livekit-sdk-go) ([docs](https://pkg.go.dev/github.com/livekit/livekit-sdk-go)) + +## Installing + +### From source Ensure Go 1.15+ is installed, and GOPATH/bin is in your PATH. -Run `./bootstrap.sh` to install mage, then `mage` to build the project +```shell +git clone https://github.com/livekit/livekit-server +cd livekit-server +./bootstrap.sh +mage +``` -## Creating API keys +### Docker + +LiveKit is published to dockerhub under livekit/livekit-server + +## Running + +### Creating API keys LiveKit utilizes JWT based access tokens for authentication to all of its APIs. Because of this, the server needs a list of valid API keys and secrets to validate the provided tokens. For more, see [Authentication](docs/authentication.md). Generate API key/secret pairs with: -``` +```shell ./bin/livekit-server generate-keys ``` +or + +```shell +docker run livekit/livekit-server:v0.9 generate-keys +``` + Store the generate keys in a YAML file like: ```yaml APIwLeah7g4fuLYDYAJeaKsSE: 8nTlwISkb-63DPP7OH4e.nw.J44JjicvZDiz8J59EoQ+ ``` -## Running the server - -LiveKit server is a distributed service that is architected for scale. It's self-encapsulated in a single binary, and horizontally scalable by adding more instances. In a production setup, the only external dependency is Redis. LiveKit uses Redis to store room & participant information, and utilizes its pub/sub functionality to coordinate activity between instances. - -### Running for development +### Starting the server In development mode, LiveKit has no external dependencies. With the key file ready, you can start LiveKit with -``` +```shell ./bin/livekit-server --key-file --dev ``` +or + +```shell +docker run -e LIVEKIT_KEYS=": " livekit/livekit-server:v0.9 --dev +``` + the `--dev` flag turns on log verbosity to make it easier for local debugging/development -### Running for production +### Sample client -TBD +[client-sdk-js](https://github.com/livekit/client-sdk-js) contains a web sample client that can connect to your server locally. -## CLI +Clone the repo and run `yarn sample` -The CLI provides a few tools that makes working with LiveKit easier: +### Creating a JWT token -- Room creation/deletion/etc -- Access token creation -- Joining room as a participant -- Publishing files as tracks to a room +To create a join token for clients, livekit-server provides a convenient subcommand to create a **development** token. +This token has an expiration of a month, which is useful for development & testing, but not appropriate for production use. -### Setting API key and secret - -CLI commands require --api-key and --api-secret arguments. To avoid having to pass these in for each command, it's simplest to set them as environment vars: - -```bash -export LK_API_KEY= -export LK_API_SECRET= +```shell +./bin/livekit-server --key-file create-join-token --room "myroom" --identity "myidentity" ``` -### Creating a room (optional) -``` -./bin/livekit-cli create-room --name myroom -``` +## Deploying for production -### Creating a participant token +LiveKit is deployable to any environment that supports docker, including Kubernetes and Amazon ECS -``` -./bin/livekit-cli create-token --join --r myroom --dev --p -``` +See documentation at https://docs.livekit.io/guides/deploy -`--dev` creates a development token that doesn't expire for a year +## License -### Joining a participant - -``` -./bin/livekit-cli join --token -``` - -### Publishing static files as tracks - -To use the publish client, download the following files to your computer: - -- [happier.ivf](https://www.dropbox.com/s/4ze93d6070s0qj7/happier.ivf?dl=0) - video track in VP8 -- [happier.ogg](https://www.dropbox.com/s/istrnolnh7avftq/happier.ogg?dl=0) - audio track in ogg - -Join as a publishing participant - -``` -./ bin/livekit-cli join --audio --video --token -``` - -That's it, join the room with another participant and see it receiving those tracks +LiveKit server is licensed under AGPL v3.0. ## APIs & Protocol -`livekit-server` provides two primary services, a `Room` service that allows for room creation & management, and `RTC` service to handle real time communications. +`livekit-server` provides two primary services, a `Room` service that allows for room management and participant moderation, and `RTC` service to handle WebRTC communications. -Room APIs are defined in [room.proto](proto/room.proto), it's fairly straight forward with typical CRUD APIs. Room APIs are in HTTP, built with Twirp and follows [its the conventions](https://twitchtv.github.io/twirp/docs/routing.html). +Room APIs are defined in [room.proto](proto/room.proto). Room APIs are in HTTP, built with Twirp and follows [its the conventions](https://twitchtv.github.io/twirp/docs/routing.html). -The RTC service provides the signaling and everything else when the client interacts with the room. See [RTC Protocol](docs/protocol.md). +The RTC service provides the signaling and everything else when the client interacts with the room. diff --git a/cmd/cli/commands/room.go b/cmd/cli/commands/room.go deleted file mode 100644 index 9f0b34d50..000000000 --- a/cmd/cli/commands/room.go +++ /dev/null @@ -1,247 +0,0 @@ -package commands - -import ( - "context" - "fmt" - "net/http" - - "github.com/twitchtv/twirp" - "github.com/urfave/cli/v2" - - "github.com/livekit/livekit-server/cmd/cli/client" - "github.com/livekit/livekit-server/pkg/logger" - livekit "github.com/livekit/livekit-server/proto" - "github.com/livekit/protocol/auth" -) - -var ( - RoomCommands = []*cli.Command{ - { - Name: "create-room", - Before: createClient, - Action: createRoom, - Flags: []cli.Flag{ - roomHostFlag, - &cli.StringFlag{ - Name: "name", - Usage: "name of the room", - Required: true, - }, - apiKeyFlag, - secretFlag, - }, - }, - { - Name: "list-rooms", - Before: createClient, - Action: listRooms, - Flags: []cli.Flag{ - roomHostFlag, - apiKeyFlag, - secretFlag, - }, - }, - { - Name: "delete-room", - Before: createClient, - Action: deleteRoom, - Flags: []cli.Flag{ - roomFlag, - roomHostFlag, - apiKeyFlag, - secretFlag, - }, - }, - { - Name: "list-participants", - Before: createClient, - Action: listParticipants, - Flags: []cli.Flag{ - roomFlag, - roomHostFlag, - apiKeyFlag, - secretFlag, - }, - }, - { - Name: "get-participant", - Before: createClient, - Action: getParticipant, - Flags: []cli.Flag{ - roomFlag, - identityFlag, - roomHostFlag, - apiKeyFlag, - secretFlag, - }, - }, - { - Name: "remove-participant", - Before: createClient, - Action: removeParticipant, - Flags: []cli.Flag{ - roomFlag, - identityFlag, - roomHostFlag, - apiKeyFlag, - secretFlag, - }, - }, - { - Name: "mute-track", - Before: createClient, - Action: muteTrack, - Flags: []cli.Flag{ - roomFlag, - identityFlag, - &cli.StringFlag{ - Name: "track", - Usage: "track sid to mute", - Required: true, - }, - &cli.BoolFlag{ - Name: "muted", - Usage: "set to true to mute, false to unmute", - }, - roomHostFlag, - apiKeyFlag, - secretFlag, - }, - }, - } - - roomClient livekit.RoomService -) - -func createClient(c *cli.Context) error { - host := c.String("host") - roomClient = livekit.NewRoomServiceJSONClient(host, &http.Client{}) - return nil -} - -func createRoom(c *cli.Context) error { - ctx := contextWithAccessToken(c, &auth.VideoGrant{RoomCreate: true}) - room, err := roomClient.CreateRoom(ctx, &livekit.CreateRoomRequest{ - Name: c.String("name"), - }) - if err != nil { - return err - } - - PrintJSON(room) - return nil -} - -func listRooms(c *cli.Context) error { - ctx := contextWithAccessToken(c, &auth.VideoGrant{RoomList: true}) - res, err := roomClient.ListRooms(ctx, &livekit.ListRoomsRequest{}) - if err != nil { - return err - } - for _, rm := range res.Rooms { - fmt.Printf("%s\t%s\n", rm.Sid, rm.Name) - } - return nil -} - -func deleteRoom(c *cli.Context) error { - ctx := contextWithAccessToken(c, &auth.VideoGrant{RoomCreate: true}) - roomId := c.String("room") - _, err := roomClient.DeleteRoom(ctx, &livekit.DeleteRoomRequest{ - Room: roomId, - }) - if err != nil { - return err - } - - fmt.Println("deleted room", roomId) - return nil -} - -func listParticipants(c *cli.Context) error { - roomName := c.String("room") - ctx := contextWithAccessToken(c, &auth.VideoGrant{RoomAdmin: true, Room: roomName}) - res, err := roomClient.ListParticipants(ctx, &livekit.ListParticipantsRequest{ - Room: roomName, - }) - if err != nil { - return err - } - - for _, p := range res.Participants { - fmt.Printf("%s (%s)\t tracks: %d\n", p.Identity, p.State.String(), len(p.Tracks)) - } - return nil -} - -func getParticipant(c *cli.Context) error { - roomName := c.String("room") - identity := c.String("identity") - ctx := contextWithAccessToken(c, &auth.VideoGrant{RoomAdmin: true, Room: roomName}) - res, err := roomClient.GetParticipant(ctx, &livekit.RoomParticipantIdentity{ - Room: roomName, - Identity: identity, - }) - if err != nil { - return err - } - - PrintJSON(res) - - return nil -} - -func removeParticipant(c *cli.Context) error { - roomName := c.String("room") - identity := c.String("identity") - ctx := contextWithAccessToken(c, &auth.VideoGrant{RoomAdmin: true, Room: roomName}) - _, err := roomClient.RemoveParticipant(ctx, &livekit.RoomParticipantIdentity{ - Room: roomName, - Identity: identity, - }) - if err != nil { - return err - } - - fmt.Println("successfully removed participant", identity) - - return nil -} - -func muteTrack(c *cli.Context) error { - roomName := c.String("room") - identity := c.String("identity") - trackSid := c.String("track") - ctx := contextWithAccessToken(c, &auth.VideoGrant{RoomAdmin: true, Room: roomName}) - _, err := roomClient.MutePublishedTrack(ctx, &livekit.MuteRoomTrackRequest{ - Room: roomName, - Identity: identity, - TrackSid: trackSid, - Muted: c.Bool("muted"), - }) - if err != nil { - return err - } - - fmt.Println("muted track", trackSid) - return nil -} - -func contextWithAccessToken(c *cli.Context, grant *auth.VideoGrant) context.Context { - ctx := context.Background() - token, err := accessToken(c, grant, "").ToJWT() - if err != nil { - logger.Errorw("Could not get access token", "err", err) - } - if token != "" { - header := make(http.Header) - client.SetAuthorizationToken(header, token) - if tctx, err := twirp.WithHTTPRequestHeaders(ctx, header); err == nil { - logger.Debugw("requesting with token") - ctx = tctx - } else { - logger.Errorw("Error setting Twirp auth header", "err", err) - } - } - return ctx -} diff --git a/cmd/cli/commands/rtc.go b/cmd/cli/commands/rtc.go deleted file mode 100644 index 251b3cb4b..000000000 --- a/cmd/cli/commands/rtc.go +++ /dev/null @@ -1,113 +0,0 @@ -package commands - -import ( - "fmt" - "os" - "os/signal" - "path/filepath" - "syscall" - - "github.com/urfave/cli/v2" - - "github.com/livekit/livekit-server/cmd/cli/client" - "github.com/livekit/livekit-server/pkg/logger" - "github.com/livekit/protocol/auth" -) - -var ( - RTCCommands = []*cli.Command{ - { - Name: "join", - Action: joinRoom, - Flags: []cli.Flag{ - rtcHostFlag, - &cli.StringFlag{ - Name: "token", - Usage: "access token, not required in dev mode. if passed in, ignores --api-key, --api-secret, and --identity", - }, - &cli.StringFlag{ - Name: "identity", - Usage: "identity of the participant, required if token isn't passed in", - }, - &cli.StringFlag{ - Name: "audio", - Usage: "an ogg file to publish upon connection", - }, - &cli.StringFlag{ - Name: "video", - Usage: "an ivf file to publish upon connection", - }, - apiKeyFlag, - secretFlag, - }, - }, - } -) - -func joinRoom(c *cli.Context) error { - identity := c.String("identity") - roomId := c.String("room") - token := c.String("token") - - // generate access token if needed - if token == "" { - // require roomId & name to be passed in - if roomId == "" { - return fmt.Errorf("--room is required") - } - if identity == "" { - return fmt.Errorf("--identity is required") - } - // token may be nil in dev mode - var err error - token, err = accessToken(c, &auth.VideoGrant{ - RoomJoin: true, - Room: roomId, - }, identity).ToJWT() - if err != nil { - return err - } - } - - host := c.String("host") - logger.Infow("connecting to Websocket signal", "host", host) - conn, err := client.NewWebSocketConn(host, token) - if err != nil { - return err - } - defer conn.Close() - - rc, err := client.NewRTCClient(conn) - if err != nil { - return err - } - - handleSignals(rc) - - // add tracks if needed - audioFile := c.String("audio") - videoFile := c.String("video") - rc.OnConnected = func() { - // add after connection, since we need proper publish track APIs - if audioFile != "" { - rc.AddFileTrack(audioFile, "audio", filepath.Base(audioFile)) - } - if videoFile != "" { - rc.AddFileTrack(videoFile, "video", filepath.Base(videoFile)) - } - } - - return rc.Run() -} - -func handleSignals(rc *client.RTCClient) { - // signal to stop client - sigChan := make(chan os.Signal, 1) - signal.Notify(sigChan, syscall.SIGINT, syscall.SIGTERM, syscall.SIGQUIT) - - go func() { - sig := <-sigChan - logger.Infow("exit requested, shutting down", "signal", sig) - rc.Stop() - }() -} diff --git a/cmd/cli/commands/token.go b/cmd/cli/commands/token.go deleted file mode 100644 index 96a562fe6..000000000 --- a/cmd/cli/commands/token.go +++ /dev/null @@ -1,93 +0,0 @@ -package commands - -import ( - "fmt" - - "github.com/urfave/cli/v2" - - "github.com/livekit/protocol/auth" -) - -var ( - TokenCommands = []*cli.Command{ - { - Name: "create-token", - Usage: "create token for Room APIs", - Action: createToken, - Flags: []cli.Flag{ - apiKeyFlag, - secretFlag, - &cli.BoolFlag{ - Name: "join", - Usage: "enable token to be used to join a room", - }, - &cli.BoolFlag{ - Name: "create", - Usage: "enable token to be used to create rooms", - }, - &cli.BoolFlag{ - Name: "admin", - Usage: "enable token to be used to manage a room", - }, - &cli.StringFlag{ - Name: "participant", - Aliases: []string{"p"}, - Usage: "unique name of the participant, used with --join", - }, - &cli.StringFlag{ - Name: "room", - Aliases: []string{"r"}, - Usage: "name of the room to join, empty to allow joining all rooms", - }, - &cli.StringFlag{ - Name: "metadata", - Usage: "JSON metadata to encode in the token, will be passed to participant", - }, - devFlag, - }, - }, - } -) - -func createToken(c *cli.Context) error { - if !c.IsSet("api-key") || !c.IsSet("api-secret") { - return fmt.Errorf("api-key and api-secret are required") - } - p := c.String("participant") // required only for join - room := c.String("room") - metadata := c.String("metadata") - - grant := &auth.VideoGrant{} - if c.Bool("create") { - grant.RoomCreate = true - } - if c.Bool("join") { - grant.RoomJoin = true - grant.Room = room - if p == "" { - return fmt.Errorf("participant name is required") - } - } - if c.Bool("admin") { - grant.RoomAdmin = true - grant.Room = room - } - - if !grant.RoomJoin && !grant.RoomCreate && !grant.RoomAdmin { - return fmt.Errorf("one of --join, --create, or --admin is required") - } - - at := accessToken(c, grant, p) - - if metadata != "" { - at.SetMetadata(metadata) - } - - token, err := at.ToJWT() - if err != nil { - return err - } - - fmt.Println("access token: ", token) - return nil -} diff --git a/cmd/cli/commands/utils.go b/cmd/cli/commands/utils.go deleted file mode 100644 index e7e776d12..000000000 --- a/cmd/cli/commands/utils.go +++ /dev/null @@ -1,83 +0,0 @@ -package commands - -import ( - "encoding/json" - "fmt" - "os" - "path/filepath" - "strings" - "time" - - "github.com/urfave/cli/v2" - - "github.com/livekit/protocol/auth" -) - -var ( - roomFlag = &cli.StringFlag{ - Name: "room", - Usage: "name or id of the room", - Required: true, - } - roomHostFlag = &cli.StringFlag{ - Name: "host", - Value: "http://localhost:7880", - } - rtcHostFlag = &cli.StringFlag{ - Name: "host", - Value: "ws://localhost:7880", - } - apiKeyFlag = &cli.StringFlag{ - Name: "api-key", - EnvVars: []string{"LIVEKIT_API_KEY"}, - Required: true, - } - secretFlag = &cli.StringFlag{ - Name: "api-secret", - EnvVars: []string{"LIVEKIT_API_SECRET"}, - Required: true, - } - identityFlag = &cli.StringFlag{ - Name: "identity", - Usage: "identity of participant", - Required: true, - } - devFlag = &cli.BoolFlag{ - Name: "dev", - Usage: "enables dev mode, longer expiration for tokens", - } -) - -func PrintJSON(obj interface{}) { - txt, _ := json.MarshalIndent(obj, "", " ") - fmt.Println(string(txt)) -} - -func ExpandUser(p string) string { - if strings.HasPrefix(p, "~") { - home, _ := os.UserHomeDir() - return filepath.Join(home, p[1:]) - } - - return p -} - -func accessToken(c *cli.Context, grant *auth.VideoGrant, identity string) *auth.AccessToken { - apiKey := c.String("api-key") - apiSecret := c.String("api-secret") - if apiKey == "" && apiSecret == "" { - // not provided, don't sign request - return nil - } - - isDev := c.Bool("dev") - - at := auth.NewAccessToken(apiKey, apiSecret). - AddGrant(grant). - SetIdentity(identity) - if isDev { - fmt.Println("creating dev token") - at.SetValidFor(time.Hour * 24 * 30) - } - return at -} diff --git a/cmd/cli/main.go b/cmd/cli/main.go deleted file mode 100644 index b0d640d94..000000000 --- a/cmd/cli/main.go +++ /dev/null @@ -1,27 +0,0 @@ -package main - -import ( - "fmt" - "os" - - "github.com/urfave/cli/v2" - - "github.com/livekit/livekit-server/cmd/cli/commands" - "github.com/livekit/livekit-server/pkg/logger" -) - -// command line util that tests server -func main() { - app := &cli.App{ - Name: "livekit-cli", - } - - app.Commands = append(app.Commands, commands.RoomCommands...) - app.Commands = append(app.Commands, commands.RTCCommands...) - app.Commands = append(app.Commands, commands.TokenCommands...) - - logger.InitDevelopment("") - if err := app.Run(os.Args); err != nil { - fmt.Println(err) - } -} diff --git a/cmd/server/commands.go b/cmd/server/commands.go new file mode 100644 index 000000000..79aeba78e --- /dev/null +++ b/cmd/server/commands.go @@ -0,0 +1,117 @@ +package main + +import ( + "fmt" + "os" + "strconv" + "time" + + "github.com/livekit/protocol/auth" + "github.com/livekit/protocol/utils" + "github.com/urfave/cli/v2" + "gopkg.in/yaml.v3" +) + +func generateKeys(c *cli.Context) error { + apiKey := utils.NewGuid(utils.APIKeyPrefix) + secret := utils.RandomSecret() + fmt.Println("API Key: ", apiKey) + fmt.Println("Secret Key: ", secret) + return nil +} + +func printPorts(c *cli.Context) error { + conf, err := getConfig(c) + if err != nil { + return err + } + + udpPorts := make([]string, 0) + tcpPorts := make([]string, 0) + + tcpPorts = append(tcpPorts, fmt.Sprintf("%d - HTTP service", conf.Port)) + if conf.RTC.TCPPort != 0 { + tcpPorts = append(tcpPorts, fmt.Sprintf("%d - ICE/TCP", conf.RTC.TCPPort)) + } + if conf.RTC.UDPPort != 0 { + udpPorts = append(udpPorts, fmt.Sprintf("%d - ICE/UDP", conf.RTC.UDPPort)) + } else { + udpPorts = append(udpPorts, fmt.Sprintf("%d-%d - ICE/UDP range", conf.RTC.ICEPortRangeStart, conf.RTC.ICEPortRangeEnd)) + } + + if conf.TURN.Enabled { + udpPorts = append(udpPorts, fmt.Sprintf("%d-%d", conf.TURN.PortRangeStart, conf.TURN.PortRangeEnd)) + udpPorts = append(udpPorts, strconv.Itoa(conf.TURN.TCPPort)) + tcpPorts = append(tcpPorts, strconv.Itoa(conf.TURN.TCPPort)) + } + + fmt.Println("TCP Ports") + for _, p := range tcpPorts { + fmt.Println(p) + } + + fmt.Println("UDP Ports") + for _, p := range udpPorts { + fmt.Println(p) + } + return nil +} + +func createToken(c *cli.Context) error { + room := c.String("room") + identity := c.String("identity") + + conf, err := getConfig(c) + if err != nil { + return err + } + + // use the first API key from config + if len(conf.Keys) == 0 { + // try to load from file + if _, err := os.Stat(conf.KeyFile); err != nil { + return err + } + f, err := os.Open(conf.KeyFile) + if err != nil { + return err + } + defer func() { + _ = f.Close() + }() + decoder := yaml.NewDecoder(f) + if err = decoder.Decode(conf.Keys); err != nil { + return err + } + + if len(conf.Keys) == 0 { + return fmt.Errorf("keys are not configured") + } + } + + var apiKey string + var apiSecret string + for k, v := range conf.Keys { + apiKey = k + apiSecret = v + break + } + + grant := &auth.VideoGrant{ + RoomJoin: true, + Room: room, + } + at := auth.NewAccessToken(apiKey, apiSecret). + AddGrant(grant). + SetIdentity(identity). + SetValidFor(30 * 24 * time.Hour) + + token, err := at.ToJWT() + if err != nil { + return err + } + + fmt.Println("Token:", token) + + return nil +} diff --git a/cmd/server/main.go b/cmd/server/main.go index bd801bb89..84b342778 100644 --- a/cmd/server/main.go +++ b/cmd/server/main.go @@ -9,7 +9,6 @@ import ( "os/signal" "runtime" "runtime/pprof" - "strconv" "syscall" "time" @@ -23,7 +22,6 @@ import ( "github.com/livekit/livekit-server/pkg/service" "github.com/livekit/livekit-server/version" "github.com/livekit/protocol/auth" - "github.com/livekit/protocol/utils" ) func main() { @@ -83,6 +81,23 @@ func main() { Usage: "print ports that server is configured to use", Action: printPorts, }, + { + Name: "create-join-token", + Usage: "create a room join token for development use", + Action: createToken, + Flags: []cli.Flag{ + &cli.StringFlag{ + Name: "room", + Usage: "name of room to join", + Required: true, + }, + &cli.StringFlag{ + Name: "identity", + Usage: "identity of participant that holds the token", + Required: true, + }, + }, + }, }, Version: version.Version, } @@ -92,26 +107,34 @@ func main() { } } +func getConfig(c *cli.Context) (*config.Config, error) { + confString, err := getConfigString(c) + if err != nil { + return nil, err + } + + conf, err := config.NewConfig(confString) + if err != nil { + return nil, err + } + + if err = conf.UpdateFromCLI(c); err != nil { + return nil, err + } + return conf, nil +} + func startServer(c *cli.Context) error { rand.Seed(time.Now().UnixNano()) cpuProfile := c.String("cpuprofile") memProfile := c.String("memprofile") - confString, err := getConfigString(c) + conf, err := getConfig(c) if err != nil { return err } - conf, err := config.NewConfig(confString) - if err != nil { - return err - } - - if err = conf.UpdateFromCLI(c); err != nil { - return err - } - if conf.Development { logger.InitDevelopment(conf.LogLevel) } else { @@ -216,7 +239,9 @@ func createKeyProvider(conf *config.Config) (auth.KeyProvider, error) { if err != nil { return nil, err } - defer f.Close() + defer func() { + _ = f.Close() + }() return auth.NewFileBasedKeyProviderFromReader(f) } @@ -241,46 +266,3 @@ func getConfigString(c *cli.Context) (string, error) { } return configBody, nil } - -func generateKeys(c *cli.Context) error { - apiKey := utils.NewGuid(utils.APIKeyPrefix) - secret := utils.RandomSecret() - fmt.Println("API Key: ", apiKey) - fmt.Println("Secret Key: ", secret) - return nil -} - -func printPorts(c *cli.Context) error { - confString, err := getConfigString(c) - if err != nil { - return err - } - - conf, err := config.NewConfig(confString) - if err != nil { - return err - } - - udpPorts := make([]string, 0) - tcpPorts := make([]string, 0) - - tcpPorts = append(tcpPorts, strconv.Itoa(int(conf.Port))) - udpPorts = append(udpPorts, fmt.Sprintf("%d-%d", conf.RTC.ICEPortRangeStart, conf.RTC.ICEPortRangeEnd)) - - if conf.TURN.Enabled { - udpPorts = append(udpPorts, fmt.Sprintf("%d-%d", conf.TURN.PortRangeStart, conf.TURN.PortRangeEnd)) - udpPorts = append(udpPorts, strconv.Itoa(conf.TURN.TCPPort)) - tcpPorts = append(tcpPorts, strconv.Itoa(conf.TURN.TCPPort)) - } - - fmt.Println("TCP Ports") - for _, p := range tcpPorts { - fmt.Println(p) - } - - fmt.Println("UDP Ports") - for _, p := range udpPorts { - fmt.Println(p) - } - return nil -} diff --git a/go.sum b/go.sum index 00984d788..5313c772b 100644 --- a/go.sum +++ b/go.sum @@ -70,8 +70,6 @@ github.com/creack/pty v1.1.7/go.mod h1:lj5s0c3V2DBrqTV7llrYr5NG6My20zk30Fl46Y7Do github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= -github.com/davidzhao/ice/v2 v2.0.17-0.20210425192821-8eeae55b4708 h1:wuF8jQJrUhwb9tT+IftzQ3VYve9WKifWhocYmMY+1go= -github.com/davidzhao/ice/v2 v2.0.17-0.20210425192821-8eeae55b4708/go.mod h1:kV4EODVD5ux2z8XncbLHIOtcXKtYXVgLVCeVqnpoeP0= github.com/desertbit/timer v0.0.0-20180107155436-c41aec40b27f/go.mod h1:xH/i4TFMt8koVQZ6WFms69WAsDWr2XsYL3Hkl7jkoLE= github.com/dgrijalva/jwt-go v3.2.0+incompatible/go.mod h1:E3ru+11k8xSBh+hMPgOLZmtrrCbhqsmaPHjLKYnJCaQ= github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f h1:lO4WD4F/rVNCu3HqELle0jiPLLBs70cWOduZpkS1E78= @@ -233,8 +231,6 @@ github.com/lightstep/lightstep-tracer-common/golang/gogo v0.0.0-20190605223551-b github.com/lightstep/lightstep-tracer-go v0.18.1/go.mod h1:jlF1pusYV4pidLvZ+XD0UBX0ZE6WURAspgAczcDHrL4= github.com/lithammer/shortuuid/v3 v3.0.6 h1:pr15YQyvhiSX/qPxncFtqk+v4xLEpOZObbsY/mKrcvA= github.com/lithammer/shortuuid/v3 v3.0.6/go.mod h1:vMk8ke37EmiewwolSO1NLW8vP4ZaKlRuDIi8tWWmAts= -github.com/livekit/protocol v0.4.0 h1:s+dkTG2gVTD8bsM3QEqPn9JZgO/yukcMWDAA0xkZkDU= -github.com/livekit/protocol v0.4.0/go.mod h1:wo3CGfYB7XMF8GoVJAfTARrYSP/ombi+sbLl6AYdKP0= github.com/livekit/protocol v0.5.0 h1:dcehG+icwEkHCutjb3erSpaElNa86OLVL0KKZbiajKo= github.com/livekit/protocol v0.5.0/go.mod h1:wo3CGfYB7XMF8GoVJAfTARrYSP/ombi+sbLl6AYdKP0= github.com/lucsky/cuid v1.0.2 h1:z4XlExeoderxoPj2/dxKOyPxe9RCOu7yNq9/XWxIUMQ= @@ -321,9 +317,6 @@ github.com/pion/dtls/v2 v2.0.8/go.mod h1:QuDII+8FVvk9Dp5t5vYIMTo7hh7uBkra+8QIm7Q github.com/pion/dtls/v2 v2.0.9 h1:7Ow+V++YSZQMYzggI0P9vLJz/hUFcffsfGMfT/Qy+u8= github.com/pion/dtls/v2 v2.0.9/go.mod h1:O0Wr7si/Zj5/EBFlDzDd6UtVxx25CE1r7XM7BQKYQho= github.com/pion/ice/v2 v2.0.15/go.mod h1:ZIiVGevpgAxF/cXiIVmuIUtCb3Xs4gCzCbXB6+nFkSI= -github.com/pion/ice/v2 v2.1.4/go.mod h1:kV4EODVD5ux2z8XncbLHIOtcXKtYXVgLVCeVqnpoeP0= -github.com/pion/ice/v2 v2.1.6 h1:PyqyUY9dTAjTrUmCq9qY6Yy3FagZlh5HQIVr27cwF6g= -github.com/pion/ice/v2 v2.1.6/go.mod h1:kV4EODVD5ux2z8XncbLHIOtcXKtYXVgLVCeVqnpoeP0= github.com/pion/ice/v2 v2.1.7 h1:FjgDfUNrVYTxQabJrkBX6ld12tvYbgzHenqPh3PJF6E= github.com/pion/ice/v2 v2.1.7/go.mod h1:kV4EODVD5ux2z8XncbLHIOtcXKtYXVgLVCeVqnpoeP0= github.com/pion/interceptor v0.0.9/go.mod h1:dHgEP5dtxOTf21MObuBAjJeAayPxLUAZjerGH8Xr07c= @@ -342,7 +335,6 @@ github.com/pion/randutil v0.1.0 h1:CFG1UdESneORglEsnimhUjf33Rwjubwj6xfiOXBa3mA= github.com/pion/randutil v0.1.0/go.mod h1:XcJrSMMbbMRhASFVOlj/5hQial/Y8oH/HVo7TBZq+j8= github.com/pion/rtcp v1.2.6 h1:1zvwBbyd0TeEuuWftrd/4d++m+/kZSeiguxU61LFWpo= github.com/pion/rtcp v1.2.6/go.mod h1:52rMNPWFsjr39z9B9MhnkqhPLoeHTv1aN63o/42bWE0= -github.com/pion/rtp v1.6.2 h1:iGBerLX6JiDjB9NXuaPzHyxHFG9JsIEdgwTC0lp5n/U= github.com/pion/rtp v1.6.2/go.mod h1:bDb5n+BFZxXx0Ea7E5qe+klMuqiBrP+w8XSjiWtCUko= github.com/pion/rtp v1.6.5 h1:o2cZf8OascA5HF/b0PAbTxRKvOWxTQxWYt7SlToxFGI= github.com/pion/rtp v1.6.5/go.mod h1:bDb5n+BFZxXx0Ea7E5qe+klMuqiBrP+w8XSjiWtCUko= @@ -370,8 +362,6 @@ github.com/pion/udp v0.1.0/go.mod h1:BPELIjbwE9PRbd/zxI/KYBnbo7B6+oA6YuEaNE8lths github.com/pion/udp v0.1.1 h1:8UAPvyqmsxK8oOjloDk4wUt63TzFe9WEJkg5lChlj7o= github.com/pion/udp v0.1.1/go.mod h1:6AFo+CMdKQm7UiA0eUPA8/eVCTx8jBIITLZHc9DWX5M= github.com/pion/webrtc/v3 v3.0.10/go.mod h1:KdEZWLmBnxB2Qj4FtUb9vi1sIpqsHOisI7L6ggQBD0A= -github.com/pion/webrtc/v3 v3.0.23 h1:Kp9uSekT03j9tdug3Zj3h5CYXwkvksLomiFM4yihyk4= -github.com/pion/webrtc/v3 v3.0.23/go.mod h1:3rjilTvGQsmLzWgIVuHm8F3YbmV1Nff9EP6bwFxGwoA= github.com/pion/webrtc/v3 v3.0.27 h1:cPQEFNFrRSMT11j9c9aTmXzL3ikKAFPE2kR0ZrQcviw= github.com/pion/webrtc/v3 v3.0.27/go.mod h1:QpLDmsU5a/a05n230gRtxZRvfHhFzn9ukGUL2x4G5ic= github.com/pkg/errors v0.8.0/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= @@ -578,10 +568,6 @@ golang.org/x/net v0.0.0-20210119194325-5f4716e94777/go.mod h1:m0MpNAwzfU5UDzcl9v golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= golang.org/x/net v0.0.0-20210331212208-0fccb6fa2b5c/go.mod h1:p54w0d4576C0XHj96bSt6lcn1PtDYWL6XObtHCRCNQM= golang.org/x/net v0.0.0-20210420210106-798c2154c571/go.mod h1:72T/g9IO56b78aLF+1Kcs5dz7/ng1VjMUvfKvpfy+jM= -golang.org/x/net v0.0.0-20210421230115-4e50805a0758 h1:aEpZnXcAmXkd6AvLb2OPt+EN1Zu/8Ne3pCqPjja5PXY= -golang.org/x/net v0.0.0-20210421230115-4e50805a0758/go.mod h1:72T/g9IO56b78aLF+1Kcs5dz7/ng1VjMUvfKvpfy+jM= -golang.org/x/net v0.0.0-20210423184538-5f58ad60dda6 h1:0PC75Fz/kyMGhL0e1QnypqK2kQMqKt9csD1GnMJR+Zk= -golang.org/x/net v0.0.0-20210423184538-5f58ad60dda6/go.mod h1:OJAsFXCWl8Ukc7SiCT/9KSuxbyM7479/AVlXFRxuMCk= golang.org/x/net v0.0.0-20210427231257-85d9c07bbe3a h1:njMmldwFTyDLqonHMagNXKBWptTBeDZOdblgaDsNEGQ= golang.org/x/net v0.0.0-20210427231257-85d9c07bbe3a/go.mod h1:OJAsFXCWl8Ukc7SiCT/9KSuxbyM7479/AVlXFRxuMCk= golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U= @@ -633,11 +619,7 @@ golang.org/x/sys v0.0.0-20210124154548-22da62e12c0c/go.mod h1:h1NjWce9XRLGQEsW7w golang.org/x/sys v0.0.0-20210217090653-ed5674b6da4a/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210330210617-4fbd30eecc44/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210420072515-93ed5bcd2bfe/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= -golang.org/x/sys v0.0.0-20210421221651-33663a62ff08 h1:qyN5bV+96OX8pL78eXDuz6YlDPzCYgdW74H5yE9BoSU= -golang.org/x/sys v0.0.0-20210421221651-33663a62ff08/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= -golang.org/x/sys v0.0.0-20210423185535-09eb48e85fd7 h1:iGu644GcxtEcrInvDsQRCwJjtCIOlT2V7IRt6ah2Whw= -golang.org/x/sys v0.0.0-20210423185535-09eb48e85fd7/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210426230700-d19ff857e887 h1:dXfMednGJh/SUUFjTLsWJz3P+TQt9qnR11GgeI3vWKs= golang.org/x/sys v0.0.0-20210426230700-d19ff857e887/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/term v0.0.0-20201117132131-f5c789dd3221/go.mod h1:Nr5EML6q2oocZ2LXRh80K7BxOlk5/8JxuGnuhpl+muw= diff --git a/magefile.go b/magefile.go index 59d382b5b..9a764d255 100644 --- a/magefile.go +++ b/magefile.go @@ -130,7 +130,7 @@ func Proto() error { return nil } -// builds LiveKit server and cli +// builds LiveKit server func Build() error { mg.Deps(Proto, generateWire) if !checksummer.IsChanged() { @@ -149,13 +149,6 @@ func Build() error { return err } - cmd = exec.Command("go", "build", "-o", "../../bin/livekit-cli") - cmd.Dir = "cmd/cli" - connectStd(cmd) - if err := cmd.Run(); err != nil { - return err - } - checksummer.WriteChecksum() return nil } diff --git a/pkg/config/config.go b/pkg/config/config.go index 7d6cc8240..b76ab6596 100644 --- a/pkg/config/config.go +++ b/pkg/config/config.go @@ -22,10 +22,10 @@ type Config struct { } type RTCConfig struct { - UDPPort uint16 `yaml:"udp_port"` - TCPPort uint16 `yaml:"tcp_port"` - ICEPortRangeStart uint16 `yaml:"port_range_start"` - ICEPortRangeEnd uint16 `yaml:"port_range_end"` + UDPPort uint32 `yaml:"udp_port"` + TCPPort uint32 `yaml:"tcp_port"` + ICEPortRangeStart uint32 `yaml:"port_range_start"` + ICEPortRangeEnd uint32 `yaml:"port_range_end"` // for testing, disable UDP ForceTCP bool `yaml:"force_tcp"` StunServers []string `yaml:"stun_servers"` @@ -69,8 +69,10 @@ func NewConfig(confString string) (*Config, error) { Port: 7880, RTC: RTCConfig{ UseExternalIP: true, - ICEPortRangeStart: 9000, - ICEPortRangeEnd: 11000, + TCPPort: 7881, + UDPPort: 7882, + ICEPortRangeStart: 0, + ICEPortRangeEnd: 0, StunServers: []string{ "stun.l.google.com:19302", "stun1.l.google.com:19302", diff --git a/pkg/rtc/config.go b/pkg/rtc/config.go index 00786aa8f..39d873f32 100644 --- a/pkg/rtc/config.go +++ b/pkg/rtc/config.go @@ -16,11 +16,13 @@ import ( ) type WebRTCConfig struct { - Configuration webrtc.Configuration - SettingEngine webrtc.SettingEngine - Receiver ReceiverConfig - BufferFactory *buffer.Factory - UDPMux ice.UDPMux + Configuration webrtc.Configuration + SettingEngine webrtc.SettingEngine + Receiver ReceiverConfig + BufferFactory *buffer.Factory + UDPMux ice.UDPMux + UDPMuxConn *net.UDPConn + TCPMuxListener *net.TCPListener } type ReceiverConfig struct { @@ -66,30 +68,34 @@ func NewWebRTCConfig(conf *config.RTCConfig, externalIP string) (*WebRTCConfig, } var udpMux *ice.UDPMuxDefault + var udpMuxConn *net.UDPConn + var err error if conf.UDPPort != 0 { - conn, err := net.ListenUDP("udp4", &net.UDPAddr{ + udpMuxConn, err = net.ListenUDP("udp4", &net.UDPAddr{ Port: int(conf.UDPPort), }) if err != nil { return nil, err } + udpMux = ice.NewUDPMuxDefault(ice.UDPMuxParams{ Logger: lkLogger, - UDPConn: conn, + UDPConn: udpMuxConn, }) s.SetICEUDPMux(udpMux) } else if conf.ICEPortRangeStart != 0 && conf.ICEPortRangeEnd != 0 { - if err := s.SetEphemeralUDPPortRange(conf.ICEPortRangeStart, conf.ICEPortRangeEnd); err != nil { + if err := s.SetEphemeralUDPPortRange(uint16(conf.ICEPortRangeStart), uint16(conf.ICEPortRangeEnd)); err != nil { return nil, err } } // use TCP mux when it's set + var tcpListener *net.TCPListener if conf.TCPPort != 0 { networkTypes = append(networkTypes, webrtc.NetworkTypeTCP4, ) - tcpListener, err := net.ListenTCP("tcp4", &net.TCPAddr{ + tcpListener, err = net.ListenTCP("tcp4", &net.TCPAddr{ Port: int(conf.TCPPort), }) if err != nil { @@ -113,6 +119,8 @@ func NewWebRTCConfig(conf *config.RTCConfig, externalIP string) (*WebRTCConfig, packetBufferSize: conf.PacketBufferSize, maxBitrate: conf.MaxBitrate, }, - UDPMux: udpMux, + UDPMux: udpMux, + UDPMuxConn: udpMuxConn, + TCPMuxListener: tcpListener, }, nil } diff --git a/pkg/rtc/participant_internal_test.go b/pkg/rtc/participant_internal_test.go index 3fa9da5d1..75d43c15c 100644 --- a/pkg/rtc/participant_internal_test.go +++ b/pkg/rtc/participant_internal_test.go @@ -146,7 +146,13 @@ func TestCorrectJoinedAt(t *testing.T) { func newParticipantForTest(identity string) *ParticipantImpl { conf, _ := config.NewConfig("") - rtcConf, _ := NewWebRTCConfig(&conf.RTC, "") + // disable mux, it doesn't play too well with unit test + conf.RTC.UDPPort = 0 + conf.RTC.TCPPort = 0 + rtcConf, err := NewWebRTCConfig(&conf.RTC, "") + if err != nil { + panic(err) + } p, _ := NewParticipant( identity, rtcConf, diff --git a/pkg/service/auth.go b/pkg/service/auth.go index 5a45464f4..d162eacb6 100644 --- a/pkg/service/auth.go +++ b/pkg/service/auth.go @@ -64,7 +64,7 @@ func (m *APIKeyAuthMiddleware) ServeHTTP(w http.ResponseWriter, r *http.Request, grants, err := v.Verify(secret) if err != nil { - handleError(w, http.StatusUnauthorized, "invalid token: "+err.Error()) + handleError(w, http.StatusUnauthorized, "invalid token: "+authToken+", error: "+err.Error()) return } diff --git a/pkg/service/roommanager.go b/pkg/service/roommanager.go index edfbc17f3..fe6dcc70d 100644 --- a/pkg/service/roommanager.go +++ b/pkg/service/roommanager.go @@ -172,6 +172,17 @@ func (r *RoomManager) CloseIdleRooms() { } } +func (r *RoomManager) Stop() { + if r.rtcConfig != nil { + if r.rtcConfig.UDPMuxConn != nil { + _ = r.rtcConfig.UDPMuxConn.Close() + } + if r.rtcConfig.TCPMuxListener != nil { + _ = r.rtcConfig.TCPMuxListener.Close() + } + } +} + // StartSession starts WebRTC session when a new participant is connected, takes place on RTC node func (r *RoomManager) StartSession(roomName string, pi routing.ParticipantInit, requestSource routing.MessageSource, responseSink routing.MessageSink) { room, err := r.getOrCreateRoom(roomName) diff --git a/pkg/service/server.go b/pkg/service/server.go index 7ce066128..3ac3cc999 100644 --- a/pkg/service/server.go +++ b/pkg/service/server.go @@ -102,7 +102,11 @@ func (s *LivekitServer) Start() error { if err := s.router.RegisterNode(); err != nil { return err } - defer s.router.UnregisterNode() + defer func() { + if err := s.router.UnregisterNode(); err != nil { + logger.Errorw("could not unregister node", "error", err) + } + }() if err := s.router.Start(); err != nil { return err @@ -152,12 +156,14 @@ func (s *LivekitServer) Start() error { // wait for shutdown ctx, _ := context.WithTimeout(context.Background(), time.Second*5) - s.httpServer.Shutdown(ctx) + _ = s.httpServer.Shutdown(ctx) if s.turnServer != nil { - s.turnServer.Close() + _ = s.turnServer.Close() } + s.roomManager.Stop() + return nil } diff --git a/cmd/cli/client/client.go b/test/client/client.go similarity index 100% rename from cmd/cli/client/client.go rename to test/client/client.go diff --git a/cmd/cli/client/trackwriter.go b/test/client/trackwriter.go similarity index 100% rename from cmd/cli/client/trackwriter.go rename to test/client/trackwriter.go diff --git a/test/integration_helpers.go b/test/integration_helpers.go index 56f308eb6..dce131d8f 100644 --- a/test/integration_helpers.go +++ b/test/integration_helpers.go @@ -9,9 +9,9 @@ import ( "time" "github.com/go-redis/redis/v8" + testclient "github.com/livekit/livekit-server/test/client" "github.com/twitchtv/twirp" - "github.com/livekit/livekit-server/cmd/cli/client" "github.com/livekit/livekit-server/pkg/config" "github.com/livekit/livekit-server/pkg/logger" "github.com/livekit/livekit-server/pkg/routing" @@ -26,7 +26,7 @@ const ( testApiSecret = "apiSecret" testRoom = "mytestroom" defaultServerPort = 7880 - secondServerPort = 7881 + secondServerPort = 8880 nodeId1 = "node-1" nodeId2 = "node-2" @@ -80,7 +80,7 @@ func teardownTest(s *service.LivekitServer, roomName string) { func contextWithCreateRoomToken() context.Context { header := make(http.Header) - client.SetAuthorizationToken(header, createRoomToken()) + testclient.SetAuthorizationToken(header, createRoomToken()) tctx, err := twirp.WithHTTPRequestHeaders(context.Background(), header) if err != nil { panic(err) @@ -119,7 +119,7 @@ func withTimeout(t *testing.T, description string, f func() bool) bool { } } -func waitUntilConnected(t *testing.T, clients ...*client.RTCClient) { +func waitUntilConnected(t *testing.T, clients ...*testclient.RTCClient) { logger.Infow("waiting for clients to become connected") wg := sync.WaitGroup{} errChan := make(chan error, len(clients)) @@ -179,13 +179,15 @@ func createMultiNodeServer(nodeId string, port uint32) *service.LivekitServer { panic(fmt.Sprintf("could not create config: %v", err)) } conf.Port = port + conf.RTC.UDPPort = port + 1 + conf.RTC.TCPPort = port + 2 conf.Redis.Address = "localhost:6379" currentNode, err := routing.NewLocalNode(conf) - currentNode.Id = nodeId if err != nil { panic(err) } + currentNode.Id = nodeId // local routing and store rc := redisClient() @@ -198,7 +200,7 @@ func createMultiNodeServer(nodeId string, port uint32) *service.LivekitServer { router := routing.NewRedisRouter(currentNode, rc) roomStore := service.NewRedisRoomStore(rc) - roomStore.DeleteRoom(testRoom) + _ = roomStore.DeleteRoom(testRoom) s, err := service.InitializeServer(conf, &StaticKeyProvider{}, roomStore, router, currentNode, &routing.RandomSelector{}) if err != nil { panic(fmt.Sprintf("could not create server: %v", err)) @@ -209,14 +211,14 @@ func createMultiNodeServer(nodeId string, port uint32) *service.LivekitServer { } // creates a client and runs against server -func createRTCClient(name string, port int) *client.RTCClient { +func createRTCClient(name string, port int) *testclient.RTCClient { token := joinToken(testRoom, name) - ws, err := client.NewWebSocketConn(fmt.Sprintf("ws://localhost:%d", port), token) + ws, err := testclient.NewWebSocketConn(fmt.Sprintf("ws://localhost:%d", port), token) if err != nil { panic(err) } - c, err := client.NewRTCClient(ws) + c, err := testclient.NewRTCClient(ws) if err != nil { panic(err) } @@ -254,13 +256,13 @@ func createRoomToken() string { return t } -func stopWriters(writers ...*client.TrackWriter) { +func stopWriters(writers ...*testclient.TrackWriter) { for _, w := range writers { w.Stop() } } -func stopClients(clients ...*client.RTCClient) { +func stopClients(clients ...*testclient.RTCClient) { for _, c := range clients { c.Stop() } diff --git a/test/scenarios.go b/test/scenarios.go index 72cfa60d5..9d34b1a02 100644 --- a/test/scenarios.go +++ b/test/scenarios.go @@ -4,10 +4,10 @@ import ( "testing" "time" + testclient "github.com/livekit/livekit-server/test/client" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" - "github.com/livekit/livekit-server/cmd/cli/client" "github.com/livekit/livekit-server/pkg/logger" ) @@ -132,9 +132,9 @@ func scenarioWSReconnect(t *testing.T) { // c1 publishes track, but disconnects websockets and reconnects } -func publishTracksForClients(t *testing.T, clients ...*client.RTCClient) []*client.TrackWriter { +func publishTracksForClients(t *testing.T, clients ...*testclient.RTCClient) []*testclient.TrackWriter { logger.Infow("publishing tracks for clients") - var writers []*client.TrackWriter + var writers []*testclient.TrackWriter for i, _ := range clients { c := clients[i] tw, err := c.AddStaticTrack("audio/opus", "audio", "webcam")