Cloudron makes it easy to run web apps like WordPress, Nextcloud, GitLab on your server. Find out more or install now.


Skip to content
  • Categories
  • Recent
  • Tags
  • Popular
  • Bookmarks
  • Search
Skins
  • Light
  • Cerulean
  • Cosmo
  • Flatly
  • Journal
  • Litera
  • Lumen
  • Lux
  • Materia
  • Minty
  • Morph
  • Pulse
  • Sandstone
  • Simplex
  • Sketchy
  • Spacelab
  • United
  • Yeti
  • Zephyr
  • Dark
  • Cyborg
  • Darkly
  • Quartz
  • Slate
  • Solar
  • Superhero
  • Vapor

  • Default (No Skin)
  • No Skin
Collapse
Brand Logo

Cloudron Forum

Apps | Demo | Docs | Install
  1. Cloudron Forum
  2. App Packaging & Development
  3. Installing custom Apps on Cloudron

Installing custom Apps on Cloudron

Scheduled Pinned Locked Moved App Packaging & Development
63 Posts 13 Posters 7.5k Views 17 Watching
  • Oldest to Newest
  • Newest to Oldest
  • Most Votes
Reply
  • Reply as topic
Log in to reply
This topic has been deleted. Only users with topic management privileges can see it.
  • jamesJ Offline
    jamesJ Offline
    james
    Staff
    wrote last edited by james
    #49

    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:
    14b0808d-8e1e-4070-9542-14d525dbe461-image.png

    685a345b-7775-4bba-bff4-ae3678349845-image.png

    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.

    KubernetesK fbartelsF LanhildL 3 Replies Last reply
    7
    • jamesJ 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:
      14b0808d-8e1e-4070-9542-14d525dbe461-image.png

      685a345b-7775-4bba-bff4-ae3678349845-image.png

      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.

      KubernetesK Online
      KubernetesK Online
      Kubernetes
      App Dev
      wrote last edited by
      #50

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

      1 Reply Last reply
      2
      • jamesJ 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:
        14b0808d-8e1e-4070-9542-14d525dbe461-image.png

        685a345b-7775-4bba-bff4-ae3678349845-image.png

        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.

        fbartelsF Offline
        fbartelsF Offline
        fbartels
        App Dev
        wrote last edited by
        #51

        @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.

        1 Reply Last reply
        4
        • BrutalBirdieB Offline
          BrutalBirdieB Offline
          BrutalBirdie
          Partner
          wrote last edited by
          #52

          @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.

          Like my work? Consider donating a drink. Cheers!

          fbartelsF 1 Reply Last reply
          2
          • BrutalBirdieB 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.

            fbartelsF Offline
            fbartelsF Offline
            fbartels
            App Dev
            wrote last edited by
            #53

            @BrutalBirdie reading linked posts? 64f7ac82-4920-4bd1-aafb-2854f4cfadb7-image.png

            πŸ˜†

            1 Reply Last reply
            4
            • jamesJ 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:
              14b0808d-8e1e-4070-9542-14d525dbe461-image.png

              685a345b-7775-4bba-bff4-ae3678349845-image.png

              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.

              LanhildL Offline
              LanhildL Offline
              Lanhild
              App Dev
              wrote last edited by
              #54

              @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.

              1 Reply Last reply
              2
              • timconsidineT Offline
                timconsidineT Offline
                timconsidine
                App Dev
                wrote last edited by
                #55

                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.

                1 Reply Last reply
                3
                • timconsidineT Offline
                  timconsidineT Offline
                  timconsidine
                  App Dev
                  wrote last edited by timconsidine
                  #56

                  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)
                  1. visit e.g. ccai.domain.tld (or try https://ccai.appx.uk)
                  2. enter data
                  3. 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 πŸ˜†

                  Screenshot 2025-07-29 at 11.45.27.png

                  Screenshot 2025-07-29 at 11.46.58.png

                  Screenshot 2025-07-29 at 11.46.36.png

                  LanhildL 1 Reply Last reply
                  5
                  • timconsidineT Offline
                    timconsidineT Offline
                    timconsidine
                    App Dev
                    wrote last edited by timconsidine
                    #57

                    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.

                    Screenshot 2025-07-29 at 17.53.48.png

                    LanhildL 1 Reply Last reply
                    1
                    • timconsidineT 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.

                      Screenshot 2025-07-29 at 17.53.48.png

                      LanhildL Offline
                      LanhildL Offline
                      Lanhild
                      App Dev
                      wrote last edited by
                      #58

                      @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.

                      timconsidineT 1 Reply Last reply
                      1
                      • timconsidineT 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)
                        1. visit e.g. ccai.domain.tld (or try https://ccai.appx.uk)
                        2. enter data
                        3. 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 πŸ˜†

                        Screenshot 2025-07-29 at 11.45.27.png

                        Screenshot 2025-07-29 at 11.46.58.png

                        Screenshot 2025-07-29 at 11.46.36.png

                        LanhildL Offline
                        LanhildL Offline
                        Lanhild
                        App Dev
                        wrote last edited by Lanhild
                        #59

                        @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.

                        1 Reply Last reply
                        1
                        • LanhildL 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.

                          timconsidineT Offline
                          timconsidineT Offline
                          timconsidine
                          App Dev
                          wrote last edited by timconsidine
                          #60

                          @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.

                          LanhildL 1 Reply Last reply
                          0
                          • timconsidineT 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.

                            LanhildL Offline
                            LanhildL Offline
                            Lanhild
                            App Dev
                            wrote last edited by
                            #61

                            @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.

                            1 Reply Last reply
                            1
                            • timconsidineT Offline
                              timconsidineT Offline
                              timconsidine
                              App Dev
                              wrote last edited by
                              #62

                              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.

                              1 Reply Last reply
                              0
                              • timconsidineT Offline
                                timconsidineT Offline
                                timconsidine
                                App Dev
                                wrote last edited by
                                #63

                                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

                                1 Reply Last reply
                                2
                                Reply
                                • Reply as topic
                                Log in to reply
                                • Oldest to Newest
                                • Newest to Oldest
                                • Most Votes


                                • Login

                                • Don't have an account? Register

                                • Login or register to search.
                                • First post
                                  Last post
                                0
                                • Categories
                                • Recent
                                • Tags
                                • Popular
                                • Bookmarks
                                • Search