Skip to main content

Publishing

Requirements​

Publishing your app to the App Store helps users install it easily on their server and keep it up-to-date.

Steps to publish your app:

  • Before you start packaging, please leave a note in the App Wishlist category of our forum. If a topic for your app does not exist, create a new one. This avoids duplicate work as our community has already packaged apps you can use as a starting point. You can also gauge interest before packaging.

  • Package your app following the tutorial and cheat sheet. Feel free to ask any questions or help in the App Packaging & Development category of our forum. See the pinned topics in that category for answers to FAQs.

  • Once packaged, leave a note in your app's App Wishlist topic in our forum. Our community can provide early feedback and pre-release testing.

  • At this point, the team reviews your package and prepares it for publishing. The team takes over the packaging of the app from this point on. We have no mechanism for 3rd party authors to publish and update apps. As part of this process, we add automated tests to ensure the app installs, backs up, restores and updates properly.

Licensing​

We require app packages to have an Open Source license. MIT, GPL, BSD are popular choices. Pick the license you prefer. The license only applies to the packaging code and not to your app. Your app can be Open Source or Commercial license.

The package is maintained in our GitLab at https://git.cloudron.io. Original package authors receive commit permissions to the repository. To aid this process, we recommend keeping the packaging source code in a repository of its own and not part of the app's code repository.