From 7851b64b8cd63d0420b51813cf962ec6777c38e8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Josu=C3=A9=20Tille?= Date: Tue, 14 Aug 2018 22:18:22 +0200 Subject: [PATCH] Refactor app --- LICENSE | 675 ++++++++++++++++++++++++++++++++- README.md | 121 +++++- check_process | 43 +++ conf/.sogo.conf.swp | Bin 12288 -> 0 bytes conf/app.src | 6 + conf/cron | 22 ++ conf/default_sogo | 1 + conf/nginx.conf | 56 ++- conf/php-fpm.conf | 251 ------------ conf/sogo.conf | 33 +- conf/stunnel.conf | 7 + conf/systemd.service | 16 + manifest.json | 39 +- scripts/_common.sh | 81 ++++ scripts/backup | 48 ++- scripts/change_url | 50 +++ scripts/experimental_helper.sh | 13 + scripts/install | 109 +++--- scripts/remove | 52 ++- scripts/restore | 69 +++- scripts/upgrade | 122 ++++-- sources/README.md | 3 - 22 files changed, 1380 insertions(+), 437 deletions(-) create mode 100644 check_process delete mode 100644 conf/.sogo.conf.swp create mode 100644 conf/app.src create mode 100644 conf/cron create mode 100644 conf/default_sogo delete mode 100644 conf/php-fpm.conf create mode 100644 conf/stunnel.conf create mode 100644 conf/systemd.service create mode 100644 scripts/_common.sh create mode 100644 scripts/change_url create mode 100644 scripts/experimental_helper.sh delete mode 100644 sources/README.md diff --git a/LICENSE b/LICENSE index ac17d84..94a9ed0 100644 --- a/LICENSE +++ b/LICENSE @@ -1 +1,674 @@ -File containning the license of your package. + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md index 657c1da..13df533 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,122 @@ -# SOGo for Yunohost # +SOGo for Yunohost +================= + +[![Integration level](https://dash.yunohost.org/integration/sogo.svg)](https://ci-apps.yunohost.org/jenkins/job/sogo%20%28Community%29/lastBuild/consoleFull) +[![Install sogo with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=sogo) + +> *This package allow you to install sogo quickly and simply on a YunoHost server. +If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.* + +Overview +-------- SOGo is an opensource groupware solution which has Webmail, a global address book and Calender and Contacts which can be synced via caldav or cardav. -## Usage ## -Make sure you set the path to "/SOGo" case matters or SOGo will not work. +**Shipped version:** 4.0.0 -"yunohost app install https://github.com/mattronix/sogo_ynh" +Screenshots +----------- +| Localized |Drag'n'Drop | Reminders | Delegation | +| :------------: | :------------: | :------------: | :------------: | +| ![](https://sogo.nu/img/features/localized.png) | ![](https://sogo.nu/img/features/dnd_01.png) | ![](https://sogo.nu/img/features/reminders.png) | ![](https://sogo.nu/img/features/delegation.png) | +| SOGo is available in over a dozen languages so you'll always feel at home. If your language is missing, you can easily contribute to the project and submit your translation. | Move messages to folders, drag contacts to address books, and modify events time and duration from the tip of your finger. Just like a desktop app. | Set alarms to important events and get alerted directly from your browser. | Set alarms to important events and get alerted directly from your browser. | Delegate access to your mail account or delegate an invitation to another person. | + +| Resource Reservation | HTML | Mail Return Receipt | Forward and Auto-Reply | +| :------------: | :------------: | :------------: | :------------: | +| ![](https://sogo.nu/img/features/resource.png) | ![](https://sogo.nu/img/features/html.png) | ![](https://sogo.nu/img/features/return-receipt.png) | ![](https://sogo.nu/img/features/auto-reply.png) | +| Define resources like projectors and conference rooms to automatically accept invitations for them while avoiding double-booking. | Compose HTML mail with the complete inline [rich-text editor](http://www.ckeditor.com). | Request or answer to return requests to confirm the arrival of messages. | Set an auto reply while on vacation or forward all your incoming mail to one ore many alternate email addresses. | + +| S/MIME | Mail Filtering | Sharing | Recurring Events | +| :------------: | :------------: | :------------: | :------------: | +| ![](https://sogo.nu/img/features/security.png) | ![](https://sogo.nu/img/features/mail-filters.png) | ![](https://sogo.nu/img/features/sharing.png) | ![](https://sogo.nu/img/features/recurring-events.png) | +| Sign and encrypt messages using your personal secure certificate. Automatically manage public certificates you receive by email. | Define powerful server-side filters to automatically act on new messages. Forward, discard, reject, flag or move incoming mail depending on complex criteria. | Share your mail, calendars and address books with other users. Define specific rights to each person or group of persons. | Define precise recurrence pattern for your repeating events and create exceptions if necessary. | + +| Free/Busy Time | Notifications | Categories | Multiple Mail Accounts | Export/Import | +| :------------: | :------------: | :------------: | :------------: | :------------: | +| ![](https://sogo.nu/img/features/freebusy.png) | ![](https://sogo.nu/img/features/notifications.png) | ![](https://sogo.nu/img/features/categories.png) | ![](https://sogo.nu/img/features/imap-accounts.png) | ![](https://sogo.nu/img/features/import.png) | +| Before sending an invitation, see the free/busy periods of attendees, either from the local SOGo server or a remote Microsoft Exchange server. Automatically set off-hours as busy if you like. | Be informed if someone modifies your calendar or automatically inform someone if your calendar changes. | Choose from a predefined set of categories or create your own categories and associate them to your events and contacts. | Configure all your mail accounts (IMAP) from SOGo and forget about login-in to multiple webmail services. | Export calendars or import events from a vCalendar file. Export contacts to LDIF or import cards from a LDIF of vCard file. Export a mailbox to zip archive. | + + +Demo +---- + +* [Official demo](https://sogo.nu/) + + + +Documentation +------------- + + * Official documentation: https://sogo.nu/support.html#/documentation + * YunoHost documentation: There no other documentations, feel free to contribute. + +YunoHost specific features +-------------------------- + +### Multi-users support + +LDAP and HTTP auth are supported. + +### Supported architectures + +* x86-64b - [![Build Status](https://ci-apps.yunohost.org/jenkins/job/sogo%20(Community)/badge/icon)](https://ci-apps.yunohost.org/jenkins/job/sogo%20(Community)/) +* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/jenkins/job/sogo%20(Community)%20(%7EARM%7E)/badge/icon)](https://ci-apps-arm.yunohost.org/jenkins/job/sogo%20(Community)%20(%7EARM%7E)/) +* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/jenkins/job/sogo%20(Community)/badge/icon)](https://ci-stretch.nohost.me/jenkins/job/sogo%20(Community)/) + + + +Links +----- + + * Report a bug: https://github.com/YunoHost-Apps/sogo_ynh/issues + * App website: https://sogo.nu/ + * YunoHost website: https://yunohost.org/ + +--- + +Install +------- + +From command line: + +`sudo yunohost app install -l sogo https://github.com/YunoHost-Apps/sogo_ynh` + +Upgrade +------- + +From command line: + +`sudo yunohost app upgrade sogo -u https://github.com/YunoHost-Apps/sogo_ynh` + +Developers infos +---------------- + +Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/sogo_ynh/tree/testing). + +To try the testing branch, please proceed like that. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/sogo_ynh/tree/testing --debug +or +sudo yunohost app upgrade sogo -u https://github.com/YunoHost-Apps/sogo_ynh/tree/testing --debug +``` + +License +------- + +Sogo is published under the GPL-v2 and LGPL-v2 liencience : https://github.com/inverse-inc/sogo/blob/master/COPYING.GPL and https://github.com/inverse-inc/sogo/blob/master/COPYING.LGPL + +Todo +---- + +-[ ] More Tests diff --git a/check_process b/check_process new file mode 100644 index 0000000..5010f87 --- /dev/null +++ b/check_process @@ -0,0 +1,43 @@ +# See here for more informations +# https://github.com/YunoHost/package_check#syntax-check_process-file + +# Move this file from check_process.default to check_process when you have filled it. + +;; Test complet + ; Manifest + domain="domain.tld" (DOMAIN) + path="/SOGo" (PATH) + admin="john" (USER) + language="French" + is_public=1 (PUBLIC|public=1|private=0) + port="20000" (PORT) + ; Checks + pkg_linter=1 + setup_sub_dir=1 + setup_root=0 + setup_nourl=0 + setup_private=1 + setup_public=1 + upgrade=1 + upgrade=1 from_commit=cbcb85118a8bf55ed849a27381e814434e25f4d2 + backup_restore=1 + multi_instance=0 + incorrect_path=1 + port_already_use=1 (8448) + change_url=0 +;;; Levels + Level 1=auto + Level 2=auto + Level 3=auto + # https://github.com/YunoHost-Apps/sogo_ynh/blob/master/conf/sogo.conf#L25-L40 + Level 4=1 + Level 5=auto + Level 5=auto + Level 6=auto + Level 7=auto + Level 8=0 + Level 9=0 + Level 10=0 +;;; Upgrade options + ; commit=cbcb85118a8bf55ed849a27381e814434e25f4d2 + name=Branch_Old_package_For_CI1 diff --git a/conf/.sogo.conf.swp b/conf/.sogo.conf.swp deleted file mode 100644 index 84338c62e52e66318b764823641be2aa1e8cdd0d..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 12288 zcmeHN&5s;M6|clVfMCLhf)J<5LXf>#ws*Z&65BE`o>?y=?Z>daAF_p5YPxG?itVoI zRCVv}$cl3aCl0_Np!^F6aX>;s%0Iw`gF#4$3lao@ggC;@iuk?i?%kPq*O82Uh}6CQ zX{PJFe)a12KB{)z{e_+G8h>T}GQ;&5#(sS5-#c%;c!Ay1jHM#aNAi#)54}jwWDAQA zRf6ztWiZIB`M!*D7dSICdt*HcBBKZXZl1ng~s>hr1heO9;4N5eqF zK*K=8K*K=8K*K=8K*K=8K*K=8K*K=8z=x0l5i{0?-|x~d{P_R>`uG3$o@4Bnz;}RW zfpOQO;5M)Yw1A7ibHMLD z#@HLcZD1DoEbyO?GIkI6Iq);!4p0CYV1Qe|72r$2{f{vAXW$pW4}doT2iyW)2A&7* zpJVJVz@LC00uJZ`UjUv5o&o-aKd{^behs`0+y%Y|w1BSw_rd=^fqwvh2PhtY10Kiq zI%B&VyT)NK!Ils;q7p^hRgJ5@K)eLW{L}DyB5H?86(7%XLzKwyqTCZbtep_Xm z(q%?F(!aGFmcnpj#cX$vIo04A6{Wkx9Glq}3vo5CF z36->pBb6v&$3#>siYTYuDT(I^Rq{ZFkyY85DmRTi6gED?z>X-rctA|ndsy3+%6<9J zJ>Ql66dqQq#2xQyP%;patk&wo!ujhUkuK$0acre?H;mcGN~@ysBC4XyhllLZH9{Uz zWa#!s#QH3O$9d;*fGNazWgC+eAmLC{w^?g{4( zjU_i~%cY>Rj-i=IUl(zz^jsWW9~at?7xdlO;qfee6k)0TFeS`&Q^_Ru316sqjuVMx zx|ca_27FLz;*qZpWLd)(&I7Xa>rng1re2TU0A>i;SFN zV*5cG%-iPe^-1HAu4&1~Ssjyd=nfvBgrE!!O<|+s$_ZvUH8w7$b6g&YG(#Ruwx62+ z_6TJpA4ou0nus73%H+d0O%kKwhp6CXDw=hZt3g#!#Pdl>wc4v^t4%feR+bs1^AxrD z0e0cr^n~PE#Ywr4vhSdJk^6Axc%JnY>g|`&v@}ACRfV}#dKgOdHjyJ>)Q0Oe3WjNI zVP;Iy6Zr^2-=eWcnZ!3;3P%u7C{X5+Ts}fIYLQ^qQ+ikBqh-ppV>(JrGKneIWCY@s zOCfe?o}HK?g^t0K)SIfv;myV4wim8#^+IV6Bze1d>6Q5f{4CP*H$BIGjro`nCDIh$whALq;+F^(&fa^-X+%{*@ zv3o6nZ=D;o|6J|d=(WP|n-d*pY2oFQ!@{1cZ0rqu>iHPKbm>A@56q*PEv@Y-81N>E zLhKR)99kaDAlirB!#k*Cp-d#~{UR6Ct2n)Xs)hwpjSA{QO#w&ZW$151v}(`E#fm#V z%V!_k6(BS)`1r2b(qJm~C3l6D9NjZD2a@C5Ar5hNz`ZyyD&~bg6xgX^IznLEK$URl zS&M^%n?G@=GI-Y?YF5^_vEOGwbv|&xd^J)J@R4vlLyML;eqaYAi|D;Lyb$+uWVSMR zGQS-b3sc5)6TBfz1t$d z6Tz$+OCzWJE~{x@bok(-f7#P*I+Gvj{5KD<7{i)*riZV(|MC&YwsgzL806Q8<5R mINsuj;hjcmKM@Ymw@+<0oZ7keyUY7J7!?|vIrU<9*#7{d0$MHr diff --git a/conf/app.src b/conf/app.src new file mode 100644 index 0000000..e4dd89f --- /dev/null +++ b/conf/app.src @@ -0,0 +1,6 @@ +SOURCE_URL=url of app's source +SOURCE_SUM=sha256 checksum +SOURCE_SUM_PRG=sha256sum +SOURCE_FORMAT=tar.gz +SOURCE_IN_SUBDIR=true +SOURCE_FILENAME= diff --git a/conf/cron b/conf/cron new file mode 100644 index 0000000..3e4484b --- /dev/null +++ b/conf/cron @@ -0,0 +1,22 @@ +# Sogod cronjobs + +# Vacation messages expiration +# The credentials file should contain the sieve admin credentials (username:passwd) +0 0 * * * __APP__ /opt/yunohost/__APP__/sbin/sogo-tool update-autoreply -p /etc/sogo/sieve.creds + +# Session cleanup - runs every minute +# - Ajust the nbMinutes parameter to suit your needs +# Example: Sessions without activity since 60 minutes will be dropped: +* * * * * __APP__ /opt/yunohost/__APP__/sbin/sogo-tool expire-sessions 60 > /dev/null 2>&1 + +# Email alarms - runs every minutes +# If you need to use SMTP AUTH for outgoing mails, specify credentials to use +# with '-p /path/to/credentialsFile' (same format as the sieve credentials) +* * * * * __APP__ /opt/yunohost/__APP__/sbin/sogo-ealarms-notify > /dev/null 2>&1 + +# Daily backups +# - writes to ~sogo/backups/ by default +# - will keep 31 days worth of backups by default +# - runs once a day by default, but can run more frequently +# - make sure to set the path to sogo-backup.sh correctly +#30 0 * * * __APP__ /opt/yunohost/__APP__/share/doc/sogo/sogo-backup.sh \ No newline at end of file diff --git a/conf/default_sogo b/conf/default_sogo new file mode 100644 index 0000000..05efad1 --- /dev/null +++ b/conf/default_sogo @@ -0,0 +1 @@ +PREFORK=3 diff --git a/conf/nginx.conf b/conf/nginx.conf index 96b7eec..dbf86fd 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -1,33 +1,25 @@ - # SOGo Proxying - location ^~ VARPATH { - proxy_pass http://127.0.0.1:20000; - proxy_redirect http://127.0.0.1:20000/SOGo/ /SOGo; - # forward user's IP address - proxy_set_header X-Real-IP $remote_addr; - proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; - proxy_set_header Host $host; - proxy_set_header x-webobjects-server-protocol HTTP/1.0; - proxy_set_header x-webobjects-remote-host 127.0.0.1; - proxy_set_header x-webobjects-server-name $server_name; - proxy_set_header x-webobjects-server-url $scheme://$host; - include conf.d/yunohost_panel.conf.inc; - } - - # For IOS 7 - location = /principals/ { - rewrite ^ https://$server_name/SOGo/dav; - allow all; - } - - - location VARPATH.woa/WebServerResources/ { - alias /usr/lib/GNUstep/SOGo/WebServerResources/; - } - location VARPATH/WebServerResources/ { - alias /usr/lib/GNUstep/SOGo/WebServerResources/; - } - location ^VARPATH/so/ControlPanel/Products/([^/]*)/Resources/(.*)$ { - alias /usr/lib/GNUstep/SOGo/$1.SOGo/Resources/$2; - } - +# SOGo Proxying +#sub_path_only rewrite ^__PATH__$ __PATH__/ permanent; +location ^~ __PATH__/ { + proxy_pass http://127.0.0.1:__PORT__; + proxy_redirect http://127.0.0.1:__PORT__/SOGo/ /SOGo; + # forward user's IP address + proxy_set_header X-Real-IP $remote_addr; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + proxy_set_header Host $host; + proxy_set_header x-webobjects-server-protocol HTTP/1.0; + proxy_set_header x-webobjects-remote-host 127.0.0.1; + proxy_set_header x-webobjects-server-name $server_name; + proxy_set_header x-webobjects-server-url $scheme://$host; + include conf.d/yunohost_panel.conf.inc; +} +location __PATH__.woa/WebServerResources/ { + alias /usr/lib/GNUstep/SOGo/WebServerResources/; +} +location __PATH__/WebServerResources/ { + alias /usr/lib/GNUstep/SOGo/WebServerResources/; +} +location ^__PATH__/so/ControlPanel/Products/([^/]*)/Resources/(.*)$ { + alias /usr/lib/GNUstep/SOGo/$1.SOGo/Resources/$2; +} diff --git a/conf/php-fpm.conf b/conf/php-fpm.conf deleted file mode 100644 index 2061166..0000000 --- a/conf/php-fpm.conf +++ /dev/null @@ -1,251 +0,0 @@ -; Start a new pool named 'www'. -; the variable $pool can we used in any directive and will be replaced by the -; pool name ('www' here) -[YNH_WWW_APP] - -; Per pool prefix -; It only applies on the following directives: -; - 'slowlog' -; - 'listen' (unixsocket) -; - 'chroot' -; - 'chdir' -; - 'php_values' -; - 'php_admin_values' -; When not set, the global prefix (or /usr) applies instead. -; Note: This directive can also be relative to the global prefix. -; Default Value: none -;prefix = /path/to/pools/$pool - -; The address on which to accept FastCGI requests. -; Valid syntaxes are: -; 'ip.add.re.ss:port' - to listen on a TCP socket to a specific address on -; a specific port; -; 'port' - to listen on a TCP socket to all addresses on a -; specific port; -; '/path/to/unix/socket' - to listen on a unix socket. -; Note: This value is mandatory. -listen = /var/run/php5-fpm-YNH_WWW_APP.sock - -; Set listen(2) backlog. A value of '-1' means unlimited. -; Default Value: 128 (-1 on FreeBSD and OpenBSD) -;listen.backlog = -1 - -; List of ipv4 addresses of FastCGI clients which are allowed to connect. -; Equivalent to the FCGI_WEB_SERVER_ADDRS environment variable in the original -; PHP FCGI (5.2.2+). Makes sense only with a tcp listening socket. Each address -; must be separated by a comma. If this value is left blank, connections will be -; accepted from any ip address. -; Default Value: any -;listen.allowed_clients = 127.0.0.1 - -; Set permissions for unix socket, if one is used. In Linux, read/write -; permissions must be set in order to allow connections from a web server. Many -; BSD-derived systems allow connections regardless of permissions. -; Default Values: user and group are set as the running user -; mode is set to 0666 -listen.owner = www-data -listen.group = www-data -listen.mode = 0600 - -; Unix user/group of processes -; Note: The user is mandatory. If the group is not set, the default user's group -; will be used. -user = www-data -group = www-data - -; Choose how the process manager will control the number of child processes. -; Possible Values: -; static - a fixed number (pm.max_children) of child processes; -; dynamic - the number of child processes are set dynamically based on the -; following directives: -; pm.max_children - the maximum number of children that can -; be alive at the same time. -; pm.start_servers - the number of children created on startup. -; pm.min_spare_servers - the minimum number of children in 'idle' -; state (waiting to process). If the number -; of 'idle' processes is less than this -; number then some children will be created. -; pm.max_spare_servers - the maximum number of children in 'idle' -; state (waiting to process). If the number -; of 'idle' processes is greater than this -; number then some children will be killed. -; Note: This value is mandatory. -pm = dynamic - -; The number of child processes to be created when pm is set to 'static' and the -; maximum number of child processes to be created when pm is set to 'dynamic'. -; This value sets the limit on the number of simultaneous requests that will be -; served. Equivalent to the ApacheMaxClients directive with mpm_prefork. -; Equivalent to the PHP_FCGI_CHILDREN environment variable in the original PHP -; CGI. -; Note: Used when pm is set to either 'static' or 'dynamic' -; Note: This value is mandatory. -pm.max_children = 6 - -; The number of child processes created on startup. -; Note: Used only when pm is set to 'dynamic' -; Default Value: min_spare_servers + (max_spare_servers - min_spare_servers) / 2 -pm.start_servers = 3 - -; The desired minimum number of idle server processes. -; Note: Used only when pm is set to 'dynamic' -; Note: Mandatory when pm is set to 'dynamic' -pm.min_spare_servers = 3 - -; The desired maximum number of idle server processes. -; Note: Used only when pm is set to 'dynamic' -; Note: Mandatory when pm is set to 'dynamic' -pm.max_spare_servers = 5 - -; The number of requests each child process should execute before respawning. -; This can be useful to work around memory leaks in 3rd party libraries. For -; endless request processing specify '0'. Equivalent to PHP_FCGI_MAX_REQUESTS. -; Default Value: 0 -pm.max_requests = 500 - -; The URI to view the FPM status page. If this value is not set, no URI will be -; recognized as a status page. By default, the status page shows the following -; information: -; accepted conn - the number of request accepted by the pool; -; pool - the name of the pool; -; process manager - static or dynamic; -; idle processes - the number of idle processes; -; active processes - the number of active processes; -; total processes - the number of idle + active processes. -; max children reached - number of times, the process limit has been reached, -; when pm tries to start more children (works only for -; pm 'dynamic') -; The values of 'idle processes', 'active processes' and 'total processes' are -; updated each second. The value of 'accepted conn' is updated in real time. -; Example output: -; accepted conn: 12073 -; pool: www -; process manager: static -; idle processes: 35 -; active processes: 65 -; total processes: 100 -; max children reached: 1 -; By default the status page output is formatted as text/plain. Passing either -; 'html' or 'json' as a query string will return the corresponding output -; syntax. Example: -; http://www.foo.bar/status -; http://www.foo.bar/status?json -; http://www.foo.bar/status?html -; Note: The value must start with a leading slash (/). The value can be -; anything, but it may not be a good idea to use the .php extension or it -; may conflict with a real PHP file. -; Default Value: not set -pm.status_path = /fpm-status - -; The ping URI to call the monitoring page of FPM. If this value is not set, no -; URI will be recognized as a ping page. This could be used to test from outside -; that FPM is alive and responding, or to -; - create a graph of FPM availability (rrd or such); -; - remove a server from a group if it is not responding (load balancing); -; - trigger alerts for the operating team (24/7). -; Note: The value must start with a leading slash (/). The value can be -; anything, but it may not be a good idea to use the .php extension or it -; may conflict with a real PHP file. -; Default Value: not set -ping.path = /ping - -; This directive may be used to customize the response of a ping request. The -; response is formatted as text/plain with a 200 response code. -; Default Value: pong -;ping.response = pong - -; The timeout for serving a single request after which the worker process will -; be killed. This option should be used when the 'max_execution_time' ini option -; does not stop script execution for some reason. A value of '0' means 'off'. -; Available units: s(econds)(default), m(inutes), h(ours), or d(ays) -; Default Value: 0 -request_terminate_timeout = 120s - -; The timeout for serving a single request after which a PHP backtrace will be -; dumped to the 'slowlog' file. A value of '0s' means 'off'. -; Available units: s(econds)(default), m(inutes), h(ours), or d(ays) -; Default Value: 0 -request_slowlog_timeout = 5s - -; The log file for slow requests -; Default Value: not set -; Note: slowlog is mandatory if request_slowlog_timeout is set -slowlog = /var/log/nginx/YNH_WWW_APP.slow.log - -; Set open file descriptor rlimit. -; Default Value: system defined value -rlimit_files = 4096 - -; Set max core size rlimit. -; Possible Values: 'unlimited' or an integer greater or equal to 0 -; Default Value: system defined value -rlimit_core = 0 - -; Chroot to this directory at the start. This value must be defined as an -; absolute path. When this value is not set, chroot is not used. -; Note: you can prefix with '$prefix' to chroot to the pool prefix or one -; of its subdirectories. If the pool prefix is not set, the global prefix -; will be used instead. -; Note: chrooting is a great security feature and should be used whenever -; possible. However, all PHP paths will be relative to the chroot -; (error_log, sessions.save_path, ...). -; Default Value: not set -;chroot = - -; Chdir to this directory at the start. -; Note: relative path can be used. -; Default Value: current directory or / when chroot -chdir = /var/www/YNH_WWW_ALIAS - -; Redirect worker stdout and stderr into main error log. If not set, stdout and -; stderr will be redirected to /dev/null according to FastCGI specs. -; Note: on highloaded environement, this can cause some delay in the page -; process time (several ms). -; Default Value: no -catch_workers_output = yes - -; Pass environment variables like LD_LIBRARY_PATH. All $VARIABLEs are taken from -; the current environment. -; Default Value: clean env -;env[HOSTNAME] = $HOSTNAME -;env[PATH] = /usr/local/bin:/usr/bin:/bin -;env[TMP] = /tmp -;env[TMPDIR] = /tmp -;env[TEMP] = /tmp - -; Additional php.ini defines, specific to this pool of workers. These settings -; overwrite the values previously defined in the php.ini. The directives are the -; same as the PHP SAPI: -; php_value/php_flag - you can set classic ini defines which can -; be overwritten from PHP call 'ini_set'. -; php_admin_value/php_admin_flag - these directives won't be overwritten by -; PHP call 'ini_set' -; For php_*flag, valid values are on, off, 1, 0, true, false, yes or no. - -; Defining 'extension' will load the corresponding shared extension from -; extension_dir. Defining 'disable_functions' or 'disable_classes' will not -; overwrite previously defined php.ini values, but will append the new value -; instead. - -; Note: path INI options can be relative and will be expanded with the prefix -; (pool, global or /usr) - -; Default Value: nothing is defined by default except the values in php.ini and -; specified at startup with the -d argument -;php_admin_value[sendmail_path] = /usr/sbin/sendmail -t -i -f www@my.domain.com -;php_flag[display_errors] = off -;php_admin_value[error_log] = /var/log/fpm-php.www.log -;php_admin_flag[log_errors] = on -;php_admin_value[memory_limit] = 32M - -# Common values to change to increase file upload limit -;php_value[upload_max_filesize] = 50M -;php_value[post_max_size] = 50M -;php_value[mail.add_x_header] = Off - -# Other common parameters -;php_value[max_execution_time] = 600 -;php_value[max_input_time] = 300 -;php_value[memory_limit] = 256M -;php_value[short_open_tag] = On - diff --git a/conf/sogo.conf b/conf/sogo.conf index 391d43a..b19e9f6 100644 --- a/conf/sogo.conf +++ b/conf/sogo.conf @@ -1,25 +1,32 @@ { - SOGoProfileURL = "mysql://DBUSER:DBPASS@localhost:3306/sogo/sogo_user_profile"; - OCSFolderInfoURL = "mysql://DBUSER:DBPASS@localhost:3306/sogo/sogo_folder_info"; - OCSSessionsFolderURL = "mysql://DBUSER:DBPASS@localhost:3306/sogo/sogo_sessions_folder"; - SOGoLanguage = English; + WOPort = 127.0.0.1:__PORT__; + WOLogFile = /var/log/__APP__/sogo.log; + /* Fix Yunohost Tile */ + WODontZipResponse = YES; + SOGoProfileURL = "mysql://__DBUSER__:__DBPASS__@localhost:3306/__APP__/sogo_user_profile"; + OCSFolderInfoURL = "mysql://__DBUSER__:__DBPASS__@localhost:3306/__APP__/sogo_folder_info"; + OCSSessionsFolderURL = "mysql://__DBUSER__:__DBPASS__@localhost:3306/__APP__/sogo_sessions_folder"; SOGoAppointmentSendEMailNotifications = YES; SOGoEnablePublicAccess = YES; SOGoMailingMechanism = smtp; - SOGoSMTPServer = 127.0.0.1; + SOGoSMTPServer = 127.0.0.1:__SMTP_PORT__; + SOGoSMTPAuthenticationType = PLAIN; SOGoTimeZone = UTC; SOGoSentFolderName = Sent; SOGoTrashFolderName = Trash; SOGoDraftsFolderName = Drafts; SOGoIMAPServer = "imaps://localhost:993/"; SOGoIMAPAclConformsToIMAPExt = YES; - SOGoVacationEnabled = NO; - SOGoForwardEnabled = NO; - SOGoSieveScriptsEnabled = NO; + SOGoVacationEnabled = YES; + SOGoForwardEnabled = YES; + SOGoSieveScriptsEnabled = YES; + SOGoSieveServer = sieve://127.0.0.1:4190; SOGoFirstDayOfWeek = 0; - SOGoMailMessageCheck = manually; + SOGoMailMessageCheck = every_10_minutes; SOGoMailAuxiliaryUserAccountsEnabled = NO; - /* LDAP authentication example */ + SOGoTrustProxyAuthentication = YES; + SOGoSuperUsernames = (__ADMINUSER__); + /* LDAP authentication */ SOGoUserSources = ( { type = ldap; @@ -29,12 +36,10 @@ bindFields = (uid, mail); // array of fields to use for indirect binds baseDN = "ou=users,dc=yunohost,dc=org"; canAuthenticate = YES; - displayName = "Global Address Book"; + displayName = "Yunohost Users"; hostname = ldap://localhost:389; - id = public; + id = directory; isAddressBook = YES; } ); - } - diff --git a/conf/stunnel.conf b/conf/stunnel.conf new file mode 100644 index 0000000..484c3e7 --- /dev/null +++ b/conf/stunnel.conf @@ -0,0 +1,7 @@ +[Smtp-Starttls] +client=yes +accept = __SMTP_PORT__ +connect = 587 + +protocol = smtp +protocolAuthentication = plain diff --git a/conf/systemd.service b/conf/systemd.service new file mode 100644 index 0000000..e66b848 --- /dev/null +++ b/conf/systemd.service @@ -0,0 +1,16 @@ +[Unit] +Description=SOGo is a groupware server +After=network.target +After=mariadb.service + +[Service] +Environment="PREFORK=3" +Environment="LD_LIBRARY_PATH=/lib:/usr/lib:/opt/yunohost/__APP__/Library/Libraries/sogo:/opt/yunohost/__APP__/Local/Library/Libraries/sogo" +EnvironmentFile=-/etc/default/__APP__ +Type=forking +ExecStart=/opt/yunohost/__APP__/sbin/sogod -WOWorkersCount ${PREFORK} -WOPidFile /var/run/__APP__/sogo.pid -WOLogFile /var/log/__APP__/sogo.log +PIDFile=/var/run/__APP__/sogo.pid +User=__APP__ + +[Install] +WantedBy=multi-user.target \ No newline at end of file diff --git a/manifest.json b/manifest.json index 0342ed1..c0700ae 100644 --- a/manifest.json +++ b/manifest.json @@ -1,29 +1,45 @@ { "name": "SOGo", "id": "sogo", + "packaging_format": 1, + "license": "LGPL-2.1,GPL-2.0", + "url": "https://sogo.nu/", + "version": "4.0.0~ynh1", "description": { "en": "Sogo is an opensource groupware for E-Mail, Contacts and Calender.", - "fr": "Insert French Here" + "fr": "Sogo est un groupware opensource pour les e-mail, contacts et calendrier" }, - "developer": { + "maintainer": { + "name": "Josué Tille", + "email": "josue@tille.ch" + }, + "previous_maintainers": { "name": "mattronix", "email": "mattronix@weho.st", "url": "http://sogo.nu" }, - "multi_instance": "false", + "multi_instance": false, + "services": [ + "nginx", + "mysql" + ], + "requirements": { + "yunohost": ">= 2.7.14" + }, "arguments": { "install" : [ { "name": "domain", + "type": "domain", "ask": { - "en": "Choose a domain for sogo", - "fr": "Choisissez un domaine pour sogo" + "en": "Choose a domain name for SOGo", + "fr": "Choisissez un nom de domaine pour SOGo" }, - "example": "domain.org" + "example": "example.com" }, { "name": "admin", - "type": "user", + "type": "user", "ask": { "en": "Choose an admin user", "fr": "Choisissez l’administrateur" @@ -32,14 +48,13 @@ }, { "name": "is_public", + "type": "boolean", "ask": { - "en": "Is it a public application?", - "fr": "Est-ce une application publique ?" + "en": "Is it a public site ? To be able to use caldav and cardav you need to set as public.", + "fr": "Est-ce un site public ? Pour pouvoir utiliser caldav et cardav vous devz mettre en public." }, - "choices": ["Yes", "No"], - "default": "Yes" + "default": true } - ] } } diff --git a/scripts/_common.sh b/scripts/_common.sh new file mode 100644 index 0000000..ee17190 --- /dev/null +++ b/scripts/_common.sh @@ -0,0 +1,81 @@ +#!/bin/bash + +#================================================= +# SET ALL CONSTANTS +#================================================= + +app=$YNH_APP_INSTANCE_NAME + +#================================================= +# DEFINE ALL COMMON FONCTIONS +#================================================= + +install_dependance() { + ynh_install_app_dependencies sogo stunnel4 +} + +config_sogo() { + ynh_backup_if_checksum_is_different /etc/$app/sogo.conf + cp ../conf/sogo.conf /etc/$app/sogo.conf + + ynh_replace_string "__APP__" "$app" /etc/$app/sogo.conf + ynh_replace_string "__ADMINUSER__" "$admin" /etc/$app/sogo.conf + ynh_replace_string "__DBUSER__" "$db_user" /etc/$app/sogo.conf + ynh_replace_string "__DBPASS__" "$db_pwd" /etc/$app/sogo.conf + ynh_replace_string "__PORT__" "$port" /etc/$app/sogo.conf + ynh_replace_string "__SMTP_PORT__" "$smtp_port" /etc/$app/sogo.conf + + ynh_store_file_checksum /etc/$app/sogo.conf +} + +config_stunnel() { + ynh_backup_if_checksum_is_different /etc/stunnel/$app.conf + cp ../conf/stunnel.conf /etc/stunnel/$app.conf + + ynh_replace_string "__SMTP_PORT__" "$smtp_port" /etc/stunnel/$app.conf + + ynh_store_file_checksum /etc/stunnel/$app.conf + + # Enable stunnel at startup + ynh_replace_string "ENABLED=0" "ENABLED=1" /etc/default/stunnel4 +} + +config_cron() { + ynh_backup_if_checksum_is_different /etc/cron.d/$app + + cp ../conf/cron /etc/cron.d/$app + ynh_replace_string "__APP__" "$app" /etc/cron.d/$app + ynh_store_file_checksum /etc/cron.d/$app + systemctl restart cron +} + +config_nginx() { + ynh_add_nginx_config + + nginx_domain_path=/etc/nginx/conf.d/$domain.d/* + nginx_config_path="/etc/nginx/conf.d/$domain.d/$app.conf" + + grep "/principals" $nginx_domain_path || echo "# For IOS 7 +location = /principals/ { + rewrite ^ https://\$server_name/SOGo/dav; + allow all; +} +" >> "$nginx_config_path" + + grep "/Microsoft-Server-ActiveSync" $nginx_domain_path || echo "# For ActiveSync +location /Microsoft-Server-ActiveSync/ { + proxy_pass http://127.0.0.1:$port/SOGo/Microsoft-Server-ActiveSync/; +} +" >> "$nginx_config_path" + + ynh_store_file_checksum "$nginx_config_path" + + systemctl reload nginx +} + +set_permission() { + chown -R $app:$app /etc/$app + chmod u=rwX,g=rwX,o= -R /etc/$app + chown -R $app:$app /var/log/$app + chmod u=rwX,g=rwX,o= -R /var/log/$app +} \ No newline at end of file diff --git a/scripts/backup b/scripts/backup index 39f30ff..e674dea 100755 --- a/scripts/backup +++ b/scripts/backup @@ -1,24 +1,40 @@ #!/bin/bash -# causes the shell to exit if any subcommand or pipeline returns a non-zero status -set -e +#================================================= +# GENERIC START +#================================================= -app=sogo +# Source YunoHost helpers +source /usr/share/yunohost/helpers -# The parameter $1 is the backup directory location -# which will be compressed afterward -backup_dir=$1/apps/$app -sudo mkdir -p $backup_dir +# Stop script if errors +ynh_abort_if_errors -# Backup sources & data -sudo cp /etc/sogo/sogo.conf $backup_dir/sources +# Import common cmd +source ../settings/scripts/experimental_helper.sh +source ../settings/scripts/_common.sh -# Backup mysql database if needed - db_pwd=$(sudo yunohost app setting $app mysqlpwd) - sudo mysqldump -u $app -p$db_pwd $app > $backup_dir/$app.dmp +domain=$(ynh_app_setting_get $app domain) +db_name=$(ynh_app_setting_get $app db_name) -# Copy Nginx and YunoHost parameters to make the script "standalone" -sudo cp -a /etc/yunohost/apps/$app/. $backup_dir/yunohost -domain=$(sudo yunohost app setting $app domain) -sudo cp -a /etc/nginx/conf.d/$domain.d/$app.conf $backup_dir/nginx.conf +#================================================= +# STANDARD BACKUP STEPS +#================================================= +# BACKUP THE NGINX CONFIGURATION +ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf" + +# Backup SOGo config +ynh_backup "/etc/$app" + +# Backup stunnel config +ynh_backup "/etc/stunnel/$app.conf" + +# Backup Logs +ynh_backup "/var/log/$app" + +# Backup Cron +ynh_backup "/etc/cron.d/$app" + +# BACKUP THE MYSQL DATABASE +ynh_mysql_dump_db "$db_name" > db.sql diff --git a/scripts/change_url b/scripts/change_url new file mode 100644 index 0000000..d3f38f9 --- /dev/null +++ b/scripts/change_url @@ -0,0 +1,50 @@ +#!/bin/bash + +#================================================= +# GENERIC START +#================================================= + +# IMPORT GENERIC HELPERS +source /usr/share/yunohost/helpers + +# Exit if an error occurs during the execution of the script +ynh_abort_if_errors + +# Import common cmd +source ./experimental_helper.sh +source ./_common.sh + +# RETRIEVE ARGUMENTS +old_domain=$YNH_APP_OLD_DOMAIN +domain=$YNH_APP_NEW_DOMAIN +path_url=$(ynh_normalize_url_path ${YNH_APP_NEW_PATH:-'/'}) +app=$YNH_APP_INSTANCE_NAME + +domain=$(ynh_app_setting_get $app domain) +path_url=$(ynh_normalize_url_path $(ynh_app_setting_get $app path)) +admin=$(ynh_app_setting_get $app admin) +final_path=$(ynh_app_setting_get $app final_path) + +# Check if the new path stay /SOGo if not exit + +if [[ $path_url != "/SOGo" ]] +then + ynh_die "You can't use an other path than '/SOGo'" +fi + +#================================================= +# STANDARD MODIFICATIONS +#================================================= + +# MODIFY URL IN NGINX CONF +nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf + +# Change the domain for nginx +# Delete file checksum for the old conf file location +ynh_delete_file_checksum "$nginx_conf_path" +mv $nginx_conf_path /etc/nginx/conf.d/$domain.d/$app.conf +# Store file checksum for the new config file location +ynh_store_file_checksum "/etc/nginx/conf.d/$domain.d/$app.conf" + +#Configure Nginx +config_nginx diff --git a/scripts/experimental_helper.sh b/scripts/experimental_helper.sh new file mode 100644 index 0000000..bb04a03 --- /dev/null +++ b/scripts/experimental_helper.sh @@ -0,0 +1,13 @@ +#!/bin/bash + +# ============= FUTURE YUNOHOST HELPER ============= +# Delete a file checksum from the app settings +# +# $app should be defined when calling this helper +# +# usage: ynh_remove_file_checksum file +# | arg: file - The file for which the checksum will be deleted +ynh_delete_file_checksum () { + local checksum_setting_name=checksum_${1//[\/ ]/_} # Replace all '/' and ' ' by '_' + ynh_app_setting_delete $app $checksum_setting_name +} \ No newline at end of file diff --git a/scripts/install b/scripts/install index 1462301..f751927 100755 --- a/scripts/install +++ b/scripts/install @@ -1,70 +1,89 @@ #!/bin/bash -# causes the shell to exit if any subcommand or pipeline returns a non-zero status -set -e +#================================================= +# GENERIC START +#================================================= -app=sogo +# Source YunoHost helpers +source /usr/share/yunohost/helpers -# Retrieve arguments -domain=$1 -admin=$2 -is_public=$3 -path="/SOGo" -codename=$(lsb_release -c -s) +# Stop script if errors +ynh_abort_if_errors +# Import common cmd +source ./experimental_helper.sh +source ./_common.sh -# Save app settings -sudo yunohost app setting $app admin -v "$admin" -sudo yunohost app setting $app is_public -v "$is_public" +# RETRIEVE ARGUMENTS FROM THE MANIFEST +domain=$YNH_APP_ARG_DOMAIN +admin=$YNH_APP_ARG_ADMIN +is_public=$YNH_APP_ARG_IS_PUBLIC -# Check domain/path availability -sudo yunohost app checkurl $domain$path -a $app \ - || (echo "Path not available: $domain$path" && exit 1) +# Set variable +path_url="/SOGo" +# final_path="/opt/yunohost/$app" -#Add Repositories -sudo sh -c 'echo "deb http://inverse.ca/debian-v3 $codename $codename" > sogo.list' +# STORE SETTINGS FROM MANIFEST +ynh_app_setting_set $app admin $admin +ynh_app_setting_set $app is_public $is_public +# Check web path availability +ynh_webpath_available $domain $path_url || ynh_die "$domain$path_url is not available, please use an other domain or path." +# Register (book) web path +ynh_webpath_register $app $domain $path_url -#Add Repository Key -sudo apt-key adv --keyserver keys.gnupg.net --recv-key 0x810273C4 +# Find a port for SOGo +port=$(ynh_find_port 20000) +ynh_app_setting_set $app web_port $port +smtp_port=$(ynh_find_port $((port+1))) +ynh_app_setting_set $app smtp_port $smtp_port -#Update Package Cache -sudo apt-get update +#================================================= +# STANDARD MODIFICATIONS +#================================================= -#install Sogo -sudo apt-get install sogo --assume-yes +# INSTALL DEPENDENCIES +install_dependance +# CREATE A MYSQL DATABASE +db_name=$(ynh_sanitize_dbid $app) +db_user=$db_name +ynh_app_setting_set $app db_name $db_name +ynh_app_setting_set $app db_user $db_user +db_pwd=$(ynh_string_random 15) +ynh_mysql_setup_db $db_name $db_user $db_pwd -# If your app use a MySQL database you can use these lines to bootstrap -# a database, an associated user and save the password in app settings - db_pwd=$(openssl rand -hex 15) - sudo yunohost app initdb $app -p $db_pwd - sudo yunohost app setting $app mysqlpwd -v $db_pwd +# Configure SOGO +config_sogo -#Set SOGo Details -sudo sed -i "s@ADMINUSER@$admin@g" ../conf/sogo.conf -sudo sed -i "s@DBUSER@$app@g" ../conf/sogo.conf -sudo sed -i "s@DBPASS@$db_pwd@g" ../conf/sogo.conf +# Configure stunnel +# To fix the issue https://sogo.nu/bugs/view.php?id=31 we need stunnel to be able to connect correctly to the smtp server +config_stunnel -#Copy SOGo config -sudo cp ../conf/sogo.conf /etc/sogo/sogo.conf +# Install crontab +config_cron #Configure Nginx -sudo sed -i "s@VARPATH@$path@g" ../conf/nginx.conf +config_nginx -#copy Nginx config -sudo cp ../conf/nginx.conf /etc/nginx/conf.d/$domain.d/$app.conf +#================================================= +# GENERIC FINALIZATION +#================================================= +# SECURE FILES AND DIRECTORIES +set_permission -# If app is public, add url to SSOWat conf as skipped_uris -if [ "$is_public" = "Yes" ]; -then - # unprotected_uris allows SSO credentials to be passed anyway. - sudo yunohost app setting $app unprotected_uris -v "/" +# configure the sso +if [ "$is_public" = "0" ]; +then # Retire l'accès public + ynh_app_setting_delete $app skipped_uris +else + ynh_app_setting_set $app unprotected_uris "/" fi +# SETUP LOGROTATE +ynh_use_logrotate /var/log/$app/sogo.log # Restart services -sudo service nginx reload -sudo yunohost app ssowatconf -sudo service sogo restart +systemctl restart sogo +systemctl restart stunnel4 diff --git a/scripts/remove b/scripts/remove index 9388c7a..3c56dfa 100755 --- a/scripts/remove +++ b/scripts/remove @@ -1,25 +1,43 @@ #!/bin/bash -app=sogo -# Retrieve arguments -domain=$(sudo yunohost app setting $app domain) -path=$(sudo yunohost app setting $app path) -admin=$(sudo yunohost app setting $app admin) -is_public=$(sudo yunohost app setting $app is_public) +#================================================= +# GENERIC START +#================================================= +# Source YunoHost helpers +source /usr/share/yunohost/helpers -# Remove configuration files -sudo rm -f /etc/nginx/conf.d/$domain.d/$app.conf +# Import common cmd +source ./experimental_helper.sh +source ./_common.sh -# If a database is used, remove it - root_pwd=$(sudo cat /etc/yunohost/mysql) - mysql -u root -p$root_pwd -e "DROP DATABASE $app ; DROP USER $app@localhost ;" +# Retrieve app settings +app=$YNH_APP_INSTANCE_NAME -sudo rm /etc/apt/sources.list.d/sogo.list -sudo apt-get update -sudo apt-get remove sogo +domain=$(ynh_app_setting_get $app domain) +port=$(ynh_app_setting_get $app port) +db_name=$(ynh_app_setting_get $app db_name) +db_user=$(ynh_app_setting_get $app db_user) +final_path=$(ynh_app_setting_get $app final_path) +#================================================= +# STANDARD REMOVE +#================================================= -# Restart services -sudo service nginx reload -sudo yunohost app ssowatconf +# Remove metapackage and its dependencies +ynh_remove_app_dependencies + +# Remove a database if it exists, along with the associated user +ynh_mysql_remove_db $db_user $db_name + +# Remove the app directory securely +ynh_secure_remove "$final_path" + +# Remove sogo config +ynh_secure_remove "/etc/$app" + +# Remove stunnel config +ynh_secure_remove "/etc/stunnel/$app.conf" + +# Remove the app-specific logrotate config +ynh_remove_logrotate diff --git a/scripts/restore b/scripts/restore index 411ae3b..91b39f0 100755 --- a/scripts/restore +++ b/scripts/restore @@ -1,29 +1,58 @@ #!/bin/bash -# causes the shell to exit if any subcommand or pipeline returns a non-zero status -set -e +#================================================= +# GENERIC START +#================================================= -app=sogo +# Source YunoHost helpers +source /usr/share/yunohost/helpers -# The parameter $1 is the uncompressed restore directory location -backup_dir=$1/apps/$app +# Stop script if errors +ynh_abort_if_errors -# Restore sources & data -sudo cp -a $backup_dir/sources/sogo.conf /etc/sogo/sogo.conf +# Import common cmd +source ../settings/scripts/experimental_helper.sh +source ../settings/scripts/_common.sh -# Restore permissions to app files -# you may need to make some file and/or directory writeable by www-data (nginx user) -sudo chown -R root:sogo /etc/sogo/sogo.conf +domain=$(ynh_app_setting_get $app domain) +path_url=$(ynh_app_setting_get $app path) +final_path=$(ynh_app_setting_get $app final_path) +db_name=$(ynh_app_setting_get $app db_name) -# Restore mysql database if needed - db_pwd=$(sudo yunohost app setting $app mysqlpwd) - sudo mysql -u $app -p$db_pwd $app < $backup_dir/$app.dmp +# CHECK IF THE APP CAN BE RESTORED +ynh_webpath_available $domain $path_url \ + || ynh_die "Path not available: ${domain}${path_url}" -# Restore Nginx and YunoHost parameters -sudo cp -a $backup_dir/yunohost/. /etc/yunohost/apps/$app -domain=$(sudo yunohost app setting $app domain) -sudo cp -a $backup_dir/nginx.conf /etc/nginx/conf.d/$domain.d/$app.conf +#================================================= +# STANDARD RESTORATION STEPS +#================================================= -# Restart webserver -sudo service nginx reload -sudo service sogo restart +# Define and install dependencies +install_dependance + +# Restore all config and data +ynh_restore + +# RESTORE THE MYSQL DATABASE +db_pwd=$(ynh_app_setting_get $app mysqlpwd) +ynh_mysql_setup_db $db_name $db_name $db_pwd +ynh_mysql_connect_as $db_name $db_pwd $db_name < ./db.sql + +# Enable stunnel at startup +ynh_replace_string "ENABLED=0" "ENABLED=1" /etc/default/stunnel4 + +#================================================= +# GENERIC FINALIZATION +#================================================= + +# SECURE FILES AND DIRECTORIES +set_permission + +# SETUP LOGROTATE +ynh_use_logrotate /var/log/$app/sogo.log + +# Restart services +systemctl restart sogo +systemctl restart stunnel4 +systemctl reload nginx +systemctl restart cron diff --git a/scripts/upgrade b/scripts/upgrade index cd8047c..b6fe540 100755 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -1,34 +1,112 @@ #!/bin/bash -# causes the shell to exit if any subcommand or pipeline returns a non-zero status -set -e +#================================================= +# GENERIC START +#================================================= -app=sogo +# IMPORT GENERIC HELPERS +source /usr/share/yunohost/helpers -# Retrieve arguments -domain=$(sudo yunohost app setting $app domain) -path=$(sudo yunohost app setting $app path) -admin=$(sudo yunohost app setting $app admin) -is_public=$(sudo yunohost app setting $app is_public) +# Exit if an error occurs during the execution of the script +ynh_abort_if_errors -# Remove trailing "/" for next commands -path=${path%/} +# Import common cmd +source ./experimental_helper.sh +source ./_common.sh -# If app is public, add url to SSOWat conf as skipped_uris -if [ "$is_public" = "Yes" ]; +# LOAD SETTINGS +domain=$(ynh_app_setting_get $app domain) +path_url=$(ynh_normalize_url_path $(ynh_app_setting_get $app path)) +admin=$(ynh_app_setting_get $app admin) +is_public=$(ynh_app_setting_get $app is_public) +port=$(ynh_app_setting_get $app web_port) +smtp_port=$(ynh_app_setting_get $app smtp_port) +db_name=$(ynh_app_setting_get $app db_name) +db_user=$(ynh_app_setting_get $app db_user) +db_pwd=$(ynh_app_setting_get $app mysqlpwd) + +# Backup the current version of the app +ynh_backup_before_upgrade + +ynh_clean_setup () { + # restore it if the upgrade fails + ynh_restore_upgradebackup +} +# Exit if an error occurs during the execution of the script +ynh_abort_if_errors + +#================================================= +# UPGRADE SETTINGS FROM OLD INSTALL +#================================================= + +if [[ ${is_public,,*} = "yes" ]] then - # See install script - sudo yunohost app setting $app unprotected_uris -v "/" - # Remove old settings - sudo yunohost app setting $app skipped_uris -d + is_public=1 + ynh_app_setting_set $app is_public 1 fi -sudo apt-get update -sudo apt-get install sogo --assume-yes +if [[ ${is_public,,*} = "no" ]] +then + is_public=0 + ynh_app_setting_set $app is_public 0 +fi +if [[ -z $port ]] +then + # Find a port for SOGo + port=$(ynh_find_port 20000) + ynh_app_setting_set $app web_port $port +fi + +if [[ -z $db_name ]] +then + db_name=$app + ynh_app_setting_set $app db_name $db_name +fi + +if [[ -z $db_user ]] +then + db_user=$app + ynh_app_setting_set $app db_user $db_user +fi + +#================================================= +# STANDARD MODIFICATIONS +#================================================= + +# INSTALL DEPENDENCIES +install_dependance + +# Configure SOGO +config_sogo + +# Configure stunnel +config_stunnel + +# Install crontab +config_cron + +#Configure Nginx +config_nginx + +#================================================= +# GENERIC FINALIZATION +#================================================= + +# SECURE FILES AND DIRECTORIES +set_permission + +# configure the sso +if [ "$is_public" = "0" ]; +then # Retire l'accès public + ynh_app_setting_delete $app skipped_uris +else + ynh_app_setting_set $app unprotected_uris "/" +fi + +# SETUP LOGROTATE +ynh_use_logrotate /var/log/$app/sogo.log # Restart services -sudo service nginx reload -sudo service sogo restart -sudo yunohost app ssowatconf - +systemctl restart sogo +systemctl restart stunnel4 diff --git a/sources/README.md b/sources/README.md deleted file mode 100644 index bd2bfad..0000000 --- a/sources/README.md +++ /dev/null @@ -1,3 +0,0 @@ -Place the sources of the webapp in this folder. - -This file can be removed.