commit 9d1218edbfa2dd031a90b552a1d5d7d503443328 Author: Miroslav Pejic Date: Thu Sep 12 20:22:27 2024 +0200 [call-me] - init commit diff --git a/.env.template b/.env.template new file mode 100644 index 0000000..b1294e9 --- /dev/null +++ b/.env.template @@ -0,0 +1,22 @@ +# Server + +SSL=false # true or false +DOMAIN=localhost +PORT=8000 + +# Stun + +STUN_SERVER_ENABLED=true # true or false +STUN_SERVER_URL=stun:stun.l.google.com:19302 + +# Turn +# Please create your own free account on: https://www.metered.ca/tools/openrelay/ + +TURN_SERVER_ENABLED=false # true or false +TURN_SERVER_URL=turn:a.relay.metered.ca:443 +TURN_SERVER_USERNAME=e8dd65b92c62d3e36cafb807 +TURN_SERVER_CREDENTIAL=uWdWNmkhvyqTEswO + +# API + +API_KEY_SECRET=call_me_api_key_secret # change me diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..941d536 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +.env +node_modules +package-lock.json \ No newline at end of file diff --git a/.prettierignore b/.prettierignore new file mode 100644 index 0000000..012e4f6 --- /dev/null +++ b/.prettierignore @@ -0,0 +1,3 @@ +.github +package-lock.json +node_modules diff --git a/.prettierrc.js b/.prettierrc.js new file mode 100644 index 0000000..c8c6a54 --- /dev/null +++ b/.prettierrc.js @@ -0,0 +1,7 @@ +module.exports = { + semi: true, + trailingComma: 'all', + singleQuote: true, + printWidth: 120, + tabWidth: 4, +}; diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..dc205f5 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,21 @@ +# Use a lightweight Node.js image +FROM node:20-alpine + +# Set working directory +WORKDIR /src + +# Copy package.json and .env dependencies +COPY package.json . +COPY .env ./.env + +# Install necessary system packages and dependencies +RUN npm install \ + && npm cache clean --force \ + && rm -rf /tmp/* /var/tmp/* /usr/share/doc/* + +# Copy the application code +COPY app app +COPY public public + +# Set default command to start the application +CMD ["npm", "start"] \ No newline at end of file diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..142733b --- /dev/null +++ b/LICENSE.md @@ -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 new file mode 100644 index 0000000..16978c0 --- /dev/null +++ b/README.md @@ -0,0 +1,54 @@ +# Call-Me + +This project enables easy one-to-one video calls directly from your web browser using WebRTC technology. + +![callme](./assets/doc/callme.png) + +## Getting Started + +### Overview + +This project allows you to: + +- `Sign in` with a username. +- `Make video calls` by entering the recipient's username. +- `Toggle` your video feed visibility. +- `Hang up` the call when done. +- `Rest API` to get all connected users. + +### Quick Start + +**[Install Node.js and npm](https://nodejs.org/en/download)** + +```shell +# Copy the .env and edit if need +cp .env.template .env + +# Install dependencies: +npm install + +# Start the application: +npm start +``` + +1. Open your browser and visit [http://localhost:8000](http://localhost:8000). + +2. Sign in with your username. + +3. Enter the recipient's username and click `Call`. + +4. Enjoy your one-to-one video call. + +## API + +Get all connected users + +```shell +curl -X GET "http://localhost:8000/api/v1/users" -H "authorization: call_me_api_key_secret" -H "Content-Type: application/json" +``` + +## Self-Hosting + +To install this on your VPS, VDS, or personal server, please follow the instructions in **[the self-hosting documentation](./doc/self-hosting.md)**. + +--- diff --git a/app/api/swagger.yaml b/app/api/swagger.yaml new file mode 100644 index 0000000..4e3a5b5 --- /dev/null +++ b/app/api/swagger.yaml @@ -0,0 +1,47 @@ +swagger: '2.0' + +info: + title: Call-me API + description: API description for external applications that integrates with Call-me. + version: 1.0.0 + +basePath: /api/v1 + +schemes: + - https + - http + +paths: + /users: + get: + tags: + - 'users' + summary: 'Connected users' + description: 'Get all connected users' + consumes: + - 'application/json' + produces: + - 'application/json' + security: + - secretApiKey: [] + responses: + '200': + description: 'Connected users' + schema: + $ref: '#/definitions/UsersResponse' + '403': + description: 'Unauthorized!' + +securityDefinitions: + secretApiKey: + type: 'apiKey' + name: 'authorization' + in: 'header' + description: 'Format like this: authorization: {API_KEY_SECRET}' + +definitions: + UsersResponse: + type: 'object' + properties: + users: + type: 'array' diff --git a/app/server.js b/app/server.js new file mode 100755 index 0000000..9acc3f0 --- /dev/null +++ b/app/server.js @@ -0,0 +1,272 @@ +'use strict'; + +// Import necessary modules +const dotenv = require('dotenv').config(); +const express = require('express'); +const fs = require('fs'); +const http = require('http'); +const https = require('https'); +const socketIO = require('socket.io'); +const path = require('path'); +const yaml = require('js-yaml'); +const swaggerUi = require('swagger-ui-express'); + +// Public directory location +const PUBLIC_DIR = path.join(__dirname, '../', 'public'); + +// Map to store connected users +const users = new Map(); + +// Configuration settings +const config = { + iceServers: [], + stunServerEnabled: process.env.STUN_SERVER_ENABLED === 'true', + stunServerUrl: process.env.STUN_SERVER_URL, + turnServerEnabled: process.env.TURN_SERVER_ENABLED === 'true', + turnServerUrl: process.env.TURN_SERVER_URL, + turnServerUsername: process.env.TURN_SERVER_USERNAME, + turnServerCredential: process.env.TURN_SERVER_CREDENTIAL, + apiKeySecret: process.env.API_KEY_SECRET, + apiBasePath: '/api/v1', + swaggerDocument: yaml.load(fs.readFileSync(path.join(__dirname, '/api/swagger.yaml'), 'utf8')), +}; + +// Add STUN server if enabled and URL is provided +if (config.stunServerEnabled && config.stunServerUrl) { + config.iceServers.push({ urls: config.stunServerUrl }); +} + +// Add TURN server if enabled and all required information is provided +if (config.turnServerEnabled && config.turnServerUrl && config.turnServerUsername && config.turnServerCredential) { + config.iceServers.push({ + urls: config.turnServerUrl, + username: config.turnServerUsername, + credential: config.turnServerCredential, + }); +} + +// Create Express application +const app = express(); + +// Server configurations +const domain = process.env.DOMAIN || 'localhost'; +const isHttps = process.env.SSL === 'true'; +const port = process.env.PORT || 4000; +const host = `http${isHttps ? 's' : ''}://${domain}:${port}`; +const apiDocs = host + config.apiBasePath + '/docs'; + +// This server +let server; + +// Load self-signed certificates if HTTPS is enabled +if (isHttps) { + try { + const options = { + key: fs.readFileSync(path.join(__dirname, '/ssl/key.pem'), 'utf-8'), + cert: fs.readFileSync(path.join(__dirname, '/ssl/cert.pem'), 'utf-8'), + }; + // Create HTTPS server using Express + server = https.createServer(options, app); + } catch (err) { + console.error('Error loading certificates:', err); + process.exit(1); // Exit the process if certificates cannot be loaded + } +} else { + // Create HTTP server using Express + server = http.createServer(app); +} + +// Create WebSocket server using Socket.io on top of HTTP server +const io = socketIO(server); + +// Start the server and listen on the specified port +server.listen(port, () => { + console.log('Server', { + running_at: host, + ice: config.iceServers, + api_key_secret: config.apiKeySecret, + api_docs: apiDocs, + }); +}); + +// Handle WebSocket connections +io.on('connection', handleConnection); + +app.use(express.static(PUBLIC_DIR)); // Serve static files from the 'public' directory +app.use(express.json()); // Api parse body data as json +app.use(config.apiBasePath + '/docs', swaggerUi.serve, swaggerUi.setup(config.swaggerDocument)); // api docs + +// Logs requests +app.use((req, res, next) => { + console.log('New request', { + headers: req.headers, + body: req.body, + method: req.method, + path: req.originalUrl, + }); + next(); +}); + +// Set up route to serve the main HTML file +app.get('/', (req, res) => { + res.sendFile(path.join(PUBLIC_DIR, '/index.html')); +}); + +// Axios API requests +app.get(`${config.apiBasePath}/users`, (req, res) => { + // check if user is authorized for the API call + const { authorization } = req.headers; + console.log(authorization); + if (authorization != config.apiKeySecret) { + console.log('Unauthorized API call: Get Users', { + headers: req.headers, + body: req.body, + }); + return res.status(403).json({ error: 'Unauthorized!' }); + } + // Get connected users + const users = getConnectedUsers(); + return res.json({ users }); +}); + +// Function to handle individual WebSocket connections +function handleConnection(socket) { + console.log('User connected:', socket.id); + + // Send a ping message to the newly connected client + sendPing(socket); + + // Set up event listeners for incoming messages and disconnect + socket.on('message', handleMessage); + socket.on('disconnect', handleClose); + + // Function to handle incoming messages + function handleMessage(data) { + const { type } = data; + + console.log('Received message:', type); + + switch (type) { + case 'signIn': + handleSignIn(data); + break; + case 'offerAccept': + case 'offerDecline': + case 'offerCreate': + handleOffer(data); + break; + case 'offer': + case 'answer': + case 'candidate': + case 'leave': + handleSignalingMessage(data); + break; + case 'pong': + console.log('Client response:', data.message); + break; + default: + sendError(socket, `Unknown command: ${type}`); + break; + } + } + + // Send a ping message to the newly connected client and iceServers for peer connection + function sendPing(socket) { + sendMsgTo(socket, { + type: 'ping', + message: 'Hello Client!', + iceServers: config.iceServers, + }); + } + + // Function to handle user sign-in request + function handleSignIn(data) { + const { name } = data; + if (!users.has(name)) { + users.set(name, socket); + socket.username = name; + console.log('User signed in:', name); + sendMsgTo(socket, { type: 'signIn', success: true }); + console.log('Users', getConnectedUsers()); + } else { + sendMsgTo(socket, { type: 'signIn', success: false, message: 'Username already in use' }); + } + } + + // Function to handle offer request + function handleOffer(data) { + console.log('handleOffer', data); + + const { from, to, name, type } = data; + const toName = type === 'offerAccept' ? to : from; + const recipientSocket = users.get(toName); + + console.log(`Handling offer for ${toName}`); + + switch (type) { + case 'offerAccept': + case 'offerCreate': + if (recipientSocket) { + sendMsgTo(recipientSocket, data); + } else { + console.warn(`Recipient (${toName}) not found`); + sendError(socket, `User ${toName} not found`); + } + break; + case 'offerDecline': + console.warn(`User ${name} declined your call`); + sendError(recipientSocket || socket, `User ${name} declined your call`); + break; + default: + console.warn(`Unknown offer type: ${type}`); + break; + } + } + + // Function to handle signaling messages (offer, answer, candidate, leave) + function handleSignalingMessage(data) { + const { name } = data; + const recipientSocket = users.get(name); + if (recipientSocket) { + sendMsgTo(recipientSocket, { ...data, name: socket.username }); + } else { + sendError(socket, `User ${name} not found`); + } + } + + // Function to handle the closing of a connection + function handleClose() { + if (socket.username) { + console.log('User disconnected:', socket.username); + users.delete(socket.username); + const recipientSocket = users.get(socket.recipient); + if (recipientSocket) { + sendMsgTo(recipientSocket, { type: 'leave' }); + } + console.log('Users', getConnectedUsers()); + } + } +} + +// Function to get all connected users +function getConnectedUsers() { + return Array.from(users.keys()); +} + +// Function to broadcast a message to all connection +function broadcastMsg(socket, message) { + console.log('Broadcast message:', message.type); + socket.broadcast.emit('message', message); +} + +// Function to send a message to a specific connection +function sendMsgTo(socket, message) { + console.log('Sending message:', message.type); + socket.emit('message', message); +} + +// Function to send an error message to a specific connection +function sendError(socket, message) { + console.error('Error:', message); + sendMsgTo(socket, { type: 'error', message: message }); +} diff --git a/app/ssl/README.md b/app/ssl/README.md new file mode 100644 index 0000000..2025dbb --- /dev/null +++ b/app/ssl/README.md @@ -0,0 +1,27 @@ +## Call-me SSL + +![call-me-https](https.png) + +1. Generate a [self-signed certificate](https://en.wikipedia.org/wiki/Self-signed_certificate) + +```bash +# install openssl 4 ubuntu +apt install openssl + +# install openssl 4 mac +brew install openssl + +# self-signed certificate +openssl genrsa -out key.pem +openssl req -new -key key.pem -out csr.pem +openssl x509 -req -days 9999 -in csr.pem -signkey key.pem -out cert.pem +rm csr.pem + +# https://www.sslchecker.com/certdecoder +``` + +2. Expose `server.js` on `https` using the `self-signed certificate`, edit the `.env` file + +```bash +SSL=true +``` diff --git a/app/ssl/cert.pem b/app/ssl/cert.pem new file mode 100644 index 0000000..2d5174c --- /dev/null +++ b/app/ssl/cert.pem @@ -0,0 +1,21 @@ +-----BEGIN CERTIFICATE----- +MIIDcTCCAlkCFBqR3KLE2n3uKEy+2GmqGQPmrWDmMA0GCSqGSIb3DQEBCwUAMHQx +CzAJBgNVBAYTAklUMQ4wDAYDVQQIDAVJdGFseTEQMA4GA1UECgwHQ2FsbC1tZTEX +MBUGA1UEAwwOTWlyb3NsYXYgUGVqaWMxKjAoBgkqhkiG9w0BCQEWG21pcm9zbGF2 +LnBlamljLjg1QGdtYWlsLmNvbTAgFw0yNDAzMDgwODM0MzNaGA8yMDUxMDcyNDA4 +MzQzM1owdDELMAkGA1UEBhMCSVQxDjAMBgNVBAgMBUl0YWx5MRAwDgYDVQQKDAdD +YWxsLW1lMRcwFQYDVQQDDA5NaXJvc2xhdiBQZWppYzEqMCgGCSqGSIb3DQEJARYb +bWlyb3NsYXYucGVqaWMuODVAZ21haWwuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOC +AQ8AMIIBCgKCAQEAwVWgx7jwFD/XmvIDOgkl7thhxC97fuDOEs6CDGB2KBtykfM6 +xtrXDYryS7ZQgzba27JTABd5CIv/9tBAt6orYVtQmj5ABBTJjJ+zVCYpyoW9NRzs +0vejatoKksbovd1mr8QHrZJUvR6e5lXvg+rK311fAHo5WWBPJwwbB6z9mxtHQWuU +OOfjGaYxOyuNXbVDKZYC8c8LxxowwZ7VXt3gt+mIYLh99iUXOaD7jusljz87ZlGx +JKpbL5C4qXAx0nB4UH0XeZTrPz6NHXHn0RpAn33IztbSPcf8iOJO7JkaZwNBGrDW +RzlpKWas57Mb1I0u7A38oFMdS/BTaWkq5E8diwIDAQABMA0GCSqGSIb3DQEBCwUA +A4IBAQAtUmzF798rFWXc5c8K/QtHaB0oqnadC3FvvQDVDI8OtYzE3Cnst32CKFTn +ueFmCShWryKVnKgszTjrQfuKFwj5U5EKnlwMwmjKzB1bHLj0hn2Olzq4f5IJw3pp +pAKPhvgZxI4PPv+Q6xaGYvmn3jeNx5UlL5Xb6JkC1pUIJayj8HBSyuT47poXny1J +Cyi2nK8kuG2hXUyHK02DVr39wx+ir84gpkafAHQYm9dlCyQ+YXXxq28egxSrenCH +wwNSXWLN9LO4T4OGJNa+inyya+y7QvhNYDUkWhsXwZCuP0YLPiSwor7vi/hSw2NL +E29H8F6yW3sOND7e9wlpEWkN4ZGy +-----END CERTIFICATE----- diff --git a/app/ssl/https.png b/app/ssl/https.png new file mode 100644 index 0000000..467dbde Binary files /dev/null and b/app/ssl/https.png differ diff --git a/app/ssl/key.pem b/app/ssl/key.pem new file mode 100644 index 0000000..0babd4a --- /dev/null +++ b/app/ssl/key.pem @@ -0,0 +1,27 @@ +-----BEGIN RSA PRIVATE KEY----- +MIIEowIBAAKCAQEAwVWgx7jwFD/XmvIDOgkl7thhxC97fuDOEs6CDGB2KBtykfM6 +xtrXDYryS7ZQgzba27JTABd5CIv/9tBAt6orYVtQmj5ABBTJjJ+zVCYpyoW9NRzs +0vejatoKksbovd1mr8QHrZJUvR6e5lXvg+rK311fAHo5WWBPJwwbB6z9mxtHQWuU +OOfjGaYxOyuNXbVDKZYC8c8LxxowwZ7VXt3gt+mIYLh99iUXOaD7jusljz87ZlGx +JKpbL5C4qXAx0nB4UH0XeZTrPz6NHXHn0RpAn33IztbSPcf8iOJO7JkaZwNBGrDW +RzlpKWas57Mb1I0u7A38oFMdS/BTaWkq5E8diwIDAQABAoIBAGVx3M9vhunZJfSz +kGXfbvwIpiQfFhnZM8hCe5Kq+tTIsjFLA0hchAMjKUf4/f4bxnMI+uxNZMDLVR/Y +3lyA+go3s+97QnPhxG/5TEuXSs5tpn48EzgPoLvsdSfXH0Cg78TCg5Tb94LUkmQi +K294v8K8Z6EEgRsYoe/HNlesudWsa/MRGuslkxSsi8MpBK0PnH3sT7X4lIGHWW2V +EL+tZ8FXvzFdeIddwn8f4S2OOzYD3ZPq1/afoH1tlB++IInc60a+9m8tTdnbfAYU +JDGolz02IVzuxts6ybeVilNnqX4cl/awZdZ3EySfE9XUb9OP+HCuO3u3yzhOoGWr +JhMqKuECgYEA9bsyDpWV7V8iEOQa5NGL/sJwPoLh9FofURaV5Uydbvb4uc1aZQ0T +l1EJj1kkLN+c57cuUxj48vMcll7nSOfozSuxC3v62izzpQ+9c50rTQbLh0wqoRRs +R62l/DYyW4TaWrZ+eB2k81VTDfrqSkWqE09Pz5HlGw0TaT4yYibLXdUCgYEAyWnl +676IjkseusUl3IYseL2tCSxe2qnJkcMqiiLhqm4h2Nc57tP/ltxVykR967N7eEhf +KYG0oTkaZtwSc5dwX7BwO6YlcvUZsxEwC3X5i7fNz54B9ClgMiTSen0YEODdITU8 +Awz8hZVJ18OZhOFX7R/OE34SeskT8FxC73bKXd8CgYBB8zSzD1iGtZKZ/+5r3QV6 +oUqorE3iW9Gt3KbsPIzAPE5y53dMSZ8pbFlpfJ4l4PnmgpZPPROLeM4CWYQvX/Zu +IjzI/URNC+V0Nm49OkBl0t4K+Nk0FBwffK5gq1cGkvhbgkEdEa+0kwDQbrg0qM/F +kPK1nc1kXjUIeOXiy9Cm5QKBgQCX4a9r0kYPZz5JARnH7bXjZsTxQfBVW+uQa2fM +uvkJF/uWFNau7layYHyhBn0eHD5jOc/o8NJRMUpjfli7qdsnjVlU4bkjswgqLC/a +tJ/1aClfAnversTHi1Tc4TAgqjCWNhqHAmf6I9WHSwydU4CGY5F2yX8N8EuE2U3w +XdfEaQKBgAmfLYP9OYIrgJf9KazENSlzE06axaH9e1Td5pBWoegNQ2BscqYDqVp6 +qusnty1PU86r0kR+RmzlBNSkNKL0t9j8s5h4d8YPWJh2lQs6f/ZGXo9nGPbzLADU +Eh7HnwpDw8AdvO07OLRYrQwToovHggqmg8ebXW56llFEudoilp8D +-----END RSA PRIVATE KEY----- diff --git a/assets/.DS_Store b/assets/.DS_Store new file mode 100644 index 0000000..9b4ce52 Binary files /dev/null and b/assets/.DS_Store differ diff --git a/assets/app/1.png b/assets/app/1.png new file mode 100644 index 0000000..07ceaff Binary files /dev/null and b/assets/app/1.png differ diff --git a/assets/app/2.png b/assets/app/2.png new file mode 100644 index 0000000..3fa620d Binary files /dev/null and b/assets/app/2.png differ diff --git a/assets/app/3.png b/assets/app/3.png new file mode 100644 index 0000000..131495e Binary files /dev/null and b/assets/app/3.png differ diff --git a/assets/app/4.png b/assets/app/4.png new file mode 100644 index 0000000..36bc456 Binary files /dev/null and b/assets/app/4.png differ diff --git a/assets/doc/apache.png b/assets/doc/apache.png new file mode 100644 index 0000000..b489b19 Binary files /dev/null and b/assets/doc/apache.png differ diff --git a/assets/doc/callme.png b/assets/doc/callme.png new file mode 100644 index 0000000..36bc456 Binary files /dev/null and b/assets/doc/callme.png differ diff --git a/assets/doc/docker.png b/assets/doc/docker.png new file mode 100644 index 0000000..db8cb8b Binary files /dev/null and b/assets/doc/docker.png differ diff --git a/assets/doc/logo.png b/assets/doc/logo.png new file mode 100644 index 0000000..4d41f49 Binary files /dev/null and b/assets/doc/logo.png differ diff --git a/assets/doc/nginx.png b/assets/doc/nginx.png new file mode 100644 index 0000000..f59edfb Binary files /dev/null and b/assets/doc/nginx.png differ diff --git a/assets/doc/pm2.png b/assets/doc/pm2.png new file mode 100644 index 0000000..70a1a6f Binary files /dev/null and b/assets/doc/pm2.png differ diff --git a/doc/self-hosting.md b/doc/self-hosting.md new file mode 100644 index 0000000..b25dc0f --- /dev/null +++ b/doc/self-hosting.md @@ -0,0 +1,290 @@ +# Call-me - Self Hosting + +![logo](../assets/doc/logo.png) + +## Requirements + +- Server Selection: + - [Hetzner](https://www.hetzner.com/cloud) (CX11) - Use [this link](https://hetzner.cloud/?ref=XdRifCzCK3bn) to receive `€⁠20 in cloud credits` + - [Contabo](https://www.dpbolvw.net/click-101027391-14462707) (VPS-0) +- OS: Ubuntu 22.04 LTS. +- [Node.js](https://nodejs.org/en/) (LTS) and npm +- Domain or Subdomain Name (e.g., `YOUR.DOMAIN.NAME`) with a DNS A record pointing to your server's IPv4 address. +- `Recommend` utilizing a [Turn Server](../coturn/stun-turn.md) the installation documentation accessible [here](https://docs.mirotalk.com/coturn/installation/). + +--- + +## Installation + +Install `NodeJS 18.X` and `npm` using [Node Version Manager](https://docs.mirotalk.com/nvm/nvm/) + +--- + +## Quick start + +```bash +# Install dependencies +$ npm install + +# Start the server +$ npm start +``` + +Check if is correctly installed: [http://YOUR.DOMAIN.NAME:8000](http://YOUR.DOMAIN.NAME:8000) + +--- + +## Using [PM2](https://pm2.keymetrics.io) (Process Manager) + +![pm2](../assets/doc/pm2.png) + +```bash +# Install pm2 +$ npm install -g pm2 + +# Start the server +$ pm2 start app/server.js + +# Takes a snapshot +$ pm2 save + +# Add it on startup +$ pm2 startup +``` + +--- + +## Using Docker + +![docker](../assets/doc/docker.png) + +```bash +# Install docker +$ sudo apt install -y docker.io + +# Instal docker-compose +$ sudo apt install -y docker-compose + +# Build the docker image +$ docker build -t call/me . # --load + +# Create and start containers (-d as daemon) +$ docker-compose up +``` + +Check if is correctly installed: [http://YOUR.DOMAIN.NAME:8000](http://YOUR.DOMAIN.NAME:8000) + +--- + +## Configuring Nginx & Certbot + +![nginx](../assets/doc/nginx.png) + +In order to use it without the port number and to have encrypted communications (`mandatory to make it work correctly`), we going to install **[nginx](https://www.nginx.com)** and **[certbot](https://certbot.eff.org)** + +```bash +# Install Nginx +$ sudo apt-get install -y nginx + +# Install Certbot (SSL certificates) +$ sudo apt install -y snapd +$ sudo snap install core; sudo snap refresh core +$ sudo snap install --classic certbot +$ sudo ln -s /snap/bin/certbot /usr/bin/certbot + +# Configure Nginx +$ sudo vim /etc/nginx/sites-enabled/default +``` + +Add the following: + +```bash +# HTTP — redirect all traffic to HTTPS +server { + listen 80; + listen [::]:80; + server_name YOUR.DOMAIN.NAME; + + return 301 https://$host$request_uri; +} +``` + +```bash +# Test Nginx configuration +$ sudo nginx -t + +# Enable HTTPS with Certbot (follow the instruction) +$ sudo certbot certonly --nginx + +# Add Let's Encrypt configuration to Nginx +$ sudo vim /etc/nginx/sites-enabled/default +``` + +Add the following: + +```bash +# CallMe - HTTPS — proxy all requests to the Node app +server { + # Enable HTTP/2 + listen 443 ssl http2; + listen [::]:443 ssl http2; + server_name YOUR.DOMAIN.NAME; + + # Use the Let’s Encrypt certificates + ssl_certificate /etc/letsencrypt/live/YOUR.DOMAIN.NAME/fullchain.pem; + ssl_certificate_key /etc/letsencrypt/live/YOUR.DOMAIN.NAME/privkey.pem; + + location / { + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + proxy_set_header Host $host; + proxy_pass http://localhost:8000/; + proxy_http_version 1.1; + proxy_set_header Upgrade $http_upgrade; + proxy_set_header Connection "upgrade"; + } +} +``` + +```bash +# Test Nginx configuration again +$ sudo nginx -t + +# Restart nginx +$ service nginx restart +$ service nginx status + +# Set up auto-renewal for SSL certificates +$ sudo certbot renew --dry-run + +# Show certificates +$ sudo certbot certificates +``` + +Check Your CallMe instance: [https://YOUR.DOMAIN.NAME](https://YOUR.DOMAIN.NAME) + +--- + +## Apache Virtual Host (Alternative to Nginx) + +![apache](../assets/doc/apache.png) + +If you prefer `Apache`, configure it with the equivalent settings provided in this guide. + +```bash +# Edit the apache sites +vim /etc/apache2/sites-enabled/YOUR.DOMAIN.NAME.conf +``` + +Add the following: + +```bash +# HTTP — redirect all traffic to HTTPS + + ServerName YOUR.DOMAIN.NAME + Redirect permanent / https://YOUR.DOMAIN.NAME + + +# CallMe - HTTPS — proxy all requests to the Node app + + ServerName YOUR.DOMAIN.NAME + + # SSL Configuration + SSLEngine on + SSLCertificateFile /etc/letsencrypt/live/YOUR.DOMAIN.NAME/fullchain.pem + SSLCertificateKeyFile /etc/letsencrypt/live/YOUR.DOMAIN.NAME/privkey.pem + Include /etc/letsencrypt/options-ssl-apache.conf + + # Enable HTTP/2 support + Protocols h2 http/1.1 + + + # Proxy Configuration for Node.js App + ProxyPass http://localhost:8000/ + ProxyPassReverse http://localhost:8000/ + + ProxyPreserveHost On + + RequestHeader set X-Forwarded-For "%{REMOTE_ADDR}s" + RequestHeader set X-Forwarded-Proto "https" + RequestHeader set Host "%{HTTP_HOST}s" + + # Enable WebSocket proxy support for Socket.IO + RewriteEngine On + RewriteCond %{HTTP:Upgrade} =websocket [NC] + RewriteRule /(.*) ws://localhost:8000/socket.io/$1 [P,L] + # Adjust the WebSocket path according to your Socket.IO configuration + # For Socket.IO 3.x or higher, use /socket.io/?EIO=4&transport=websocket + + +``` + +```bash +# Check configuration +sudo apache2ctl configtest + +sudo a2enmod proxy # Enables the `mod_proxy` module, which is essential for proxying HTTP and WebSocket connections. +sudo a2enmod proxy_http # Enables the `mod_proxy_http` module, which adds support for proxying HTTP connections. +sudo a2enmod proxy_wstunnel # Enables the `mod_proxy_wstunnel` module, which provides support for tunneling WebSocket connections + +# Restart apache +sudo systemctl restart apache2 +``` + +--- + +## Updating Your Instance + +To keep your CallMe instance up to date, create an update script: + +```bash +cd +# Create a file p2pUpdate.sh +$ vim callmeUpdate.sh +``` + +--- + +For `PM2`: + +```bash +#!/bin/bash + +cd callme +pm2 stop app/server.js +sudo npm install +pm2 start app/server.js +``` + +--- + +For `Docker`: + +```bash +#!/bin/bash + +cd callme +docker-compose down +docker build -t call/me . # --load +docker images |grep '' |awk '{print $3}' |xargs docker rmi +docker-compose up -d +``` + +--- + +Make the script executable + +```bash +$ chmod +x callmeUpdate.sh +``` + +To update your CallMe instance to the latest version, follow these steps: + +1. Replace the existing `callme` folder with the newest version + +```bash +scp -r /path/to/local/folder username@remote_host:/path/to/remote/folder +``` + +2. Run the update script `./callmeUpdate.sh` + +--- diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..c12683d --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,17 @@ +version: '3' + +services: + callme: + image: call/me:latest + build: + context: . + dockerfile: Dockerfile + container_name: callme + hostname: callme + volumes: + - .env:/src/.env:ro + - ./app/:/src/app/:ro + - ./public/:/src/public/:ro + restart: unless-stopped + ports: + - '${PORT}:${PORT}' diff --git a/package.json b/package.json new file mode 100755 index 0000000..38b6fa1 --- /dev/null +++ b/package.json @@ -0,0 +1,23 @@ +{ + "name": "callme", + "version": "1.0.2", + "description": "callme", + "author": "Miroslav Pejic - miroslav.pejic.85@gmail.com", + "license": "AGPLv3", + "scripts": { + "start": "node app/server.js", + "dev": "nodemon app/server.js", + "lint": "npx prettier --write ." + }, + "dependencies": { + "dotenv": "^16.4.5", + "express": "^5.0.0", + "js-yaml": "4.1.0", + "socket.io": "^4.7.5", + "swagger-ui-express": "5.0.1" + }, + "devDependencies": { + "nodemon": "^3.1.4", + "prettier": "3.3.3" + } +} diff --git a/public/.DS_Store b/public/.DS_Store new file mode 100644 index 0000000..c328838 Binary files /dev/null and b/public/.DS_Store differ diff --git a/public/assets/notify.wav b/public/assets/notify.wav new file mode 100644 index 0000000..453a38d Binary files /dev/null and b/public/assets/notify.wav differ diff --git a/public/assets/ring.png b/public/assets/ring.png new file mode 100644 index 0000000..0bf59b4 Binary files /dev/null and b/public/assets/ring.png differ diff --git a/public/assets/ring.wav b/public/assets/ring.wav new file mode 100644 index 0000000..b37d90e Binary files /dev/null and b/public/assets/ring.wav differ diff --git a/public/background.jpg b/public/background.jpg new file mode 100644 index 0000000..7116f49 Binary files /dev/null and b/public/background.jpg differ diff --git a/public/client.js b/public/client.js new file mode 100755 index 0000000..96e7511 --- /dev/null +++ b/public/client.js @@ -0,0 +1,357 @@ +'use strict'; + +// This user agent +const userAgent = navigator.userAgent; + +// WebSocket connection to the signaling server +const socket = io(); + +// WebRTC configuration +const config = { iceServers: [{ urls: 'stun:stun.l.google.com:19302' }] }; + +// DOM elements +const signInPage = document.querySelector('#signInPage'); +const usernameIn = document.querySelector('#usernameIn'); +const signInBtn = document.querySelector('#signInBtn'); +const roomPage = document.querySelector('#roomPage'); +const callUsernameIn = document.querySelector('#callUsernameIn'); +const callBtn = document.querySelector('#callBtn'); +const hideBtn = document.querySelector('#hideBtn'); +const hangUpBtn = document.querySelector('#hangUpBtn'); +const localVideoContainer = document.querySelector('#localVideoContainer'); +const localVideo = document.querySelector('#localVideo'); +const localUsername = document.querySelector('#localUsername'); +const remoteVideo = document.querySelector('#remoteVideo'); + +// User and connection information +let userName; +let connectedUser; +let thisConnection; +let stream; + +// Hide room page initially +roomPage.style.display = 'none'; + +// WebSocket event listeners +socket.on('connect', handleSocketConnect); +socket.on('message', handleMessage); +socket.on('error', handleSocketError); + +// Handle WebSocket connection establishment +function handleSocketConnect() { + console.log('Connected to the signaling server'); +} + +// Handle WebSocket errors +function handleSocketError(err) { + handleError('Socket error', err.message); +} + +// Handle incoming messages based on type +function handleMessage(data) { + const { type } = data; + + console.log('Got message', type); + + switch (type) { + case 'ping': + handlePing(data); + break; + case 'signIn': + handleSignIn(data); + break; + case 'notfound': + handleNotFound(data); + break; + case 'offerAccept': + offerAccept(data); + break; + case 'offerCreate': + offerCreate(); + break; + case 'offer': + handleOffer(data); + break; + case 'answer': + handleAnswer(data); + break; + case 'candidate': + handleCandidate(data); + break; + case 'leave': + handleLeave(); + break; + case 'error': + handleError(data.message, data.message); + break; + default: + break; + } +} + +// Event listeners +signInBtn.addEventListener('click', handleSignInClick); +callBtn.addEventListener('click', handleCallClick); +hideBtn.addEventListener('click', toggleLocalVideo); +hangUpBtn.addEventListener('click', handleHangUpClick); + +// Handle sign-in button click +function handleSignInClick() { + userName = usernameIn.value; + if (userName.length > 0) { + sendMsg({ + type: 'signIn', + name: userName, + }); + } +} + +// Handle call button click +function handleCallClick() { + const callToUsername = callUsernameIn.value; + if (callToUsername.length > 0) { + if (callToUsername === userName) { + handleError('You cannot call yourself.'); + return; + } + connectedUser = callToUsername; + sendMsg({ + type: 'offerAccept', + from: userName, + to: callToUsername, + }); + } else { + handleError('Please enter a username to call.'); + } +} + +// Toggle local video visibility +function toggleLocalVideo() { + localVideoContainer.classList.toggle('hide'); +} + +// Handle hang-up button click +function handleHangUpClick() { + sendMsg({ type: 'leave' }); + handleLeave(); +} + +// Handle ping message from the server +function handlePing(data) { + const { iceServers } = data; + if (iceServers) { + config.iceServers = iceServers; + } + sendMsg({ + type: 'pong', + message: { + client: 'Hello Server!', + agent: userAgent, + }, + }); +} + +// Handle user not found from the server +function handleNotFound(data) { + const { username } = data; + callUsernameIn.value = ''; + handleError(`Username ${username} not found!`); +} + +// Handle sign-in response from the server +function handleSignIn(data) { + const { success } = data; + if (!success) { + handleError('Username already in use. Try a different username.'); + } else { + signInPage.style.display = 'none'; + roomPage.style.display = 'block'; + + navigator.mediaDevices + .getUserMedia({ video: true, audio: true }) + .then((myStream) => { + stream = myStream; + localVideo.srcObject = stream; + localVideo.playsInline = true; + localVideo.autoplay = true; + localVideo.muted = true; + localVideo.volume = 0; + localVideo.controls = false; + localUsername.innerText = userName; + initializeConnection(); + }) + .catch((error) => { + handleError('Failed to access camera and microphone.', error); + }); + } +} + +// Initialize WebRTC connection +function initializeConnection() { + thisConnection = new RTCPeerConnection(config); + + stream.getTracks().forEach((track) => thisConnection.addTrack(track, stream)); + + thisConnection.ontrack = (e) => { + if (e.streams && e.streams[0]) { + remoteVideo.srcObject = e.streams[0]; + remoteVideo.playsInline = true; + remoteVideo.autoplay = true; + remoteVideo.controls = false; + console.log('Remote stream set to video element'); + } else { + handleError('No stream available in the ontrack event.'); + } + }; + + thisConnection.onicecandidate = (event) => { + if (event.candidate) { + sendMsg({ + type: 'candidate', + candidate: event.candidate, + }); + } + }; + + // For debugging purposes + thisConnection.onconnectionstatechange = (event) => { + console.log('Connection state change:', thisConnection.connectionState); + }; + + thisConnection.oniceconnectionstatechange = (event) => { + console.log('ICE connection state change:', thisConnection.iceConnectionState); + }; +} + +// Create and send an offer +function offerCreate() { + if (!thisConnection) { + initializeConnection(); + } + thisConnection + .createOffer() + .then((offer) => { + thisConnection.setLocalDescription(offer); + sendMsg({ + type: 'offer', + offer, + }); + callUsernameIn.style.display = 'none'; + }) + .catch((error) => { + handleError('Error when creating an offer.', error); + }); +} + +// Accept incoming offer +function offerAccept(data) { + sound('ring'); + Swal.fire({ + position: 'center', + //icon: 'question', + imageUrl: 'assets/ring.png', + text: 'Do you want to accept call from ' + data.from + ' ?', + showDenyButton: true, + confirmButtonText: `Yes`, + denyButtonText: `No`, + showClass: { popup: 'animate__animated animate__fadeInDown' }, + hideClass: { popup: 'animate__animated animate__fadeOutUp' }, + }).then((result) => { + if (result.isConfirmed) { + callUsernameIn.style.display = 'none'; + callBtn.style.display = 'none'; + data.type = 'offerCreate'; + } else { + data.type = 'offerDecline'; + } + sendMsg({ ...data }); + }); +} + +// Handle incoming offer +function handleOffer(data) { + const { offer, name } = data; + connectedUser = name; + initializeConnection(); + thisConnection.setRemoteDescription(new RTCSessionDescription(offer)); + thisConnection + .createAnswer() + .then((answer) => { + thisConnection.setLocalDescription(answer); + sendMsg({ + type: 'answer', + answer, + }); + }) + .catch((error) => { + handleError('Error when creating an answer.', error); + }); +} + +// Handle incoming answer +function handleAnswer(data) { + const { answer } = data; + thisConnection.setRemoteDescription(new RTCSessionDescription(answer)).catch((error) => { + handleError('Error when set remote description.', error); + }); +} + +// Handle incoming ICE candidate +function handleCandidate(data) { + const { candidate } = data; + callBtn.style.display = 'none'; + thisConnection.addIceCandidate(new RTCIceCandidate(candidate)).catch((error) => { + handleError('Error when add ice candidate.', error); + callBtn.style.display = 'inline'; + }); +} + +// Play audio sound +async function sound(name) { + const sound = './assets/' + name + '.wav'; + const audio = new Audio(sound); + try { + audio.volume = 0.5; + await audio.play(); + } catch (err) { + return false; + } +} + +// Handle leaving the room +function handleLeave() { + connectedUser = null; + remoteVideo.srcObject = null; + if (thisConnection) { + thisConnection.close(); + thisConnection = null; + } + window.location.href = '/'; +} + +// Handle and display errors +function handleError(message, error = false) { + if (error) console.error(error); + sound('notify'); + Swal.fire({ + title: 'Warning', + text: message, + icon: 'warning', + confirmButtonText: 'OK', + showClass: { popup: 'animate__animated animate__fadeInDown' }, + hideClass: { popup: 'animate__animated animate__fadeOutUp' }, + }); +} + +// Send messages to the server +function sendMsg(message) { + if (connectedUser) { + message.name = connectedUser; + } + socket.emit('message', message); +} + +// Clean up before window close or reload +window.onbeforeunload = () => { + handleHangUpClick(); +}; diff --git a/public/favicon/about.txt b/public/favicon/about.txt new file mode 100644 index 0000000..952febe --- /dev/null +++ b/public/favicon/about.txt @@ -0,0 +1,6 @@ +This favicon was generated using the following font: + +- Font Title: Leckerli One +- Font Author: Copyright (c) 2011 Gesine Todt (www.gesine-todt.de hallo@gesine-todt.de), with Reserved Font Names "Leckerli" +- Font Source: https://fonts.gstatic.com/s/leckerlione/v20/V8mCoQH8VCsNttEnxnGQ-1itLZxcBtItFw.ttf +- Font License: SIL Open Font License, 1.1 (http://scripts.sil.org/OFL)) diff --git a/public/favicon/android-chrome-192x192.png b/public/favicon/android-chrome-192x192.png new file mode 100644 index 0000000..7ece4fc Binary files /dev/null and b/public/favicon/android-chrome-192x192.png differ diff --git a/public/favicon/android-chrome-512x512.png b/public/favicon/android-chrome-512x512.png new file mode 100644 index 0000000..6da4cd8 Binary files /dev/null and b/public/favicon/android-chrome-512x512.png differ diff --git a/public/favicon/apple-touch-icon.png b/public/favicon/apple-touch-icon.png new file mode 100644 index 0000000..4d41f49 Binary files /dev/null and b/public/favicon/apple-touch-icon.png differ diff --git a/public/favicon/favicon-16x16.png b/public/favicon/favicon-16x16.png new file mode 100644 index 0000000..e2ac2eb Binary files /dev/null and b/public/favicon/favicon-16x16.png differ diff --git a/public/favicon/favicon-32x32.png b/public/favicon/favicon-32x32.png new file mode 100644 index 0000000..ef4f360 Binary files /dev/null and b/public/favicon/favicon-32x32.png differ diff --git a/public/favicon/favicon.ico b/public/favicon/favicon.ico new file mode 100644 index 0000000..33b8eec Binary files /dev/null and b/public/favicon/favicon.ico differ diff --git a/public/favicon/site.webmanifest b/public/favicon/site.webmanifest new file mode 100644 index 0000000..1033ed0 --- /dev/null +++ b/public/favicon/site.webmanifest @@ -0,0 +1,11 @@ +{ + "name": "", + "short_name": "", + "icons": [ + { "src": "/android-chrome-192x192.png", "sizes": "192x192", "type": "image/png" }, + { "src": "/android-chrome-512x512.png", "sizes": "512x512", "type": "image/png" } + ], + "theme_color": "#ffffff", + "background_color": "#ffffff", + "display": "standalone" +} diff --git a/public/index.html b/public/index.html new file mode 100755 index 0000000..21ba06b --- /dev/null +++ b/public/index.html @@ -0,0 +1,143 @@ + + + + Call-me + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+

Call-me

+
+ +
+
+ + +
+ + +
+
+
+
+
+
+
+ + +
+
+ +
+ + +
+ + +
+
+
+ + +
+ + + + + + +
+
+
+
+ + + + + + + + + + + + + + + diff --git a/public/style.css b/public/style.css new file mode 100644 index 0000000..6945d65 --- /dev/null +++ b/public/style.css @@ -0,0 +1,133 @@ +/* Import font-family */ +@import url('https://fonts.googleapis.com/css?family=Comfortaa:wght@500&display=swap'); + +/* Variables */ +:root { + --border-radius: 10px; +} + +/* Global Styles */ +* { + outline: none; + font-family: 'Comfortaa'; +} + +html, +body { + width: 100%; + height: 100%; + margin: 0; + padding: 0; + overflow: hidden; /* Prevent scrolling if the image is larger than the viewport */ + background: url('background.jpg') center/cover no-repeat; /* Consolidate background properties */ +} + +/* General Card Styles */ +.card { + max-width: 400px !important; + margin: 0 auto !important; + color: #fff !important; + font-weight: bold !important; + border: none !important; + border-radius: 10px !important; + background: rgb(0 0 0 / 7%) !important; +} + +/* Video Styles */ +video { + width: 100%; + height: auto; + border: none; + border-radius: var(--border-radius); + object-fit: contain; +} + +/* Local Video Styles */ +#localVideoContainer { + position: absolute; + top: 10px; + left: 20px; + width: 15vw; + height: 15vh; + border-radius: var(--border-radius); + border: none; +} + +#localUsername { + position: absolute; + top: 0px; + left: 0px; + color: #fff; + font-size: x-small; + border-radius: 5px; + margin: 5px; +} + +/* Remote Video Styles */ +#remoteVideo { + width: 100%; + height: auto; + background: rgba(0, 0, 0, 0.5); + border-radius: var(--border-radius); + border: none; +} + +/* Hidden Elements */ +.hide { + display: none; +} + +input { + text-align: center; +} + +/* Text Input Styles */ +#callUsernameIn { + background: rgba(0, 0, 0, 0.5); + color: #fff; + border: none; +} + +/* Placeholder Styles */ +#callUsernameIn::placeholder { + color: #525252; + opacity: 1; +} + +/* Center Alignment */ +.center { + position: fixed; + top: 50%; + left: 50%; + transform: translate(-50%, -50%); +} + +/* Custom button */ +.btn-custom { + height: 48px; + width: 48px; + border-radius: 50px !important; +} + +/* Swal2 custom theme */ +.swal2-popup { + background-color: #333 !important; + color: #fff !important; + border: none !important; +} +.swal2-popup .swal2-styled:focus { + box-shadow: none !important; +} +.swal2-title { + color: #fff !important; +} +.swal2-actions .swal2-confirm { + background-color: #157346 !important; + color: #fff !important; + border: none !important; +} +.swal2-actions .swal2-cancel { + background-color: #666 !important; + color: #fff !important; + border: none !important; +}