Installing custom Apps on Cloudron

[timconsidine]

Working on another approach.
It is possible to do ‘cloudron login -u username -p password my.domain.tld’ but what about 2FA ?
Is there a parameter for that value ?
Like ‘-2fa 123456’ ?

[james]

There is also this topic Proposal: The CUR - Cloudron User Repository

What do you people think of the following?
Adding an input field in the app-store view to directly upload a CloudronManifest.json.

Mockup:

To make this work, a new optional 'key': 'value' in the CloudronManifest.json would be needed to add the Docker Image information so Cloudron knows where to pull the image from for this custom app.
Example from @BrutalBirdie custom FounderyVTT app => https://forum.cloudron.io/topic/8296/foundry-virtual-tabletop // https://github.com/BrutalBirdie/cloudron-foundryvtt

{
  "id": "foundryvtt.cloudron.app",
  "title": "FoundryVTT",
  "author": "Elias Hackradt ",
  "tagline": "FounderyVTT",
  "upstreamVersion": "13.345",
  "version": "1.2.0",
  "healthCheckPath": "/",
  "icon": "file://logo.png",
  "tags": [ "game", "multiplayer" ],
  "memoryLimit": 1342177280,
  "httpPort": 30000,
  "manifestVersion": 2,
  "minBoxVersion": "5.3.0",
  "addons": {
    "localstorage": {}
  },
  "dockerimage": "brutalbirdie/foundryvtt.cloudron.app:1.2.0"
}

This would make the barrier relatively small in my opinion.

Looking forward to reading your opinions.

[Kubernetes]

@james I would love to have this enhancement. This would be a game changer for custom (unsupported) Apps

[fbartels]

@james said in Installing custom Apps on Cloudron:

upload a CloudronManifest.json

I would absolutely welcome the idea to make custom app installations more easy for third party installations and less technical users. I am not sure however is uploading a json file will really make it easier for the majority of users, as these will still need to rely on someone else producing a properly formatting manifest file (and don't mess up formatting on the way).

Including the container image name in the manifest does sound like a good idea, but how about instead of uploading the manifest through the store the user could provide the url for where multiple such manifests are stored? Then app developers could publish their own stores.

[BrutalBirdie]

@fbartels so basically what I proposed here Proposal: The CUR - Cloudron User Repository

I said in Proposal: The CUR - Cloudron User Repository:

Now imagine a CUR.
With a simple click in the setting you can enable the CUR and can install a community app to test and give feedback.

[fbartels]

@BrutalBirdie reading linked posts?

[Lanhild]

@james I'm good with this approach, as long as "apps" I upload can be private. Custom applications aren't necessarily public or shareable, but would greatly benefit from this.

[timconsidine]

I have thought long and hard about this.

I welcome anything to make it easier for regular users to deploy a custom app.
Uploading manifest (but remember the logo referenced in the manifest also if used), or the CUR can work.
These are good measures, but require some changes to Cloudron.

And frankly (unless I have misunderstood) it's still too much for some users. They need something vaguely similar to what they have, as a minimum a walk-through which handles the tech stuff.

I am working on a solution.
Think I have got past a critical point, and will finish off tomorrow.
Will post it here.

[timconsidine]

OK, so <nervously> how about this ?
Not sure if it gets me banned for side-stepping Cloudron process.
But all I am doing is presenting the Cloudron manual process for custom app install in a GUI with backend execution.

I present <drum roll> for your review and comments :
"CCAI" a Cloudron Custom App Installer.

A GUI which :

• logs the user in to their cloudron,
• gets details from the user of the target custom app to be installed,
• performs the custom install, and
• logs out on completion (and on error).

Features :

• security sensitive : no login details saved
• user does not need to install CLI on their local device
• user does not need to use the scary terminal on their device
• user does not need to download or clone any custom app repo
• user does not need Docker installed, and does not need to build a Docker image

Pre-requisites :

• the target custom app's publicly available git repo containing CloudronManifest.json and an icon file, e.g. logo.png but whatever, and a POSTNSTALL.md
• the target custom app's publicly available hosted pre-built docker image

Demo Site : https://ccai.appx.uk
(may go up and down as further tweaks are made, available for your review and live usage)

Source code available at https://git.cloudron.io/timconsidine/cloudron-customapp-installer

1. EITHER :

• install CCAI (ah, maybe a gotcha, you have to do it manually for now, but I'm hoping Cloudron will approve this as an app),
  OR
• use a kind developer's "hosted-as-a-service" CCAI (see BONUS below)

2. visit e.g. ccai.domain.tld (or try https://ccai.appx.uk)
3. enter data
4. enjoy the new custom app installed on your cloudron.

NOTE : developers who want to share their custom app should make a pre-built image and host it at a publicly accessible docker registry. But hey, if you can make a custom app, you can build and host a docker image.

BONUS :
Although not designed deliberately, as an unintended bonus, once CCAI has been deployed, it should be able to install a custom app on any Cloudron (provided access is granted).
So actually user does not need to install their own CCAI, unless they want to for privacy. They can just use another deployed instance, e.g. from a custom app dev, or even from Cloudron itself.
Feel free to anonymously use my deployment https://ccai.appx.uk to install custom apps to your own cloudron (no login or usage details saved).

WARNING - this is an alpha release.
I need to test with more custom apps (only done my own).
Volunteer testers very welcome !

So ... @staff would you be ok to make this an official App Store app ?
Feel free to re-write it however you wish, you're the professionals, I'm just hacking about

[timconsidine]

Admittedly CCAI as above does nothing about "discovery" of custom apps.
I favour low-tech approaches where possible.
Why not just make a new forum category "CustomApps" ?
One post for each custom app a dev wants to make available.
Some 'house rule' that custom apps must be maintained by the original dev, and if that ceases, to update the post accordingly.

EDIT : CCAI could be extended to load a custom app install data from a dropdown list of known apps, in addition to manual entry of a custom app's data.

EDIT #2 : CCAI now has a dropdown to populate known custom app install data.
Makes testing easier.
Because finding a custom app with pre-built docker image to deploy is not easy.
And it could be valuable functionality if the app is left running as a service.

[Lanhild]

@timconsidine

Why not just make a new forum category "CustomApps" ?
One post for each custom app a dev wants to make available
Some 'house rule' that custom apps must be maintained by the original dev, and if that ceases, to update the post accordingly.

This totally prevents the use cases of private custom apps.

[Lanhild]

@timconsidine nice proof of concept. It could help pave the way to have it natively inside a Cloudron's dashboard.

Like you mentioned, discovery of custom apps by the means of repositories is much needed, and would facilitate the use of this feature.

[timconsidine]

@Lanhild err yes ... and no

Feature rather than a bug/omission.

It wasn't designed for private custom apps.
It was designed to help those users who hate or are not familiar with terminal and docker building to deploy public custom apps.

It doesn't prevent use of private apps - just install them manually.

I could look at extending it for private apps, with more logins / auth to the repos.

Maybe I thought wrongly, but I worked on the basis that the priority is public custom apps, and those with private custom apps were probably ok with building and deploying in the traditional way.

If I got that wrong, happy to review.

[Lanhild]

@timconsidine My point was mainly about the would be final implementation in Cloudron. If such a feature were to be added to Cloudron, I believe that private and public custom apps should both be prioritized for it. Cloudron is very facilitating on the infrastructure part of deploying code apps, thus why I think this. Your POC demonstrates this aspect clearly.

[timconsidine]

Understood

You got me thinking about how private repos could be supported.
I guess it’s just another login.
But not sure about the pre-built docker image.

[timconsidine]

For those not wanting to spend time on installing or using deployed instance, here's a 2min video showing the process.
https://ccai-demo.appx.uk

[girish]

@timconsidine very nice! Thanks fo posting notes/progress here. I will comment on this a bit later after our current release, I am all too consumed by it ... I am sure we can steal some of your ideas and maybe even integrate this into Cloudron itself.

[timconsidine]

@girish
I haven't made it into a App Wishlist because it started as proof of concept.

But latest version 4.0.9 has been polished and some edge cases (Gitea support, detecting main/master, etc.) have been addressed.

Now it also has a simple catalogue (not in video - I will update it).
Not quite 1-click install, but close.
So it could become an App Wishlist item.

You should even be able to use the hosted ccai.appx.uk to install CCAI on to another Cloudron for private deployments !

Yep, stay focussed on your release - much more important.
When you're ready, I think there is mileage in this approach, even if it is re-written from scratch on similar approach.

Features not yet addressed :

• support private repos
• discovery of custom apps

[timconsidine]

I've been wrestling with an internal dialogue about strategy or positioning from Cloudron's perspective.

Official apps in the official App Store carry maintenance burdens for cloudron staff, and a significant support burden, so I totally get that Cloudron might want to take/continue a black/white stance on custom apps.
Not supported, not maintained, you're on your own.

And by extension Cloudron might want nothing to do with CCAI or something like it, because it facilitates users going in a direction which is not endorsed.
Even though it actually does nothing that a user can't do manually by themselves.

But there are some good custom apps from good developers, and an installer might take the pressure off cloudron staff to consider some App Wishlist requests.
"You're still on your own, but we have made it a bit easier for you to try it out if you want to."

As I said, potential dilemma, but an interesting one, no doubt with different opinions.

[girish]

@timconsidine this is just my personal view and I haven't discussed with the team yet... I think it's a good idea to have a mechanism to add custom appstores/repos. Say, one can add TimsRepo to Cloudron. You (as a 3rd party) can then offer whatever apps you want there to others. This way Cloudron team is also not burdened with all sorts of specialized apps. I think this is an interesting concept to be explored because it allows service providers to provide custom and private apps.

For example, say Agate/Renato which you have packaged to some extent. You could provide this to others. Maybe even some monetization mechanism for your effort. Atleast, I am quite open to exploring if this model would work