commit 8277b023b8660fad0a9f3313808522fbea9dd6e1 Author: Josue Date: Thu Jan 5 23:37:07 2017 +0100 First commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..729b1bc --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +# From kateproject +.kateproject +.kateproject.d +.directory diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..2c7293d --- /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 +. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..4c20ee2 --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# Monitorix + +## Install + +From command line: + +`sudo yunohost app install -l Monitorix https://github.com/YunoHost-Apps/monitorix_ynh` + +## Upgrade + +From command line: + +`sudo yunohost app upgrade -u https://github.com/YunoHost-Apps/monitorix_ynh` + +## More sensor + +If you want to see the temperature of some sensor you can install the `lm-sensor` packet. For disk temperature you can instal the `hddtemp` packet. + +## Custom config + +If you want do custom the monitorix config for more personnal information you can add a file in `/etc/monitorix/conf.d/`. This config file will be overwritte the original config in `/etc/monitorix/monitorix.conf`. \ No newline at end of file diff --git a/conf/monitorix.conf b/conf/monitorix.conf new file mode 100644 index 0000000..dd8dbfd --- /dev/null +++ b/conf/monitorix.conf @@ -0,0 +1,1051 @@ +# Monitorix - configuration file +# +# See monitorix.conf(5) manpage for a detailed description of each option. +# + +title = Yunohost Stats +hostname = Yunohost Server +theme_color = black +refresh_rate = 150 +iface_mode = graph +enable_zoom = y +netstats_in_bps = y +disable_javascript_void = y +temperature_scale = c +show_gaps = n +global_zoom = 1 +max_historic_years = 5 +accept_selfsigned_certs = y +image_format = svg +include_dir = /etc/monitorix/conf.d + +base_dir = /var/lib/monitorix/www/ +base_lib = /var/lib/monitorix/ +base_url = YNH_WWW_PATH +base_cgi = YNH_WWW_PATH-cgi + + + enabled = y + host = localhost + port = SERVICE_PORT + user = www-data + group = nogroup + log_file = /var/log/monitorix-httpd + hosts_deny = + hosts_allow = + https_url = y + + enabled = n + msg = Monitorix: Restricted access + htpasswd = /var/lib/monitorix/htpasswd + + + + +# Log files pathnames +# ----------------------------------------------------------------------------- +log_file = /var/log/monitorix +secure_log = /var/log/secure +mail_log = /var/log/maillog +milter_gl = /var/milter-greylist/greylist.db +imap_log = /var/log/imap +hylafax_log = /var/spool/hylafax/etc/xferfaxlog +cups_log = /var/log/cups/page_log +ftp_log = /var/log/proftpd/access.log +fail2ban_log = /var/log/fail2ban.log +spamassassin_log = /var/log/maillog +clamav_log = /var/log/clamav/clamav.log +cg_logdir = /var/CommuniGate/SystemLogs/ +squid_log = /var/log/squid/access.log + +imap_log_date_format = %b %d +secure_log_date_format = %b %e + + + + enabled = n + url = "://example.com/piwik/" + sid = "1" + img = "http://example.com/piwik/piwik.php?idsite=1" + + + +# Graphs (de)activation +# ----------------------------------------------------------------------------- + + system = y + kern = y + proc = y + hptemp = n + lmsens = n + gensens = n + nvidia = n + disk = n + fs = y + zfs = n + du = n + net = y + netstat = y + tc = n + libvirt = n + process = y + serv = y + mail = y + port = y + user = y + ftp = n + apache = n + nginx = y + lighttpd = n + mysql = y + varnish = n + pagespeed = n + squid = n + nfss = n + nfsc = n + bind = n + ntp = n + chrony = n + fail2ban = y + icecast = n + raspberrypi = n + phpapc = n + memcached = n + apcupsd = n + nut = n + wowza = n + int = y + verlihub = n + + + +# SYSTEM graph +# ----------------------------------------------------------------------------- + + rigid = 1, 0 + limit = 1, 100 + + loadavg_enabled = n + loadavg_timeintvl = 3600 + loadavg_threshold = 5.0 + loadavg_script = /path/to/script.sh + + + + +# KERN graph +# ----------------------------------------------------------------------------- + + graph_mode = r + + user = y + nice = y + sys = y + iow = y + irq = y + sirq = y + steal = y + guest = y + + rigid = 2, 1, 2 + limit = 100, 1000, 100 + + + +# PROC graph +# ----------------------------------------------------------------------------- + + max = 4 + graphs_per_row = 2 + size = medium + data = y + rigid = 2 + limit = 100 + + + +# HPTEMP graph +# ----------------------------------------------------------------------------- + + graph_0 = 2, 3 + graph_1 = 1, 6 + graph_2 = 16, 18, 19, 20, 21, 22 + + + +# LMSENS graph +# ----------------------------------------------------------------------------- + + + core0 = Core 0 + core1 = Core 1 + mb0 = M/B Temp + cpu0 = CPU Temp + fan0 = fan1 + fan1 = fan2 + fan2 = fan3 + volt0 = VCore 1 + volt1 = VCore 2 + volt2 = \+3.3V + volt3 = \+5V + volt4 = \+12V + volt5 = \-12V + volt6 = \-5V + volt7 = Battery + gpu0 = nvidia + + + + + + +# GENSENS graph +# ----------------------------------------------------------------------------- + + + 0 = temp0 + 1 = cpu0 + + + temp0 = /sys/devices/virtual/thermal/thermal_zone0/temp + cpu0 = /sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq + + + temp0 = 1000 + cpu0 = 0.001 + + + temp0 = Temperature Zone 0 + cpu0 = CPU0 frequency + + rigid = 0, 0 + limit = 100, 100 + + + +# NVIDIA graph +# ----------------------------------------------------------------------------- + + max = 1 + rigid = 1, 2, 2 + limit = 50, 100, 100 + + + +# DISK graph +# ----------------------------------------------------------------------------- + + + 0 = /dev/sda, /dev/sdb, /dev/sdc + + + realloc_enabled = n + realloc_timeintvl = 0 + realloc_threshold = 1 + realloc_script = /path/to/script.sh + pendsect_enabled = n + pendsect_timeintvl = 0 + pendsect_threshold = 1 + pendsect_script = /path/to/script.sh + + + + +# FS graph +# ----------------------------------------------------------------------------- + + + 0 = /, swap + + + + + + rigid = 2, 0, 2, 0 + limit = 100, 1000, 100, 1000 + + + + + +# ZFS graph +# ----------------------------------------------------------------------------- + + max_pools = 5 + list = pool1, pool2 + rigid = 0, 0, 0, 0, 2, 0, 2 + limit = 1000, 1000, 1000, 1000, 100, 1000, 100 + + + +# DU graph +# ----------------------------------------------------------------------------- + + list = System, Users + + 0 = /var/spool/mail, /var/spool/mqueue, /etc, /var/ftp, /tmp + 1 = /home/ace, /home/gene, /home/paul, /home/peter + + + /var/spool/mail = Mail boxes + /var/spool/mqueue = Mail queue + + graphs_per_row = 2 + rigid = 0 + limit = 100 + + + +# NET graph +# ----------------------------------------------------------------------------- + + list = eth0 + + eth0 = FastEthernet LAN, 0, 10000000 + + gateway = eth0 + + + +# NETSTAT graph +# ----------------------------------------------------------------------------- + + rigid = 0, 0, 0, 0, 0 + limit = 100, 100, 100, 100, 100 + + + +# TC graph +# ----------------------------------------------------------------------------- + + list = eth0 + + eth0 = cbq 1, sfq 10, sfq 20, sfq 30, ingress ffff + + + + rigid = 0, 0, 0, 0 + limit = 1000, 1000, 1000, 1000 + + + +# LIBVIRT graph +# ----------------------------------------------------------------------------- + + cmd = virsh + + 0 = centos6, winxp + + + centos6 = CentOS 6, vda, 52:54:00:45:d0:e7 + winxp = MS Windows XP, hda, 52:54:00:97:1c:e5 + + rigid = 2, 0, 0, 0 + limit = 100, 1000, 1000, 1000 + + + +# PROCESS graph +# ----------------------------------------------------------------------------- + + + 0 = sshd, ntpd, monitorix, monitorix-httpd, mysqld, slapd, dnsmasq + 1 = master, imap, sendmail, postfix, rmilter, dovecot, rspamd + 2 = nginx, uwsgi, php5-fpm + + + httpd = Apache + imap = Dovecot + named = Bind + + rigid = 2, 0, 0, 0, 0, 0, 0, 0 + limit = 100, 1000, 1000, 1000, 1000, 1000, 1000, 1000 + + + +# SERV graph +# ----------------------------------------------------------------------------- + + mode = i + rigid = 0, 0, 0 + limit = 1000, 1000, 1000 + + + +# MAIL graph +# ----------------------------------------------------------------------------- + + mta = postfix + greylist = milter-greylist + rigid = 0, 0, 0, 0, 0 + limit = 1, 1000, 1000, 1000, 1000 + + delvd_enabled = n + delvd_timeintvl = 60 + delvd_threshold = 100 + delvd_script = /path/to/script.sh + mqueued_enabled = n + mqueued_timeintvl = 3600 + mqueued_threshold = 100 + mqueued_script = /path/to/script.sh + + + + +# PORT graph +# ----------------------------------------------------------------------------- + + max = 9 + rule = 24000 + list = 25, 21, 80, 22, 110, 139, 3306, 53, 143 + + 25 = SMTP, tcp, in, 0, 1000 + 21 = FTP, tcp, in, 0, 1000 + 80 = HTTP, tcp, in, 0, 1000 + 22 = SSH, tcp, in, 0, 1000 + 110 = POP3, tcp, in, 0, 1000 + 139 = NETBIOS, tcp, in, 0, 1000 + 3306 = MYSQL, tcp, in, 0, 1000 + 53 = DNS, udp, in, 0, 1000 + 143 = IMAP, tcp, in, 0, 1000 + + graphs_per_row = 3 + + + +# USER graph +# ----------------------------------------------------------------------------- + + rigid = 0, 0, 0 + limit = 1000, 1000, 1000 + + + +# FTP graph +# ----------------------------------------------------------------------------- + + server = proftpd + anon_user = anonymous, ftp + rigid = 0, 0, 0 + limit = 1000, 1000, 1000 + + + +# APACHE graph +# ----------------------------------------------------------------------------- + + list = http://localhost/server-status?auto + + + rigid = 0, 0, 2, 0, 0, 0 + limit = 100, 100, 100, 100, 100, 100 + + + +# NGINX graph +# ----------------------------------------------------------------------------- + + url = http://localhost:NGINX_STATUS_PORT/nginx_status_monitorix + port = NGINX_STATUS_PORT + rule = 24100 + rigid = 0, 0, 0 + limit = 100, 100, 100 + + + +# LIGHTTPD graph +# ----------------------------------------------------------------------------- + + list = http://localhost/server-status?auto + rigid = 0, 0, 0 + limit = 100, 100, 100 + + + +# MYSQL graph +# ----------------------------------------------------------------------------- + + conn_type = socket + list = /var/run/mysqld/mysqld.sock + + /var/run/mysqld/mysqld.sock = 3306, MYSQL_USER, MYSQL_PASSWORD + + rigid = 0, 2, 0, 0, 0, 0 + limit = 100, 100, 100, 100, 100, 100 + + + +# VARNISH graph +# ----------------------------------------------------------------------------- + + rigid = 0, 0, 0, 0, 0, 0 + limit = 100, 100, 100, 100, 100, 100 + + + +# PAGESPEED graph +# ----------------------------------------------------------------------------- + + list = http://modpagespeed.com/mod_pagespeed_statistics + rigid = 0, 0, 2, 0, 0, 0, 0, 0 + limit = 1000, 1000, 100, 1000, 1000, 1000, 1000, 1000 + + + +# SQUID graph +# ----------------------------------------------------------------------------- + + cmd = squidclient -h 127.0.0.1 + graph_0 = TCP_MISS, TCP_DENIED, TCP_REFRESH_HIT, TCP_IMS_HIT, TCP_HIT, TCP_REFRESH_MISS, TCP_MEM_HIT, TCP_NEGATIVE_HIT, TCP_CLIENT_REFRESH_MISS + graph_1 = 200, 403, 304, 204, 302, 000, 404, 301, 206 + rigid = 0, 0, 0, 0, 0, 0, 0, 0, 0 + limit = 100, 100, 100, 100, 100, 100, 100, 100, 100 + + + +# NFSS graph +# ----------------------------------------------------------------------------- + + version = 3 + graph_0 = readlink, create, mkdir, symlink, rmdir, remove, rename, link, readdir + graph_1 = mknod, readdirplus, fsstat, fsinfo, pathconf, access, lookup, commit, null + graph_2 = read, write, getattr, setattr + rigid = 0, 0, 0, 0, 0, 0, 0, 0, 0 + limit = 100, 100, 100, 100, 100, 100, 100, 100, 100 + + + +# NFSC graph +# ----------------------------------------------------------------------------- + + version = 3 + graph_0 = readlink, create, mkdir, symlink, rmdir, remove, rename, link, readdir + graph_1 = mknod, readdirplus, fsstat, fsinfo, pathconf + graph_2 = read, write + graph_3 = getattr, setattr + graph_4 = access, lookup, commit, null + rigid = 0, 0, 0, 0, 0, 0 + limit = 100, 100, 100, 100, 100, 100 + + + +# BIND graph +# ----------------------------------------------------------------------------- + + list = http://localhost:8053/ + + http://localhost:8053/ = A, AAAA, ANY, DS, MX, NS, PTR, SOA, SRV, TXT, NAPTR, A6, CNAME, SPF, KEY, DNSKEY, HINFO, WKS, PX, NSAP + + + http://localhost:8053/ = A, AAAA, ANY, DS, MX, NS, PTR, SOA, SRV, TXT, NAPTR, A6, CNAME, SPF, KEY, DNSKEY, HINFO, WKS, PX, NSAP + + + http://localhost:8053/ = Requestv4, Requestv6, ReqEdns0, ReqBadEDNSVer, ReqTSIG, ReqSIG0, ReqBadSIG, ReqTCP, Response, QrySuccess, QryAuthAns, QryNoauthAns, QryReferral, QryNxrrset, QrySERVFAIL, QryNXDOMAIN, QryRecursion, QryDuplicate, QryDropped, QryFailure + + + http://localhost:8053/ = Queryv4, Queryv6, Responsev4, Responsev6, NXDOMAIN, SERVFAIL, FORMERR, OtherError, EDNS0Fail, Truncated, Lame, Retry, QueryTimeout, GlueFetchv4, GlueFetchv6, GlueFetchv4Fail, GlueFetchv6Fail, ValAttempt, ValOk, ValNegOk + + + http://localhost:8053/ = A, !A, AAAA, !AAAA, DLV, !DLV, DS, !DS, MX, NS, CNAME, !CNAME, SOA, !SOA, !ANY, PTR, RRSIG, NSEC, DNSKEY, NXDOMAIN + + rigid = 0, 0, 0, 0, 0, 0, 0, 0 + limit = 100, 100, 100, 100, 100, 100, 100, 100 + + + +# NTP graph +# ----------------------------------------------------------------------------- + + list = localhost + + localhost = AUTH, AUTO, CRYP, DENY, GPS, INIT, NKEY, RATE, RMOT, RSTR + + rigid = 0, 0, 0 + limit = 100, 100, 100 + + + +# CHRONY graph +# ----------------------------------------------------------------------------- + + list = localhost + rigid = 0, 0, 0, 0, 0, 0 + limit = 100, 100, 100, 100, 100, 100 + + + +# FAIL2BAN graph +# ----------------------------------------------------------------------------- + + list = Security, Overload / Abuse + + 0 = [apache], [apache-mod-security], [apache-overflows], [courierauth], [ssh], [pam-generic], [php-url-fopen], [vsftpd] + 1 = [apache-evasive], [apache-badbots], [named-refused-udp], [named-refused-tcp] + + graphs_per_row = 2 + rigid = 0 + limit = 100 + + + +# ICECAST graph +# ----------------------------------------------------------------------------- + + list = http://localhost:8000/status.xsl + + http://localhost:8000/status.xsl = stream1, stream2, stream3 + + graph_mode = r + rigid = 0, 0 + limit = 100, 100 + + + +# RASPBERRYPI graph +# ----------------------------------------------------------------------------- + + cmd = /opt/vc/bin/vcgencmd + clocks = arm, core, h264, isp, v3d, uart, emmc, pixel, hdmi + volts = core, sdram_c, sdram_i, sdram_p + rigid = 0, 0, 0 + limit = 100, 100, 100 + + + +# PHPAPC graph +# ----------------------------------------------------------------------------- + + list = http://localhost/apc.php?auto + rigid = 2, 2, 0 + limit = 100, 100, 100 + + + +# MEMCACHED graph +# ----------------------------------------------------------------------------- + + list = localhost:11211 + rigid = 0, 0, 0, 0, 0, 0, 0 + limit = 100, 100, 100, 100, 100, 100, 100 + + + +# APCUPSD graph +# ----------------------------------------------------------------------------- + + cmd = /sbin/apcaccess + list = localhost:3551 + rigid = 0, 2, 0, 0, 0, 0 + limit = 100, 100, 100, 100, 100, 100 + + + +# NUT graph +# ----------------------------------------------------------------------------- + + list = ups@localhost + rigid = 0, 2, 0, 0, 0, 0 + limit = 100:0, 100, 100:0, 100:0, 100:0, 100:0 + + + +# WOWZA graph +# ----------------------------------------------------------------------------- + + list = http://localhost:8086/connectioncounts + + http://localhost:8086/connectioncounts = channel1, channel2 + + rigid = 0, 0, 0, 0, 0 + limit = 100, 100, 100, 100, 100 + + + +# INT graph +# ----------------------------------------------------------------------------- + + rigid = 0, 0, 0 + limit = 100, 100, 100 + + + +# VERLIHUB graph +# ----------------------------------------------------------------------------- + + host = localhost + port = 3306 + user = verlihub_user + password = verlihub_password + database = verlihub_database + rigid = 0, 0, 0 + limit = 1000, 1000, 1000 + + + +# TRAFFACCT graph +# ----------------------------------------------------------------------------- + + enabled = n + max = 10 + graphs_per_row = 2 + list = pc101, pc102, pc103, pc104 + + 0 = 192.168.1.101/32, ace@example.com + 1 = 192.168.1.102/32, gene@example.com + 2 = 192.168.1.103/32, paul@example.com + 3 = 192.168.1.104/32, peter@example.com + + + enabled = n + language = en + default_mail = root@localhost + url_prefix = http://localhost:8080 + smtp_hostname = localhost + from_address = noreply@example.com + + rigid = 0 + limit = 100 + + + +# Multihost +# ----------------------------------------------------------------------------- + + enabled = n + footer_url = y + graphs_per_row = 2 + remotehost_list = server 1, server 2, server 3 + + 0 = http://www.example.com,/monitorix,/monitorix-cgi + 1 = http://10.0.0.1,/monitorix,/monitorix-cgi + 2 = http://192.168.0.100:8080,/,/ + + groups = n + remotegroup_list = My Group + + 0 = server 2, server 3 + + + + +# Email Reports +# ----------------------------------------------------------------------------- + + enabled = n + url_prefix = https://YNH_DOMAINYNH_WWW_PATH + smtp_hostname = localhost + from_address = noreply@YNH_DOMAIN + hour = 0 + minute = 0 + + enabled = n + graphs = system, fs + to = ace@example.com + + + enabled = n + graphs = system, fs + to = gene@example.com + + + enabled = n + graphs = system, fs + to = paul@example.com + + + enabled = n + graphs = system, fs + to = peter@example.com + + + + + +# ======================================================================== +# ====== Probably you don't need to touch anything below this line ====== +# ======================================================================== + +timeout = 15 + +imgs_dir = imgs/ +usage_dir = usage/ +report_dir = reports/ +favicon = monitorixico.png +logo_top = logo_top.png +logo_top_url = http://www.monitorix.org/ +logo_bottom = logo_bot.png + + + + main_bg = FFFFFF + main_fg = 000000 + title_bg = 777777 + title_fg = CCCC00 + graph_bg = CCCCCC + gap = 000000 + + + canvas = 000000 + back = 101010 + font = C0C0C0 + mgrid = 80C080 + grid = 808020 + frame = 808080 + arrow = FFFFFF + shadea = 404040 + shadeb = 404040 + axis = 101010 + main_bg = 000000 + main_fg = FFFFFF + title_bg = 333333 + title_fg = 888800 + graph_bg = 888888 + gap = FFFFFF + + + + + main = 450x150 + medium = 325x150 + medium2 = 325x70 + small = 200x66 + mini = 183x66 + tiny = 110x40 + zoom = 800x300 + remote = 300x100 + + +graph_name = system, kern, proc, hptemp, lmsens, gensens, nvidia, disk, fs, zfs, du, net, netstat, tc, libvirt, process, serv, mail, port, user, ftp, apache, nginx, lighttpd, mysql, varnish, pagespeed, squid, nfss, nfsc, bind, ntp, chrony, fail2ban, icecast, raspberrypi, phpapc, memcached, apcupsd, nut, wowza, int, verlihub + + + system = System load average and usage + kern = Global kernel usage + proc = Kernel usage per processor + hptemp = HP ProLiant System Health + lmsens = LM-Sensors and GPU temperatures + gensens = Generic sensor statistics + nvidia = NVIDIA temperatures and usage + disk = Disk drive temperatures and health + fs = Filesystem usage and I/O activity + zfs = ZFS statistics + du = Directory usage + net = Network traffic and usage + netstat = Netstat statistics + tc = Traffic Control statistics + libvirt = Libvirt statistics + process = Processes statistics + serv = System services demand + mail = Mail statistics + port = Network port traffic + user = Users using the system + ftp = FTP statistics + apache = Apache statistics + nginx = Nginx statistics + lighttpd = Lighttpd statistics + mysql = MySQL statistics + varnish = Varnish statistics + pagespeed = PageSpeed statistics + squid = Squid statistics + nfss = NFS server statistics + nfsc = NFS client statistics + bind = BIND statistics + ntp = NTP statistics + chrony = Chrony statistics + fail2ban = Fail2ban statistics + icecast = Icecast Streaming Media Server + raspberrypi = Raspberry Pi sensor statistics + phpapc = Alternative PHP Cache statistics + memcached = Memcached statistics + apcupsd = APC UPS statistics + nut = Network UPS Tools statistics + wowza = Wowza Media Server + int = Devices interrupt activity + verlihub = VerliHub statistics + + + + _system1 = System load + _system2 = Active processes + _system3 = Memory allocation + _kern1 = Kernel usage + _kern2 = Context switches and forks + _kern3 = VFS usage + _proc = Processor + _hptemp1 = Temperatures 1 + _hptemp2 = Temperatures 2 + _hptemp3 = Temperatures 3 + _lmsens1 = Core temperatures + _lmsens2 = Voltages + _lmsens3 = MB and CPU temperatures + _lmsens4 = Fan speeds + _lmsens5 = GPU temperatures + _gensens1 = Temperatures + _gensens2 = CPU frequency + _nvidia1 = NVIDIA temperatures + _nvidia2 = CPU usage + _nvidia3 = Memory usage + _disk1 = Disk drives temperatures + _disk2 = Reallocated sector count + _disk3 = Current pending sector + _fs1 = Filesystems usage + _fs2 = Disk I/O activity + _fs3 = Inode usage + _fs4 = Time spent in I/O activity + _zfs1 = ARC usage + _zfs2 = ARC cache + _zfs3 = L2ARC cache + _zfs4 = Pool data usage + _zfs5 = Pool usage + _du = Directory usage + _net1 = Network traffic + _net2 = Network packets + _net3 = Network errors + _netstat1 = IPv4 states + _netstat2 = IPv6 states + _netstat3 = Active close + _netstat4 = Passive close + _netstat5 = UDP statistics + _tc1 = Traffic + _tc2 = Dropped + _tc3 = Overlimits + _tc4 = Requeues + _libvirt1 = CPU time usage + _libvirt2 = Memory usage + _libvirt3 = Disk usage + _libvirt4 = Network usage + _process1 = CPU time usage + _process2 = Memory usage + _process3 = Disk usage + _process4 = Network usage + _process5 = Opened files + _process6 = Number of threads + _process7 = Context switches + _process8 = Number of processes + _serv1 = System services demand + _serv2 = IMAP and POP3 services + _serv3 = SMTP service + _mail1 = Mail statistics + _mail2 = Network traffic + _mail3 = Mails in queue + _mail4 = Queue size + _mail5 = SPF + _mail6 = Greylisting + _port = Port + _user1 = Users logged in + _user2 = Samba users + _user3 = Netatalk users + _ftp1 = Commands usage + _ftp2 = New sessions + _ftp3 = FTP traffic + _apache1 = Apache workers + _apache2 = Apache workers + _apache3 = Apache CPU usage + _apache4 = Apache requests + _apache5 = Apache workers + _apache6 = Apache open slots + _nginx1 = Nginx connections + _nginx2 = Nginx requests + _nginx3 = Nginx traffic + _lighttpd1 = Lighttpd workers + _lighttpd2 = Lighttpd traffic + _lighttpd3 = Lighttpd requests + _mysql1 = MySQL query types + _mysql2 = MySQL overall stats + _mysql3 = Table saturation and MyISAM + _mysql4 = MySQL queries + _mysql5 = MySQL connections + _mysql6 = MySQL traffic + _varnish1 = Varnish statistics + _varnish2 = Backend usage + _varnish3 = Client connections + _varnish4 = Cache performance + _varnish5 = Objects + _varnish6 = Traffic + _pagespeed1 = Cache overview + _pagespeed2 = HTML optimization + _pagespeed3 = Saved ratio + _pagespeed4 = Memcached + _pagespeed5 = Pcache cohorts + _pagespeed6 = Rewrite & SHM cache + _pagespeed7 = LRU & File cache + _pagespeed8 = Cache time + _squid1 = Squid statistics 1 + _squid2 = Squid statistics 2 + _squid3 = Overall I/O + _squid4 = Memory usage + _squid5 = Store directory stats + _squid6 = IP cache stats + _squid7 = Network protocols usage + _squid8 = Client traffic + _squid9 = Server traffic + _nfss1 = NFS server stats 1 + _nfss2 = NFS server stats 2 + _nfss3 = NFS server stats 3 + _nfss4 = Overall I/O + _nfss5 = Network layer + _nfss6 = RPC + _nfss7 = Thread utilization + _nfss8 = Read cache + _nfss9 = File handle cache + _nfsc1 = NFS client stats 1 + _nfsc2 = NFS client stats 2 + _nfsc3 = NFS client stats 3 + _nfsc4 = NFS client stats 4 + _nfsc5 = NFS client stats 5 + _nfsc6 = RPC client stats + _bind1 = Incoming queries + _bind2 = Outgoing queries (_default) + _bind3 = Name server statistics + _bind4 = Resolver statistics (_default) + _bind5 = Cache DB RRsets (_default) + _bind6 = Memory usage + _bind7 = Task manager + _ntp1 = NTP timing stats + _ntp2 = Stratum level + _ntp3 = Codes + _chrony1 = Chrony timing stats + _chrony2 = Network path delays + _chrony3 = Stratum level + _chrony4 = System's clock drift + _chrony5 = Estimated error in frequency + _chrony6 = Update interval + _fail2ban = Fail2ban jails + _icecast1 = Current listeners + _icecast2 = Bitrate + _raspberrypi1 = Clock frequency + _raspberrypi2 = Temperatures + _raspberrypi3 = Voltages + _phpapc1 = Memory usage + _phpapc2 = Hits & misses + _phpapc3 = File cache + _memcached1 = Memcached statistics 1 + _memcached2 = Memcached statistics 2 + _memcached3 = Cache usage + _memcached4 = Items in cache + _memcached5 = Objects I/O + _memcached6 = Connections + _memcached7 = Memcached traffic + _apcupsd1 = Line voltage + _apcupsd2 = Battery charge + _apcupsd3 = Temperatures + _apcupsd4 = Battery voltage + _apcupsd5 = Time left + _apcupsd6 = Line frequency + _nut1 = Line voltage + _nut2 = Battery charge + _nut3 = Temperatures + _nut4 = Battery voltage + _nut5 = Time left + _nut6 = Line frequency + _wowza1 = Current connections + _wowza2 = Messages bytes rate + _wowza3 = Connections accepted + _wowza4 = Connections rejected + _wowza5 = Streams + _int1 = Interrupt activity + _int2 = Core activity + _int3 = Interrupt activity + _verlihub1 = Users in hub + _verlihub2 = Total hub upload + _verlihub3 = Total hub share + diff --git a/conf/nginx.conf b/conf/nginx.conf new file mode 100644 index 0000000..8e99278 --- /dev/null +++ b/conf/nginx.conf @@ -0,0 +1,12 @@ +location YNH_WWW_PATH { + include proxy_params; + proxy_pass http://127.0.0.1:SERVICE_PORTYNH_WWW_PATH; + allow 127.0.0.0/8; + + location ~ ^YNH_WWW_PATH/(.+\.png)$ { + alias /var/lib/monitorix/www/$1; + } + + # Include SSOWAT user panel. + include conf.d/yunohost_panel.conf.inc; +} \ No newline at end of file diff --git a/conf/nginx_status.conf b/conf/nginx_status.conf new file mode 100644 index 0000000..b0dc12f --- /dev/null +++ b/conf/nginx_status.conf @@ -0,0 +1,15 @@ +server { + listen PORT; + listen [::]:PORT; + + access_log /var/log/nginx/localhost-nginx_status_monitorix.lan-access.log; + error_log /var/log/nginx/localhost-nginx_status_monitorix.lan-error.log; + + location /nginx_status_monitorix { + stub_status on; + access_log off; + allow 127.0.0.1; + allow ::1; + deny all; + } +} \ No newline at end of file diff --git a/manifest.json b/manifest.json new file mode 100644 index 0000000..430bbe1 --- /dev/null +++ b/manifest.json @@ -0,0 +1,46 @@ +{ + "name": "Monitorix", + "id": "monitorix", + "packaging_format": 1, + "description": { + "en": "A monitoring tools", + "fr": "Un outils de monitoring" + }, + "url": "http://monitorix.org", + "license": "free", + "maintainer": { + "name": "Josué Tille", + "email": "josue@familletille.ch" + }, + "requirements": { + "yunohost": ">> 2.4.0" + }, + "multi_instance": false, + "services": [ + "nginx", + "mysql" + ], + "arguments": { + "install" : [ + { + "name": "domain", + "type": "domain", + "ask": { + "en": "Choose a domain name for Monitorix", + "fr": "Choisissez un nom de domaine pour Monitorix" + }, + "example": "example.com" + }, + { + "name": "path", + "type": "path", + "ask": { + "en": "Choose a path for Monitorix", + "fr": "Choisissez un chemin pour Monitorix" + }, + "example": "/monitorix", + "default": "/monitorix" + } + ] + } +} diff --git a/scripts/_common.sh b/scripts/_common.sh new file mode 100644 index 0000000..8f520f4 --- /dev/null +++ b/scripts/_common.sh @@ -0,0 +1,34 @@ +#!/bin/bash + +## Adapt md5sum while you update app +md5sum="7314ad6fcd014a34c2e4e8a95455bcaa" + +init_script() { + # Exit on command errors and treat unset variables as an error + set -eu + + # Source YunoHost helpers + source /usr/share/yunohost/helpers + + # Retrieve arguments + app=$YNH_APP_INSTANCE_NAME +} + +correct_path() { + if [ "${path:0:1}" != "/" ] && [ ${#path} -gt 0 ]; then + path="/$path" + fi + if [ "${path:${#path}-1}" == "/" ] && [ ${#path} -gt 1 ]; then + path="${path:0:${#path}-1}" + fi +} + +get_source() { + + wget -q -O '/tmp/monitorix.deb' 'http://www.monitorix.org/monitorix_3.9.0-izzy1_all.deb' + + if [[ ! -e '/tmp/monitorix.deb' ]] || [[ $(md5sum '/tmp/monitorix.deb' | cut -d' ' -f1) != $md5sum ]] + then + ynh_die "Error : can't get monitorix debian package" + fi +} \ No newline at end of file diff --git a/scripts/backup b/scripts/backup new file mode 100755 index 0000000..85b1fc0 --- /dev/null +++ b/scripts/backup @@ -0,0 +1,24 @@ +#!/bin/bash + +# Exit on command errors and treat unset variables as an error +set -eu + +# See comments in install script +app=$YNH_APP_INSTANCE_NAME + +# Source YunoHost helpers +source /usr/share/yunohost/helpers + +# # Dump the database +dbname=$app +dbuser=$app +dbpass=$(ynh_app_setting_get "$app" mysqlpwd) +mysqldump -u "$dbuser" -p"$dbpass" --no-create-db "$dbname" > ./dump.sql + +# Copy NGINX configuration +domain=$(ynh_app_setting_get "$app" domain) +ynh_backup "/etc/nginx/conf.d/${domain}.d/${app}.conf" "nginx.conf" +ynh_backup "/etc/nginx/conf.d/monitorix_status.conf" "/monitorix_status.conf" + +# Copy Monitorix configuration +ynh_backup "/etc/monitorix" "config" diff --git a/scripts/install b/scripts/install new file mode 100755 index 0000000..7f925ec --- /dev/null +++ b/scripts/install @@ -0,0 +1,76 @@ +#!/bin/bash + +# Import common cmd +source ./_common.sh + +# Init script +init_script + +# Retrieve arguments +domain=$YNH_APP_ARG_DOMAIN +path=$YNH_APP_ARG_PATH + +# Correct path if it is not correct +correct_path + +# Check domain/path availability +sudo yunohost app checkurl "${domain}${path}" -a "$app" \ + || ynh_die "Path not available: ${domain}${path}" + +# Download package +get_source + +# Install package +ynh_package_update +ynh_package_install rrdtool perl libwww-perl libmailtools-perl libmime-lite-perl librrds-perl libdbi-perl libxml-simple-perl libhttp-server-simple-perl libconfig-general-perl pflogsumm +sudo dpkg -i /tmp/monitorix.deb +sudo rm -rf /etc/monitorix/conf.d/00-debian.conf +ynh_package_install -f + +# # Generate MySQL password and create database +dbuser=$app +dbname=$app +dbpass=$(ynh_string_random 12) +ynh_app_setting_set "$app" mysqlpwd "$dbpass" +ynh_mysql_create_db "$dbname" "$dbuser" "$dbpass" + +# Find a port for built-in monitorix HTTP server +port='' +findPort () { + port=$1 + + while ! sudo yunohost app checkport $port ; do + port=$(($port + 1)) + done +} +findPort 8080 +http_port=$port +ynh_app_setting_set $app http_port $http_port +findPort $(($port +1)) +nginx_status_port=$port +ynh_app_setting_set $app nginx_status_port $nginx_status_port + +# Modify Nginx configuration file and copy it to Nginx conf directory +nginx_conf=../conf/nginx.conf +sed -i "s@YNH_WWW_PATH@$path@g" $nginx_conf +sed -i "s@SERVICE_PORT@$http_port@g" $nginx_conf +sudo cp $nginx_conf /etc/nginx/conf.d/$domain.d/$app.conf + +# Add special hostname for monitorix status +nginx_status_conf=../conf/nginx_status.conf +sed -i "s@PORT@$nginx_status_port@g" $nginx_status_conf +sudo cp $nginx_status_conf /etc/nginx/conf.d/monitorix_status.conf + +# Update monitorix configuration +monitorix_conf=../conf/monitorix.conf +sed -i "s@SERVICE_PORT@$http_port@g" $monitorix_conf +sed -i "s@YNH_DOMAIN@$domain@g" $monitorix_conf +sed -i "s@NGINX_STATUS_PORT@$nginx_status_port@g" $monitorix_conf +sed -i "s@YNH_WWW_PATH@$path@g" $monitorix_conf +sed -i "s@MYSQL_USER@$dbuser@g" $monitorix_conf +sed -i "s@MYSQL_PASSWORD@$dbpass@g" $monitorix_conf +sudo cp $monitorix_conf /etc/monitorix/monitorix.conf + +# Reload services +sudo service nginx reload +sudo service monitorix restart diff --git a/scripts/remove b/scripts/remove new file mode 100755 index 0000000..9b4b75c --- /dev/null +++ b/scripts/remove @@ -0,0 +1,28 @@ +#!/bin/bash + +# Import common cmd +source ./_common.sh + +# Init script +init_script + +# Retrieve app settings +domain=$(ynh_app_setting_get "$app" domain) + +# Stop service +sudo service monitorix stop || true + +# Remove nginx configuration file +sudo rm -f /etc/nginx/conf.d/$domain.d/$app.conf + +# Drop MySQL database and user +dbname=$app +dbuser=$app +ynh_mysql_drop_db "$dbname" || true +ynh_mysql_drop_user "$dbuser" || true + +# Autoremove package +ynh_package_autoremove monitorix + +# Reload nginx service +sudo service nginx reload diff --git a/scripts/restore b/scripts/restore new file mode 100755 index 0000000..9b9dbee --- /dev/null +++ b/scripts/restore @@ -0,0 +1,48 @@ +#!/bin/bash + +# Import common cmd +source ./_common.sh + +# Init script +init_script + +# Note: each files and directories you've saved using the ynh_backup helper +# will be located in the current directory, regarding the last argument. + +# Retrieve old app settings +domain=$(ynh_app_setting_get "$app" domain) +path=$(ynh_app_setting_get "$app" path) + +# Correct path if it is not correct +correct_path + +# Check domain/path availability +sudo yunohost app checkurl "${domain}${path}" -a "$app" \ + || ynh_die "Path not available: ${domain}${path}" + +# Download package +get_source + +# Install package +ynh_package_update +ynh_package_install rrdtool perl libwww-perl libmailtools-perl libmime-lite-perl librrds-perl libdbi-perl libxml-simple-perl libhttp-server-simple-perl libconfig-general-perl +sudo dpkg -i /tmp/monitorix.deb +ynh_package_install -f + +# # Create and restore the database +dbname=$app +dbuser=$app +dbpass=$(ynh_app_setting_get "$app" mysqlpwd) +ynh_mysql_create_db "$dbname" "$dbuser" "$dbpass" +ynh_mysql_connect_as "$dbuser" "$dbpass" "$dbname" < ./dump.sql + +# Restore NGINX configuration +sudo cp -a ./nginx.conf "/etc/nginx/conf.d/${domain}.d/${app}.conf" +sudo cp -a ./monitorix_status.conf "/etc/nginx/conf.d/monitorix_status.conf" + +# Restore Monitorix configuration +sudo cp -a ./config "/etc/monitorix" + + +# Restart webserver +sudo service nginx reload diff --git a/scripts/upgrade b/scripts/upgrade new file mode 100755 index 0000000..f349024 --- /dev/null +++ b/scripts/upgrade @@ -0,0 +1,51 @@ +#!/bin/bash + +# Import common cmd +source ./_common.sh + +# Init script +init_script + +# Retrieve app settings +domain=$(ynh_app_setting_get "$app" domain) +path=$(ynh_app_setting_get "$app" path) +http_port=$(ynh_app_setting_get "$app" http_port) +nginx_status_port=$(ynh_app_setting_get "$app" nginx_status_port) +dbuser=$app +dbname=$app +dbpass=$(ynh_app_setting_get "$app" mysqlpwd) + +# Correct path if it is not correct +correct_path + +# Download package +get_source + +# Update package +sudo dpkg -i /tmp/monitorix.deb +sudo rm -rf /etc/monitorix/conf.d/00-debian.conf + +# Modify Nginx configuration file and copy it to Nginx conf directory +nginx_conf=../conf/nginx.conf +sed -i "s@YNH_WWW_PATH@$path@g" $nginx_conf +sed -i "s@SERVICE_PORT@$http_port@g" $nginx_conf +sudo cp $nginx_conf /etc/nginx/conf.d/$domain.d/$app.conf + +# Add special hostname for monitorix status +nginx_status_conf=../conf/nginx_status.conf +sed -i "s@PORT@$nginx_status_port@g" $nginx_status_conf +sudo cp $nginx_status_conf /etc/nginx/conf.d/monitorix_status.conf + +# Update monitorix configuration +monitorix_conf=../conf/monitorix.conf +sed -i "s@SERVICE_PORT@$http_port@g" $monitorix_conf +sed -i "s@YNH_DOMAIN@$domain@g" $monitorix_conf +sed -i "s@NGINX_STATUS_PORT@$nginx_status_port@g" $monitorix_conf +sed -i "s@YNH_WWW_PATH@$path@g" $monitorix_conf +sed -i "s@MYSQL_USER@$dbuser@g" $monitorix_conf +sed -i "s@MYSQL_PASSWORD@$dbpass@g" $monitorix_conf +sudo cp $monitorix_conf /etc/monitorix/monitorix.conf + +# Reload services +sudo service nginx reload +sudo service monitorix restart