Do not show repair and configure together

.eslintrc.json

@@ -1,29 +0,0 @@
-{
-    "env": {
-        "node": true,
-        "es6": true
-    },
-    "extends": "eslint:recommended",
-    "parserOptions": {
-        "ecmaVersion": 8
-    },
-    "rules": {
-        "indent": [
-            "error",
-            4
-        ],
-        "linebreak-style": [
-            "error",
-            "unix"
-        ],
-        "quotes": [
-            "error",
-            "single"
-        ],
-        "semi": [
-            "error",
-            "always"
-        ],
-        "no-console": "off"
-    }
-}

.gitattributes

@@ -1,7 +1,6 @@
 # following files are skipped when exporting using git archive
 test export-ignore
-.jshintrc export-ignore
-.gitlab export-ignore
+docs export-ignore
 .gitattributes export-ignore
 .gitignore export-ignore
 

.gitignore

@@ -1,8 +1,10 @@
 node_modules/
 coverage/
 webadmin/dist/
+setup/splash/website/
 installer/src/certs/server.key
 
 # vim swap files
 *.swp
 
+

.gitlab/issue_templates/Bug.md

@@ -1,6 +0,0 @@
-Please do not use this issue tracker for support requests and bug reports.
-This issue tracker is used by the Cloudron development team to track actual
-bugs in the code.
-
-Please use the forum at https://forum.cloudron.io to report bugs. For
-confidential issues, please email us at support@cloudron.io.

.gitlab/issue_templates/Feature.md

@@ -1,7 +0,0 @@
-Please do not use this issue tracker for support requests and feature reports.
-This issue tracker is used by the Cloudron development team to track issues in
-the code.
-
-Please use the forum at https://forum.cloudron.io to report bugs. For
-confidential issues, please email us at support@cloudron.io.
-

.jshintrc

@@ -0,0 +1,8 @@
+{
+    "node": true,
+    "browser": true,
+    "unused": true,
+    "globalstrict": true,
+    "predef": [ "angular", "$" ],
+    "esnext": true
+}

LICENSE

@@ -1,35 +1,661 @@
-The Cloudron Subscription license
-Copyright (c) 2020 Cloudron UG
+                    GNU AFFERO GENERAL PUBLIC LICENSE
+                       Version 3, 19 November 2007
 
-With regard to the Cloudron Software:
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
 
-This software and associated documentation files (the "Software") may only be
-used in production, if you (and any entity that you represent) have agreed to,
-and are in compliance with, the Cloudron Subscription Terms of Service, available
-at https://cloudron.io/legal/terms.html (the “Subscription Terms”), or other
-agreement governing the use of the Software, as agreed by you and Cloudron,
-and otherwise have a valid Cloudron Subscription. Subject to the foregoing sentence,
-you are free to modify this Software and publish patches to the Software. You agree
-that Subscription and/or its licensors (as applicable) retain all right, title and
-interest in and to all such modifications and/or patches, and all such modifications
-and/or patches may only be used, copied, modified, displayed, distributed, or otherwise
-exploited with a valid Cloudron subscription. Notwithstanding the foregoing, you may copy
-and modify the Software for development and testing purposes, without requiring a
-subscription.  You agree that Cloudron and/or its licensors (as applicable) retain
-all right, title and interest in and to all such modifications.  You are not
-granted any other rights beyond what is expressly stated herein.  Subject to the
-foregoing, it is forbidden to copy, merge, publish, distribute, sublicense,
-and/or sell the Software.
+                            Preamble
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+  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.
 
-For all third party components incorporated into the Cloudron Software, those
-components are licensed under the original license provided by the owner of the
-applicable component.
+  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.
+
+    box
+    Copyright (C) 2016 Cloudron UG
+
+    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 <http://www.gnu.org/licenses/>.
+
+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
+<http://www.gnu.org/licenses/>.

README.md

@@ -9,6 +9,10 @@ a complex task.
 We are building the ultimate platform for self-hosting web apps. The Cloudron allows
 anyone to effortlessly host web applications on their server on their own terms.
 
+Support us on
+[![Flattr Cloudron](https://button.flattr.com/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=cloudron&url=https://cloudron.io&title=Cloudron&tags=opensource&category=software)
+or [pay us a coffee](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=8982CKNM46D8U)
+
 ## Features
 
 * Single click install for apps. Check out the [App Store](https://cloudron.io/appstore.html).
@@ -29,49 +33,47 @@ anyone to effortlessly host web applications on their server on their own terms.
 * Trivially migrate to another server keeping your apps and data (for example, switch your
   infrastructure provider or move to a bigger server).
 
-* Comprehensive [REST API](https://docs.cloudron.io/api/).
+* Comprehensive [REST API](https://cloudron.io/references/api.html).
 
-* [CLI](https://docs.cloudron.io/custom-apps/cli/) to configure apps.
+* [CLI](https://git.cloudron.io/cloudron/cloudron-cli) to configure apps.
 
 * Alerts, audit logs, graphs, dns management ... and much more
 
 ## Demo
 
-Try our demo at https://my.demo.cloudron.io (username: cloudron password: cloudron).
+Try our demo at https://my-demo.cloudron.me (username: cloudron password: cloudron).
 
 ## Installing
 
-[Install script](https://docs.cloudron.io/installation/) - [Pricing](https://cloudron.io/pricing.html)
+You can install the Cloudron platform on your own server or get a managed server
+from cloudron.io.
 
-**Note:** This repo is a small part of what gets installed on your server - there is
-the dashboard, database addons, graph container, base image etc. Cloudron also relies
-on external services such as the App Store for apps to be installed. As such, don't
-clone this repo and npm install and expect something to work.
+* [Selfhosting](https://cloudron.io/references/selfhosting.html)
+* [Managed Hosting](https://cloudron.io/pricing.html)
 
-## Development
+## Documentation
 
-This is the backend code of Cloudron. The frontend code is [here](https://git.cloudron.io/cloudron/dashboard).
+* [User manual](https://cloudron.io/references/usermanual.html)
+* [Developer docs](https://cloudron.io/documentation.html)
+* [Architecture](https://cloudron.io/references/architecture.html)
 
-The way to develop is to first install a full instance of Cloudron in a VM. Then you can use the [hotfix](https://git.cloudron.io/cloudron/cloudron-machine)
-tool to patch the VM with the latest code.
+## Related repos
 
-```
-SSH_PASSPHRASE=sshkeypassword cloudron-machine hotfix --cloudron my.example.com --release 6.0.0 --ssh-key keyname
-```
+The [base image repo](https://git.cloudron.io/cloudron/docker-base-image) is the parent image of all
+the containers in the Cloudron.
 
-## License
+The [graphite repo](https://git.cloudron.io/cloudron/docker-graphite) contains the graphite code
+that collects metrics for graphs.
 
-Please note that the Cloudron code is under a source-available license. This is not the same as an
-open source license but ensures the code is available for introspection (and hacking!).
+The addons are located in separate repositories
+* [Redis](https://git.cloudron.io/cloudron/redis-addon)
+* [Postgresql](https://git.cloudron.io/cloudron/postgresql-addon)
+* [MySQL](https://git.cloudron.io/cloudron/mysql-addon)
+* [Mongodb](https://git.cloudron.io/cloudron/mongodb-addon)
+* [Mail](https://git.cloudron.io/cloudron/mail-addon)
 
-## Contributions
+## Community
 
-Just to give some heads up, we are a bit restrictive in merging changes. We are a small team and
-would like to keep our maintenance burden low. It might be best to discuss features first in the [forum](https://forum.cloudron.io),
-to also figure out how many other people will use it to justify maintenance for a feature.
-
-## Support
-
-* [Documentation](https://docs.cloudron.io/)
-* [Forum](https://forum.cloudron.io/)
+* [Chat](https://chat.cloudron.io/)
+* [Support](mailto:support@cloudron.io)
 

VERSION

@@ -1 +0,0 @@
-# release version. do not edit manually

baseimage/createDOImage

@@ -0,0 +1,179 @@
+#!/bin/bash
+
+set -eu -o pipefail
+
+assertNotEmpty() {
+    : "${!1:? "$1 is not set."}"
+}
+
+readonly SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+readonly SOURCE_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")"/.. && pwd)"
+export JSON="${SOURCE_DIR}/node_modules/.bin/json"
+
+revision=$(git rev-parse HEAD)
+box_name=""
+server_id=""
+server_ip=""
+destroy_server="yes"
+deploy_env="dev"
+
+# Only GNU getopt supports long options. OS X comes bundled with the BSD getopt
+# brew install gnu-getopt to get the GNU getopt on OS X
+[[ $(uname -s) == "Darwin" ]] && GNU_GETOPT="/usr/local/opt/gnu-getopt/bin/getopt" || GNU_GETOPT="getopt"
+readonly GNU_GETOPT
+
+args=$(${GNU_GETOPT} -o "" -l "revision:,regions:,size:,name:,no-destroy,env:" -n "$0" -- "$@")
+eval set -- "${args}"
+
+while true; do
+    case "$1" in
+    --env) deploy_env="$2"; shift 2;;
+    --revision) revision="$2"; shift 2;;
+    --name) box_name="$2"; destroy_server="no"; shift 2;;
+    --no-destroy) destroy_server="no"; shift 2;;
+    --) break;;
+    *) echo "Unknown option $1"; exit 1;;
+    esac
+done
+
+echo "Creating digitalocean image"
+if [[ "${deploy_env}" == "staging" ]]; then
+    assertNotEmpty DIGITAL_OCEAN_TOKEN_STAGING
+    export DIGITAL_OCEAN_TOKEN="${DIGITAL_OCEAN_TOKEN_STAGING}"
+elif [[ "${deploy_env}" == "dev" ]]; then
+    assertNotEmpty DIGITAL_OCEAN_TOKEN_DEV
+    export DIGITAL_OCEAN_TOKEN="${DIGITAL_OCEAN_TOKEN_DEV}"
+elif [[ "${deploy_env}" == "prod" ]]; then
+    assertNotEmpty DIGITAL_OCEAN_TOKEN_PROD
+    export DIGITAL_OCEAN_TOKEN="${DIGITAL_OCEAN_TOKEN_PROD}"
+else
+    echo "No such env ${deploy_env}."
+    exit 1
+fi
+
+vps="/bin/bash ${SCRIPT_DIR}/digitalocean.sh"
+
+readonly ssh_keys="${HOME}/.ssh/id_rsa_caas_${deploy_env}"
+readonly scp202="scp -P 202 -o ConnectTimeout=10 -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no -i ${ssh_keys}"
+readonly scp22="scp -o ConnectTimeout=10 -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no -i ${ssh_keys}"
+
+readonly ssh202="ssh -p 202 -o IdentitiesOnly=yes -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no -i ${ssh_keys}"
+readonly ssh22="ssh -o IdentitiesOnly=yes -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no -i ${ssh_keys}"
+
+if [[ ! -f "${ssh_keys}" ]]; then
+    echo "caas ssh key is missing at ${ssh_keys} (pick it up from secrets repo)"
+    exit 1
+fi
+
+function get_pretty_revision() {
+    local git_rev="$1"
+    local sha1=$(git rev-parse --short "${git_rev}" 2>/dev/null)
+
+    echo "${sha1}"
+}
+
+now=$(date "+%Y-%m-%d-%H%M%S")
+pretty_revision=$(get_pretty_revision "${revision}")
+
+if [[ -z "${box_name}" ]]; then
+    # if you change this, change the regexp is appstore/janitor.js
+    box_name="box-${deploy_env}-${pretty_revision}-${now}" # remove slashes
+
+    # create a new server if no name given
+    if ! caas_ssh_key_id=$($vps get_ssh_key_id "caas"); then
+        echo "Could not query caas ssh key"
+        exit 1
+    fi
+    echo "Detected caas ssh key id: ${caas_ssh_key_id}"
+
+    echo "Creating Server with name [${box_name}]"
+    if ! server_id=$($vps create ${caas_ssh_key_id} ${box_name}); then
+        echo "Failed to create server"
+        exit 1
+    fi
+    echo "Created server with id: ${server_id}"
+
+    # If we run scripts overenthusiastically without the wait, setup script randomly fails
+    echo -n "Waiting 120 seconds for server creation"
+    for i in $(seq 1 24); do
+        echo -n "."
+        sleep 5
+    done
+    echo ""
+else
+    if ! server_id=$($vps get_id "${box_name}"); then
+        echo "Could not determine id from name"
+        exit 1
+    fi
+    echo "Reusing server with id: ${server_id}"
+
+    $vps power_on "${server_id}"
+fi
+
+# Query until we get an IP
+while true; do
+    echo "Trying to get the server IP"
+    if server_ip=$($vps get_ip "${server_id}"); then
+        echo "Server IP : [${server_ip}]"
+        break
+    fi
+    echo "Timedout, trying again in 10 seconds"
+    sleep 10
+done
+
+while true; do
+    echo "Trying to copy init script to server"
+    if $scp22 "${SCRIPT_DIR}/initializeBaseUbuntuImage.sh" root@${server_ip}:.; then
+        break
+    fi
+    echo "Timedout, trying again in 30 seconds"
+    sleep 30
+done
+
+echo "Copying infra_version.js"
+$scp22 "${SCRIPT_DIR}/../src/infra_version.js" root@${server_ip}:.
+
+echo "Copying box source"
+cd "${SOURCE_DIR}"
+git archive --format=tar HEAD | $ssh22 "root@${server_ip}" "cat - > /tmp/box.tar.gz"
+
+echo "Executing init script"
+if ! $ssh22 "root@${server_ip}" "/bin/bash /root/initializeBaseUbuntuImage.sh caas"; then
+    echo "Init script failed"
+    exit 1
+fi
+
+echo "Shutting down server with id : ${server_id}"
+$ssh22 "root@${server_ip}" "shutdown -f now" || true # shutdown sometimes terminates ssh connection immediately making this command fail
+
+# wait 10 secs for actual shutdown
+echo "Waiting for 10 seconds for server to shutdown"
+sleep 30
+
+echo "Powering off server"
+if ! $vps power_off "${server_id}"; then
+    echo "Could not power off server"
+    exit 1
+fi
+
+snapshot_name="box-${deploy_env}-${pretty_revision}-${now}"
+echo "Snapshotting as ${snapshot_name}"
+if ! image_id=$($vps snapshot "${server_id}" "${snapshot_name}"); then
+    echo "Could not snapshot and get image id"
+    exit 1
+fi
+
+if [[ "${destroy_server}" == "yes" ]]; then
+    echo "Destroying server"
+    if ! $vps destroy "${server_id}"; then
+        echo "Could not destroy server"
+        exit 1
+    fi
+else
+    echo "Skipping server destroy"
+fi
+
+echo "Transferring image ${image_id} to other regions"
+$vps transfer_image_to_all_regions "${image_id}"
+
+echo "Done."

baseimage/digitalocean.sh

@@ -29,7 +29,7 @@ function create_droplet() {
     local ssh_key_id="$1"
     local box_name="$2"
 
-    local image_region="sfo2"
+    local image_region="sfo1"
     local ubuntu_image_slug="ubuntu-16-04-x64"
     local box_size="1gb"
 

baseimage/initializeBaseUbuntuImage.sh

@@ -4,7 +4,8 @@ set -euv -o pipefail
 
 readonly SOURCE_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
 
-readonly arg_infraversionpath="${SOURCE_DIR}/../src"
+readonly arg_provider="${1:-generic}"
+readonly arg_infraversionpath="${SOURCE_DIR}/${2:-}"
 
 function die {
     echo $1
@@ -13,14 +14,8 @@ function die {
 
 export DEBIAN_FRONTEND=noninteractive
 
-readonly ubuntu_codename=$(lsb_release -cs)
-readonly ubuntu_version=$(lsb_release -rs)
-
-# hold grub since updating it breaks on some VPS providers. also, dist-upgrade will trigger it
-apt-mark hold grub* >/dev/null
 apt-get -o Dpkg::Options::="--force-confdef" update -y
-apt-get -o Dpkg::Options::="--force-confdef" upgrade -y
-apt-mark unhold grub* >/dev/null
+apt-get -o Dpkg::Options::="--force-confdef" dist-upgrade -y
 
 echo "==> Installing required packages"
 
@@ -28,81 +23,84 @@ debconf-set-selections <<< 'mysql-server mysql-server/root_password password pas
 debconf-set-selections <<< 'mysql-server mysql-server/root_password_again password password'
 
 # this enables automatic security upgrades (https://help.ubuntu.com/community/AutomaticSecurityUpdates)
-# resolvconf is needed for unbound to work property after disabling systemd-resolved in 18.04
-
-gpg_package=$([[ "${ubuntu_version}" == "16.04" ]] && echo "gnupg" || echo "gpg")
-mysql_package=$([[ "${ubuntu_version}" == "20.04" ]] && echo "mysql-server-8.0" || echo "mysql-server-5.7")
-apt-get -y install --no-install-recommends \
+apt-get -y install \
     acl \
-    apparmor \
+    awscli \
+    btrfs-tools \
     build-essential \
-    cifs-utils \
     cron \
     curl \
-    debconf-utils \
     dmsetup \
-    $gpg_package \
-    ipset \
     iptables \
-    libpython2.7 \
-    linux-generic \
     logrotate \
-    $mysql_package \
+    mysql-server-5.7 \
+    nginx-full \
     openssh-server \
     pwgen \
-    resolvconf \
+    rcconf \
     swaks \
-    tzdata \
     unattended-upgrades \
-    unbound \
-    unzip \
-    xfsprogs
-
-echo "==> installing nginx for xenial for TLSv3 support"
-curl -sL http://nginx.org/packages/ubuntu/pool/nginx/n/nginx/nginx_1.18.0-2~${ubuntu_codename}_amd64.deb -o /tmp/nginx.deb
-# apt install with install deps (as opposed to dpkg -i)
-apt install -y /tmp/nginx.deb
-rm /tmp/nginx.deb
-
-# on some providers like scaleway the sudo file is changed and we want to keep the old one
-apt-get -o Dpkg::Options::="--force-confold" install -y --no-install-recommends sudo
-
-# this ensures that unattended upgades are enabled, if it was disabled during ubuntu install time (see #346)
-# debconf-set-selection of unattended-upgrades/enable_auto_updates + dpkg-reconfigure does not work
-cp /usr/share/unattended-upgrades/20auto-upgrades /etc/apt/apt.conf.d/20auto-upgrades
+    unbound
 
 echo "==> Installing node.js"
-mkdir -p /usr/local/node-10.18.1
-curl -sL https://nodejs.org/dist/v10.18.1/node-v10.18.1-linux-x64.tar.gz | tar zxf - --strip-components=1 -C /usr/local/node-10.18.1
-ln -sf /usr/local/node-10.18.1/bin/node /usr/bin/node
-ln -sf /usr/local/node-10.18.1/bin/npm /usr/bin/npm
-apt-get install -y --no-install-recommends python   # Install python which is required for npm rebuild
+mkdir -p /usr/local/node-6.9.2
+curl -sL https://nodejs.org/dist/v6.9.2/node-v6.9.2-linux-x64.tar.gz | tar zxvf - --strip-components=1 -C /usr/local/node-6.9.2
+ln -sf /usr/local/node-6.9.2/bin/node /usr/bin/node
+ln -sf /usr/local/node-6.9.2/bin/npm /usr/bin/npm
+apt-get install -y python   # Install python which is required for npm rebuild
 [[ "$(python --version 2>&1)" == "Python 2.7."* ]] || die "Expecting python version to be 2.7.x"
 
 # https://docs.docker.com/engine/installation/linux/ubuntulinux/
 echo "==> Installing Docker"
+docker_key="-----BEGIN PGP PUBLIC KEY BLOCK-----
+Version: GnuPG v1
 
-# create systemd drop-in file. if you channge options here, be sure to fixup installer.sh as well
+mQINBFWln24BEADrBl5p99uKh8+rpvqJ48u4eTtjeXAWbslJotmC/CakbNSqOb9o
+ddfzRvGVeJVERt/Q/mlvEqgnyTQy+e6oEYN2Y2kqXceUhXagThnqCoxcEJ3+KM4R
+mYdoe/BJ/J/6rHOjq7Omk24z2qB3RU1uAv57iY5VGw5p45uZB4C4pNNsBJXoCvPn
+TGAs/7IrekFZDDgVraPx/hdiwopQ8NltSfZCyu/jPpWFK28TR8yfVlzYFwibj5WK
+dHM7ZTqlA1tHIG+agyPf3Rae0jPMsHR6q+arXVwMccyOi+ULU0z8mHUJ3iEMIrpT
+X+80KaN/ZjibfsBOCjcfiJSB/acn4nxQQgNZigna32velafhQivsNREFeJpzENiG
+HOoyC6qVeOgKrRiKxzymj0FIMLru/iFF5pSWcBQB7PYlt8J0G80lAcPr6VCiN+4c
+NKv03SdvA69dCOj79PuO9IIvQsJXsSq96HB+TeEmmL+xSdpGtGdCJHHM1fDeCqkZ
+hT+RtBGQL2SEdWjxbF43oQopocT8cHvyX6Zaltn0svoGs+wX3Z/H6/8P5anog43U
+65c0A+64Jj00rNDr8j31izhtQMRo892kGeQAaaxg4Pz6HnS7hRC+cOMHUU4HA7iM
+zHrouAdYeTZeZEQOA7SxtCME9ZnGwe2grxPXh/U/80WJGkzLFNcTKdv+rwARAQAB
+tDdEb2NrZXIgUmVsZWFzZSBUb29sIChyZWxlYXNlZG9ja2VyKSA8ZG9ja2VyQGRv
+Y2tlci5jb20+iQI4BBMBAgAiBQJVpZ9uAhsvBgsJCAcDAgYVCAIJCgsEFgIDAQIe
+AQIXgAAKCRD3YiFXLFJgnbRfEAC9Uai7Rv20QIDlDogRzd+Vebg4ahyoUdj0CH+n
+Ak40RIoq6G26u1e+sdgjpCa8jF6vrx+smpgd1HeJdmpahUX0XN3X9f9qU9oj9A4I
+1WDalRWJh+tP5WNv2ySy6AwcP9QnjuBMRTnTK27pk1sEMg9oJHK5p+ts8hlSC4Sl
+uyMKH5NMVy9c+A9yqq9NF6M6d6/ehKfBFFLG9BX+XLBATvf1ZemGVHQusCQebTGv
+0C0V9yqtdPdRWVIEhHxyNHATaVYOafTj/EF0lDxLl6zDT6trRV5n9F1VCEh4Aal8
+L5MxVPcIZVO7NHT2EkQgn8CvWjV3oKl2GopZF8V4XdJRl90U/WDv/6cmfI08GkzD
+YBHhS8ULWRFwGKobsSTyIvnbk4NtKdnTGyTJCQ8+6i52s+C54PiNgfj2ieNn6oOR
+7d+bNCcG1CdOYY+ZXVOcsjl73UYvtJrO0Rl/NpYERkZ5d/tzw4jZ6FCXgggA/Zxc
+jk6Y1ZvIm8Mt8wLRFH9Nww+FVsCtaCXJLP8DlJLASMD9rl5QS9Ku3u7ZNrr5HWXP
+HXITX660jglyshch6CWeiUATqjIAzkEQom/kEnOrvJAtkypRJ59vYQOedZ1sFVEL
+MXg2UCkD/FwojfnVtjzYaTCeGwFQeqzHmM241iuOmBYPeyTY5veF49aBJA1gEJOQ
+TvBR8Q==
+=Fm3p
+-----END PGP PUBLIC KEY BLOCK-----
+"
+echo "$docker_key" | apt-key add -
+echo "deb https://apt.dockerproject.org/repo ubuntu-xenial main" > /etc/apt/sources.list.d/docker.list
+apt-get -y update
+
+# create systemd drop-in file
 mkdir -p /etc/systemd/system/docker.service.d
-echo -e "[Service]\nExecStart=\nExecStart=/usr/bin/dockerd -H fd:// --log-driver=journald --exec-opt native.cgroupdriver=cgroupfs --storage-driver=overlay2" > /etc/systemd/system/docker.service.d/cloudron.conf
-
-# there are 3 packages for docker - containerd, CLI and the daemon
-curl -sL "https://download.docker.com/linux/ubuntu/dists/${ubuntu_codename}/pool/stable/amd64/containerd.io_1.2.13-2_amd64.deb" -o /tmp/containerd.deb
-curl -sL "https://download.docker.com/linux/ubuntu/dists/${ubuntu_codename}/pool/stable/amd64/docker-ce-cli_19.03.12~3-0~ubuntu-${ubuntu_codename}_amd64.deb" -o /tmp/docker-ce-cli.deb
-curl -sL "https://download.docker.com/linux/ubuntu/dists/${ubuntu_codename}/pool/stable/amd64/docker-ce_19.03.12~3-0~ubuntu-${ubuntu_codename}_amd64.deb" -o /tmp/docker.deb
-# apt install with install deps (as opposed to dpkg -i)
-apt install -y /tmp/containerd.deb  /tmp/docker-ce-cli.deb /tmp/docker.deb
-rm /tmp/containerd.deb /tmp/docker-ce-cli.deb /tmp/docker.deb
+echo -e "[Service]\nExecStart=\nExecStart=/usr/bin/dockerd -H fd:// --log-driver=journald --exec-opt native.cgroupdriver=cgroupfs --storage-driver=devicemapper" > /etc/systemd/system/docker.service.d/cloudron.conf
 
+apt-get -y --allow-downgrades install docker-engine=1.12.5-0~ubuntu-xenial # apt-cache madison docker-engine
+apt-mark hold docker-engine # do not update docker
 storage_driver=$(docker info | grep "Storage Driver" | sed 's/.*: //')
-if [[ "${storage_driver}" != "overlay2" ]]; then
-    echo "Docker is using "${storage_driver}" instead of overlay2"
+if [[ "${storage_driver}" != "devicemapper" ]]; then
+    echo "Docker is using "${storage_driver}" instead of devicemapper"
     exit 1
 fi
 
-# do not upgrade grub because it might prompt user and break this script
 echo "==> Enable memory accounting"
-apt-get -y --no-upgrade --no-install-recommends install grub2-common
+apt-get -y install grub2
 sed -e 's/^GRUB_CMDLINE_LINUX="\(.*\)"$/GRUB_CMDLINE_LINUX="\1 cgroup_enable=memory swapaccount=1 panic_on_oops=1 panic=5"/' -i /etc/default/grub
 update-grub
 
@@ -112,63 +110,17 @@ if [ ! -f "${arg_infraversionpath}/infra_version.js" ]; then
     exit 1
 fi
 
-images=$(node -e "var i = require('${arg_infraversionpath}/infra_version.js'); console.log(i.baseImages.map(function (x) { return x.tag; }).join(' '), Object.keys(i.images).map(function (x) { return i.images[x].tag; }).join(' '));")
+images=$(node -e "var i = require('${arg_infraversionpath}/infra_version.js'); console.log(i.baseImages.join(' '), Object.keys(i.images).map(function (x) { return i.images[x].tag; }).join(' '));")
 
 echo -e "\tPulling docker images: ${images}"
 for image in ${images}; do
     docker pull "${image}"
-    docker pull "${image%@sha256:*}" # this will tag the image for readability
 done
 
 echo "==> Install collectd"
-# without this, libnotify4 will install gnome-shell
-apt-get install -y libnotify4 --no-install-recommends
-if ! apt-get install -y --no-install-recommends libcurl3-gnutls collectd collectd-utils; then
+if ! apt-get install -y collectd collectd-utils; then
     # FQDNLookup is true in default debian config. The box code has a custom collectd.conf that fixes this
     echo "Failed to install collectd. Presumably because of http://mailman.verplant.org/pipermail/collectd/2015-March/006491.html"
     sed -e 's/^FQDNLookup true/FQDNLookup false/' -i /etc/collectd/collectd.conf
 fi
-# https://bugs.launchpad.net/ubuntu/+source/collectd/+bug/1872281
-[[ "${ubuntu_version}" == "20.04" ]] && echo -e "\nLD_PRELOAD=/usr/lib/python3.8/config-3.8-x86_64-linux-gnu/libpython3.8.so" >> /etc/default/collectd
 
-# some hosts like atlantic install ntp which conflicts with timedatectl. https://serverfault.com/questions/1024770/ubuntu-20-04-time-sync-problems-and-possibly-incorrect-status-information
-echo "==> Configuring host"
-sed -e 's/^#NTP=/NTP=0.ubuntu.pool.ntp.org 1.ubuntu.pool.ntp.org 2.ubuntu.pool.ntp.org 3.ubuntu.pool.ntp.org/' -i /etc/systemd/timesyncd.conf
-if systemctl is-active ntp; then
-    systemctl stop ntp
-    apt purge -y ntp
-fi
-timedatectl set-ntp 1
-# mysql follows the system timezone
-timedatectl set-timezone UTC
-
-echo "==> Adding sshd configuration warning"
-sed -e '/Port 22/ i # NOTE: Cloudron only supports moving SSH to port 202. See https://docs.cloudron.io/security/#securing-ssh-access' -i /etc/ssh/sshd_config
-
-# https://bugs.launchpad.net/ubuntu/+source/base-files/+bug/1701068
-echo "==> Disabling motd news"
-if [ -f "/etc/default/motd-news" ]; then
-    sed -i 's/^ENABLED=.*/ENABLED=0/' /etc/default/motd-news
-fi
-
-# Disable bind for good measure (on online.net, kimsufi servers these are pre-installed)
-systemctl stop bind9 || true
-systemctl disable bind9 || true
-
-# on ovh images dnsmasq seems to run by default
-systemctl stop dnsmasq || true
-systemctl disable dnsmasq || true
-
-# on ssdnodes postfix seems to run by default
-systemctl stop postfix || true
-systemctl disable postfix || true
-
-# on ubuntu 18.04 and 20.04, this is the default. this requires resolvconf for DNS to work further after the disable
-systemctl stop systemd-resolved || true
-systemctl disable systemd-resolved || true
-
-# ubuntu's default config for unbound does not work if ipv6 is disabled. this config is overwritten in start.sh
-# we need unbound to work as this is required for installer.sh to do any DNS requests
-ip6=$([[ -s /proc/net/if_inet6 ]] && echo "yes" || echo "no")
-echo -e "server:\n\tinterface: 127.0.0.1\n\tdo-ip6: ${ip6}" > /etc/unbound/unbound.conf.d/cloudron-network.conf
-systemctl restart unbound

box.js

@@ -2,65 +2,55 @@
 
 'use strict';
 
-let async = require('async'),
-    dockerProxy = require('./src/dockerproxy.js'),
-    fs = require('fs'),
+require('supererror')({ splatchError: true });
+
+// remove timestamp from debug() based output
+require('debug').formatArgs = function formatArgs(args) {
+    args[0] = this.namespace + ' ' + args[0];
+};
+
+var appHealthMonitor = require('./src/apphealthmonitor.js'),
+    async = require('async'),
+    config = require('./src/config.js'),
     ldap = require('./src/ldap.js'),
-    paths = require('./src/paths.js'),
-    proxyAuth = require('./src/proxyauth.js'),
     server = require('./src/server.js');
 
-const NOOP_CALLBACK = function () { };
-
-function setupLogging(callback) {
-    if (process.env.BOX_ENV === 'test') return callback();
-
-    var logfileStream = fs.createWriteStream(paths.BOX_LOG_FILE, { flags:'a' });
-    process.stdout.write = process.stderr.write = logfileStream.write.bind(logfileStream);
-
-    callback();
-}
+console.log();
+console.log('==========================================');
+console.log(' Cloudron will use the following settings ');
+console.log('==========================================');
+console.log();
+console.log(' Environment:                    ', config.CLOUDRON ? 'CLOUDRON' : 'TEST');
+console.log(' Version:                        ', config.version());
+console.log(' Admin Origin:                   ', config.adminOrigin());
+console.log(' Appstore API server origin:     ', config.apiServerOrigin());
+console.log(' Appstore Web server origin:     ', config.webServerOrigin());
+console.log();
+console.log('==========================================');
+console.log();
 
 async.series([
-    setupLogging,
-    server.start, // do this first since it also inits the database
-    proxyAuth.start,
+    server.start,
     ldap.start,
-    dockerProxy.start
+    appHealthMonitor.start,
 ], function (error) {
     if (error) {
-        console.log('Error starting server', error);
+        console.error('Error starting server', error);
         process.exit(1);
     }
-
-    // require those here so that logging handler is already setup
-    require('supererror');
-    const debug = require('debug')('box:box');
-
-    process.on('SIGINT', function () {
-        debug('Received SIGINT. Shutting down.');
-
-        proxyAuth.stop(NOOP_CALLBACK);
-        server.stop(NOOP_CALLBACK);
-        ldap.stop(NOOP_CALLBACK);
-        dockerProxy.stop(NOOP_CALLBACK);
-        setTimeout(process.exit.bind(process), 3000);
-    });
-
-    process.on('SIGTERM', function () {
-        debug('Received SIGTERM. Shutting down.');
-
-        proxyAuth.stop(NOOP_CALLBACK);
-        server.stop(NOOP_CALLBACK);
-        ldap.stop(NOOP_CALLBACK);
-        dockerProxy.stop(NOOP_CALLBACK);
-        setTimeout(process.exit.bind(process), 3000);
-    });
-
-    process.on('uncaughtException', function (error) {
-        console.error((error && error.stack) ? error.stack : error);
-        setTimeout(process.exit.bind(process, 1), 3000);
-    });
-
-    console.log(`Cloudron is up and running. Logs are at ${paths.BOX_LOG_FILE}`); // this goes to journalctl
+    console.log('Cloudron is up and running');
+});
+
+var NOOP_CALLBACK = function () { };
+
+process.on('SIGINT', function () {
+    server.stop(NOOP_CALLBACK);
+    ldap.stop(NOOP_CALLBACK);
+    setTimeout(process.exit.bind(process), 3000);
+});
+
+process.on('SIGTERM', function () {
+    server.stop(NOOP_CALLBACK);
+    ldap.stop(NOOP_CALLBACK);
+    setTimeout(process.exit.bind(process), 3000);
 });

crashnotifierservice.js

@@ -2,27 +2,15 @@
 
 'use strict';
 
-var database = require('./src/database.js');
+var sendFailureLogs = require('./src/logcollector').sendFailureLogs;
 
-var crashNotifier = require('./src/crashnotifier.js');
-
-// This is triggered by systemd with the crashed unit name as argument
 function main() {
-    if (process.argv.length !== 3) return console.error('Usage: crashnotifier.js <unitName>');
+    if (process.argv.length !== 3) return console.error('Usage: crashnotifier.js <processName>');
 
-    var unitName = process.argv[2];
-    console.log('Started crash notifier for', unitName);
+    var processName = process.argv[2];
+    console.log('Started crash notifier for', processName);
 
-    // eventlog api needs the db
-    database.initialize(function (error) {
-        if (error) return console.error('Cannot connect to database. Unable to send crash log.', error);
-
-        crashNotifier.sendFailureLogs(unitName, function (error) {
-            if (error) console.error(error);
-
-            process.exit();
-        });
-    });
+    sendFailureLogs(processName, { unit: processName });
 }
 
 main();

docs/references/addons.md

@@ -0,0 +1,320 @@
+# Overview
+
+Addons are services like database, authentication, email, caching that are part of the
+Cloudron runtime. Setup, provisioning, scaling and maintanence of addons is taken care of
+by the runtime.
+
+The fundamental idea behind addons is to allow sharing of Cloudron resources across applications.
+For example, a single MySQL server instance can be used across multiple apps. The Cloudron
+runtime sets up addons in such a way that apps are isolated from each other.
+
+# Using Addons
+
+Addons are opt-in and must be specified in the [Cloudron Manifest](/references/manifest.html).
+When the app runs, environment variables contain the necessary information to access the addon.
+For example, the mysql addon sets the `MYSQL_URL` environment variable which is the
+connection string that can be used to connect to the database.
+
+When working with addons, developers need to remember the following:
+* Environment variables are subject to change every time the app restarts. This can happen if the
+Cloudron is rebooted or restored or the app crashes or an addon is re-provisioned. For this reason,
+applications must never cache the value of environment variables across restarts.
+
+* Addons must be setup or updated on each application start up. Most applications use DB migration frameworks
+for this purpose to setup and update the DB schema.
+
+* Addons are configured in the [addons section](/references/manifest.html#addons) of the manifest as below:
+```
+    {
+      ...
+      "addons": {
+        "oauth": { },
+        "redis" : { }
+      }
+    }
+```
+
+# All addons
+
+## email
+
+This addon allows an app to send and recieve emails on behalf of the user. The intended use case is webmail applications.
+
+If an app wants to send mail (e.g notifications), it must use the [sendmail](/references/addons#sendmail)
+addon. If the app wants to receive email (e.g user replying to notification), it must use the
+[recvmail](/references/addons#recvmail) addon instead.
+
+Apps using the IMAP and ManageSieve services below must be prepared to accept self-signed certificates (this is not a problem
+because these are addresses internal to the Cloudron).
+
+Exported environment variables:
+```
+MAIL_SMTP_SERVER=       # SMTP server IP or hostname. Supports STARTTLS (TLS upgrade is enforced).
+MAIL_SMTP_PORT=         # SMTP server port
+MAIL_IMAP_SERVER=       # IMAP server IP or hostname. TLS required.
+MAIL_IMAP_PORT=         # IMAP server port
+MAIL_SIEVE_SERVER=      # ManageSieve server IP or hostname. TLS required.
+MAIL_SIEVE_PORT=        # ManageSieve server port
+MAIL_DOMAIN=            # Domain of the mail server
+```
+
+## ldap
+
+This addon provides LDAP based authentication via LDAP version 3.
+
+Exported environment variables:
+```
+LDAP_SERVER=                                # ldap server IP
+LDAP_PORT=                                  # ldap server port
+LDAP_URL=                                   # ldap url of the form ldap://ip:port
+LDAP_USERS_BASE_DN=                         # ldap users base dn of the form ou=users,dc=cloudron
+LDAP_GROUPS_BASE_DN=                        # ldap groups base dn of the form ou=groups,dc=cloudron
+LDAP_BIND_DN=                               # DN to perform LDAP requests
+LDAP_BIND_PASSWORD=                         # Password to perform LDAP requests
+```
+
+For debugging, [cloudron exec](https://www.npmjs.com/package/cloudron) can be used to run the `ldapsearch` client within the context of the app:
+```
+cloudron exec
+
+# list users
+> ldapsearch -x -h "${LDAP_SERVER}" -p "${LDAP_PORT}" -b  "${LDAP_USERS_BASE_DN}"
+
+# list users with authentication (Substitute username and password below)
+> ldapsearch -x -D cn=<username>,${LDAP_USERS_BASE_DN} -w <password> -h "${LDAP_SERVER}" -p "${LDAP_PORT}" -b  "${LDAP_USERS_BASE_DN}"
+
+# list admins
+> ldapsearch -x -h "${LDAP_SERVER}" -p "${LDAP_PORT}" -b  "${LDAP_USERS_BASE_DN}" "memberof=cn=admins,${LDAP_GROUPS_BASE_DN}"
+
+# list groups
+> ldapsearch -x -h "${LDAP_SERVER}" -p "${LDAP_PORT}" -b  "${LDAP_GROUPS_BASE_DN}"
+```
+
+## localstorage
+
+Since all Cloudron apps run within a read-only filesystem, this addon provides a writeable folder under `/app/data/`.
+All contents in that folder are included in the backup. On first run, this folder will be empty. File added in this path
+as part of the app's image (Dockerfile) won't be present. A common pattern is to create the directory structure required
+the app as part of the app's startup script.
+
+The permissions and ownership of data within that directory are not guranteed to be preserved. For this reason, each app
+has to restore permissions as required by the app as part of the app's startup script.
+
+If the app is running under the recommeneded `cloudron` user, this can be achieved with:
+```
+chown -R cloudron:cloudron /app/data
+```
+
+## mongodb
+
+By default, this addon provide mongodb 2.6.3.
+
+Exported environment variables:
+```
+MONGODB_URL=          # mongodb url
+MONGODB_USERNAME=     # username
+MONGODB_PASSWORD=     # password
+MONGODB_HOST=         # server IP/hostname
+MONGODB_PORT=         # server port
+MONGODB_DATABASE=     # database name
+```
+
+For debugging, [cloudron exec](https://www.npmjs.com/package/cloudron) can be used to run the `mongo` shell within the context of the app:
+```
+cloudron exec
+
+# mongo -u "${MONGODB_USERNAME}" -p "${MONGODB_PASSWORD}" ${MONGODB_HOST}:${MONGODB_PORT}/${MONGODB_DATABASE}
+
+```
+## mysql
+
+By default, this addon provides a single database on MySQL 5.6.19. The database is already created and the application
+only needs to create the tables.
+
+Exported environment variables:
+```
+MYSQL_URL=            # the mysql url (only set when using a single database, see below)
+MYSQL_USERNAME=       # username
+MYSQL_PASSWORD=       # password
+MYSQL_HOST=           # server IP/hostname
+MYSQL_PORT=           # server port
+MYSQL_DATABASE=       # database name (only set when using a single database, see below)
+```
+
+For debugging, [cloudron exec](https://www.npmjs.com/package/cloudron) can be used to run the `mysql` client within the context of the app:
+```
+cloudron exec
+
+> mysql --user=${MYSQL_USERNAME} --password=${MYSQL_PASSWORD} --host=${MYSQL_HOST} ${MYSQL_DATABASE}
+
+```
+
+The `multipleDatabases` option can be set to `true` if the app requires more than one database. When enabled,
+the following environment variables are injected:
+
+```
+MYSQL_DATABASE_PREFIX=      # prefix to use to create databases
+```
+
+## oauth
+
+The Cloudron OAuth 2.0 provider can be used in an app to implement Single Sign-On.
+
+Exported environment variables:
+```
+OAUTH_CLIENT_ID=      # client id
+OAUTH_CLIENT_SECRET=  # client secret
+```
+
+The callback url required for the OAuth transaction can be contructed from the environment variables below:
+
+```
+APP_DOMAIN=           # hostname of the app
+APP_ORIGIN=           # origin of the app of the form https://domain
+API_ORIGIN=      # origin of the OAuth provider of the form https://my-cloudrondomain
+```
+
+OAuth2 URLs can be constructed as follows:
+
+```
+AuthorizationURL = ${API_ORIGIN}/api/v1/oauth/dialog/authorize # see above for API_ORIGIN
+TokenURL = ${API_ORIGIN}/api/v1/oauth/token
+```
+
+The token obtained via OAuth has a restricted scope wherein they can only access the [profile API](/references/api.html#profile). This restriction
+is so that apps cannot make undesired changes to the user's Cloudron.
+
+We currently provide OAuth2 integration for Ruby [omniauth](https://github.com/cloudron-io/omniauth-cloudron) and Node.js [passport](https://github.com/cloudron-io/passport-cloudron).
+
+## postgresql
+
+By default, this addon provides PostgreSQL 9.4.4.
+
+Exported environment variables:
+```
+POSTGRESQL_URL=       # the postgresql url
+POSTGRESQL_USERNAME=  # username
+POSTGRESQL_PASSWORD=  # password
+POSTGRESQL_HOST=      # server name
+POSTGRESQL_PORT=      # server port
+POSTGRESQL_DATABASE=  # database name
+```
+
+The postgresql addon whitelists the hstore and pg_trgm extensions to be installable by the database owner.
+
+For debugging, [cloudron exec](https://www.npmjs.com/package/cloudron) can be used to run the `psql` client within the context of the app:
+```
+cloudron exec
+
+> PGPASSWORD=${POSTGRESQL_PASSWORD} psql -h ${POSTGRESQL_HOST} -p ${POSTGRESQL_PORT} -U ${POSTGRESQL_USERNAME} -d ${POSTGRESQL_DATABASE}
+```
+
+## recvmail
+
+The recvmail addon can be used to receive email for the application.
+
+Exported environment variables:
+```
+MAIL_IMAP_SERVER=     # the IMAP server. this can be an IP or DNS name
+MAIL_IMAP_PORT=       # the IMAP server port
+MAIL_IMAP_USERNAME=   # the username to use for authentication
+MAIL_IMAP_PASSWORD=   # the password to use for authentication
+MAIL_TO=              # the "To" address to use
+MAIL_DOMAIN=          # the mail for which email will be received
+```
+
+The IMAP server only accepts TLS connections. The app must be prepared to accept self-signed certs (this is not a problem because the
+imap address is internal to the Cloudron).
+
+For debugging, [cloudron exec](https://www.npmjs.com/package/cloudron) can be used to run the `openssl` tool within the context of the app:
+```
+cloudron exec
+
+> openssl s_client -connect "${MAIL_IMAP_SERVER}:${MAIL_IMAP_PORT}" -crlf
+```
+
+The IMAP command `? LOGIN username password` can then be used to test the authentication.
+
+## redis
+
+By default, this addon provides redis 2.8.13. The redis is configured to be persistent and data is preserved across updates
+and restarts.
+
+Exported environment variables:
+```
+REDIS_URL=            # the redis url
+REDIS_HOST=           # server name
+REDIS_PORT=           # server port
+REDIS_PASSWORD=       # password
+```
+
+For debugging, [cloudron exec](https://www.npmjs.com/package/cloudron) can be used to run the `redis-cli` client within the context of the app:
+```
+cloudron exec
+
+> redis-cli -h "${REDIS_HOST}" -p "${REDIS_PORT}" -a "${REDIS_PASSWORD}"
+```
+
+## scheduler
+
+The scheduler addon can be used to run tasks at periodic intervals (cron).
+
+Scheduler can be configured as below:
+```
+    "scheduler": {
+        "update_feeds": {
+            "schedule": "*/5 * * * *",
+            "command": "/app/code/update_feed.sh"
+        }
+    }
+```
+
+In the above example, `update_feeds` is the name of the task and is an arbitrary string.
+
+`schedule` values must fall within the following ranges:
+
+ * Minutes: 0-59
+ * Hours: 0-23
+ * Day of Month: 1-31
+ * Months: 0-11
+ * Day of Week: 0-6
+
+_NOTE_: scheduler does not support seconds
+
+`schedule` supports ranges (like standard cron):
+
+ * Asterisk. E.g. *
+ * Ranges. E.g. 1-3,5
+ * Steps. E.g. */2
+
+`command` is executed through a shell (sh -c). The command runs in the same launch environment
+as the application. Environment variables, volumes (`/tmp` and `/run`) are all
+shared with the main application.
+
+If a task is still running when a new instance of the task is scheduled to be started, the previous
+task instance is killed.
+
+
+## sendmail
+
+The sendmail addon can be used to send email from the application.
+
+Exported environment variables:
+```
+MAIL_SMTP_SERVER=     # the mail server (relay) that apps can use. this can be an IP or DNS name
+MAIL_SMTP_PORT=       # the mail server port
+MAIL_SMTP_USERNAME=   # the username to use for authentication as well as the `from` username when sending emails
+MAIL_SMTP_PASSWORD=   # the password to use for authentication
+MAIL_FROM=            # the "From" address to use
+MAIL_DOMAIN=          # the domain name to use for email sending (i.e username@domain)
+```
+
+The SMTP server does not require STARTTLS. If STARTTLS is used, the app must be prepared to accept self-signed certs.
+
+For debugging, [cloudron exec](https://www.npmjs.com/package/cloudron) can be used to run the `swaks` tool within the context of the app:
+```
+cloudron exec
+
+> swaks --server "${MAIL_SMTP_SERVER}" -p "${MAIL_SMTP_PORT}" --from "${MAIL_SMTP_USERNAME}@${MAIL_DOMAIN}" --body "Test mail from cloudron app at $(hostname -f)" --auth-user "${MAIL_SMTP_USERNAME}" --auth-password "${MAIL_SMTP_PASSWORD}"
+```
+

docs/references/architecture.md

@@ -0,0 +1,88 @@
+# Introduction
+
+The Cloudron platform is designed to easily install and run web applications.
+The application architecture is designed to let the Cloudron take care of system 
+operations like updates, backups, firewalls, domain management, certificate management
+etc. This allows app developers to focus on their application logic instead of deployment.
+
+At a high level, an application provides an `image` and a `manifest`. The image is simply
+a docker image that is a bundle of the application code and it's dependencies.  The manifest 
+file specifies application runtime requirements like database type and authentication scheme.
+It also provides meta information for display purposes in the [Cloudron Store](/appstore.html) 
+like the title, icon and pricing.
+
+Web applications like blogs, wikis, password managers, code hosting, document editing, 
+file syncers, notes, email, forums are a natural fit for the Cloudron. Decentralized "social" 
+networks are also good app candidates for the Cloudron.
+
+# Image
+
+Application images are created using [Docker](https://www.docker.io). Docker provides a way
+to package (and containerize) the application as a filesystem which contains it's code, system libraries 
+and just about anything the app requires. This flexible approach allows the application to use just 
+about any language or framework.
+
+Application images are instantiated as `containers`. Cloudron can run one or more isolated instances
+of the same application as one or more containers.
+
+Containerizing your application provides the following benefits:
+* Apps run in the familiar environment that they were packaged for and can have libraries
+and packages that are independent of the host OS.
+* Containers isolate applications from one another.
+
+The [base image](/references/baseimage.html) is the parent of all app images.
+
+# Cloudron Manifest
+
+Each app provides a `CloudronManifest.json` that specifies information required for the
+`Cloudron Store` and for the installation of the image in the Cloudron.
+
+Information required for container installation includes:
+* List of `addons` like databases, caches, authentication mechanisms and file systems
+* The http port on which the container is listening for incoming requests
+* Additional TCP ports on which the application is listening to (for e.g., git, ssh,
+irc protocols)
+
+Information required for the Cloudron Store includes:
+* Unique App Id
+* Title
+* Version
+* Logo
+
+See the [manifest reference](/references/manifest.html) for more information.
+
+# Addons
+
+Addons are services like database, authentication, email, caching that are part of the
+Cloudron. Setup, provisioning, scaling and maintenance of addons is taken care of by the
+Cloudron.
+
+The fundamental idea behind addons is to allow resource sharing across applications.
+For example, a single MySQL server instance can be used across multiple apps. The Cloudron
+sets up addons in such a way that apps are isolated from each other.
+
+Addons are opt-in and must be specified in the Cloudron Manifest. When the app runs, environment
+variables contain the necessary information to access the addon. See the
+[addon reference](/references/addons.html) for more information.
+
+# Authentication
+
+The Cloudron provides a centralized dashboard to manage users, roles and permissions. Applications
+do not create or manage user credentials on their own and instead use one of the various
+authentication strategies provided by the Cloudron.
+
+Authentication strategies include OAuth 2.0, LDAP or Simple Auth. See the
+[Authentication Reference](/references/authentication.html) for more information.
+
+Authorizing users is application specific and it is only authentication that is delegated to the
+Cloudron.
+
+# Cloudron Store
+
+Cloudron Store provides a market place to publish and optionally monetize your app. Submitting to the
+Cloudron Store enables any Cloudron user to discover, purchase and install your application with
+a few clicks.
+
+# What next?
+
+* [Package an existing app for the Cloudron](/tutorials/packaging.html)

docs/references/authentication.md

@@ -0,0 +1,105 @@
+# Overview
+
+Cloudron provides a centralized dashboard to manage users, roles and permissions. Applications
+do not create or manage user credentials on their own and instead use one of the various
+authentication strategies provided by the Cloudron.
+
+Note that authentication only identifies a user and does not indicate if the user is authorized
+to perform an action in the application. Authorizing users is application specific and must be
+implemented by the application.
+
+# Users & Admins
+
+Cloudron user management is intentionally very simple. The owner (first user) of the
+Cloudron is `admin` by default. The `admin` role allows one to install, uninstall and reconfigure
+applications on the Cloudron.
+
+A Cloudron `admin` can create one or more users. Cloudron users can login and use any of the installed
+apps in the Cloudron. In general, adding a cloudron user is akin to adding a person from one's family
+or organization or team because such users gain access to all apps in the Cloudron. Removing a user
+immediately revokes access from all apps.
+
+A Cloudron `admin` can give admin privileges to one or more Cloudron users.
+
+Each Cloudron user has an unique `username` and an `email`.
+
+# Strategies
+
+Cloudron provides multiple authentication strategies.
+
+* OAuth 2.0 provided by the [OAuth addon](/references/addons.html#oauth)
+* LDAP provided by the [LDAP addon](/references/addons.html#ldap)
+
+# Choosing a strategy
+
+Applications can be broadly categorized based on their user management as follows:
+
+* Multi-user aware
+  * Such apps have a full fledged user system and support multiple users and groups.
+  * These apps should use OAuth or LDAP.
+  * LDAP and OAuth APIs allow apps to detect if the user is a cloudron `admin`. Apps should use this flag
+    to show the application's admin panel for such users.
+
+
+* No user
+  * Such apps have no concept of logged-in user.
+
+* Single user
+  * Such apps only have a single user who is usually also the `admin`.
+  * These apps can use Simple Auth or LDAP since they can authenticate users with a simple HTTP or LDAP request.
+  * Such apps _must_ set the `singleUser` property in the manifest which will restrict login to a single user
+    (configurable through the Cloudron's admin panel).
+
+# Public and Private apps
+
+`Private` apps display content only when they have a signed-in user. These apps can choose one of the
+authentication strategies listed above.
+
+`Public` apps display content to any visiting user (e.g a blog). These apps have a `login` url to allow
+the editors & admins to login. This path can be optionally set as the `configurePath` in the manifest for
+discoverability (for example, some blogs hide the login link).
+
+Some apps allow the user to choose `private` or `public` mode or some other combination. Such configuration
+is done at app install time and cannot be changed using a settings interface. It is tempting to show the user
+a configuration dialog on first installation to switch the modes. This, however, leads the user to believe that
+this configuration can be changed at any time later. In the case where this setting can be changed dynamically
+from a settings ui in the app, it's better to simply put some sensible defaults and let the user discover
+the settings. In the case where such settings cannot be changed dynamically, it is best to simply publish two
+separate apps in the Cloudron store each with a different configuration.
+
+# External User Registration
+
+Some apps allow external users to register and create accounts. For example, a public company chat that
+can invite anyone to join or a blog allowing registered commenters.
+
+Such applications must track Cloudron users and external registered users independently (for example, using a flag).
+As a thumb rule, apps must provide separate login buttons for each of the possible user sources. Such a design prevents
+external users from (inadvertently) spoofing Cloudron users.
+
+Naively handling user registration enables attacks of the following kind:
+* An external user named `foo` registers in the app.
+* A LDAP user named `foo` is later created on the Cloudron.
+* When a user named `foo` logs in, the app cannot determine the correct `foo` anymore. Making separate login buttons for each
+login source clears the confusion for both the user and the app.
+
+# Userid
+
+The preferred approach to track users in an application is a uuid or the Cloudron `username`.
+The `username` in Cloudron is unique and cannot be changed.
+
+Tracking users using `email` field is error prone since that may be changed by the user anytime.
+
+# Single Sign-on
+
+Single sign-on (SSO) is a property where a user logged in one application automatically logs into
+another application without having to re-enter his credentials. When applications implement the
+OAuth strategy, they automatically take part in Cloudron SSO. When a user signs in one application with
+OAuth, they will automatically log into any other app implementing OAuth.
+
+Conversely, signing off from one app, logs them off from all the apps.
+
+# Security
+
+The LDAP and Simple Auth strategies require the user to provide their plain text passwords to the
+application. This might be a cause of concern and app developers are thus highly encouraged to integrate
+with OAuth. OAuth also has the advantage of supporting Single Sign On.

docs/references/baseimage.md

@@ -0,0 +1,94 @@
+# Overview
+
+The application's Dockerfile must specify the FROM base image to be `cloudron/base:0.10.0`.
+
+The base image already contains most popular software packages including node, nginx, apache,
+ruby, PHP. Using the base image greatly reduces the size of app images.
+
+The goal of the base image is simply to provide pre-downloaded software packages. The packages
+are not configured in any way and it's up to the application to configure them as they choose.
+For example, while `apache` is installed, there are no meaningful site configurations that the
+application can use.
+
+# Packages
+
+The following packages are part of the base image. If you need another version, you will have to
+install it yourself.
+
+* Apache 2.4.18
+* Composer 1.2.0
+* Go 1.6.4, 1.7.5 (install under `/usr/local/go-<version>`)
+* Gunicorn 19.4.5
+* Java 1.8
+* Maven 3.3.9
+* Mongo 2.6.10
+* MySQL Client 5.7.17
+* nginx 1.10.0
+* Node 0.10.48, 0.12.18, 4.7.3, 6.9.5 (installed under `/usr/local/node-<version>`) [more information](#node-js)
+* Perl 5.22.1
+* PHP 7.0.13
+* Postgresql client 9.5.4
+* Python 2.7.12
+* Redis 3.0.6
+* Ruby 2.3.1
+* sqlite3 3.11.0
+* Supervisor 3.2.0
+* uwsgi 2.0.12
+
+# Inspecting the base image
+
+The base image can be inspected by installing [Docker](https://docs.docker.com/installation/).
+
+Once installed, pull down the base image locally using the following command:
+```
+    docker pull cloudron/base:0.10.0
+```
+
+To inspect the base image:
+```
+    docker run -ti cloudron/base:0.10.0 /bin/bash
+```
+
+*Note:* Please use `docker 1.9.0` or above to pull the base image. Doing otherwise results in a base
+image with an incorrect image id. The image id of `cloudron/base:0.10.0` is `5ec8ca8525be`.
+
+# The `cloudron` user
+
+The base image contains a user named `cloudron` that apps can use to run their app.
+
+It is good security practice to run apps as a non-previleged user.
+
+# Env vars
+
+The following environment variables are set as part of the application runtime.
+
+## API_ORIGIN
+
+API_ORIGIN is set to the HTTP(S) origin of this Cloudron's API. For example,
+`https://my-girish.cloudron.us`.
+
+## APP_DOMAIN
+
+APP_DOMAIN is set to the domain name of the application. For example, `app-girish.cloudron.us`.
+
+## APP_ORIGIN
+
+APP_ORIGIN is set to the HTTP(S) origin on the application. This is origin which the
+user can use to reach the application. For example, `https://app-girish.cloudron.us`.
+
+## CLOUDRON
+
+CLOUDRON is always set to '1'. This is useful to write Cloudron specific code.
+
+## WEBADMIN_ORIGIN
+
+WEBADMIN_ORIGIN is set to the HTTP(S) origin of the Cloudron's web admin. For example,
+`https://my-girish.cloudron.us`.
+
+# Node.js
+
+The base image comes pre-installed with various node.js versions.
+
+They can be used by adding `ENV PATH /usr/local/node-<version>/bin:$PATH`.
+
+See [Packages](/references/baseimage.html#packages) for available versions.

docs/references/bestpractices.md

@@ -0,0 +1,93 @@
+# Best practices
+
+## Overview
+
+This document explains the spirit of what makes a Cloudron app.
+
+## No Setup
+
+Cloudron apps do not show a setup screen after installation and should choose reasonable
+defaults.
+
+Databases, email configuration should be automatically picked up using [addons](/references/addons.html).
+
+Admin role for the application can be detected dynamically using one of the [authentication](/references/authentication.html)
+strategies.
+
+## Image
+
+The Dockerfile contains a specification for building an application image.
+
+  * Install any required software packages in the Dockerfile.
+
+  * Create static configuration files in the Dockerfile.
+
+  * Create symlinks to dynamic configuration files under `/run` in the Dockerfile.
+
+  * Docker supports restarting processes natively. Should your application crash, it will
+    be restarted automatically. If your application is a single process, you do not require
+    any process manager.
+
+  * The main process must handle `SIGTERM` and forward it as required to child processes. `bash`
+    does not automatically forward signals to child processes. For this reason, when using a startup
+    shell script, remember to use `exec <app>` as the last line. Doing so will replace bash with your
+    program and allows your program to handle signals as required.
+
+  * Use `supervisor`, `pm2` or any of the other process managers if you application has more
+    then one component. This excludes web servers like apache, nginx which can already manage their
+    children by themselves. Be sure to pick a process manager that forwards signals to child processes.
+
+  * Disable auto updates for apps. Updates must be triggered through the Cloudron Store. This allows the admin
+    to manage updates and downtime in a central location (the Cloudron Webadmin).
+
+## File system
+
+The Cloudron runs the application image as read-only. The app can only write to the following directories:
+
+  * `/tmp` - use this for temporary files.
+
+  * `/run` - use this for runtime configration and any dynamic data.
+
+  * `/app/data` - When the `localstorage` addon is enabled, any data under this directory is automatically backed up.
+
+## Logging
+
+Cloudron applications stream their logs to stdout and stderr. In contrast to logging
+to files, this approach has many advantages:
+
+  * App does not need to rotate logs and the Cloudron takes care of managing logs
+  * App does not need special mechanism to release log file handles (on a log rotate)
+  * Integrates better with tooling like `cloudron cli`
+
+This document gives you some recipes for configuring popular libraries to log to stdout. See 
+[base image](/references/baseimage.html#configuring) on how to configure various libraries to log to stdout/stderr.
+
+
+## Memory
+
+By default, applications get 256MB RAM (including swap). This can be changed using the `memoryLimit` field in the manifest.
+
+Design your application runtime for concurrent use by 10s of users. The Cloudron is not designed for concurrent access by
+100s or 1000s of users.
+
+## Startup
+
+  * Apps must not present a post-installation screen on first run. It should be already pre-configured for
+    a specific purpose.
+
+  * Do not run as `root`. Apps can use the `cloudron` user which is part of the [base image](/references/baseimage.html)
+    for this purpose or create their own.
+
+  * When using the `localstorage` addon, the application must change the ownership of files in `/app/data` as desired using `chown`. This
+    is necessary because file permissions may not be correctly preserved across backup, restore, application and base image
+    updates.
+
+  * Addon information (mail, database) is exposed as environment variables. An application must use these values directly
+    and not cache them across restarts. If the variables are stored in a configuration file, then the configuration file
+    must be regenerated on every application start. This is usually done using a configuration template that is patched
+    on every startup.
+
+## Authentication
+
+Apps should integrate with one of the [authentication strategies](/references/authentication.html).
+This saves the user from having to manage separate set of users for different apps.

docs/references/button.md

@@ -0,0 +1,47 @@
+# Cloudron Button
+
+The `Cloudron Button` allows anyone to install an application with
+the click of a button on their Cloudron.
+
+The button can be added to just about any website including the application's website
+and README.md files in GitHub repositories.
+
+## Prerequisites
+
+The `Cloudron Button` is intended to work only for applications that have been
+published on the Cloudron Store. The [basic tutorial](/tutorials/basic.html#publishing)
+gives an overview of how to package and publish your application for the
+Cloudron Store.
+
+## HTML Snippet
+
+```
+<img src="https://cloudron.io/img/button32.png" href="https://cloudron.io/button.html?app=<appid>">
+```
+
+_Note_: Replace `<appid>` with your application's id.
+
+## Markdown Snippet
+
+```
+[![Install](https://cloudron.io/img/button32.png)](https://cloudron.io/button.html?app=<appid>)
+```
+
+_Note_: Replace `<appid>` with your application's id.
+
+
+## Button Height
+
+The button may be used in different heights - 32, 48 and 64 pixels.
+
+[![Install](/img/button32.png)](https://cloudron.io/button.html?app=io.gogs.cloudronapp)
+
+[![Install](/img/button48.png)](https://cloudron.io/button.html?app=io.gogs.cloudronapp)
+
+[![Install](/img/button64.png)](https://cloudron.io/button.html?app=io.gogs.cloudronapp)
+
+or as SVG
+
+[![Install](/img/button.svg)](https://cloudron.io/button.html?app=io.gogs.cloudronapp)
+
+_Note_: Clicking the buttons above will install [Gogs](http://gogs.io/) on your Cloudron.

docs/references/manifest.md

@@ -0,0 +1,441 @@
+# Overview
+
+Every Cloudron Application contains a `CloudronManifest.json`.
+
+The manifest contains two categories of information:
+
+* Information about displaying the app on the Cloudron Store. For example,
+  the title, author information, description etc
+
+* Information for installing the app on the Cloudron. This includes fields
+  like httpPort, tcpPorts.
+
+A CloudronManifest.json can **only** contain fields that are listed as part of this
+specification. The Cloudron Store and the Cloudron *may* reject applications that have
+extra fields.
+
+Here is an example manifest:
+
+```
+{
+  "id": "com.example.test",
+  "title": "Example Application",
+  "author": "Girish Ramakrishnan <girish@cloudron.io>",
+  "description": "This is an example app",
+  "tagline": "A great beginning",
+  "version": "0.0.1",
+  "healthCheckPath": "/",
+  "httpPort": 8000,
+  "addons": {
+    "localstorage": {}
+  },
+  "manifestVersion": 1,
+  "website": "https://www.example.com",
+  "contactEmail": "support@clourdon.io",
+  "icon": "file://icon.png",
+  "tags": [ "test", "collaboration" ],
+  "mediaLinks": [ "https://images.rapgenius.com/fd0175ef780e2feefb30055be9f2e022.520x343x1.jpg" ]
+}
+```
+
+# Fields
+
+## addons
+
+Type: object
+
+Required: no
+
+Allowed keys
+* [email](addons.html#email)
+* [ldap](addons.html#ldap)
+* [localstorage](addons.html#localstorage)
+* [mongodb](addons.html#mongodb)
+* [mysql](addons.html#mysql)
+* [oauth](addons.html#oauth)
+* [postgresql](addons.html#postgresql)
+* [recvmail](addons.html#recvmail)
+* [redis](addons.html#redis)
+* [sendmail](addons.html#sendmail)
+
+The `addons` object lists all the [addons](addons.html) and the addon configuration used by the application.
+
+Example:
+```
+  "addons": {
+    "localstorage": {},
+    "mongodb": {}
+  }
+```
+
+## author
+
+Type: string
+
+Required: yes
+
+The `author` field contains the name and email of the app developer (or company).
+
+Example:
+```
+  "author": "Cloudron UG <girish@cloudron.io>"
+```
+
+## changelog
+
+Type: markdown string
+
+Required: no (required for submitting to the Cloudron Store)
+
+The `changelog` field contains the changes in this version of the application. This string
+can be a markdown style bulleted list.
+
+Example:
+```
+  "changelog": "* Add support for IE8 \n* New logo"
+```
+
+## contactEmail
+
+Type: email
+
+Required: yes
+
+The `contactEmail` field contains the email address that Cloudron users can contact for any
+bug reports and suggestions.
+
+Example:
+```
+  "contactEmail": "support@testapp.com"
+```
+
+## description
+
+Type: markdown string
+
+Required: yes
+
+The `description` field contains a detailed description of the app. This information is shown
+to the user when they install the app from the Cloudron Store.
+
+Example:
+```
+  "description": "This is a detailed description of this app."
+```
+
+A large `description` can be unweildy to manage and edit inside the CloudronManifest.json. For
+this reason, the `description` can also contain a file reference. The Cloudron CLI tool fills up
+the description from this file when publishing your application.
+
+Example:
+```
+  "description:": "file://DESCRIPTION.md"
+```
+
+## healthCheckPath
+
+Type: url path
+
+Required: yes
+
+The `healthCheckPath` field is used by the Cloudron Runtime to determine if your app is running and
+responsive. The app must return a 2xx HTTP status code as a response when this path is queried. In
+most cases, the default "/" will suffice but there might be cases where periodically querying "/"
+is an expensive operation. In addition, the app might want to use a specialized route should it
+want to perform some specialized internal checks.
+
+Example:
+```
+  "healthCheckPath": "/"
+```
+## httpPort
+
+Type: positive integer
+
+Required: yes
+
+The `httpPort` field contains the TCP port on which your app is listening for HTTP requests. This
+is the HTTP port the Cloudron will use to access your app internally.
+
+While not required, it is good practice to mark this port as `EXPOSE` in the Dockerfile.
+
+Cloudron Apps are containerized and thus two applications can listen on the same port. In reality,
+they are in different network namespaces and do not conflict with each other.
+
+Note that this port has to be HTTP and not HTTPS or any other non-HTTP protocol. HTTPS proxying is
+handled by the Cloudron platform (since it owns the certificates).
+
+Example:
+```
+  "httpPort": 8080
+```
+
+## icon
+
+Type: local image filename
+
+Required: no (required for submitting to the Cloudron Store)
+
+The `icon` field is used to display the application icon/logo in the Cloudron Store. Icons are expected
+to be square of size 256x256.
+
+```
+  "icon": "file://icon.png"
+```
+
+## id
+
+Type: reverse domain string
+
+Required: yes
+
+The `id` is a unique human friendly Cloudron Store id. This is similar to reverse domain string names used
+as java package names. The convention is to base the `id` based on a domain that you own.
+
+The Cloudron tooling allows you to build applications with any `id`. However, you will be unable to publish
+the application if the id is already in use by another application.
+
+```
+  "id": "io.cloudron.testapp"
+```
+
+## manifestVersion
+
+Type: integer
+
+Required: yes
+
+`manifestVersion` specifies the version of the manifest and is always set to 1.
+
+```
+  "manifestVersion": 1
+```
+
+## mediaLinks
+
+Type: array of urls
+
+Required: no (required for submitting to the Cloudron Store)
+
+The `mediaLinks` field contains an array of links that the Cloudron Store uses to display a slide show of pictures of the application.
+
+They have to be publicly reachable via `https` and should have an aspect ratio of 3 to 1.
+For example `600px by 200px` (with/height).
+
+```
+  "mediaLinks": [
+    "https://s3.amazonaws.com/cloudron-app-screenshots/org.owncloud.cloudronapp/556f6a1d82d5e27a7c4fca427ebe6386d373304f/2.jpg",
+    "https://images.rapgenius.com/fd0175ef780e2feefb30055be9f2e022.520x343x1.jpg"
+  ]
+```
+
+## memoryLimit
+
+Type: bytes (integer)
+
+Required: no
+
+The `memoryLimit` field is the maximum amount of memory (including swap) in bytes an app is allowed to consume before it
+gets killed and restarted.
+
+By default, all apps have a memoryLimit of 256MB. For example, to have a limit of 500MB,
+
+```
+  "memoryLimit": 524288000
+```
+
+## maxBoxVersion
+
+Type: semver string
+
+Required: no
+
+The `maxBoxVersion` field is the maximum box version that the app can possibly run on. Attempting to install the app on
+a box greater than `maxBoxVersion` will fail.
+
+This is useful when a new box release introduces features which are incompatible with the app. This situation is quite
+unlikely and it is recommended to leave this unset.
+
+## minBoxVersion
+
+Type: semver string
+
+Required: no
+
+The `minBoxVersion` field is the minimum box version that the app can possibly run on. Attempting to install the app on
+a box lesser than `minBoxVersion` will fail.
+
+This is useful when the app relies on features that are only available from a certain version of the box. If unset, the
+default value is `0.0.1`.
+
+## postInstallMessage
+
+Type: markdown string
+
+Required: no
+
+The `postInstallMessageField` is a message that is displayed to the user after an app is installed.
+
+The intended use of this field is to display some post installation steps that the user has to carry out to
+complete the installation. For example, displaying the default admin credentials and informing the user to
+to change it.
+
+The message can have the following special tags:
+* `<sso> ... </sso>` - Content in `sso` blocks are shown if SSO enabled.
+* `<nosso> ... </nosso>`- Content in `nosso` blocks are shows when SSO is disabled.
+
+## optionalSso
+
+Type: boolean
+
+Required: no
+
+The `optionalSso` field can be set to true for apps that can be installed optionally without using the Cloudron user management.
+
+This only applies if any Cloudron auth related addons are used. When set, the Cloudron will not inject the auth related addon environment variables.
+Any app startup scripts have to be able to deal with missing env variables in this case.
+
+## tagline
+
+Type: one-line string
+
+Required: no (required for submitting to the Cloudron Store)
+
+The `tagline` is used by the Cloudron Store to display a single line short description of the application.
+
+```
+  "tagline": "The very best note keeper"
+```
+
+## tags
+
+Type: Array of strings
+
+Required: no (required for submitting to the Cloudron Store)
+
+The `tags` are used by the Cloudron Store for filtering searches by keyword.
+
+```
+  "tags": [ "git", "version control", "scm" ]
+```
+
+## targetBoxVersion
+
+Type: semver string
+
+Required: no
+
+The `targetBoxVersion` field is the box version that the app was tested on. By definition, this version has to be greater
+than the `minBoxVersion`.
+
+The box uses this value to enable compatibility behavior of APIs. For example, an app sets the targetBoxVersion to 0.0.5
+and is published on the store. Later, box version 0.0.10 introduces a new feature that conflicts with how apps used
+to run in 0.0.5 (say SELinux was enabled for apps). When the box runs such an app, it ensures compatible behavior
+and will disable the SELinux feature for the app.
+
+If unspecified, this value defaults to `minBoxVersion`.
+
+## tcpPorts
+
+Type: object
+
+Required: no
+
+Syntax: Each key is the environment variable. Each value is an object containing `title`, `description` and `defaultValue`.
+An optional `containerPort` may be specified.
+
+The `tcpPorts` field provides information on the non-http TCP ports/services that your application is listening on. During
+installation, the user can decide how these ports are exposed from their Cloudron.
+
+For example, if the application runs an SSH server at port 29418, this information is listed here. At installation time,
+the user can decide any of the following:
+* Expose the port with the suggested `defaultValue` to the outside world. This will only work if no other app is being exposed at same port.
+* Provide an alternate value on which the port is to be exposed to outside world.
+* Disable the port/service.
+
+To illustrate, the application lists the ports as below:
+```
+  "tcpPorts": {
+    "SSH_PORT": {
+      "title": "SSH Port",
+      "description": "SSH Port over which repos can be pushed & pulled",
+      "defaultValue": 29418,
+      "containerPort": 22
+    }
+  },
+```
+
+In the above example:
+* `SSH_PORT` is an app specific environment variable. Only strings, numbers and _ (underscore) are allowed. The author has to ensure that they don't clash with platform profided variable names.
+
+* `title` is a short one line information about this port/service.
+
+* `description` is a multi line description about this port/service.
+
+* `defaultValue` is the recommended port value to be shown in the app installation UI.
+
+* `containerPort` is the port that the app is listening on (recall that each app has it's own networking namespace).
+
+In more detail:
+
+* If the user decides to disable the SSH service, this environment variable `SSH_PORT` is absent. Applications _must_ detect this on
+  start up and disable these services.
+
+* `SSH_PORT` is set to the value of the exposed port. Should the user choose to expose the SSH server on port 6000, then the
+  value of SSH_PORT is 6000.
+
+* `defaultValue` is **only** used for display purposes in the app installation UI.  This value is independent of the value
+   that the app is listening on. For example, the app can run an SSH server at port 22 but still recommend a value of 29418 to the user.
+
+* `containerPort` is the port that the app is listening on. The Cloudron runtime will _bridge_ the user chosen external port
+  with the app specific `containerPort`. Cloudron Apps are containerized and each app has it's own networking namespace.
+  As a result, different apps can have the same `containerPort` value because these values are namespaced.
+
+* The environment variable `SSH_PORT` may be used by the app to display external URLs. For example, the app might want to display
+  the SSH URL. In such a case, it would be incorrect to use the `containerPort` 22 or the `defaultValue` 29418 since this is not
+  the value chosen by the user.
+
+* `containerPort` is optional and can be omitted, in which case the bridged port numbers are the same internally and externally.
+  Some apps use the same variable (in their code) for listen port and user visible display strings. When packaging these apps,
+  it might be simpler to listen on `SSH_PORT` internally. In such cases, the app can omit the `containerPort` value and should
+  instead reconfigure itself to listen internally on `SSH_PORT` on each start up.
+
+## title
+
+Type: string
+
+Required: yes
+
+The `title` is the primary application title displayed on the Cloudron Store.
+
+Example:
+```
+  "title": "Gitlab"
+```
+
+## version
+
+Type: semver string
+
+Required: yes
+
+The `version` field specifies a [semver](http://semver.org/) string. The version is used by the Cloudron to compare versions and to
+determine if an update is available.
+
+Example:
+```
+  "version": "1.1.0"
+```
+
+## website
+
+Type: url
+
+Required: yes
+
+The `website` field is a URL where the user can read more about the application.
+
+Example:
+```
+  "website": "https://example.com/myapp"
+```

docs/references/recipes.md

@@ -0,0 +1,61 @@
+# Configuration Recipes
+
+## nginx
+
+`nginx` is often used as a reverse proxy in front of the application, to dispatch to different backend programs based on the request route or other characteristics. In such a case it is recommended to run nginx and the application through a process manager like `supervisor`.
+
+Example nginx supervisor configuration file:
+```
+[program:nginx]
+directory=/tmp
+command=/usr/sbin/nginx -g "daemon off;"
+user=root
+autostart=true
+autorestart=true
+stdout_logfile=/var/log/supervisor/%(program_name)s.log
+stderr_logfile=/var/log/supervisor/%(program_name)s.log
+```
+
+The nginx configuration, provided with the base image, can be used by adding an application specific config file under `/etc/nginx/sites-enabled/` when building the docker image.
+
+```
+ADD <app config file> /etc/nginx/sites-enabled/<app config file>
+```
+
+Since the base image nginx configuration is unpatched from the ubuntu package, the application configuration has to ensure nginx is using `/run/` instead of `/var/lib/nginx/` to support the read-only filesystem nature of a Cloudron application.
+
+Example nginx app config file:
+```
+client_body_temp_path /run/client_body;
+proxy_temp_path /run/proxy_temp;
+fastcgi_temp_path /run/fastcgi_temp;
+scgi_temp_path /run/scgi_temp;
+uwsgi_temp_path /run/uwsgi_temp;
+
+server {
+  listen 8000;
+
+  root /app/code/dist;
+
+  location /api/v1/ {
+    proxy_pass http://127.0.0.1:8001;
+    proxy_http_version 1.1;
+    proxy_set_header Upgrade $http_upgrade;
+    proxy_set_header Connection "upgrade";
+    proxy_read_timeout 86400;
+  }
+}
+
+```
+
+## supervisor
+
+Use this in the program's config:
+
+```
+[program:app]
+stdout_logfile=/dev/stdout
+stdout_logfile_maxbytes=0
+stderr_logfile=/dev/stderr
+stderr_logfile_maxbytes=0
+```

docs/references/selfhosting.md

@@ -0,0 +1,395 @@
+# Overview
+
+The Cloudron platform can be installed on public cloud servers from EC2, Digital Ocean, Hetzner,
+Linode, OVH, Scaleway, Vultr etc. Cloudron also runs well on a home server or company intranet.
+
+If you run into any trouble following this guide, ask us at our [chat](https://chat.cloudron.io).
+
+# Understand
+
+Before installing the Cloudron, it is helpful to understand Cloudron's design. The Cloudron
+intends to make self-hosting effortless. It takes care of updates, backups, firewall, dns setup,
+certificate management etc. All app and user configuration is carried out using the web interface.
+
+This approach to self-hosting means that the Cloudron takes complete ownership of the server and
+only tracks changes that were made via the web interface. Any external changes made to the server
+(i.e other than via the Cloudron web interface or API) may be lost across updates.
+
+The Cloudron requires a domain name when it is installed. Apps are installed into subdomains.
+The `my` subdomain is special and is the location of the Cloudron web interface. For this to
+work, the Cloudron requires a way to programmatically configure the DNS entries of the domain.
+Note that the Cloudron will never overwrite _existing_ DNS entries and refuse to install
+apps on existing subdomains (so, it is safe to reuse an existing domain that runs other services).
+
+# Cloud Server
+
+DigitalOcean and EC2 (Amazon Web Services) are frequently tested by us.
+
+Please use the below links to support us with referrals:
+* [Amazon EC2](https://aws.amazon.com/ec2/)
+* [DigitalOcean](https://m.do.co/c/933831d60a1e)
+
+In addition to those, the Cloudron community has successfully installed the platform on those providers:
+* [Amazon Lightsail](https://amazonlightsail.com/)
+* [hosttech](https://www.hosttech.ch/?promocode=53619290)
+* [Linode](https://www.linode.com/?r=f68d816692c49141e91dd4cef3305da457ac0f75)
+* [OVH](https://www.ovh.com/)
+* [Rosehosting](https://secure.rosehosting.com/clientarea/?affid=661)
+* [Scaleway](https://www.scaleway.com/)
+* [So you Start](https://www.soyoustart.com/)
+* [Vultr](http://www.vultr.com/?ref=7110116-3B)
+
+Please let us know if any of them requires tweaks or adjustments.
+
+# Installing
+
+## Create server
+
+Create an `Ubuntu 16.04 (Xenial)` server with at-least `1gb` RAM and 20GB disk space.
+Do not make any changes to vanilla ubuntu. Be sure to allocate a static IPv4 address
+for your server.
+
+Cloudron has a built-in firewall and ports are opened and closed dynamically, as and when
+apps are installed, re-configured or removed. For this reason, be sure to open all TCP and
+UDP traffic to the server and leave the traffic management to the Cloudron.
+
+### Linode
+
+Since Linode does not manage SSH keys, be sure to add the public key to
+`/root/.ssh/authorized_keys`.
+
+### Scaleway
+
+Use the [boot script](https://github.com/scaleway-community/scaleway-docker/issues/2) to
+enable memory accouting.
+
+## Run setup
+
+SSH into your server and run the following commands:
+
+```
+wget https://cloudron.io/cloudron-setup
+chmod +x cloudron-setup
+./cloudron-setup --provider <azure|digitalocean|ec2|lightsail|linode|ovh|rosehosting|scaleway|vultr|generic>
+```
+
+The setup will take around 10-15 minutes.
+
+**cloudron-setup** takes the following arguments:
+
+* `--provider` is the name of your VPS provider. If the name is not on the list, simply
+choose `generic`. In most cases, the `generic` provider mostly will work fine.
+If the Cloudron does not complete initialization, it may mean that
+we have to add some vendor specific quirks. Please open a
+[bug report](https://git.cloudron.io/cloudron/box/issues) in that case.
+
+Optional arguments for installation:
+
+* `--tls-provider` is the name of the SSL/TLS certificate backend. Defaults to Let's encrypt.
+Specifying `fallback` will setup the Cloudron to use the fallback wildcard certificate.
+Initially a self-signed one is provided, which can be overwritten later in the admin interface.
+This may be useful for non-public installations.
+
+Optional arguments used for update and restore:
+
+* `--version` is the version of Cloudron to install. By default, the setup script installs
+the latest version. You can set this to an older version when restoring a Cloudron from a backup.
+
+* `--restore-url` is a backup URL to restore from.
+
+## Domain setup
+
+Once the setup script completes, the server will reboot, then visit your server by its
+IP address (`https://ip`) to complete the installation.
+
+The setup website will show a certificate warning. Accept the self-signed certificate
+and proceed to the domain setup.
+
+Currently, only subdomains of the [Public Suffix List](https://publicsuffix.org/) are supported.
+For example, `example.com`,  `example.co.uk` will work fine. Choosing other non-registrable
+domain names like `cloudron.example.com` will not work.
+
+### Route 53
+
+Create root or IAM credentials and choose `Route 53` as the DNS provider.
+
+* For root credentials:
+  * In AWS Console, under your name in the menu bar, click `Security Credentials`
+  * Click on `Access Keys` and create a key pair.
+* For IAM credentials:
+    * You can use the following policy to create IAM credentials:
+
+```
+{
+    "Version": "2012-10-17",
+    "Statement": [
+        {
+            "Effect": "Allow",
+            "Action": "route53:*",
+            "Resource": [
+                "arn:aws:route53:::hostedzone/<hosted zone id>"
+            ]
+        },
+        {
+            "Effect": "Allow",
+            "Action": [
+                "route53:ListHostedZones",
+                "route53:GetChange"
+            ],
+            "Resource": [
+                "*"
+            ]
+        }
+    ]
+}
+```
+
+### Digital Ocean
+
+Create an API token with read+write access and choose `Digital Ocean` as the DNS provider.
+
+### Other
+
+If your domain *does not* use Route 53 or Digital Ocean, setup a wildcard (`*`) DNS `A` record that points to the
+IP of the server created above. If your DNS provider has an API, please open an
+[issue](https://git.cloudron.io/cloudron/box/issues) and we may be able to support it.
+
+## Finish Setup
+
+Once the domain setup is done, the Cloudron will configure the DNS and get a SSL certificate. It will automatically redirect to `https://my.<domain>`.
+
+# Backups
+
+The Cloudron creates encrypted backups once a day. Each app is backed up independently and these
+backups have the prefix `app_`. The platform state is backed up independently with the
+prefix `box_`.
+
+By default, backups reside in `/var/backups`. Please note that having backups reside in the same
+physical machine as the Cloudron server instance is dangerous and it must be changed to
+an external storage location like `S3` as soon as possible.
+
+## Amazon S3
+
+Provide S3 backup credentials in the `Settings` page and leave the endpoint field empty.
+
+Create a bucket in S3 (You have to have an account at [AWS](https://aws.amazon.com/)). The bucket can be setup to periodically delete old backups by
+adding a lifecycle rule using the AWS console. S3 supports both permanent deletion
+or moving objects to the cheaper Glacier storage class based on an age attribute.
+With the current daily backup schedule a setting of two days should be sufficient
+for most use-cases.
+
+* For root credentials:
+    * In AWS Console, under your name in the menu bar, click `Security Credentials`
+    * Click on `Access Keys` and create a key pair.
+* For IAM credentials:
+* You can use the following policy to create IAM credentials:
+
+```
+{
+    "Version": "2012-10-17",
+    "Statement": [
+        {
+            "Effect": "Allow",
+            "Action": "s3:*",
+            "Resource": [
+                "arn:aws:s3:::<your bucket name>",
+                "arn:aws:s3:::<your bucket name>/*"
+            ]
+        }
+    ]
+}
+```
+
+The `Encryption key` is an arbitrary passphrase used to encrypt the backups. Keep the passphrase safe; it is
+required to decrypt the backups when restoring the Cloudron.
+
+## Minio S3
+
+[Minio](https://minio.io/) is a distributed object storage server, providing the same API as Amazon S3.
+Since Cloudron supports S3, any API compatible solution should be supported as well, if this is not the case, let us know.
+
+Minio can be setup, by following the [installation instructions](https://docs.minio.io/) on any server, which is reachable by the Cloudron.
+Do not setup Minio on the same server as the Cloudron, this will inevitably result in data loss, if backups are stored on the same instance.
+
+Once setup, minio will print the necessary information, like login credentials, region and endpoints in its logs.
+
+```
+$ ./minio server ./storage
+
+Endpoint:  http://192.168.10.113:9000  http://127.0.0.1:9000
+AccessKey: GFAWYNJEY7PUSLTHYHT6
+SecretKey: /fEWk66E7GsPnzE1gohqKDovaytLcxhr0tNWnv3U
+Region:    us-east-1
+```
+
+First create a new bucket for the backups, using the minio commandline tools or the webinterface. The bucket has to have **read and write** permissions.
+
+The information to be copied to the Cloudron's backup settings form may look similar to:
+
+<img src="/docs/img/minio_backup_config.png" class="shadow"><br/>
+
+The `Encryption key` is an arbitrary passphrase used to encrypt the backups. Keep the passphrase safe; it is
+required to decrypt the backups when restoring the Cloudron.
+
+# Email
+
+Cloudron has a built-in email server. By default, it only sends out email on behalf of apps
+(for example, password reset or notification). You can enable the email server for sending
+and receiving mail on the `settings` page. This feature is only available if you have setup
+a DNS provider like Digital Ocean or Route53.
+
+Your server's IP plays a big role in how emails from our Cloudron get handled. Spammers
+frequently abuse public IP addresses and as a result your Cloudron might possibly start
+out with a bad reputation. The good news is that most IP based blacklisting services cool
+down over time. The Cloudron sets up DNS entries for SPF, DKIM, DMARC automatically and
+reputation should be easy to get back.
+
+## Checklist
+
+* If you are unable to receive mail, first thing to check is if your VPS provider lets you
+  receive mail on port 25.
+
+    * Digital Ocean - New accounts frequently have port 25 blocked. Write to their support to
+      unblock your server.
+
+    * EC2, Lightsail & Scaleway - Edit your security group to allow email.
+
+* Setup a Reverse DNS PTR record to be setup for the `my` subdomain.
+  **Note:** PTR records are a feature of your VPS provider and not your domain provider.
+
+    * You can verify the PTR record [https://mxtoolbox.com/ReverseLookup.aspx](here).
+
+    * AWS EC2 & Lightsail - Fill the [PTR request form](https://aws-portal.amazon.com/gp/aws/html-forms-controller/contactus/ec2-email-limit-rdns-request).
+
+    * Digital Ocean - Digital Ocean sets up a PTR record based on the droplet's name. So, simply rename
+    your droplet to `my.<domain>`. Note that some new Digital Ocean accounts have [port 25 blocked](https://www.digitalocean.com/community/questions/port-25-smtp-external-access).
+
+    * Linode - Follow this [guide](https://www.linode.com/docs/networking/dns/setting-reverse-dns).
+
+    * Scaleway - Edit your security group to allow email and [reboot the server](https://community.online.net/t/security-group-not-working/2096) for the change to take effect. You can also set a PTR record on the interface with your `my.<domain>`.
+
+* Check if your IP is listed in any DNSBL list [here](http://multirbl.valli.org/). In most cases,
+you can apply for removal of your IP by filling out a form at the DNSBL manager site.
+
+* When using wildcard or manual DNS backends, you have to setup the DMARC, MX records manually.
+
+* Finally, check your spam score at [mail-tester.com](https://www.mail-tester.com/). The Cloudron
+should get 100%, if not please let us know.
+
+# CLI Tool
+
+The [Cloudron tool](https://git.cloudron.io/cloudron/cloudron-cli) is useful for managing
+a Cloudron. <b class="text-danger">The Cloudron CLI tool has to be installed & run on a Laptop or PC</b>
+
+Once installed, you can install, configure, list, backup and restore apps from the command line.
+
+## Linux & OS X
+
+Installing the CLI tool requires node.js and npm. The CLI tool can be installed using the following command:
+
+```
+npm install -g cloudron
+```
+
+Depending on your setup, you may need to run this as root.
+
+On OS X, it is known to work with the `openssl` package from homebrew.
+
+See [#14](https://git.cloudron.io/cloudron/cloudron-cli/issues/14) for more information.
+
+## Windows
+
+The CLI tool does not work on Windows. Please contact us on our [chat](https://chat.cloudron.io) if you want to help with Windows support.
+
+# Updates
+
+Apps installed from the Cloudron Store are automatically updated every night.
+
+The Cloudron platform itself updates in two ways: update or upgrade.
+
+### Update
+
+An **update** is applied onto the running server instance. Such updates are performed
+every night. You can also use the Cloudron UI to initiate an update immediately.
+
+The Cloudron will always make a complete backup before attempting an update. In the unlikely
+case an update fails, it can be [restored](/references/selfhosting.html#restore).
+
+### Upgrade
+
+An **upgrade** requires a new OS image. This process involves creating a new server from scratch
+with the latest code and restoring it from the last backup.
+
+To upgrade follow these steps closely:
+
+* Create a new backup - `cloudron machine backup create`
+
+* List the latest backup - `cloudron machine backup list`
+
+* Make the backup available for the new cloudron instance:
+
+  * `S3` - When storing backup ins S3, make the latest box backup public - files starting with `box_` (from v0.94.0) or `backup_`. This can be done from the AWS S3 console as seen here:
+
+    <img src="/docs/img/aws_backup_public.png" class="shadow haze"><br/>
+
+    Copy the new public URL of the latest backup for use as the `--restore-url` below.
+
+    <img src="/docs/img/aws_backup_link.png" class="shadow haze"><br/>
+
+  * `File system` - When storing backups in `/var/backups`, you have to make the box and the app backups available to the new Cloudron instance's `/var/backups`. This can be achieved in a variety of ways depending on the situation: like scp'ing the backup files to the machine before installation, mounting the external backup hard drive into the new Cloudron's `/var/backup` OR downloading a copy of the backup using `cloudron machine backup download` and uploading them to the new machine. After doing so, pass `file:///var/backups/<path to box backup>` as the `--restore-url` below.
+
+* Create a new Cloudron by following the [installing](/references/selfhosting.html#installing) section.
+  When running the setup script, pass in the `--encryption-key` and `--restore-url` flags.
+  The `--encryption-key` is the backup encryption key. It can be displayed with `cloudron machine info`
+
+Similar to the initial installation, a Cloudron upgrade looks like:
+```
+$ ssh root@newserverip
+> wget https://cloudron.io/cloudron-setup
+> chmod +x cloudron-setup
+> ./cloudron-setup --provider <digitalocean|ec2|generic|scaleway> --domain <example.com> --encryption-key <key> --restore-url <publicS3Url>
+```
+
+Note: When upgrading an old version of Cloudron (<= 0.94.0), pass the `--version 0.94.1` flag and then continue updating
+from that.
+
+ * Finally, once you see the newest version being displayed in your Cloudron webinterface, you can safely delete the old server instance.
+
+# Restore
+
+To restore a Cloudron from a specific backup:
+
+* Select the backup - `cloudron machine backup list`
+
+* Make the backup public
+
+  * `S3` - Make the box backup publicly readable - files starting with `box_` (from v0.94.0) or `backup_`. This can be done from the AWS S3 console. Once the box has restored, you can make it private again.
+
+  * `File system` - When storing backups in `/var/backups`, you have to make the box and the app backups available to the new Cloudron instance's `/var/backups`. This can be achieved in a variety of ways depending on the situation: like scp'ing the backup files to the new machine before Cloudron installation OR mounting an external backup hard drive into the new Cloudron's `/var/backup` OR downloading a copy of the backup using `cloudron machine backup download` and uploading them to the new machine. After doing so, pass `file:///var/backups/<path to box backup>` as the `--restore-url` below.
+
+* Create a new Cloudron by following the [installing](/references/selfhosting.html#installing) section.
+  When running the setup script, pass in the `version`, `encryption-key`, `domain` and `restore-url` flags.
+  The `version` field is the version of the Cloudron that the backup corresponds to (it is embedded
+  in the backup file name).
+
+* Make the box backup private, once the upgrade is complete.
+
+# Debug
+
+You can SSH into your Cloudron and collect logs:
+
+* `journalctl -a -u box` to get debug output of box related code.
+* `docker ps` will give you the list of containers. The addon containers are named as `mail`, `postgresql`,
+   `mysql` etc. If you want to get a specific container's log output, `journalctl -a CONTAINER_ID=<container_id>`.
+
+# Alerts
+
+The Cloudron will notify the Cloudron administrator via email if apps go down, run out of memory, have updates
+available etc.
+
+You will have to setup a 3rd party service like [Cloud Watch](https://aws.amazon.com/cloudwatch/) or [UptimeRobot](http://uptimerobot.com/) to monitor the Cloudron itself. You can use `https://my.<domain>/api/v1/cloudron/status`
+as the health check URL.
+
+# Help
+
+If you run into any problems, join us at our [chat](https://chat.cloudron.io) or [email us](mailto:support@cloudron.io).

docs/references/usermanual.md

@@ -0,0 +1,354 @@
+# Introduction
+
+The Cloudron is the best platform self-hosting web applications on your server. You
+can easily install apps on it, add users, manage access restriction and keep your
+server and apps updated with no effort.
+
+You might wonder that there are so many 1-click app solutions out there and what is so special
+about Cloudron? As the name implies, 1-click installers simply install code into a server
+and leave it at that. There's so much more to do:
+
+1. Configure a domain to point to your server
+2. Setup SSL certificates and renew them periodically
+3. Ensure apps are backed up correctly
+4. Ensure apps are uptodate and secure
+5. Have a mechanism to quickly restore apps from a backup
+6. Manage users across all your apps
+7. Get alerts and notifications about the status of apps
+
+... and so on ...
+
+We made the Cloudron to dramatically lower the bar for people to run apps on servers. Just provide
+a domain name, install apps and add users. All the server management tasks listed above is
+completely automated.
+
+If you want to learn more about the secret sauce that makes the Cloudron, please read our
+[architecture overview](/references/architecture.html).
+
+# Use cases
+
+Here are some of the apps you can run on a Cloudron:
+
+* RSS Reader
+* Chat, IRC, Jabber servers
+* Public forum
+* Blog
+* File syncing and sharing
+* Code hosting
+* Email
+
+Our list of apps is growing everyday, so be sure to [follow us on twitter](https://twitter.com/cloudron_io).
+
+# Activation
+
+When you first create the Cloudron, the setup wizard will ask you to setup an administrator
+account. Don't worry, a Cloudron adminstrator doesn't need to know anything about maintaining
+a server! It's the whole reason why we made the Cloudron. Being a Cloudron administrator is
+more analagous to being the owner of a smartphone. You can always add more administrators to
+the Cloudron from the `Users` menu item.
+
+<img src="/docs/img/webadmin_domain.png" class="shadow">
+
+The Cloudron administration page is located at the `my` subdomain. You might want to bookmark
+this link!
+
+# Apps
+
+## Installation
+
+You can install apps on the Cloudron by choosing the `App Store` menu item. Use the 'Search' bar
+to search for apps.
+
+Clicking on app gives you information about the app.
+
+<img src="/docs/img/app_info.png" class="shadow">
+
+Clicking the `Install` button will show an install dialog like below:
+
+<img src="/docs/img/app_install.png" class="shadow">
+
+The `Location` field is the subdomain in which your app will be installed. For example, if you use the
+`mail` location for your web mail client, then it will be accessible at `mail.<domain>`.
+
+Tip: You can access the apps directly on your browser using `mail.<domain>`. You don't have to
+visit the Cloudron administration panel.
+
+`Access control` specifies who can access this app.
+
+* `Every Cloudron user` - Any user in your Cloudron can access the app. Initially, you are the only
+   user in your Cloudron. Unless you explicitly invite others, nobody else can access these apps.
+   Note that the term 'access' depends on the app. For a blog, this means that nobody can post new
+   blog posts (but anybody can view them). For a chat server, this might mean that nobody can access
+   your chat server.
+
+* `Restrict to groups` - Only users in the groups can access the app.
+
+## Updates
+
+All your apps automatically update as and when the application author releases an update. The Cloudron
+will attempt to update around midnight of your timezone.
+
+Some app updates are not automatic. This can happen if a new version of the app has removed some features
+that you were relying on. In such a case, the update has to be manually approved. This is simply a matter
+of clicking the `Update` button (the green star) after you read about the changes.
+
+<img src="/docs/img/app_update.png" class="shadow">
+
+## Backups
+
+<i>If you self-host, please refer to the [self-hosting documentation](/references/selfhosting.html#backups) for backups.</i>
+
+All apps are automatically backed up every day. Backups are stored encrypted in Amazon S3. You don't have
+to do anything about it. The [Cloudron CLI](https://git.cloudron.io/cloudron/cloudron-cli) tool can be used
+to download application backups.
+
+## Configuration
+
+Apps can be reconfigured using the `Configure` button.
+
+<img src="/docs/img/app_configure_button.png" class="shadow">
+
+Click on the wrench button will bring up the configure dialog.
+
+<img src="/docs/img/app_configure.png" class="shadow">
+
+You can do the following:
+* Change the location to move the app to another subdomain. Say, you want to move your blog from `blog` to `about`.
+* Change who can access the app.
+
+Changing an app's configuration has a small downtime (usually around a minute).
+
+## Restore
+
+Apps can be restored to a previous backup by clicking on the `Restore` button.
+
+<img src="/docs/img/app_restore_button.png" class="shadow">
+
+Note that restoring previous data might also restore the previous version of the software. For example, you might
+be currently using Version 5 of the app. If you restore to a backup that was made with Version 3 of the app, then the restore
+operation will install Version 3 of the app. This is because the latest version may not be able to handle old data.
+
+## Uninstall
+
+You can uninstall an app by clicking the `Uninstall` button.
+
+<img src="/docs/img/app_uninstall_button.png" class="shadow">
+
+Note that all data associated with the app will be immediately removed from the Cloudron. App data might still
+persist in your old backups and the [CLI tool](https://git.cloudron.io/cloudron/cloudron-cli) provides a way to
+restore from those old backups should it be required.
+
+## Embedding Apps
+
+It is possible to embed Cloudron apps into other websites. By default, this is disabled to prevent
+[Clickjacking](https://cloudron.io/blog/2016-07-15-site-embedding.html).
+
+You can set a website that is allowed to embed your Cloudron app using the app's [Configure dialog](#configuration).
+Click on 'Show Advanced Settings...' and enter the embedder website name.
+
+# Custom domain
+
+When you create a Cloudron from cloudron.io, we provide a subdomain under `cloudron.me` like `girish.cloudron.me`.
+Apps are available under that subdomain using a hyphenated name like `blog-girish.cloudron.me`.
+
+Domain names are a thing of pride and the Cloudron makes it easy to make your apps accessible from memorable locations like `blog.girish.in`.
+
+## Single app on a custom domain
+
+This approach is applicable if you desire that only a single app be accessing from a custom
+domain. For this, open the app's configure dialog and choose `External Domain` in the location dropdown.
+
+<img src="/docs/img/app_external_domain.png" class="shadow">
+
+This dialog will suggest you to add a `CNAME` record. Once you setup a CNAME record with your DNS provider,
+the app will be accessible from that external domain.
+
+## Entire Cloudron on a custom domain
+
+This approach is applicable if you want all your apps to be accessible from subdomains of your custom domain.
+For example, `blog.girish.in`, `notes.girish.in`, `owncloud.girish.in`, `mail.girish.in` and so on. This
+approach is also the only way that the Cloudron supports for sending and receiving emails from your domain.
+
+For this, go to the 'Domains & Certs' menu item.
+
+<img src="/docs/img/custom_domain_menu.png" class="shadow">
+
+Change the domain name to your custom domain. Currently, we require that your domain be hosted on AWS Route53.
+
+<img src="/docs/img/custom_domain_change.png" class="shadow">
+
+Moving to a custom domain will retain all your apps and data and will take around 15 minutes. If you require assistance with another provider,
+<a href="mailto:support@cloudron.io">just let us know</a>.
+
+# User management
+
+## Users
+
+You can invite new users (friends, family, colleagues) with their email address from the `Users` menu. They will
+receive an invite to sign up with your Cloudron. They can now access the apps that you have given them access
+to.
+
+<img src="/docs/img/users.png" class="shadow">
+
+To remove a user, simply remove them from the list. Note that the removed user cannot access any app anymore.
+
+## Administrators
+
+A Cloudron administrator is a special right given to an existing Cloudron user allowing them to manage
+apps and users. To make an existing user an administator, click the edit (pencil) button corresponding to
+the user and check the `Allow this user to manage apps, groups and other users` checkbox.
+
+<img src="/docs/img/administrator.png" class="shadow">
+
+## Groups
+
+Groups provide a convenient way to group users. It's purpose is two-fold:
+
+* You can assign one or more groups to apps to restrict who can access for an app.
+* Each group is a mailing list (forwarding address) constituting of it's members.
+
+You can create a group by using the `Groups` menu item.
+
+<img src="/docs/img/groups.png" class="shadow">
+
+To set the access restriction use the app's configure dialog.
+
+<img src="/docs/img/app_access_control.png" class="shadow">
+
+You can now send mails to `groupname@<domain>` to address all the group members.
+
+# Login
+
+## Cloudron admin
+
+The Cloudron admin page is always located at the `my` subdomain of your Cloudron domain. For custom domains,
+this will be like `my.girish.in`. For domains from cloudron.io, this will be like `my-girish.cloudron.me`.
+
+## Apps (single sign-on)
+
+An important feature of the Cloudron is Single Sign-On. You use the same username & password for logging in
+to all your apps. No more having to manage separate set of credentials for each service!
+
+## Single user apps
+
+Some apps only work with a single user. For example, a notes app might allow only a single user to login and add
+notes. For such apps, you will be prompted during installation to select the single user who can access the app.
+
+<img src="/docs/img/app_single_user.png" class="shadow">
+
+If you want multiple users to use the app independently, simply install the app multiple times to different locations.
+
+# Email
+
+The Cloudron has a built-in email server. The primary email address is the same as the username. Emails can be sent
+and received from `<username>@<domain>`. The Cloudron does not allow masquerading - one user cannot send email
+pretending to be another user.
+
+## Enabling Email
+
+By default, Cloudron's email server only allows apps to send email. To enable users to send and receive email,
+turn on the option under `Settings`. Turning on this option also allows apps to _receive_ email.
+
+Once email is enabled, the Cloudron will keep the the `MX` DNS record updated.
+
+<img src="/docs/img/enable_email.png" class="shadow">
+
+## Receiving email using IMAP
+
+Use the following settings to receive email.
+
+  * Server Name - Use the `my` subdomain of your Cloudron
+  * Port - 993
+  * Connection Security - TLS
+  * Username/password - Same as your Cloudron credentials
+
+## Sending email using SMTP
+
+Use the following settings to send email.
+
+  * Server Name - Use the `my` subdomain of your Cloudron
+  * Port - 587
+  * Connection Security - STARTTLS
+  * Username/password - Same as your Cloudron credentials
+
+## Email filters using Sieve
+
+Use the following settings to setup email filtering users via Manage Sieve.
+
+  * Server Name - Use the `my` subdomain of your Cloudron
+  * Port - 4190
+  * Connection Security - TLS
+  * Username/password - Same as your Cloudron credentials
+
+The [Rainloop](https://cloudron.io/appstore.html?app=net.rainloop.cloudronapp) and [Roundcube](https://cloudron.io/appstore.html?app=net.roundcube.cloudronapp)
+apps are already pre-configured to use the above settings.
+
+## Aliases
+
+You can configure one or more aliases alongside the primary email address of each user. You can set aliases by editing the
+user's settings, available behind the edit button in the user listing. Note that aliases cannot conflict with existing user names.
+
+<img src="/docs/img/email_alias.png" class="shadow">
+
+Currently, it is not possible to login using the alias for SMTP/IMAP/Sieve services. Instead, add the alias as an identity in
+your mail client but login using the Cloudron credentials.
+
+## Subaddresses
+
+Emails addressed to `<username>+tag@<domain>` will be delivered to the `username` mailbox. You can use this feature to give out emails of the form
+`username+kayak@<domain>`, `username+aws@<domain>` and so on and have them all delivered to your mailbox.
+
+## Forwarding addresses
+
+Each group on the Cloudron is also a forwarding address. Mails can be addressed to `group@<domain>` and the mail will
+be sent to each user who is part of the group.
+
+## Marking Spam
+
+The spam detection agent on the Cloudron requires training to identify spam. To do this, simply move your junk mails
+to a pre-created folder named `Spam`. Most mail clients have a Junk or Spam button which does this automatically.
+
+# Graphs
+
+The Graphs view shows an overview of the disk and memory usage on your Cloudron.
+
+<img src="/docs/img/graphs.png" class="shadow">
+
+The `Disk Usage` graph shows you how much disk space you have left. Note that the Cloudron will
+send the Cloudron admins an email notification when the disk is ~90% full.
+
+The `Apps` Memory graph shows the memory consumed by each installed app. You can click on each segment
+on the graph to see the memory consumption over time in the chart below it.
+
+The `System` Memory graph shows the overall memory consumption on the entire Cloudron. If you see
+the Free memory < 50MB frequently, you should consider upgrading to a Cloudron with more memory.
+
+# Activity log
+
+The `Activity` view shows the activity on your Cloudron. It includes information about who is using
+the apps on your Cloudron and also tracks configuration changes.
+
+<img src="/docs/img/activity.png" class="shadow">
+
+# Domains and SSL Certificates
+
+All apps on the Cloudron can only be reached by `https`. The Cloudron automatically installs and
+renews certificates for your apps as needed. Should installation of certificate fail for reasons
+beyond it's control, Cloudron admins will get a notification about it.
+
+# API Access
+
+All the operations listed in this manual like installing app, configuring users and groups, are
+completely programmable with a [REST API](/references/api.html).
+
+# Moving to a larger Cloudron
+
+When using a Cloudron from cloudron.io, it is easy to migrate your apps and data to a bigger server.
+In the `Settings` page, you can change the plan.
+
+<insert picture>
+
+# Command line tool
+
+If you are a software developer or a sysadmin, the Cloudron comes with a CLI tool that can be
+used to develop custom apps for the Cloudron. Read more about it [here](https://git.cloudron.io/cloudron/cloudron-cli).

docs/tutorials/node.md

@@ -0,0 +1,621 @@
+# Overview
+
+This tutorial provides an introduction to developing applications
+for the Cloudron using node.js.
+
+# Installation
+
+## Install CLI tool
+
+The Cloudron CLI tool allows you to install, configure and test apps on your Cloudron.
+
+Installing the CLI tool requires [node.js](https://nodejs.org/) and
+[npm](https://www.npmjs.com/). You can then install the CLI tool using the following
+command:
+
+```
+    sudo npm install -g cloudron
+```
+
+Note: Depending on your setup, you can run the above command without `sudo`.
+
+## Testing your installation
+
+The `cloudron` command should now be available in your path.
+
+Let's login to the Cloudron as follows:
+
+```
+$ cloudron login
+Cloudron Hostname: craft.selfhost.io
+
+Enter credentials for craft.selfhost.io:
+Username: girish
+Password:
+Login successful.
+```
+
+## Your First Application
+
+Creating an application for Cloudron can be summarized as follows:
+
+1. Create a web application using any language/framework. This web application must run a HTTP server
+   and can optionally provide other services using custom protocols (like git, ssh, TCP etc).
+
+2. Create a [Dockerfile](http://docs.docker.com/engine/reference/builder/) that specifies how to create 
+   an application ```image```. An ```image``` is essentially a bundle of the application source code
+   and it's dependencies.
+
+3. Create a [CloudronManifest.json](/references/manifest.html) file that provides essential information
+   about the app. This includes information required for the Cloudron Store like title, version, icon and 
+   runtime requirements like `addons`.
+
+## Simple Web application
+
+To keep things simple, we will start by deploying a trivial node.js server running on port 8000.
+
+Create a new project folder `tutorial/` and add a file named `tutorial/server.js` with the following content:
+```javascript
+var http = require("http");
+
+var server = http.createServer(function (request, response) {
+  response.writeHead(200, {"Content-Type": "text/plain"});
+  response.end("Hello World\n");
+});
+
+server.listen(8000);
+
+console.log("Server running at port 8000");
+```
+
+## Dockerfile
+
+A Dockerfile contains commands to assemble an image.
+
+Create a file named `tutorial/Dockerfile` with the following content:
+
+```dockerfile
+FROM cloudron/base:0.10.0
+
+ADD server.js /app/code/server.js
+
+CMD [ "/usr/local/node-0.12.7/bin/node", "/app/code/server.js" ]
+```
+
+The `FROM` command specifies that we want to start off with Cloudron's [base image](/references/baseimage.html).
+All Cloudron apps **must** start from this base image.
+
+The `ADD` command copies the source code of the app into the directory `/app/code`.
+While this example only copies a single file, the ADD command can be used to copy directory trees as well.
+See the [Dockerfile](https://docs.docker.com/reference/builder/#add) documentation for more details.
+
+The `CMD` command specifies how to run the server. There are multiple versions of node available under `/usr/local`. We
+choose node v0.12.7 for our app.
+
+## CloudronManifest.json
+
+The `CloudronManifest.json` specifies
+
+* Information about displaying the app on the Cloudron Store. For example,
+  the title, author information, description etc
+
+* Information for installing the app on the Cloudron. This includes fields
+  like httpPort, tcpPorts.
+
+Create the CloudronManifest.json using the following command:
+
+```
+$ cloudron init
+id: io.cloudron.tutorial                       # unique id for this app. use reverse domain name convention
+author: John Doe                               # developer or company name of the for user <email>
+title: Tutorial App                            # Cloudron Store title of this app
+description: App that uses node.js             # A string or local file reference like file://DESCRIPTION.md
+tagline: Changing the world one app at a time  # A tag line for this app for the Cloudron Store
+website: https://cloudron.io                   # A link to this app's website
+contactEmail: support@cloudron.io              # Contact email of developer or company
+httPort: 8000                                  # The http port on which this application listens to
+```
+
+The above command creates a CloudronManifest.json:
+
+File ```tutorial/CloudronManifest.json```
+
+```json
+{
+  "id": "io.cloudron.tutorial",
+  "author": "John Doe",
+  "title": "Tutorial App",
+  "description": "App that uses node.js",
+  "tagline": "Changing the world one app at a time",
+  "version": "0.0.1",
+  "healthCheckPath": "/",
+  "httpPort": 8000,
+  "addons": {
+    "localstorage": {}
+  },
+  "minBoxVersion": "0.0.1",
+  "manifestVersion": 1,
+  "website": "https://cloudron.io",
+  "contactEmail": "support@cloudron.io",
+  "icon": "",
+  "mediaLinks": []
+}
+```
+
+You can read in more detail about each field in the [Manifest reference](/references/manifest.html).
+
+# Installing
+
+## Building
+
+We now have all the necessary files in place to build and deploy the app to the Cloudron.
+Building creates an image of the app using the Dockerfile which can then be used to deploy
+to the Cloudron.
+
+Building, pushing and pulling docker images is very bandwidth and CPU intensive. To alleviate this
+problem, apps are built using the `build service` which uses `cloudron.io` account credentials.
+
+**Warning**: As of this writing, the build service uses the public Docker registry and the images that are built
+can be downloaded by anyone. This means that your source code will be viewable by others.
+
+Initiate a build using ```cloudron build```:
+```
+$ cloudron build
+Building io.cloudron.tutorial@0.0.1
+
+Appstore login:
+Email: ramakrishnan.girish@gmail.com         # cloudron.io account
+Password:                                    # Enter password
+Login successful.
+
+Build scheduled with id 76cebfdd-7822-4f3d-af17-b3eb393ae604
+Downloading source
+Building
+Step 0 : FROM cloudron/base:0.10.0
+ ---> 97583855cc0c
+Step 1 : ADD server.js /app/code
+ ---> b09b97ecdfbc
+Removing intermediate container 03c1e1f77acb
+Step 2 : CMD /usr/local/node-0.12.7/bin/node /app/code/main.js
+ ---> Running in 370f59d87ab2
+ ---> 53b51eabcb89
+Removing intermediate container 370f59d87ab2
+Successfully built 53b51eabcb89
+The push refers to a repository [cloudron/img-2074d69134a7e0da3d6cdf3c53e241c4] (len: 1)
+Sending image list
+Pushing repository cloudron/img-2074d69134a7e0da3d6cdf3c53e241c4 (1 tags)
+Image already pushed, skipping 57f52d167bbb
+Image successfully pushed b09b97ecdfbc
+Image successfully pushed 53b51eabcb89
+Pushing tag for rev [53b51eabcb89] on {https://cdn-registry-1.docker.io/v1/repositories/cloudron/img-2074d69134a7e0da3d6cdf3c53e241c4/tags/76cebfdd-7822-4f3d-af17-b3eb393ae604}
+Build succeeded
+```
+
+## Installing
+
+Now that we have built the image, we can install our latest build on the Cloudron
+using the following command:
+
+```
+$ cloudron install
+Using cloudron craft.selfhost.io
+Using build 76cebfdd-7822-4f3d-af17-b3eb393ae604 from 1 hour ago
+Location: tutorial                         # This is the location into which the application installs
+App is being installed with id: 4dedd3bb-4bae-41ef-9f32-7f938995f85e
+
+ => Waiting to start installation
+ => Registering subdomain .
+ => Verifying manifest .
+ => Downloading image ..............
+ => Creating volume .
+ => Creating container
+ => Setting up collectd profile ................
+ => Waiting for DNS propagation ...
+
+App is installed.
+```
+
+This makes the app available at https://tutorial-craft.selfhost.io.
+
+Open the app in your default browser:
+```
+cloudron open
+```
+
+You should see `Hello World`.
+
+# Testing
+
+The application testing cycle involves `cloudron build` and `cloudron install`.
+Note that `cloudron install` updates an existing app in place.
+
+You can view the logs using `cloudron logs`. When the app is running you can follow the logs
+using `cloudron logs -f`.
+
+For example, you can see the console.log output in our server.js with the command below:
+
+```
+$ cloudron logs
+Using cloudron craft.selfhost.io
+2015-05-08T03:28:40.233940616Z Server running at port 8000
+```
+
+It is also possible to run a *shell* and *execute* arbitrary commands in the context of the application
+process by using `cloudron exec`. By default, exec simply drops you into an interactive bash shell with
+which you can inspect the file system and the environment.
+
+```
+$ cloudron exec
+```
+
+You can also execute arbitrary commands:
+```
+$ cloudron exec env # display the env variables that your app is running with
+```
+
+# Storing data
+
+For file system storage, an app can use the `localstorage` addon to store data under `/app/data`.
+When the `localstorage` addon is active, any data under /app/data is automatically backed up. When an
+app is updated, /app/data already contains the data generated by the previous version.
+
+*Note*: For convenience, the initial CloudronManifest.json generated by `cloudron init` already contains this
+addon.
+
+Let us put this theory into action by saving a *visit counter* as a file.
+*server.js* has been modified to count the number of visitors on the site by storing a counter
+in a file named ```counter.dat```.
+
+File ```tutorial/server.js```
+
+```javascript
+var http = require('http'),
+    fs = require('fs'),
+    util = require('util');
+
+var COUNTER_FILE = '/app/data/counter.dat';
+
+var server = http.createServer(function (request, response) {
+    var counter = 0;
+    if (fs.existsSync(COUNTER_FILE)) {
+        // read existing counter if it exists
+        counter = parseInt(fs.readFileSync(COUNTER_FILE, 'utf8'), 10);
+    }
+
+    response.writeHead(200, {"Content-Type": "text/plain"});
+    response.end(util.format("Hello World. %s visitors have visited this page\n", counter));
+    ++counter; // bump the counter
+    fs.writeFileSync(COUNTER_FILE, counter + '', 'utf8'); // save back counter
+});
+
+server.listen(8000);
+
+console.log("Server running at port 8000");
+```
+
+Now every time you refresh the page you will notice that the counter bumps up. You will
+also notice that if you make changes to the app and do a `cloudron install`, the `counter.dat`
+is *retained* across updates.
+
+# Database
+
+Most web applications require a database of some form. In theory, it is possible to run any
+database you want as part of the application image. This is, however, a waste of server resources
+should every app runs it's own database server.
+
+To solve this, the Cloudron provides shareable resources like databases in form of ```addons```.
+The database server is managed by the Cloudron and the application simply needs to request access to
+the database in the CloudronManifest.json. While the database server itself is a shared resource, the
+databases are exclusive to the application. Each database is password protected and accessible only
+to the application. Databases and tables can be configured without restriction as the application
+requires.
+
+Cloudron currently provides `mysql`, `postgresql`, `mongodb`, `redis` database addons.
+
+For this tutorial, let us try to save the counter in `redis` addon. For this, we make use of the
+[redis](https://www.npmjs.com/package/redis) module.
+
+Since this is a node.js app, let's add a very basic `package.json` containing the `redis` module dependency.
+
+File `tutorial/package.json`
+```json
+{
+  "name": "tutorial",
+  "version": "1.0.0",
+  "dependencies": {
+    "redis": "^0.12.1"
+  }
+}
+```
+
+and modify our Dockerfile to look like this:
+
+File `tutorial/Dockerfile`
+
+```dockerfile
+FROM cloudron/base:0.10.0
+
+ADD server.js /app/code/server.js
+ADD package.json /app/code/package.json
+
+WORKDIR /app/code
+RUN npm install --production
+
+CMD [ "/usr/local/node-0.12.7/bin/node", "/app/code/server.js" ]
+```
+
+Notice the new `RUN` command which installs the node module dependencies in package.json using `npm install`.
+
+Since we want to use redis, we have to modify the CloudronManifest.json to make redis available for this app.
+
+File `tutorial/CloudronManifest.json`
+
+```json
+{
+  "id": "io.cloudron.tutorial",
+  "author": "John Doe",
+  "title": "Tutorial App",
+  "description": "App that uses node.js",
+  "tagline": "Changing the world one app at a time",
+  "version": "0.0.1",
+  "healthCheckPath": "/",
+  "httpPort": 8000,
+  "addons": {
+    "localstorage": {},
+    "redis": {}
+  },
+  "minBoxVersion": "0.0.1",
+  "manifestVersion": 1,
+  "website": "https://cloudron.io",
+  "contactEmail": "support@cloudron.io",
+  "icon": "",
+  "mediaLinks": []
+}
+```
+
+When the application runs, environment variables `REDIS_HOST`, `REDIS_PORT` and
+`REDIS_PASSWORD` are injected. You can read about the environment variables in the
+[Redis reference](/references/addons.html#redis).
+
+Let's change `server.js` to use redis instead of file backed counting:
+
+File ```tutorial/server.js```
+
+```javascript
+var http = require('http'),
+    fs = require('fs'),
+    util = require('util'),
+    redis = require('redis');
+
+var redisClient = redis.createClient(process.env.REDIS_PORT, process.env.REDIS_HOST);
+redisClient.auth(process.env.REDIS_PASSWORD);
+redisClient.on("error", function (err) {
+  console.log("Redis Client Error " + err);
+});
+
+var COUNTER_KEY = 'counter';
+
+var server = http.createServer(function (request, response) {
+  redisClient.get(COUNTER_KEY, function (err, reply) {
+    var counter = (!err && reply) ? parseInt(reply, 10) : 0;
+    response.writeHead(200, {"Content-Type": "text/plain"});
+    response.end(util.format("Hello World. %s visitors have visited this page\n", counter));
+    redisClient.incr(COUNTER_KEY);
+  });
+});
+
+server.listen(8000);
+
+console.log("Server running at port 8000");
+```
+
+Simply `cloudron build` and `cloudron install` to test your app!
+
+# Authentication
+
+The Cloudron has a centralized panel for managing users and groups. Apps can integrate Single Sign-On
+authentication using LDAP or OAuth.
+
+Note that apps that are single user can skip Single Sign-On support. The Cloudron implements an `OAuth
+proxy` (accessed through the app configuration dialog) that optionally lets the Cloudron admin make the
+app visible only for logged in users.
+
+## LDAP
+
+Let's start out by adding the [ldap](/references/addons.html#ldap) addon to the manifest.
+
+File `tutorial/CloudronManifest.json`
+```json
+{
+  "id": "io.cloudron.tutorial",
+  "author": "John Doe",
+  "title": "Tutorial App",
+  "description": "App that uses node.js",
+  "tagline": "Changing the world one app at a time",
+  "version": "0.0.1",
+  "healthCheckPath": "/",
+  "httpPort": 8000,
+  "addons": {
+    "localstorage": {},
+    "ldap": {}
+  },
+  "minBoxVersion": "0.0.1",
+  "manifestVersion": 1,
+  "website": "https://cloudron.io",
+  "contactEmail": "support@cloudron.io",
+  "icon": "",
+  "mediaLinks": []
+}
+```
+
+Building and installing the app shows that the app gets new LDAP specific environment variables.
+
+```
+$ cloudron build
+$ cloudron install
+$ cloudron exec env | grep LDAP
+LDAP_SERVER=172.17.42.1
+LDAP_PORT=3002
+LDAP_URL=ldap://172.17.42.1:3002
+LDAP_USERS_BASE_DN=ou=users,dc=cloudron
+LDAP_GROUPS_BASE_DN=ou=groups,dc=cloudron
+```
+
+Let's test the environment variables to use by using the [ldapjs](http://www.ldapjs.org) npm module.
+We start by adding ldapjs to package.json.
+
+File `tutorial/package.json`
+```json
+{
+  "name": "tutorial",
+  "version": "1.0.0",
+  "dependencies": {
+    "ldapjs": "^0.7.1"
+  }
+}
+```
+
+The server code has been modified to authenticate using the `X-Username` and `X-Password` headers for
+any path other than '/'.
+
+File `tutorial/server.js`
+```javascript
+var http = require("http"),
+    ldap = require('ldapjs');
+
+var ldapClient = ldap.createClient({ url: process.env.LDAP_URL });
+
+var server = http.createServer(function (request, response) {
+  if (request.url === '/') {
+    response.writeHead(200, {"Content-Type": "text/plain"});
+    return response.end();
+  }
+
+  var username = request.headers['x-username'] || '';
+  var password = request.headers['x-password'] || '';
+  var ldapDn = 'cn=' + username + ',' + process.env.LDAP_USERS_BASE_DN;
+
+  ldapClient.bind(ldapDn, password, function (error) {
+    if (error) {
+      response.writeHead(401, {"Content-Type": "text/plain"});
+      response.end('Failed to authenticate: ' + error);
+    } else {
+      response.writeHead(200, {"Content-Type": "text/plain"});
+      response.end('Successfully authenticated');
+    }
+  });
+});
+
+server.listen(8000);
+
+console.log("Server running at port 8000");
+```
+
+Once we have used `cloudron build` and `cloudron install`, you can use `curl` to test
+credentials as follows:
+
+```bash
+  # Test with various credentials here. Your cloudon admin username and password should succeed.
+  curl -X 'X-Username: admin' -X 'X-Password: pass' https://tutorial-craft.selfhost.io/login
+```
+
+## OAuth
+
+An app can integrate with OAuth 2.0 Authorization code grant flow by adding
+[oauth](/references/addons.html#oauth) to CloudronManifest.json `addons` section.
+
+Doing so will get the following environment variables:
+```
+$ cloudron exec env
+OAUTH_CLIENT_ID=cid-addon-4089f65a-2adb-49d2-a6d1-e519b7d85e8d
+OAUTH_CLIENT_SECRET=5af99a9633283aa15f5e6df4a108ff57f82064e4845de8bce8ad3af54dfa9dda
+OAUTH_ORIGIN=https://my-craft.selfhost.io
+API_ORIGIN=https://my-craft.selfhost.io
+HOSTNAME=tutorial-craft.selfhost.io
+```
+
+OAuth Authorization code grant flow works as follows:
+* App starts the flow by redirecting the user to Cloudron authorization endpoint of the following format:
+```
+https://API_ORIGIN/api/v1/oauth/dialog/authorize?response_type=code&client_id=OAUTH_CLIENT_ID&redirect_uri=CALLBACK_URL&scope=profile
+```
+
+  In the above URL, API_ORIGIN and OAUTH_CLIENT_ID are environment variables. CALLBACK_URL is a url of the app
+to which the user will be redirected back to after successful authentication. CALLBACK_URL has to have the
+same origin as the app.
+
+* The Cloudron OAuth server authenticates the user (using a password form) at the above URL. It also establishes
+that the user grants the client's access request.
+
+* If the user authenticated successfully, it will redirect the browser to CALLBACK_URL with a `code` query parameter.
+
+* The app can exchange the `code` above for a `access token` by using the `OAUTH_CLIENT_SECRET`. It does so by making
+  a _POST_ request to the following url:
+```
+https://API_ORIGIN/api/v1/oauth/token?response_type=token&client_id=OAUTH_CLIENT_ID
+```
+with the following request body (json):
+```json
+{
+    "grant_type": "authorization_code",
+    "code": "<the code received in CALLBACK_URL query parameter>",
+    "redirect_uri": "https://<HOSTNAME>",
+    "client_id": "<OAUTH_CLIENT_ID>",
+    "client_secret": "<OAUTH_CLIENT_SECRET>"
+}
+```
+
+  In the above URL, API_ORIGIN, OAUTH_CLIENT_ID and HOSTNAME are environment variables. The response contains
+the `access_token` in the body.
+
+* The `access_token` can be used to get the [user's profile](/references/api.html#profile) using the following url:
+```
+https://API_ORIGIN/api/v1/profile?access_token=ACCESS_TOKEN
+```
+
+  The `access_token` may also be provided in the `Authorization` header as `Bearer: <token>`.
+
+An implementation of the above OAuth logic is at [ircd-app](https://github.com/cloudron-io/ircd-app/blob/master/settings/app.js).
+
+The following libraries implement Cloudron OAuth for Ruby and Javascript.
+
+ * [omniauth-cloudron](https://github.com/cloudron-io/omniauth-cloudron)
+ * [passport-cloudron](https://github.com/cloudron-io/passport-cloudron)
+
+# Beta Testing
+
+Once your app is ready, you can upload it to the store for `beta testing` by
+other Cloudron users. This can be done using:
+
+```
+  cloudron upload
+```
+
+The app should now be visible in the Store view of your cloudron under
+the 'Testing' section. You can check if the icon, description and other details
+appear correctly.
+
+Other Cloudron users can install your app on their Cloudron's using
+`cloudron install --appstore-id <appid@version>`. Note that this currently
+requires your beta testers to install the CLI tool and put their Cloudron in
+developer mode.
+
+# Publishing
+
+Once you are satisfied with the beta testing, you can submit it for review.
+
+```
+  cloudron submit
+```
+
+The cloudron.io team will review the app and publish the app to the store.
+
+# Next steps
+
+Congratulations! You are now well equipped to build web applications for the Cloudron.
+
+# Samples
+
+  * [Lets Chat](https://github.com/cloudron-io/letschat-app)
+  * [Haste bin](https://github.com/cloudron-io/haste-app)
+  * [Pasteboard](https://github.com/cloudron-io/pasteboard-app)

docs/tutorials/packaging.md

@@ -0,0 +1,497 @@
+# Overview
+
+This tutorial outlines how to package an existing web application for the Cloudron.
+
+If you are aware of Docker and Heroku, you should feel at home packaging for the
+Cloudron. Roughly, the steps involved are:
+
+* Create a Dockerfile for your application. If your application already has a Dockerfile, it 
+  is a good starting point for packaging for the Cloudron. By virtue of Docker, the Cloudron
+  is able to run apps written in any language/framework.
+
+* Create a CloudronManifest.json that provides information like title, author, description
+   etc. You can also specify the addons (like database) required
+  to run your app. When the app runs on the Cloudron, it will have environment
+  variables set for connecting to the addon.
+
+* Test the app on your Cloudron with the CLI tool.
+
+* Optionally, submit the app to [Cloudron Store](/appstore.html).
+
+# Prerequisites
+
+## Install CLI tool
+
+The Cloudron CLI tool allows you to install, configure and test apps on your Cloudron.
+
+Installing the CLI tool requires [node.js](https://nodejs.org/) and
+[npm](https://www.npmjs.com/). You can then install the CLI tool using the following
+command:
+
+```
+    sudo npm install -g cloudron
+```
+
+Note: Depending on your setup, you can run the above command without `sudo`.
+
+## Login to Cloudron
+
+The `cloudron` command should now be available in your path.
+
+You can login to your Cloudron now:
+
+```
+$ cloudron login
+Cloudron Hostname: craft.selfhost.io
+
+Enter credentials for craft.selfhost.io:
+Username: girish
+Password:
+Login successful.
+```
+
+# Basic app
+
+We will first package a very simple app to understand how the packaging works.
+You can clone this app from https://git.cloudron.io/cloudron/tutorial-basic.
+
+## The server
+
+The basic app server is a very simple HTTP server that runs on port 8000.
+While the server in this tutorial uses node.js, you can write your server
+in any language you want.
+
+```server.js
+var http = require("http");
+
+var server = http.createServer(function (request, response) {
+  response.writeHead(200, {"Content-Type": "text/plain"});
+  response.end("Hello World\n");
+});
+
+server.listen(8000);
+
+console.log("Server running at port 8000");
+```
+
+## Dockerfile
+
+The Dockerfile contains instructions on how to create an image for your application.
+
+```Dockerfile
+FROM cloudron/base:0.10.0
+
+ADD server.js /app/code/server.js
+
+CMD [ "/usr/local/node-4.4.7/bin/node", "/app/code/server.js" ]
+```
+
+The `FROM` command specifies that we want to start off with Cloudron's [base image](/references/baseimage.html).
+All Cloudron apps **must** start from this base image. This approach conserves space on the Cloudron since
+Docker images tend to be quite large and also helps us to do a security audit on apps more easily.
+
+The `ADD` command copies the source code of the app into the directory `/app/code`. There is nothing special
+about the `/app/code` directory and it is merely a convention we use to store the application code.
+
+The `CMD` command specifies how to run the server. The base image already contains many different versions of
+node.js. We use Node 4.4.7 here.
+
+This Dockerfile can be built and run locally as:
+```
+docker build -t tutorial .
+docker run -p 8000:8000 -t tutorial
+```
+
+## Manifest
+
+The `CloudronManifest.json` specifies
+
+* Information for installing and running the app on the Cloudron. This includes fields like addons, httpPort, tcpPorts.
+
+* Information about displaying the app on the Cloudron Store. For example, fields like title, author, description.
+
+Create the CloudronManifest.json using `cloudron init` as follows:
+
+```
+$ cloudron init
+id: io.cloudron.tutorial                       # unique id for this app. use reverse domain name convention
+author: John Doe                               # developer or company name of the for user <email>
+title: Tutorial App                            # Cloudron Store title of this app
+description: App that uses node.js             # A string or local file reference like file://DESCRIPTION.md
+tagline: Changing the world one app at a time  # A tag line for this app for the Cloudron Store
+website: https://cloudron.io                   # A link to this app's website
+contactEmail: support@cloudron.io              # Contact email of developer or company
+httPort: 8000                                  # The http port on which this application listens to
+```
+
+The above command creates a CloudronManifest.json:
+
+File ```tutorial/CloudronManifest.json```
+
+```json
+{
+  "id": "io.cloudron.tutorial",
+  "title": "Tutorial App",
+  "author": "John Doe",
+  "description": "file://DESCRIPTION.md",
+  "changelog": "file://CHANGELOG",
+  "tagline": "Changing the world one app at a time",
+  "version": "0.0.1",
+  "healthCheckPath": "/",
+  "httpPort": 8000,
+  "addons": {
+    "localstorage": {}
+  },
+  "manifestVersion": 1,
+  "website": "https://cloudron.io",
+  "contactEmail": "support@cloudron.io",
+  "icon": "",
+  "tags": [
+    "changme"
+  ],
+  "mediaLinks": [ ]
+}
+```
+
+You can read in more detail about each field in the [Manifest reference](/references/manifest.html). The
+`localstorage` addon allows the app to store files in `/app/data`. We will explore addons further further
+down in this tutorial.
+
+Additional files created by `init` are:
+* `DESCRIPTION.md` - A markdown file providing description of the app for the Cloudron Store.
+* `CHANGELOG` - A file containing change information for each version released to the Cloudron Store. This
+  information is shown when the user updates the app.
+
+# Installing
+
+We now have all the necessary files in place to build and deploy the app to the Cloudron.
+
+## Building
+
+Building, pushing and pulling docker images can be very bandwidth and CPU intensive. To alleviate this
+problem, apps are built using the `build service` which uses `cloudron.io` account credentials.
+
+**Warning**: As of this writing, the build service uses the public Docker registry and the images that are built
+can be downloaded by anyone. This means that your source code will be viewable by others.
+
+Initiate a build using ```cloudron build```:
+```
+$ cloudron build
+Building io.cloudron.tutorial@0.0.1
+
+Appstore login:
+Email: ramakrishnan.girish@gmail.com         # cloudron.io account
+Password:                                    # Enter password
+Login successful.
+
+Build scheduled with id e7706847-f2e3-4ba2-9638-3f334a9453a5
+Waiting for build to begin, this may take a bit...
+Downloading source
+Building
+Step 1 : FROM cloudron/base:0.10.0
+ ---> be9fc6312b2d
+Step 2 : ADD server.js /app/code/server.js
+ ---> 10513e428d7a
+Removing intermediate container 574573f6ed1c
+Step 3 : CMD /usr/local/node-4.2.1/bin/node /app/code/server.js
+ ---> Running in b541d149b6b9
+ ---> 51aa796ea6e5
+Removing intermediate container b541d149b6b9
+Successfully built 51aa796ea6e5
+Pushing
+The push refers to a repository [docker.io/cloudron/img-062037096d69bbf3ffb5b9316ad89cb9] (len: 1)
+Pushed 51aa796ea6e5
+Pushed 10513e428d7a
+Image already exists be9fc6312b2d
+Image already exists a0261a2a7c75
+Image already exists f9d4f0f1eeed
+Image already exists 2b650158d5d8
+e7706847-f2e3-4ba2-9638-3f334a9453a5: digest: sha256:8241d68b65874496191106ecf2ee8f3df2e05a953cd90ff074a6f8815a49389c size: 26098
+Build succeeded
+Success
+```
+
+## Installing
+
+Now that we have built the image, we can install our latest build on the Cloudron
+using the following command:
+
+```
+$ cloudron install
+Using cloudron craft.selfhost.io
+Using build 76cebfdd-7822-4f3d-af17-b3eb393ae604 from 1 hour ago
+Location: tutorial                         # This is the location into which the application installs
+App is being installed with id: 4dedd3bb-4bae-41ef-9f32-7f938995f85e
+
+ => Waiting to start installation
+ => Registering subdomain .
+ => Verifying manifest .
+ => Downloading image ..............
+ => Creating volume .
+ => Creating container
+ => Setting up collectd profile ................
+ => Waiting for DNS propagation ...
+
+App is installed.
+```
+
+Open the app in your default browser:
+```
+cloudron open
+```
+
+You should see `Hello World`.
+
+# Testing
+
+The application testing cycle involves `cloudron build` and `cloudron install`.
+Note that `cloudron install` updates an existing app in place.
+
+You can view the logs using `cloudron logs`. When the app is running you can follow the logs
+using `cloudron logs -f`.
+
+For example, you can see the console.log output in our server.js with the command below:
+
+```
+$ cloudron logs
+Using cloudron craft.selfhost.io
+16:44:11 [main] Server running at port 8000
+```
+
+It is also possible to run a *shell* and *execute* arbitrary commands in the context of the application
+process by using `cloudron exec`. By default, exec simply drops you into an interactive bash shell with
+which you can inspect the file system and the environment.
+
+```
+$ cloudron exec
+```
+
+You can also execute arbitrary commands:
+```
+$ cloudron exec env # display the env variables that your app is running with
+```
+
+### Debugging
+
+An app can be placed in `debug` mode by passing `--debug` to `cloudron install` or `cloudron configure`.
+Doing so, runs the app in a non-readonly rootfs and unlimited memory. By default, this will also ignore
+the `RUN` command specified in the Dockerfile. The developer can then interactively test the app and
+startup scripts using `cloudron exec`.
+
+This mode can be used to identify the files being modified by your application - often required to
+debug situations where your app does not run on a readonly rootfs. Run your app using `cloudron exec`
+and use `find / -mmin -30` to find file that have been changed or created in the last 30 minutes.
+
+You can turn off debugging mode using `cloudron configure --no-debug`.
+
+# Addons
+
+## Filesystem
+
+The application container created on the Cloudron has a `readonly` file system. Writing to any location
+other than the below will result in an error:
+
+* `/tmp` - Use this location for temporary files. The Cloudron will cleanup any files in this directory
+  periodically.
+
+* `/run` - Use this location for runtime configuration and dynamic data. These files should not be expected
+  to persist across application restarts (for example, after an update or a crash).
+
+* `/app/data` - Use this location to store application data that is to be backed up. To use this location,
+  you must use the [localstorage](/references/addons.html#localstorage) addon. For convenience, the initial CloudronManifest.json generated by
+  `cloudron init` already contains this addon.
+
+## Database
+
+Most web applications require a database of some form. In theory, it is possible to run any
+database you want as part of the application image. This is, however, a waste of server resources
+should every app runs it's own database server.
+
+Cloudron currently provides [mysql](/references/addons.html#mysql), [postgresql](/references/addons.html#postgresql),
+[mongodb](/references/addons.html#mongodb), [redis](/references/addons.html#redis) database addons. When choosing
+these addons, the Cloudron will inject environment variables that contain information on how to connect
+to the addon.
+
+See https://git.cloudron.io/cloudron/tutorial-redis for a simple example of how redis can be used by
+an application. The server simply uses the environment variables to connect to redis.
+
+## Email
+
+Cloudron applications can send email using the `sendmail` addon. Using the `sendmail` addon provides
+the SMTP server and authentication credentials in environment variables.
+
+Cloudron applications can also receive mail via IMAP using the `recvmail` addon.
+
+## Authentication
+
+The Cloudron has a centralized panel for managing users and groups. Apps can integrate Single Sign-On
+authentication using LDAP or OAuth.
+
+Apps can integrate with the Cloudron authentication system using LDAP, OAuth or Simple Auth. See the
+[authentication](/references/authentication.html) reference page for more details.
+
+See https://git.cloudron.io/cloudron/tutorial-ldap for a simple example of how to authenticate via LDAP.
+
+For apps that are single user can skip Single Sign-On support by setting the `"singleUser": true`
+in the manifest. By doing so, the Cloudron will installer will show a dialog to choose a user.
+
+For app that have no user management at all, the Cloudron implements an `OAuth proxy` that
+optionally lets the Cloudron admin make the app visible only for logged in users.
+
+# Best practices
+
+## No Setup
+
+A Cloudron app is meant to instantly usable after installation. For this reason, Cloudron apps must not
+show any setup screen after installation and should simply choose reasonable defaults.
+
+Databases, email configuration should be automatically picked up from the environment variables using
+addons.
+
+## Dockerfile
+
+The app is run as a read-only docker container. Because of this:
+* Install any required packages in the Dockerfile.
+* Create static configuration files in the Dockerfile.
+* Create symlinks to dynamic configuration files under /run in the Dockerfile.
+
+## Process manager
+
+Docker supports restarting processes natively. Should your application crash, it will be restarted
+automatically. If your application is a single process, you do not require any process manager.
+
+Use supervisor, pm2 or any of the other process managers if you application has more then one component.
+This **excludes** web servers like apache, nginx which can already manage their children by themselves.
+Be sure to pick a process manager that forwards signals to child processes.
+
+## Automatic updates
+
+Some apps support automatic updates by overwriting themselves. A Cloudron app cannot overwrite itself
+because of the read-only file system. For this reason, disable auto updates for app and let updates be
+triggered through the Cloudron Store. This ties in better to the Cloudron's update and restore approach
+should something go wrong with the update.
+
+## Logging
+
+Cloudron applications stream their logs to stdout and stderr. In practice, this ideal is hard to achieve.
+Some programs like apache simply don't log to stdout. In those cases, simply log to `/tmp` or `/run`.
+
+Logging to stdout has many advantages:
+* App does not need to rotate logs and the Cloudron takes care of managing logs.
+* App does not need special mechanism to release log file handles (on a log rotate).
+* Integrates better with tooling like cloudron cli.
+
+## Memory
+
+By default, applications get 256MB RAM (including swap). This can be changed using the `memoryLimit`
+field in the manifest.
+
+Design your application runtime for concurrent use by 50 users. The Cloudron is not designed for
+concurrent access by 100s or 1000s of users.
+
+An app can determine it's memory limit by reading `/sys/fs/cgroup/memory/memory.limit_in_bytes`.
+
+## Authentication
+
+Apps should integrate with one of the [authentication strategies](/references/authentication.html).
+This saves the user from having to manage separate set of credentials for each app.
+
+## Startup Script
+
+Many apps do not launch the server directly, as we did in our basic example. Instead, they execute
+a `start.sh` script (named so by convention) which launches the server. Before starting the server,
+the `start.sh` script does the following:
+
+  * When using the `localstorage` addon, it changes the ownership of files in `/app/data` as desired using `chown`. This
+    is necessary because file permissions may not be correctly preserved across backup, restore, application and base image
+    updates.
+
+  * Addon information (mail, database) exposed as environment  are subject to change across restarts and an application
+    must use these values directly (i.e not cache them across restarts). For this reason, it usually regenerates
+    any config files with the current database settings on each invocation.
+
+  * Finally, it starts the server as a non-root user.
+
+The app's main process must handle SIGTERM and forward it as required to child processes. bash does not
+automatically forward signals to child processes. For this reason, when using a startup shell script,
+remember to use exec <app> as the last line. Doing so will replace bash with your program and allows
+your program to handle signals as required.
+
+# Beta Testing
+
+## Metadata
+
+Publishing to the Cloudron Store requires apps to have meta data specified in the `CloudronManifest.json`.
+
+The `cloudron` tool will notify if any such information is missing, prior to uploading.
+See more information for each field [here](/references/manifest.html).
+
+## Upload for Testing
+
+Once your app is ready, you can upload it to the store for `beta testing` by
+other Cloudron users. This can be done using:
+
+```
+  cloudron upload
+```
+
+You should now be able to visit `/#/appstore/<appid>?version=<appversion>` on your
+Cloudron to check if the icon, description and other details appear correctly.
+
+Other Cloudron users can install your app on their Cloudron's using
+`cloudron install --appstore-id <appid@version>`.
+
+# Publishing
+
+Once you are satisfied with the beta testing, you can submit it for review.
+
+```
+  cloudron submit
+```
+
+The cloudron.io team will review the app and publish the app to the store.
+
+# Updating the app
+
+## Versioning
+
+To create an update for an app, simply bump up the [semver version](/references/manifest.html#version) field in
+the manifest and publish a new version to the store.
+
+The Cloudron chooses the next app version to update to based on the following algorithm:
+* Choose the maximum `patch` version matching the app's current `major` and `minor` version.
+* Failing the above, choose the maximum patch version of the next minor version matching the app's current `major` version.
+* Failing the above, choose the maximum patch and minor version of the next major version
+
+For example, let's assume the versions 1.1.3, 1.1.4, 1.1.5, 1.2.4, 1.2.6, 1.3.0, 2.0.0 are published.
+
+* If the app is running 1.1.3, then app will directly update to 1.1.5 (skipping 1.1.4)
+* Once in 1.1.5, the app will update to 1.2.6 (skipping 1.2.4)
+* Once in 1.2.6, the app will update to 1.3.0
+* Once in 1.3.0, the app will update to 2.0.0
+
+The Cloudron admins get notified by email for any major or minor app releases.
+
+## Failed updates
+
+The Cloudron always makes a backup of the app before making an update. Should the
+update fail, the user can restore to the backup (which will also restore the app's
+code to the previous version).
+
+# Cloudron Button
+
+The [Cloudron Button](/references/button.html) allows anyone to install your application with the click of a button
+on their Cloudron.
+
+The button can be added to just about any website including the application's website
+and README.md files in GitHub repositories.
+
+# Next steps
+
+Congratulations! You are now well equipped to build web applications for the Cloudron.
+
+You can see some examples of how real apps are packaged here:
+
+  * [Lets Chat](https://git.cloudron.io/cloudron/letschat-app)
+  * [Haste bin](https://git.cloudron.io/cloudron/haste-app)
+  * [Pasteboard](https://git.cloudron.io/cloudron/pasteboard-app)

gulpfile.js

@@ -0,0 +1,201 @@
+/* jslint node:true */
+
+'use strict';
+
+var ejs = require('gulp-ejs'),
+    gulp = require('gulp'),
+    del = require('del'),
+    concat = require('gulp-concat'),
+    uglify = require('gulp-uglify'),
+    serve = require('gulp-serve'),
+    sass = require('gulp-sass'),
+    sourcemaps = require('gulp-sourcemaps'),
+    cssnano = require('gulp-cssnano'),
+    autoprefixer = require('gulp-autoprefixer'),
+    argv = require('yargs').argv;
+
+gulp.task('3rdparty', function () {
+    gulp.src([
+        'webadmin/src/3rdparty/**/*.js',
+        'webadmin/src/3rdparty/**/*.map',
+        'webadmin/src/3rdparty/**/*.css',
+        'webadmin/src/3rdparty/**/*.otf',
+        'webadmin/src/3rdparty/**/*.eot',
+        'webadmin/src/3rdparty/**/*.svg',
+        'webadmin/src/3rdparty/**/*.gif',
+        'webadmin/src/3rdparty/**/*.ttf',
+        'webadmin/src/3rdparty/**/*.woff',
+        'webadmin/src/3rdparty/**/*.woff2'
+        ])
+        .pipe(gulp.dest('webadmin/dist/3rdparty/'))
+        .pipe(gulp.dest('setup/splash/website/3rdparty'));
+
+    gulp.src('node_modules/bootstrap-sass/assets/javascripts/bootstrap.min.js')
+        .pipe(gulp.dest('webadmin/dist/3rdparty/js'))
+        .pipe(gulp.dest('setup/splash/website/3rdparty/js'));
+});
+
+
+// --------------
+// JavaScript
+// --------------
+
+if (argv.help || argv.h) {
+    console.log('Supported arguments for "gulp develop":');
+    console.log(' --client-id <clientId>');
+    console.log(' --client-secret <clientSecret>');
+    console.log(' --api-origin <cloudron api uri>');
+
+    process.exit(1);
+}
+
+gulp.task('js', ['js-index', 'js-setup', 'js-setupdns', 'js-update'], function () {});
+
+var oauth = {
+    clientId: argv.clientId || 'cid-webadmin',
+    clientSecret: argv.clientSecret || 'unused',
+    apiOrigin: argv.apiOrigin || ''
+};
+
+console.log();
+console.log('Using OAuth credentials:');
+console.log(' ClientId:     %s', oauth.clientId);
+console.log(' ClientSecret: %s', oauth.clientSecret);
+console.log(' Cloudron API: %s', oauth.apiOrigin || 'default');
+console.log();
+
+
+gulp.task('js-index', function () {
+    // needs special treatment for error handling
+    var uglifyer = uglify();
+    uglifyer.on('error', function (error) {
+        console.error(error);
+    });
+
+    gulp.src([
+        'webadmin/src/js/index.js',
+        'webadmin/src/js/client.js',
+        'webadmin/src/js/appstore.js',
+        'webadmin/src/js/main.js',
+        'webadmin/src/views/*.js'
+        ])
+        .pipe(ejs({ oauth: oauth }, { ext: '.js' }))
+        .pipe(sourcemaps.init())
+        .pipe(concat('index.js', { newLine: ';' }))
+        .pipe(uglifyer)
+        .pipe(sourcemaps.write())
+        .pipe(gulp.dest('webadmin/dist/js'));
+});
+
+gulp.task('js-setup', function () {
+    // needs special treatment for error handling
+    var uglifyer = uglify();
+    uglifyer.on('error', function (error) {
+        console.error(error);
+    });
+
+    gulp.src(['webadmin/src/js/setup.js', 'webadmin/src/js/client.js'])
+        .pipe(ejs({ oauth: oauth }, { ext: '.js' }))
+        .pipe(sourcemaps.init())
+        .pipe(concat('setup.js', { newLine: ';' }))
+        .pipe(uglifyer)
+        .pipe(sourcemaps.write())
+        .pipe(gulp.dest('webadmin/dist/js'));
+});
+
+gulp.task('js-setupdns', function () {
+    // needs special treatment for error handling
+    var uglifyer = uglify();
+    uglifyer.on('error', function (error) {
+        console.error(error);
+    });
+
+    gulp.src(['webadmin/src/js/setupdns.js', 'webadmin/src/js/client.js'])
+        .pipe(ejs({ oauth: oauth }, { ext: '.js' }))
+        .pipe(sourcemaps.init())
+        .pipe(concat('setupdns.js', { newLine: ';' }))
+        .pipe(uglifyer)
+        .pipe(sourcemaps.write())
+        .pipe(gulp.dest('webadmin/dist/js'));
+});
+
+gulp.task('js-update', function () {
+    // needs special treatment for error handling
+    var uglifyer = uglify();
+    uglifyer.on('error', function (error) {
+        console.error(error);
+    });
+
+    gulp.src(['webadmin/src/js/update.js'])
+        .pipe(sourcemaps.init())
+        .pipe(uglifyer)
+        .pipe(sourcemaps.write())
+        .pipe(gulp.dest('webadmin/dist/js'))
+        .pipe(gulp.dest('setup/splash/website/js'));
+});
+
+
+// --------------
+// HTML
+// --------------
+
+gulp.task('html', ['html-views', 'html-update', 'html-templates'], function () {
+    return gulp.src('webadmin/src/*.html').pipe(gulp.dest('webadmin/dist'));
+});
+
+gulp.task('html-update', function () {
+    return gulp.src(['webadmin/src/update.html']).pipe(gulp.dest('setup/splash/website'));
+});
+
+gulp.task('html-views', function () {
+    return gulp.src('webadmin/src/views/**/*.html').pipe(gulp.dest('webadmin/dist/views'));
+});
+
+gulp.task('html-templates', function () {
+    return gulp.src('webadmin/src/templates/**/*.html').pipe(gulp.dest('webadmin/dist/templates'));
+});
+
+// --------------
+// CSS
+// --------------
+
+gulp.task('css', function () {
+    return gulp.src('webadmin/src/*.scss')
+        .pipe(sourcemaps.init())
+        .pipe(sass({ includePaths: ['node_modules/bootstrap-sass/assets/stylesheets/'] }).on('error', sass.logError))
+        .pipe(autoprefixer())
+        .pipe(cssnano())
+        .pipe(sourcemaps.write())
+        .pipe(gulp.dest('webadmin/dist'))
+        .pipe(gulp.dest('setup/splash/website'));
+});
+
+gulp.task('images', function () {
+    return gulp.src('webadmin/src/img/**')
+        .pipe(gulp.dest('webadmin/dist/img'));
+});
+
+// --------------
+// Utilities
+// --------------
+
+gulp.task('watch', ['default'], function () {
+    gulp.watch(['webadmin/src/*.scss'], ['css']);
+    gulp.watch(['webadmin/src/img/*'], ['images']);
+    gulp.watch(['webadmin/src/**/*.html'], ['html']);
+    gulp.watch(['webadmin/src/views/*.html'], ['html-views']);
+    gulp.watch(['webadmin/src/templates/*.html'], ['html-templates']);
+    gulp.watch(['webadmin/src/js/update.js'], ['js-update']);
+    gulp.watch(['webadmin/src/js/setup.js', 'webadmin/src/js/client.js'], ['js-setup']);
+    gulp.watch(['webadmin/src/js/setupdns.js', 'webadmin/src/js/client.js'], ['js-setupdns']);
+    gulp.watch(['webadmin/src/js/index.js', 'webadmin/src/js/client.js', 'webadmin/src/js/appstore.js', 'webadmin/src/js/main.js', 'webadmin/src/views/*.js'], ['js-index']);
+    gulp.watch(['webadmin/src/3rdparty/**/*'], ['3rdparty']);
+});
+
+gulp.task('clean', function () {
+    del.sync(['webadmin/dist', 'setup/splash/website']);
+});
+
+gulp.task('default', ['clean', 'html', 'js', '3rdparty', 'images', 'css'], function () {});
+
+gulp.task('develop', ['watch'], serve({ root: 'webadmin/dist', port: 4000 }));

migrations/20160208031241-groups-add-table.js

@@ -1,7 +1,7 @@
 'use strict';
 
 exports.up = function(db, callback) {
-    var cmd = "CREATE TABLE userGroups(" +
+    var cmd = "CREATE TABLE groups(" +
                 "id VARCHAR(128) NOT NULL UNIQUE," +
                 "name VARCHAR(128) NOT NULL UNIQUE," +
                 "PRIMARY KEY(id))";
@@ -13,7 +13,7 @@ exports.up = function(db, callback) {
 };
 
 exports.down = function(db, callback) {
-    db.runSql('DROP TABLE userGroups', function (error) {
+    db.runSql('DROP TABLE groups', function (error) {
         if (error) console.error(error);
         callback(error);
     });

migrations/20160208100000-groupMembers-add-table.js

@@ -4,7 +4,7 @@ exports.up = function(db, callback) {
 	var cmd = "CREATE TABLE IF NOT EXISTS groupMembers(" +
     			"groupId VARCHAR(128) NOT NULL," +
     			"userId VARCHAR(128) NOT NULL," +
-    			"FOREIGN KEY(groupId) REFERENCES userGroups(id)," +
+    			"FOREIGN KEY(groupId) REFERENCES groups(id)," +
     			"FOREIGN KEY(userId) REFERENCES users(id));";
 
     db.runSql(cmd, function (error) {

migrations/20160208164735-groups-add-admin.js

@@ -2,16 +2,18 @@
 
 var async = require('async');
 
-var ADMIN_GROUP_ID = 'admin'; // see constants.js
+var ADMIN_GROUP_ID = 'admin'; // see groups.js
 
 exports.up = function(db, callback) {
 	async.series([
 		db.runSql.bind(db, 'START TRANSACTION;'),
-		db.runSql.bind(db, 'INSERT INTO userGroups (id, name) VALUES (?, ?)', [ ADMIN_GROUP_ID, 'admin' ]),
+		db.runSql.bind(db, 'INSERT INTO groups (id, name) VALUES (?, ?)', [ ADMIN_GROUP_ID, 'admin' ]),
 		function migrateAdminFlag(done) {
 			db.all('SELECT * FROM users WHERE admin=1', function (error, results) {
 				if (error) return done(error);
 
+				console.dir(results);
+
 				async.eachSeries(results, function (r, next) {
 					db.runSql('INSERT INTO groupMembers (groupId, userId) VALUES (?, ?)', [ ADMIN_GROUP_ID, r.id ], next);
 				}, done);

migrations/20160430062446-eventlog-add-table.js

@@ -3,10 +3,10 @@
 exports.up = function(db, callback) {
     var cmd = "CREATE TABLE eventlog(" +
             "id VARCHAR(128) NOT NULL," +
-            "source TEXT," +
+            "source JSON," +
             "creationTime TIMESTAMP," +
             "action VARCHAR(128) NOT NULL," +
-            "data TEXT," +
+            "data JSON," +
             "PRIMARY KEY (id))";
 
     db.runSql(cmd, function (error) {

migrations/20160921205726-mailboxes-add-ownerId.js

@@ -10,7 +10,7 @@ exports.up = function(db, callback) {
         function addGroupMailboxes(done) {
             console.log('Importing group mailboxes');
 
-            db.all('SELECT id, name FROM userGroups', function (error, results) {
+            db.all('SELECT id, name FROM groups', function (error, results) {
                 if (error) return done(error);
 
                 async.eachSeries(results, function (g, next) {

migrations/20170325203037-appaddonconfigs-add-name.js

@@ -1,16 +0,0 @@
-'use strict';
-
-exports.up = function(db, callback) {
-    db.runSql('ALTER TABLE appAddonConfigs ADD COLUMN name VARCHAR(128)', function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};
-
-exports.down = function(db, callback) {
-    db.runSql('ALTER TABLE appAddonConfigs DROP COLUMN name', function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};
-

migrations/20170414193114-database-utf8mb4.js

@@ -1,14 +0,0 @@
-'use strict';
-
-var url = require('url');
-
-exports.up = function(db, callback) {
-    var dbName = url.parse(process.env.DATABASE_URL).path.substr(1); // remove slash
-
-    // by default, mysql collates case insensitively. 'utf8_general_cs' is not available
-    db.runSql('ALTER DATABASE ' + dbName + '  DEFAULT CHARACTER SET=utf8mb4 DEFAULT COLLATE utf8mb4_unicode_ci', callback);
-};
-
-exports.down = function(db, callback) {
-    callback();
-};

migrations/20170418073650-backups-add-restoreConfigJson.js

@@ -1,95 +0,0 @@
-'use strict';
-
-var async = require('async');
-
-// from apps.js DO NOT UPDATE WHEN apps.js changes, as this is part of db migration!!
-function postProcess(result) {
-    try {
-        result.manifest = JSON.parse(result.manifestJson);
-        delete result.manifestJson;
-
-        result.oldConfig = JSON.parse(result.oldConfigJson);
-        delete result.oldConfigJson;
-
-        result.portBindings = { };
-        var hostPorts = result.hostPorts === null ? [ ] : result.hostPorts.split(',');
-        var environmentVariables = result.environmentVariables === null ? [ ] : result.environmentVariables.split(',');
-
-        delete result.hostPorts;
-        delete result.environmentVariables;
-
-        for (var i = 0; i < environmentVariables.length; i++) {
-            result.portBindings[environmentVariables[i]] = parseInt(hostPorts[i], 10);
-        }
-
-        result.accessRestriction = JSON.parse(result.accessRestrictionJson);
-        if (result.accessRestriction && !result.accessRestriction.users) result.accessRestriction.users = [];
-        delete result.accessRestrictionJson;
-
-        // TODO remove later once all apps have this attribute
-        result.xFrameOptions = result.xFrameOptions || 'SAMEORIGIN';
-
-        result.sso = !!result.sso; // make it bool
-
-        result.debugMode = JSON.parse(result.debugModeJson);
-        delete result.debugModeJson;
-    } catch (e) {
-        console.error('Failed to get restoreConfig for app.', e);
-        console.error('Falling back to empty values to make the update succeed.');
-        result.manifest = null;
-    }
-}
-
-// from apps.js DO NOT UPDATE WHEN apps.js changes, as this is part of db migration!!
-var APPS_FIELDS_PREFIXED = [ 'apps.id', 'apps.appStoreId', 'apps.installationState', 'apps.installationProgress', 'apps.runState',
-    'apps.health', 'apps.containerId', 'apps.manifestJson', 'apps.httpPort', 'apps.location', 'apps.dnsRecordId',
-    'apps.accessRestrictionJson', 'apps.lastBackupId', 'apps.oldConfigJson', 'apps.memoryLimit', 'apps.altDomain',
-    'apps.xFrameOptions', 'apps.sso', 'apps.debugModeJson' ].join(',');
-
-exports.up = function(db, callback) {
-    async.series([
-        db.runSql.bind(db, 'ALTER TABLE backups ADD COLUMN restoreConfigJson TEXT'),
-        // fill all the backups with restoreConfigs from current apps
-        function addRestoreConfigs(callback) {
-            console.log('Importing restoreConfigs');
-
-            var appQuery = 'SELECT ' + APPS_FIELDS_PREFIXED + ',' +
-                'GROUP_CONCAT(CAST(appPortBindings.hostPort AS CHAR(6))) AS hostPorts, GROUP_CONCAT(appPortBindings.environmentVariable) AS environmentVariables' +
-                ' FROM apps LEFT OUTER JOIN appPortBindings ON apps.id = appPortBindings.appId' +
-                ' GROUP BY apps.id ORDER BY apps.id';
-
-            db.all(appQuery, function (error, apps) {
-                if (error) return callback(error);
-
-                apps.forEach(postProcess);
-
-                async.eachSeries(apps, function (app, next) {
-                    if (app.manifest === null) return next();
-
-                    db.all('SELECT * FROM backups WHERE type="app" AND id LIKE "%app%\\_' + app.id + '\\_%"', function (error, backups) {
-                        if (error) return next(error);
-
-                        // from apps.js:getAppConfig()
-                        var restoreConfig = {
-                            manifest: app.manifest,
-                            location: app.location,
-                            accessRestriction: app.accessRestriction,
-                            portBindings: app.portBindings,
-                            memoryLimit: app.memoryLimit,
-                            xFrameOptions: app.xFrameOptions || 'SAMEORIGIN',
-                            altDomain: app.altDomain
-                        };
-
-                        async.eachSeries(backups, function (backup, next) {
-                            db.runSql('UPDATE backups SET restoreConfigJson=?,creationTime=creationTime WHERE id=?', [ JSON.stringify(restoreConfig), backup.id ], next);
-                        }, next);
-                    });
-                }, callback);
-            });
-        }
-    ], callback);
-};
-
-exports.down = function(db, callback) {
-    db.runSql('ALTER TABLE backups DROP COLUMN restoreConfigJson', callback);
-};

migrations/20170423032116-settings-set-default-retentionSecs.js

@@ -1,22 +0,0 @@
-'use strict';
-
-exports.up = function(db, callback) {
-    db.all('SELECT value FROM settings WHERE name="backup_config"', function (error, results) {
-        if (error || results.length === 0) return callback(error);
-
-        var backupConfig = JSON.parse(results[0].value);
-        if (backupConfig.provider === 'filesystem') {
-            backupConfig.retentionSecs = 2 * 24 * 60 * 60; // 2 days
-        } else if (backupConfig.provider === 's3') { // S3
-            backupConfig.retentionSecs = -1;
-        } else if (backupConfig.provider === 'caas') {
-            backupConfig.retentionSecs = 10 * 24 * 60 * 60; // 10 days
-        }
-        db.runSql('UPDATE settings SET value=? WHERE name="backup_config"', [ JSON.stringify(backupConfig) ], callback);
-
-    });
-};
-
-exports.down = function(db, callback) {
-  callback();
-};

migrations/20170628173051-settings-default-mailrelay.js

@@ -1,9 +0,0 @@
-'use strict';
-
-exports.up = function(db, callback) {
-    db.runSql('INSERT settings (name, value) VALUES("mail_relay", ?)', [ JSON.stringify({ provider: 'cloudron-smtp' }) ], callback);
-};
-
-exports.down = function(db, callback) {
-    db.runSql('DELETE * FROM settings WHERE name="mail_relay"', [ ], callback);
-};

migrations/20170714170908-appdb-add-robotsTxt.js

@@ -1,15 +0,0 @@
-'use strict';
-
-exports.up = function(db, callback) {
-    db.runSql('ALTER TABLE apps ADD COLUMN robotsTxt TEXT', function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};
-
-exports.down = function(db, callback) {
-    db.runSql('ALTER TABLE apps DROP COLUMN robotsTxt', function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};

migrations/20170731073447-eventlog-alter-data-and-source.js

@@ -1,29 +0,0 @@
-'use strict';
-
-// we used to have JSON as the db type for those two, however mariadb does not support it
-// and we never used any JSON related features, but have the TEXT pattern everywhere
-// This ensures all old cloudrons will have the columns altered
-
-exports.up = function(db, callback) {
-    db.runSql('ALTER TABLE eventlog MODIFY data TEXT', [], function (error) {
-        if (error) console.error(error);
-
-        db.runSql('ALTER TABLE eventlog MODIFY source TEXT', [], function (error) {
-            if (error) console.error(error);
-
-            callback(error);
-        });
-    });
-};
-
-exports.down = function(db, callback) {
-    db.runSql('ALTER TABLE eventlog MODIFY data TEXT', [], function (error) {
-        if (error) console.error(error);
-
-        db.runSql('ALTER TABLE eventlog MODIFY source TEXT', [], function (error) {
-            if (error) console.error(error);
-
-            callback(error);
-        });
-    });
-};

migrations/20170816211111-appdb-add-enableBackup.js.js

@@ -1,16 +0,0 @@
-'use strict';
-
-exports.up = function(db, callback) {
-    db.runSql('ALTER TABLE apps ADD COLUMN enableBackup BOOLEAN DEFAULT 1', function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};
-
-exports.down = function(db, callback) {
-    db.runSql('ALTER TABLE apps DROP COLUMN enableBackup', function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};
-

migrations/20170911133441-settings-alter-value.js

@@ -1,15 +0,0 @@
-'use strict';
-
-exports.up = function(db, callback) {
-    db.runSql('ALTER TABLE settings MODIFY value TEXT', [], function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};
-
-exports.down = function(db, callback) {
-    db.runSql('ALTER TABLE settings MODIFY value VARCHAR(512)', [], function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};

migrations/20170919185109-settings-set-backupConfig-defaults.js

@@ -1,25 +0,0 @@
-'use strict';
-
-// ensure backupFolder and format are not empty
-exports.up = function(db, callback) {
-    db.all('SELECT * FROM settings WHERE name=?', [ 'backup_config' ], function (error, result) {
-        if (error || result.length === 0) return callback(error);
-
-        var value = JSON.parse(result[0].value);
-        value.format = 'tgz'; // set the format
-
-        if (value.provider === 'filesystem' && !value.backupFolder) {
-            value.backupFolder = '/var/backups'; // set the backupFolder
-        }
-
-        db.runSql('UPDATE settings SET value = ? WHERE name = ?', [ JSON.stringify(value), 'backup_config' ], function (error) {
-            if (error) console.error('Error setting ownerid ' + JSON.stringify(u) + error);
-            callback();
-        });
-
-    });
-};
-
-exports.down = function(db, callback) {
-    callback();
-};

migrations/20170928003352-backups-add-format.js

@@ -1,15 +0,0 @@
-'use strict';
-
-exports.up = function(db, callback) {
-    db.runSql('ALTER TABLE backups ADD COLUMN format VARCHAR(16) DEFAULT "tgz"', function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};
-
-exports.down = function(db, callback) {
-    db.runSql('ALTER TABLE backups DROP COLUMN format', function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};

migrations/20171013003424-apps-add-newConfigJson.js

@@ -1,15 +0,0 @@
-'use strict';
-
-exports.up = function(db, callback) {
-    db.runSql('ALTER TABLE apps ADD COLUMN newConfigJson TEXT', function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};
-
-exports.down = function(db, callback) {
-    db.runSql('ALTER TABLE apps DROP COLUMN newConfigJson', function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};

migrations/20171116191443-backups-add-manifestJson.js

@@ -1,40 +0,0 @@
-'use strict';
-
-var async = require('async');
-
-exports.up = function(db, callback) {
-    async.series([
-        db.runSql.bind(db, 'ALTER TABLE backups ADD COLUMN manifestJson TEXT'),
-
-        db.runSql.bind(db, 'START TRANSACTION;'),
-
-        // fill all the backups with restoreConfigs from current apps
-        function addManifests(callback) {
-            console.log('Importing manifests');
-
-            db.all('SELECT * FROM backups WHERE type="app"', function (error, backups) {
-                if (error) return callback(error);
-
-                async.eachSeries(backups, function (backup, next) {
-                    var m = backup.restoreConfigJson ? JSON.parse(backup.restoreConfigJson) : null;
-                    if (m) m = JSON.stringify(m.manifest);
-
-                    db.runSql('UPDATE backups SET manifestJson=? WHERE id=?', [ m, backup.id ], next);
-                }, callback);
-            });
-        },
-
-        db.runSql.bind(db, 'COMMIT'),
-
-        // remove the restoreConfig
-        db.runSql.bind(db, 'ALTER TABLE backups DROP COLUMN restoreConfigJson')
-    ], callback);
-};
-
-exports.down = function(db, callback) {
-    async.series([
-        db.runSql.bind(db, 'ALTER TABLE backups DROP COLUMN manifestJson'),
-        db.runSql.bind(db, 'ALTER TABLE backups ADD COLUMN restoreConfigJson TEXT'),
-    ], callback);
-};
-

migrations/20171116203507-apps-rename-newConfigJson-to-updateConfigJson.js

@@ -1,15 +0,0 @@
-'use strict';
-
-exports.up = function(db, callback) {
-    db.runSql('ALTER TABLE apps CHANGE newConfigJson updateConfigJson TEXT', [], function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};
-
-exports.down = function(db, callback) {
-    db.runSql('ALTER TABLE apps CHANGE updateConfigJson newConfigJson TEXT', [], function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};

migrations/20171116224051-apps-rename-lastBackupId-to-restoreConfigJson.js

@@ -1,15 +0,0 @@
-'use strict';
-
-exports.up = function(db, callback) {
-    db.runSql('ALTER TABLE apps CHANGE lastBackupId restoreConfigJson TEXT', [], function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};
-
-exports.down = function(db, callback) {
-    db.runSql('ALTER TABLE apps CHANGE restoreConfigJson lastBackupId TEXT', [], function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};

migrations/20171118000000-ensure-collation-utf8_bin.js

@@ -1,31 +0,0 @@
-'use strict';
-
-// WARNING!!
-// At this point the default db collation is utf8mb4_unicode_ci however we already have foreign key constraits
-// already with tables on utf8_bin charset, so we cannot convert all tables here to utf8mb4 collation without
-// a reimport from a sql dump, as foreign keys across different collations are not supported
-
-var async = require('async');
-
-exports.up = function(db, callback) {
-    async.series([
-        db.runSql.bind(db, 'ALTER TABLE appPortBindings CONVERT TO CHARACTER SET utf8 COLLATE utf8_bin'),
-        db.runSql.bind(db, 'ALTER TABLE apps CONVERT TO CHARACTER SET utf8 COLLATE utf8_bin'),
-        db.runSql.bind(db, 'ALTER TABLE authcodes CONVERT TO CHARACTER SET utf8 COLLATE utf8_bin'),
-        db.runSql.bind(db, 'ALTER TABLE backups CONVERT TO CHARACTER SET utf8 COLLATE utf8_bin'),
-        db.runSql.bind(db, 'ALTER TABLE clients CONVERT TO CHARACTER SET utf8 COLLATE utf8_bin'),
-        db.runSql.bind(db, 'ALTER TABLE eventlog CONVERT TO CHARACTER SET utf8 COLLATE utf8_bin'),
-        db.runSql.bind(db, 'ALTER TABLE groupMembers CONVERT TO CHARACTER SET utf8 COLLATE utf8_bin'),
-        db.runSql.bind(db, 'ALTER TABLE userGroups CONVERT TO CHARACTER SET utf8 COLLATE utf8_bin'),
-        db.runSql.bind(db, 'ALTER TABLE mailboxes CONVERT TO CHARACTER SET utf8 COLLATE utf8_bin'),
-        db.runSql.bind(db, 'ALTER TABLE migrations CONVERT TO CHARACTER SET utf8 COLLATE utf8_bin'),
-        db.runSql.bind(db, 'ALTER TABLE settings CONVERT TO CHARACTER SET utf8 COLLATE utf8_bin'),
-        db.runSql.bind(db, 'ALTER TABLE tokens CONVERT TO CHARACTER SET utf8 COLLATE utf8_bin'),
-        db.runSql.bind(db, 'ALTER TABLE users CONVERT TO CHARACTER SET utf8 COLLATE utf8_bin')
-    ], callback);
-};
-
-exports.down = function(db, callback) {
-    // nothing to be done here
-    callback();
-};

migrations/20171118000001-apps-add-domain.js

@@ -1,70 +0,0 @@
-'use strict';
-
-var async = require('async'),
-    safe = require('safetydance');
-
-exports.up = function(db, callback) {
-    // first check precondtion of domain entry in settings
-    db.all('SELECT * FROM settings WHERE name = ?', [ 'domain' ], function (error, result) {
-        if (error) return callback(error);
-
-        var domain = {};
-        if (result[0]) domain = safe.JSON.parse(result[0].value) || {};
-
-        async.series([
-            db.runSql.bind(db, 'START TRANSACTION;'),
-            function addAppsDomainColumn(done) {
-                db.runSql('ALTER TABLE apps ADD COLUMN domain VARCHAR(128)', [], done);
-            },
-            function setAppDomain(done) {
-                if (!domain.fqdn) return done(); // skip for new cloudrons without a domain
-                db.runSql('UPDATE apps SET domain = ?', [ domain.fqdn ], done);
-            },
-            function addAppsLocationDomainUniqueConstraint(done) {
-                db.runSql('ALTER TABLE apps ADD UNIQUE location_domain_unique_index (location, domain)', [], done);
-            },
-            function removePresetupAdminGroupIfNew(done) {
-                // do not delete on update, will update the record in setMailboxesDomain()
-                if (domain.fqdn) return done();
-
-                // this will be finally created once we have a domain when we create the owner in user.js
-                const ADMIN_GROUP_ID = 'admin'; // see constants.js
-                db.runSql('DELETE FROM userGroups WHERE id = ?', [ ADMIN_GROUP_ID ], function (error) {
-                    if (error) return done(error);
-
-                    db.runSql('DELETE FROM mailboxes WHERE ownerId = ?', [ ADMIN_GROUP_ID ], done);
-                });
-            },
-            function addMailboxesDomainColumn(done) {
-                db.runSql('ALTER TABLE mailboxes ADD COLUMN domain VARCHAR(128)', [], done);
-            },
-            function setMailboxesDomain(done) {
-                if (!domain.fqdn) return done(); // skip for new cloudrons without a domain
-                db.runSql('UPDATE mailboxes SET domain = ?', [ domain.fqdn ], done);
-            },
-            function dropAppsLocationUniqueConstraint(done) {
-                db.runSql('ALTER TABLE apps DROP INDEX location', [], done);
-            },
-            db.runSql.bind(db, 'COMMIT')
-        ], callback);
-    });
-};
-
-exports.down = function(db, callback) {
-    async.series([
-        db.runSql.bind(db, 'START TRANSACTION;'),
-        function dropMailboxesDomainColumn(done) {
-            db.runSql('ALTER TABLE mailboxes DROP COLUMN domain', [], done);
-        },
-        function dropLocationDomainUniqueConstraint(done) {
-            db.runSql('ALTER TABLE apps DROP INDEX location_domain_unique_index', [], done);
-        },
-        function dropAppsDomainColumn(done) {
-            db.runSql('ALTER TABLE apps DROP COLUMN domain', [], done);
-        },
-        function addAppsLocationUniqueConstraint(done) {
-            db.runSql('ALTER TABLE apps ADD UNIQUE location (location)', [], done);
-        },
-        db.runSql.bind(db, 'COMMIT')
-    ], callback);
-};

migrations/20171118000002-domains-add-table.js

@@ -1,61 +0,0 @@
-'use strict';
-
-var async = require('async'),
-    safe = require('safetydance'),
-    tld = require('tldjs');
-
-exports.up = function(db, callback) {
-    var fqdn, zoneName, configJson;
-
-    async.series([
-        function gatherDomain(done) {
-            db.all('SELECT * FROM settings WHERE name = ?', [ 'domain' ], function (error, result) {
-                if (error) return done(error);
-
-                var domain = {};
-                if (result[0]) domain = safe.JSON.parse(result[0].value) || {};
-
-                fqdn = domain.fqdn || ''; // will be null pre-setup
-                zoneName = domain.zoneName || tld.getDomain(fqdn) || fqdn;
-
-                done();
-            });
-        },
-        function gatherDNSConfig(done) {
-            db.all('SELECT * FROM settings WHERE name = ?', [ 'dns_config' ], function (error, result) {
-                if (error) return done(error);
-
-                configJson = (result[0] && result[0].value) ? result[0].value : JSON.stringify({ provider: 'manual'});
-
-                // caas dns config needs an fqdn
-                var config = JSON.parse(configJson);
-                if (config.provider === 'caas') config.fqdn = fqdn;
-                configJson = JSON.stringify(config);
-
-                done();
-            });
-        },
-        db.runSql.bind(db, 'START TRANSACTION;'),
-        function createDomainsTable(done) {
-            var cmd = `
-                CREATE TABLE domains(
-                domain VARCHAR(128) NOT NULL UNIQUE,
-                zoneName VARCHAR(128) NOT NULL,
-                configJson TEXT,
-                PRIMARY KEY (domain)) CHARACTER SET utf8 COLLATE utf8_bin
-            `;
-
-            db.runSql(cmd, [], done);
-        },
-        function addInitialDomain(done) {
-            if (!fqdn) return done();
-
-            db.runSql('INSERT INTO domains (domain, zoneName, configJson) VALUES (?, ?, ?)', [ fqdn, zoneName, configJson ], done);
-        },
-        db.runSql.bind(db, 'COMMIT')
-    ], callback);
-};
-
-exports.down = function(db, callback) {
-    db.runSql('DROP TABLE domains', callback);
-};

migrations/20171118000003-apps-add-domain-constraint.js

@@ -1,15 +0,0 @@
-'use strict';
-
-exports.up = function(db, callback) {
-    db.runSql('ALTER TABLE apps ADD CONSTRAINT apps_domain_constraint FOREIGN KEY(domain) REFERENCES domains(domain)', function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};
-
-exports.down = function(db, callback) {
-    db.runSql('ALTER TABLE apps DROP FOREIGN KEY apps_domain_constraint', function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};

migrations/20171118000004-mailboxes-add-domain-constraint.js

@@ -1,15 +0,0 @@
-'use strict';
-
-exports.up = function(db, callback) {
-    db.runSql('ALTER TABLE mailboxes ADD CONSTRAINT mailboxes_domain_constraint FOREIGN KEY(domain) REFERENCES domains(domain)', function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};
-
-exports.down = function(db, callback) {
-    db.runSql('ALTER TABLE mailboxes DROP FOREIGN KEY mailboxes_domain_constraint', function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};

migrations/20171118000005-mailboxes-drop-name-constraint.js

@@ -1,15 +0,0 @@
-'use strict';
-
-exports.up = function(db, callback) {
-    db.runSql('ALTER TABLE mailboxes DROP PRIMARY KEY', function (error) {
-      if (error) console.error(error);
-      callback(error);
-    });
-};
-
-exports.down = function(db, callback) {
-    db.runSql('ALTER TABLE mailboxes ADD PRIMARY KEY(name)', function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};

migrations/20171118000006-mailboxes-add-name-domain-constraint.js

@@ -1,15 +0,0 @@
-'use strict';
-
-exports.up = function(db, callback) {
-    db.runSql('ALTER TABLE mailboxes ADD UNIQUE mailboxes_name_domain_unique_index (name, domain)', function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};
-
-exports.down = function(db, callback) {
-    db.runSql('ALTER TABLE mailboxes DROP INDEX mailboxes_name_domain_unique_index', function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};

migrations/20171119203452-apps-add-updateTime.js

@@ -1,15 +0,0 @@
-'use strict';
-
-exports.up = function(db, callback) {
-    db.runSql('ALTER TABLE apps ADD COLUMN updateTime TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP', function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};
-
-exports.down = function(db, callback) {
-    db.runSql('ALTER TABLE apps DROP COLUMN updateTime', function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};

migrations/20171119204952-apps-rename-createdAt-to-creationTime.js

@@ -1,15 +0,0 @@
-'use strict';
-
-exports.up = function(db, callback) {
-    db.runSql('ALTER TABLE apps CHANGE createdAt creationTime TIMESTAMP(2) NOT NULL', [], function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};
-
-exports.down = function(db, callback) {
-    db.runSql('ALTER TABLE apps CHANGE creationTime createdAt TIMESTAMP(2) NOT NULL', [], function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};

migrations/20171129005712-settings-add-fqdn-to-caas-backup-config.js

@@ -1,28 +0,0 @@
-'use strict';
-
-var async = require('async');
-
-// NOTE: This migration is incorrect because 'caas' domain is not guaranteed to be present in all Caas cloudrons
-exports.up = function(db, callback) {
-    db.all('SELECT * FROM domains', function (error, domains) {
-        if (error) return callback(error);
-
-        var caasDomains = domains.filter(function (d) { return JSON.parse(d.configJson).provider === 'caas'; });
-        if (caasDomains.length === 0) return callback();
-        var caasDomain = caasDomains[0].domain;
-
-        db.all('SELECT * FROM settings WHERE name=?', [ 'backup_config' ], function (error, settings) {
-            if (error) return callback(error);
-
-            var setting = settings[0];
-            var config = JSON.parse(setting.value);
-            config.fqdn = caasDomain;
-
-            db.runSql('UPDATE settings SET value=? WHERE name=?', [ JSON.stringify(config), setting.name ], callback);
-        });
-    });
-};
-
-exports.down = function(db, callback) {
-    callback();
-};

migrations/20171205124434-settings-default-backupConfig.js

@@ -1,23 +0,0 @@
-'use strict';
-
-exports.up = function(db, callback) {
-    var backupConfig = {
-        "provider": "filesystem",
-        "backupFolder": "/var/backups",
-        "format": "tgz",
-        "retentionSecs": 172800
-    };
-
-    db.runSql('INSERT settings (name, value) VALUES(?, ?)', [ 'backup_config', JSON.stringify(backupConfig) ], function (error) {
-        if (!error || error.code === 'ER_DUP_ENTRY') return callback(); // dup entry is OK for existing cloudrons
-
-        callback(error);
-    });
-};
-
-exports.down = function(db, callback) {
-    db.runSql('DELETE FROM settings WHERE name=?', ['backup_config'], function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};

migrations/20180109225024-domains-add-provider.js

@@ -1,33 +0,0 @@
-'use strict';
-
-var async = require('async');
-
-exports.up = function(db, callback) {
-    // first check precondtion of domain entry in settings
-    db.all('SELECT * FROM domains', [ ], function (error, domains) {
-        if (error) return callback(error);
-
-        async.series([
-            db.runSql.bind(db, 'START TRANSACTION;'),
-            db.runSql.bind(db, 'ALTER TABLE domains ADD COLUMN provider VARCHAR(16) DEFAULT ""'),
-            function setProvider(done) {
-                async.eachSeries(domains, function (domain, iteratorCallback) {
-                    var config = JSON.parse(domain.configJson);
-                    var provider = config.provider;
-                    delete config.provider;
-
-                    db.runSql('UPDATE domains SET provider = ?, configJson = ? WHERE domain = ?', [ provider, JSON.stringify(config), domain.domain ], iteratorCallback);
-                }, done);
-            },
-            db.runSql.bind(db, 'ALTER TABLE domains MODIFY provider VARCHAR(16) NOT NULL'),
-            db.runSql.bind(db, 'COMMIT')
-        ], callback);
-    });
-};
-
-exports.down = function(db, callback) {
-    db.runSql('ALTER TABLE domains DROP COLUMN provider', function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};

migrations/20180121061357-mail-create-table.js

@@ -1,24 +0,0 @@
-'use strict';
-
-exports.up = function(db, callback) {
-    var cmd = 'CREATE TABLE IF NOT EXISTS mail(' +
-                'domain VARCHAR(128) NOT NULL UNIQUE,' +
-                'enabled BOOLEAN DEFAULT 0,' +
-                'mailFromValidation BOOLEAN DEFAULT 1,' +
-                'catchAllJson TEXT,' +
-                'relayJson TEXT,' +
-                'FOREIGN KEY(domain) REFERENCES domains(domain),' +
-                'PRIMARY KEY(domain)) CHARACTER SET utf8 COLLATE utf8_bin';
-
-    db.runSql(cmd, function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};
-
-exports.down = function(db, callback) {
-    db.runSql('DROP TABLE mail', function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};

migrations/20180121062945-mail-migrate-settings.js

@@ -1,34 +0,0 @@
-'use strict';
-
-exports.up = function(db, callback) {
-    db.all('SELECT * FROM domains', function (error, domains) {
-        if (error) return callback(error);
-        if (domains.length === 0) return callback();
-
-        db.all('SELECT * FROM settings', function (error, allSettings) {
-            if (error) return callback(error);
-
-            // defaults
-            var mailFromValidation = true;
-            var catchAll = [ ];
-            var relay = { provider: 'cloudron-smtp' };
-            var mailEnabled = false;
-
-            allSettings.forEach(function (setting) {
-                switch (setting.name) {
-                case 'mail_from_validation': mailFromValidation = !!setting.value; break;
-                case 'catch_all_address': catchAll = JSON.parse(setting.value); break;
-                case 'mail_relay': relay = JSON.parse(setting.value); break;
-                case 'mail_config': mailEnabled = JSON.parse(setting.value).enabled; break;
-                }
-            });
-
-            db.runSql('INSERT INTO mail (domain, enabled, mailFromValidation, catchAllJson, relayJson) VALUES (?, ?, ?, ?, ?)',
-                [ domains[0].domain, mailEnabled, mailFromValidation, JSON.stringify(catchAll), JSON.stringify(relay) ], callback);
-        });
-    });
-};
-
-exports.down = function(db, callback) {
-    callback();
-};

migrations/20180121124206-users-add-fallbackEmail.js

@@ -1,44 +0,0 @@
-'use strict';
-
-var async = require('async');
-
-exports.up = function(db, callback) {
-    db.all('SELECT * FROM users', [ ], function (error, users) {
-        if (error) return callback(error);
-
-        db.all('SELECT * FROM mail WHERE enabled=1', [ ], function (error, mailDomains) {
-            if (error) return callback(error);
-
-            async.series([
-                db.runSql.bind(db, 'START TRANSACTION;'),
-                db.runSql.bind(db, 'ALTER TABLE users DROP INDEX users_email'),
-                db.runSql.bind(db, 'ALTER TABLE users ADD COLUMN fallbackEmail VARCHAR(512) DEFAULT ""'),
-                function setDefaults(done) {
-                    async.eachSeries(users, function (user, iteratorCallback) {
-                        var defaultEmail = '';
-                        var fallbackEmail = '';
-
-                        if (mailDomains.length === 0) {
-                            defaultEmail = user.email;
-                            fallbackEmail = user.email;
-                        } else {
-                            defaultEmail = user.username ? (user.username + '@' + mailDomains[0].domain) : user.email;
-                            fallbackEmail = user.email;
-                        }
-
-                        db.runSql('UPDATE users SET email = ?, fallbackEmail = ? WHERE id = ?', [ defaultEmail, fallbackEmail, user.id ], iteratorCallback);
-                    }, done);
-                },
-                db.runSql.bind(db, 'ALTER TABLE users ADD UNIQUE users_email (email)'),
-                db.runSql.bind(db, 'COMMIT')
-            ], callback);
-        });
-    });
-};
-
-exports.down = function(db, callback) {
-    db.runSql('ALTER TABLE users DROP COLUMN fallbackEmail', function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};

migrations/20180131152200-domains-add-tlsConfigJson.js

@@ -1,26 +0,0 @@
-'use strict';
-
-var async = require('async');
-
-exports.up = function(db, callback) {
-    db.all('SELECT * FROM settings WHERE name = ?', [ 'tls_config' ], function (error, result) {
-        if (error) return callback(error);
-
-        var tlsConfig = (result[0] && result[0].value) ? JSON.parse(result[0].value) : { provider: 'letsencrypt-prod'};
-        tlsConfig.provider = tlsConfig.provider.replace(/$le\-/, 'letsencrypt-'); // old cloudrons had le-prod/le-staging
-
-        async.series([
-            db.runSql.bind(db, 'START TRANSACTION;'),
-            db.runSql.bind(db, 'ALTER TABLE domains ADD COLUMN tlsConfigJson TEXT'),
-            db.runSql.bind(db, 'UPDATE domains SET tlsConfigJson = ?', [ JSON.stringify(tlsConfig) ]),
-            db.runSql.bind(db, 'COMMIT')
-        ], callback);
-    });
-};
-
-exports.down = function(db, callback) {
-    db.runSql('ALTER TABLE domains DROP COLUMN tlsConfigJson', function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};

migrations/20180202184625-download-caas-appstore-configs.js

@@ -1,47 +0,0 @@
-'use strict';
-
-var async = require('async'),
-    fs = require('fs'),
-    superagent = require('superagent');
-
-exports.up = function(db, callback) {
-    if (!fs.existsSync('/home/yellowtent/configs/cloudron.conf')) {
-        console.log('Unable to locate cloudron.conf');
-        return callback();
-    }
-
-    var config = JSON.parse(fs.readFileSync('/home/yellowtent/configs/cloudron.conf', 'utf8'));
-
-    if (config.provider !== 'caas' || !config.fqdn) {
-        console.log('Not caas (%s) or no fqdn', config.provider, config.fqdn);
-        return callback();
-    }
-
-    db.runSql('SELECT COUNT(*) AS total FROM users', function (error, result) {
-        if (error) return callback(error);
-
-        if (result[0].total === 0) {
-            console.log('This cloudron is not activated. It will automatically get appstore and caas configs from autoprovision logic');
-            return callback();
-        }
-
-        console.log('Downloading appstore and caas config');
-
-        superagent.get(config.apiServerOrigin + `/api/v1/boxes/${config.fqdn}/config`)
-            .query({ token: config.token })
-            .timeout(30 * 1000).end(function (error, result) {
-                if (error) return callback(error);
-
-                console.log('Adding %j config', result.body);
-
-                async.series([
-                    db.runSql.bind(db, 'INSERT settings (name, value) VALUES(?, ?)', [ 'appstore_config', JSON.stringify(result.body.appstoreConfig) ]),
-                    db.runSql.bind(db, 'INSERT settings (name, value) VALUES(?, ?)', [ 'caas_config', JSON.stringify(result.body.caasConfig) ])
-                ], callback);
-            });
-    });
-};
-
-exports.down = function(db, callback) {
-    callback();
-};

migrations/20180207000000-split-autoupdate-pattern-setting.js

@@ -1,24 +0,0 @@
-'use strict';
-
-var async = require('async');
-
-exports.up = function(db, callback) {
-    db.runSql('SELECT * FROM settings WHERE name=?', ['autoupdate_pattern'], function (error, results) {
-        if (error || results.length === 0) return callback(error); // will use defaults from box code
-
-        // migrate the 'daily' update pattern
-        var appUpdatePattern = results[0].value;
-        if (appUpdatePattern === '00 00 1,3,5,23 * * *') appUpdatePattern = '00 30 1,3,5,23 * * *';
-
-        async.series([
-            db.runSql.bind(db, 'START TRANSACTION;'),
-            db.runSql.bind(db, 'DELETE FROM settings WHERE name=?', ['autoupdate_pattern']),
-            db.runSql.bind(db, 'INSERT settings (name, value) VALUES(?, ?)', ['app_autoupdate_pattern', appUpdatePattern]),
-            db.runSql.bind(db, 'COMMIT')
-        ], callback);
-    });
-};
-
-exports.down = function(db, callback) {
-    callback();
-};

migrations/20180207000001-migrate-altDomain-to-manual-domain.js

@@ -1,121 +0,0 @@
-'use strict';
-
-var async = require('async'),
-    crypto = require('crypto'),
-    fs = require('fs'),
-    os = require('os'),
-    path = require('path'),
-    safe = require('safetydance'),
-    tldjs = require('tldjs');
-
-exports.up = function(db, callback) {
-    db.all('SELECT * FROM apps', function (error, apps) {
-        if (error) return callback(error);
-
-        async.eachSeries(apps, function (app, callback) {
-            if (!app.altDomain) {
-                console.log('App %s does not use altDomain, skip', app.id);
-                return callback();
-            }
-
-            const domain = tldjs.getDomain(app.altDomain);
-            const subdomain = tldjs.getSubdomain(app.altDomain);
-            const mailboxName = (subdomain ? subdomain : JSON.parse(app.manifestJson).title.toLowerCase().replace(/[^a-zA-Z0-9]/g, '')) + '.app';
-
-            console.log('App %s is on domain %s and subdomain %s with mailbox', app.id, domain, subdomain, mailboxName);
-
-            async.series([
-                // Add domain if not exists
-                function (callback) {
-                    const query = 'INSERT INTO domains (domain, zoneName, provider, configJson, tlsConfigJson) VALUES (?, ?, ?, ?, ?)';
-                    const args = [ domain, domain, 'manual', JSON.stringify({}), JSON.stringify({ provider: 'letsencrypt-prod' }) ];
-
-                    db.runSql(query, args, function (error) {
-                        if (error && error.code !== 'ER_DUP_ENTRY') return callback(error);
-
-                        console.log('Added domain %s', domain);
-
-                        // ensure we have a fallback cert for the newly added domain. This is the same as in reverseproxy.js
-                        // WARNING this will only work on the cloudron itself not during local testing!
-                        const certFilePath = `/home/yellowtent/boxdata/certs/${domain}.host.cert`;
-                        const keyFilePath = `/home/yellowtent/boxdata/certs/${domain}.host.key`;
-
-                        if (!fs.existsSync(certFilePath) || !fs.existsSync(keyFilePath)) { // generate it
-                            let opensslConf = safe.fs.readFileSync('/etc/ssl/openssl.cnf', 'utf8');
-                            let opensslConfWithSan = `${opensslConf}\n[SAN]\nsubjectAltName=DNS:${domain}\n`;
-                            let configFile = path.join(os.tmpdir(), 'openssl-' + crypto.randomBytes(4).readUInt32LE(0) + '.conf');
-                            let certCommand = `openssl req -x509 -newkey rsa:2048 -keyout ${keyFilePath} -out ${certFilePath} -days 3650 -subj /CN=*.${domain} -extensions SAN -config ${configFile} -nodes`;
-
-                            safe.fs.writeFileSync(configFile, opensslConfWithSan, 'utf8');
-                            if (!safe.child_process.execSync(certCommand)) return callback(safe.error.message);
-                            safe.fs.unlinkSync(configFile);
-                        }
-
-                        callback();
-                    });
-                },
-                // Add domain to mail table if not exists
-                function (callback) {
-                    const query = 'INSERT INTO mail (domain, enabled, mailFromValidation, catchAllJson, relayJson) VALUES (?, ?, ?, ?, ?)';
-                    const args = [ domain, 0, 1, '[]', JSON.stringify({ provider: 'cloudron-smtp' }) ];
-
-                    db.runSql(query, args, function (error) {
-                        if (error && error.code !== 'ER_DUP_ENTRY') return callback(error);
-
-                        console.log('Added domain %s to mail table', domain);
-
-                        callback();
-                    });
-                },
-                // Remove old mailbox record if any
-                function (callback) {
-                    const query = 'DELETE FROM mailboxes WHERE ownerId=?';
-                    const args = [ app.id ];
-
-                    db.runSql(query, args, function (error) {
-                        if (error) return callback(error);
-
-                        console.log('Cleaned up mailbox record for app %s', app.id);
-
-                        callback();
-                    });
-                },
-                // Add new mailbox record
-                function (callback) {
-                    const query = 'INSERT INTO mailboxes (name, domain, ownerId, ownerType) VALUES (?, ?, ?, ?)';
-                    const args = [ mailboxName, domain, app.id, 'app' /* mailboxdb.TYPE_APP */ ];
-
-                    db.runSql(query, args, function (error) {
-                        if (error) return callback(error);
-
-                        console.log('Added mailbox record for app %s', app.id);
-
-                        callback();
-                    });
-                },
-                // Update app record
-                function (callback) {
-                    const query = 'UPDATE apps SET location=?, domain=?, altDomain=? WHERE id=?';
-                    const args = [ subdomain, domain, '', app.id ];
-
-                    db.runSql(query, args, function (error) {
-                        if (error) return error;
-
-                        console.log('Updated app %s with new domain', app.id);
-
-                        callback();
-                    });
-                }
-            ], callback);
-        }, function (error) {
-            if (error) return callback(error);
-
-            // finally drop the altDomain db field
-            db.runSql('ALTER TABLE apps DROP COLUMN altDomain', [], callback);
-        });
-    });
-};
-
-exports.down = function(db, callback) {
-    db.runSql('ALTER TABLE apps ADD COLUMN altDomain VARCHAR(256)', [], callback);
-};

migrations/20180211052642-mailboxes-alter-domains-constraint.js

@@ -1,19 +0,0 @@
-'use strict';
-
-var async = require('async');
-
-exports.up = function(db, callback) {
-    async.series([
-        db.runSql.bind(db, 'START TRANSACTION;'),
-        db.runSql.bind(db, 'ALTER TABLE mailboxes DROP FOREIGN KEY mailboxes_domain_constraint'),
-        db.runSql.bind(db, 'ALTER TABLE mailboxes ADD CONSTRAINT mailboxes_domain_constraint FOREIGN KEY(domain) REFERENCES mail(domain)'),
-        db.runSql.bind(db, 'COMMIT')
-    ], callback);
-};
-
-exports.down = function(db, callback) {
-    db.runSql('ALTER TABLE mailboxes DROP FOREIGN KEY mailboxes_domain_constraint', function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};

migrations/20180405222626-mailboxes-add-members.js

@@ -1,51 +0,0 @@
-'use strict';
-
-var async = require('async');
-
-exports.up = function(db, callback) {
-    var users = { }, groupMembers = { };
-
-    async.series([
-        db.runSql.bind(db, 'START TRANSACTION;'),
-        db.runSql.bind(db, 'ALTER TABLE mailboxes ADD COLUMN membersJson TEXT'),
-        function getUsers(done) {
-            db.all('SELECT * from users', [ ], function (error, results) {
-                if (error) return done(error);
-
-                results.forEach(function (result) { users[result.id] = result; });
-
-                done();
-            });
-        },
-        function getGroups(done) {
-            db.all('SELECT id, name, GROUP_CONCAT(groupMembers.userId) AS userIds ' +
-                ' FROM userGroups LEFT OUTER JOIN groupMembers ON userGroups.id = groupMembers.groupId ' +
-                ' GROUP BY userGroups.id', [ ], function (error, results) {
-                if (error) return done(error);
-
-                results.forEach(function (result) {
-                    var userIds = result.userIds ? result.userIds.split(',') : [];
-                    var members = userIds.map(function (id) { return users[id].username; });
-                    groupMembers[result.id] = members;
-                });
-
-                done();
-            });
-        },
-        function removeGroupIdAndSetMembers(done) {
-            async.eachSeries(Object.keys(groupMembers), function (gid, iteratorDone) {
-                console.log(`Migrating group id ${gid} to ${JSON.stringify(groupMembers[gid])}`);
-
-                db.runSql('UPDATE mailboxes SET membersJson = ?, ownerId = ? WHERE ownerId = ?', [ JSON.stringify(groupMembers[gid]), 'admin', gid ], iteratorDone);
-            }, done);
-        },
-        db.runSql.bind(db, 'COMMIT')
-    ], callback);
-};
-
-exports.down = function(db, callback) {
-    db.runSql('ALTER TABLE mailboxes DROP COLUMN membersJson', function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};

migrations/20180408014539-mailboxes-add-type.js

@@ -1,34 +0,0 @@
-'use strict';
-
-var async = require('async');
-
-exports.up = function(db, callback) {
-    async.series([
-        db.runSql.bind(db, 'START TRANSACTION;'),
-        db.runSql.bind(db, 'ALTER TABLE mailboxes ADD COLUMN type VARCHAR(16)'),
-        function addMailboxType(done) {
-            db.all('SELECT * from mailboxes', [ ], function (error, results) {
-                if (error) return done(error);
-
-                async.eachSeries(results, function (mailbox, iteratorCallback) {
-                    let type = 'mailbox';
-                    if (mailbox.aliasTarget) {
-                        type = 'alias';
-                    } else if (mailbox.membersJson) {
-                        type = 'list';
-                    }
-                    db.runSql('UPDATE mailboxes SET type = ? WHERE name = ? AND domain = ?', [ type, mailbox.name, mailbox.domain ], iteratorCallback);
-                }, done);
-            });
-        },
-        db.runSql.bind(db, 'ALTER TABLE mailboxes MODIFY type VARCHAR(16) NOT NULL'),
-        db.runSql.bind(db, 'COMMIT')
-    ], callback);
-};
-
-exports.down = function(db, callback) {
-    db.runSql('ALTER TABLE mailboxes DROP COLUMN membersJson', function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};

migrations/20180425142932-user-add-twoFactorAuthenticationSecret.js

@@ -1,15 +0,0 @@
-'use strict';
-
-exports.up = function(db, callback) {
-    db.runSql('ALTER TABLE users ADD COLUMN twoFactorAuthenticationSecret VARCHAR(128) DEFAULT "", ADD COLUMN twoFactorAuthenticationEnabled BOOLEAN DEFAULT false', function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};
-
-exports.down = function(db, callback) {
-    db.runSql('ALTER TABLE users DROP twoFactorAuthenticationSecret, DROP twoFactorAuthenticationEnabled', function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};

migrations/20180429235008-fixes-scopes.js

@@ -1,21 +0,0 @@
-'use strict';
-
-exports.up = function(db, callback) {
-    db.runSql('UPDATE clients SET scope=? WHERE id=? OR id=? OR id=?', ['*', 'cid-webadmin', 'cid-sdk', 'cid-cli'], function (error) {
-        if (error) console.error(error);
-
-        db.runSql('UPDATE tokens SET scope=? WHERE scope LIKE ?', ['*', '%*%'], function (error) { // remove the roleSdk
-            if (error) console.error(error);
-
-            db.runSql('UPDATE tokens SET expires=? WHERE clientId=?', [ 1525636734905, 'cid-webadmin' ], function (error) { // force webadmin to get a new token
-                if (error) console.error(error);
-
-                callback(error);
-            });
-        });
-    });
-};
-
-exports.down = function(db, callback) {
-    callback();
-};

migrations/20180511222705-apps-add-owner-id.js

@@ -1,28 +0,0 @@
-'use strict';
-
-var async = require('async');
-
-exports.up = function(db, callback) {
-    async.series([
-        db.runSql.bind(db, 'START TRANSACTION;'),
-        db.runSql.bind(db, 'ALTER TABLE apps ADD COLUMN ownerId VARCHAR(128)'),
-        function (next) {
-            db.all('SELECT id FROM users ORDER BY createdAt LIMIT 1', [ ], function (error, results) {
-                if (error || results.length === 0) return next(error);
-
-                var ownerId = results[0].id;
-                db.runSql('UPDATE apps SET ownerId=?', [ ownerId ], next);
-            });
-        },
-        db.runSql.bind(db, 'ALTER TABLE apps MODIFY ownerId VARCHAR(128) NOT NULL'),
-        db.runSql.bind(db, 'ALTER TABLE apps ADD CONSTRAINT apps_owner_constraint FOREIGN KEY(ownerId) REFERENCES users(id)'),
-        db.runSql.bind(db, 'COMMIT'),
-    ], callback);
-};
-
-exports.down = function(db, callback) {
-    db.runSql('ALTER TABLE apps DROP COLUMN ownerId', function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};

migrations/20180627010633-apps-add-ts.js

@@ -1,15 +0,0 @@
-'use strict';
-
-exports.up = function(db, callback) {
-    db.runSql('ALTER TABLE apps ADD COLUMN ts TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP', function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};
-
-exports.down = function(db, callback) {
-    db.runSql('ALTER TABLE apps DROP COLUMN ts ', function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};

migrations/20180628162142-subdomains-create-table.js

@@ -1,25 +0,0 @@
-'use strict';
-
-exports.up = function(db, callback) {
-    var cmd = 'CREATE TABLE IF NOT EXISTS subdomains(' +
-                'appId VARCHAR(128) NOT NULL,' +
-                'domain VARCHAR(128) NOT NULL,' +
-                'subdomain VARCHAR(128) NOT NULL,' +
-                'type VARCHAR(128) NOT NULL,' +
-                'dnsRecordId VARCHAR(512),' +
-                'FOREIGN KEY(domain) REFERENCES domains(domain),' +
-                'FOREIGN KEY(appId) REFERENCES apps(id),' +
-                'UNIQUE (subdomain, domain)) CHARACTER SET utf8 COLLATE utf8_bin';
-
-    db.runSql(cmd, function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};
-
-exports.down = function(db, callback) {
-    db.runSql('DROP TABLE subdomains', function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};

migrations/20180628163616-migrate-app-subdomains.js

@@ -1,28 +0,0 @@
-'use strict';
-
-var async = require('async');
-
-exports.up = function(db, callback) {
-    db.all('SELECT * from apps', [ ], function (error, results) {
-        if (error) return callback(error);
-
-        var queries = [
-            db.runSql.bind(db, 'START TRANSACTION;')
-        ];
-
-        results.forEach(function (app) {
-            queries.push(db.runSql.bind(db, 'INSERT INTO subdomains (appId, domain, subdomain, type, dnsRecordId) VALUES (?, ?, ?, ?, ?)', [ app.id, app.domain, app.location, 'primary', app.dnsRecordId ]));
-        });
-
-        queries.push(db.runSql.bind(db, 'COMMIT'));
-
-        async.series(queries, callback);
-    });
-};
-
-exports.down = function(db, callback) {
-    db.runSql('DELETE FROM subdomains', function (error) {
-        if (error) console.error(error);
-        callback(error);
-    });
-};