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


Skip to content

App Packaging & Development

App package development & help

250 Topics 2.3k Posts

Subcategories


  • Looking to collaborate? Post here if you need help or willing to offer help.

    33 Topics
    252 Posts
    D

    Hi everyone,

    I need help with the following tasks, specifically for use within Cloudron:

    Packaging a React App:

    I need assistance in setting up a React app to connect with Directus hosted on Cloudron.

    If possible, I’d like a detailed SOP (Standard Operating Procedure) to follow for future setups.

    Setting Up a Node.js or Next.js App with React:

    I want to create a new MySQL database for this app, hosted on Cloudron, and need guidance on setting up and working with this database.

    Again, having an SOP for future reference would be highly appreciated.

    I’m willing to pay for these services or would be grateful if someone could kindly share their expertise and the required SOPs.

    Thanks in advance!

  • read-only file system, rmdir '/dist'

    Moved
    8
    1 Votes
    8 Posts
    377 Views
    nebulonN

    I am not familiar with how nestjs works during startup, but something tries to wholesale rm the /dist folder. I guess it tries to rebuild the app on startup? You may have to copy the app from read-only to /run first thing in start.sh and then start the app and not symlink the folder? Just a guess though.

  • Update app : Read-only file system

    Moved Solved
    8
    1 Votes
    8 Posts
    402 Views
    J

    Glad you got it sorted out!

  • Langfuse packaging issue

    1
    0 Votes
    1 Posts
    79 Views
    No one has replied
  • How to package third-party apps, with example

    5
    1 Votes
    5 Posts
    320 Views
    E

    Thank you for the detailed response! Since this app doesn't run the LLM itself, the system requirements are less heavy.

    But wouldn't everything that wasn't attached to Cloudron just run inside the container? I mean, let's say I write a dockerfile for this app, but "forget" to use the postgres addon of cloudron. Wouldn't the app still run, but with the database inside the app, so it would be overwritten upon updating?

    Other than that, this app seems to have a sandbox container and one for vector databases, which couldn't be rebuilt easily in Cloudron.

  • App packaging tip for easier building

    4
    4 Votes
    4 Posts
    343 Views
    LanhildL

    @girish

    To make it more clear, I have made a template repository with all the files and scripts I usually use for my Cloudron apps.

    In the future, we might benefit from adopting such a strategy for the Cloudron CLI init script by using these files as a template/starter Cloudron app project. It'd make maintenance easier, more uniform, and make the process less daunting for new app devs.

    https://github.com/Lanhild/starter-cloudron

  • Multi-Stage Dockerfiles

    10
    5 Votes
    10 Posts
    868 Views
    girishG

    @Lanhild yup, we already started using multi-stage builds by now. For app store, you have to pin the images though. Using ":latest" is not good will have to be changed.

  • Question about app versions updates

    Solved
    4
    1 Votes
    4 Posts
    275 Views
    LanhildL

    Got it. Thanks for the answer!

  • App wishlist - raw data

    4
    3 Votes
    4 Posts
    330 Views
    E

    @girish scroll and copy > chatgpt

  • 1 Votes
    1 Posts
    106 Views
    No one has replied
  • Help needed to package KoboToolBox & iHRIS V5 apps

    2
    0 Votes
    2 Posts
    135 Views
    necrevistonnezrN

    There‘s a whole category for that: https://forum.cloudron.io/category/5/app-wishlist
    I‘d suggest creating one topic per app. If your app generates enough interest, some kind soul might gift you (and us) with their spare time

  • Put reverse-proxy in front of arbitrary apps

    4
    1 Votes
    4 Posts
    328 Views
    nebulonN

    It would reach it via the public domain I would guess, so it is not dependent on the local docker network addresses.

    All this is not an elegant solution for sure but to have this well supported we would need to have a quite sophisticated reverseproxy/nginx config UI somehow.

  • Pocketbase packaging

    4
    1 Votes
    4 Posts
    410 Views
    T

    i have to test it in production so i've done it here : https://git.cloudron.io/nils/pocketbase
    i may improve this package ,handling Cloudron user management and email configuration if people or i find interest in it .

  • Postgres Addon

    Moved
    9
    1 Votes
    9 Posts
    717 Views
    girishG

    @ekevu123 yes, of course, you add do whatever you want in that database (it's no different from an doing whatever it wants with the database).

    There is a guide to connect via ssh - https://docs.cloudron.io/guides/connect-postgresql/

  • install custom app via private registry and cloudron build

    7
    4 Votes
    7 Posts
    690 Views
    bmannB

    @rosano woo hoo! Thanks for this not having to learn much of Docker tutorial!

  • How to deploy NextJs app via cloudron to the subdomain?

    6
    0 Votes
    6 Posts
    569 Views
    klawitterbK

    So here's a little sum up how I do it:

    Create dockerfile ARG nodeversion=21-bullseye # build stage using standard node container FROM docker.io/node:$nodeversion AS builder WORKDIR /app # copy & install dependencies COPY package.json yarn.lock .yarnrc.yml ./ COPY .yarn/ .yarn RUN yarn install # copy source code & build COPY . . ENV NODE_ENV=production RUN yarn build --standalone # use cloudron base image for running the app FROM docker.io/cloudron/base:4.0.0@sha256:31b195ed0662bdb06a6e8a5ddbedb6f191ce92e8bee04c03fb02dd4e9d0286df WORKDIR /app ENV NODE_ENV=production # copy built files COPY --from=builder ./app/.output ./.output/ # start script for execution of the app, make sure its executable COPY --from=builder ./app/start.sh ./ RUN chmod +x /app/start.sh # set the port and host and expose the port ENV HOST 0.0.0.0 ENV PORT 8000 EXPOSE 8000 # start the app using start script CMD [ "/app/start.sh"] Create start.sh #!/bin/bash set -eu # set any environment variables here, e.g. database connection details # run the server node .output/server/index.mjs Create CloudronManifest.json
    Nothing special here, follow documentation from Cloudron, set app details, add addons, set exposed port, etc. Create CI/CD pipeline
    This depends a bit on your runner setup, I'm using a custom gitlab runner package on Cloudron I build for myself + the cloudron build service app. This has some quirks but works for me. Its a docker in docker runner but without access to the docker.sock its not possible to run docker commands itself (or at least didn't figure out how). Normally you'd need access to the docker.sock which is not possible with app packages and a security risk.
    Nevertheless here's a sample of my .gitlab-ci.yml stages: - stage deploy_stage: stage: stage image: node:19 environment: name: STAGE variables: BUILD_SERVICE: 'https://builderbot.serverdomain.de' FQ_IMAGE_NAME: 'docker.serverdomain.de/imagepath' TAG: pre only: - main script: - npm install -g cloudron - cloudron build --tag $TAG --set-build-service $BUILD_SERVICE --set-repository $FQ_IMAGE_NAME --build-service-token $CI_BUILD_SERVICE_TOKEN - cloudron update --server my.serverdomain.de --token $CI_CLOUDRON_TOKEN --app appsubdomain.serverdomain.de --image docker.serverdomain.de/imagepath:$TAG #- cloudron install --server my.serverdomain.de --token $CI_CLOUDRON_TOKEN --location appsubdomain.serverdomain.de --image docker.serverdomain.de/imagepath:$TAG

    For first run you need to use install cli cmd and afterwards update. Hence I always keep it commented out in the pipeline in case I need to reinstall the app from scratch. A combined command for this would be brilliant *hint *hint @girish 😉

    Apart from that there's a little more to it in terms of one time setup which I ommited:

    Setup private docker registry in Cloudron (alternative use a public registry) Register the gitlab runner in gitlab Setup secrets in gitlab, e.g. Cloudron access tokens might be more I've forgotten, as always once setup things get blurry in memory 🙂
  • How to create additional postgresql role's needed for an application?

    5
    1 Votes
    5 Posts
    456 Views
    girishG

    @ChristopherMag great for exploring this further! Since roles are database global, installing/clone etc will cause conflicts. So, we have to have some elaborate scheme to accommodate this. This is quite complicated right now because only this specific app needs this. But TBF, if an app needs custom roles etc, it requires complete control of the database and Cloudron is probably not best suited for this at the moment.

  • Install Docker Compose apps

    1
    1 Votes
    1 Posts
    154 Views
    No one has replied
  • OpenId Connect on custom web apps

    3
    1 Votes
    3 Posts
    270 Views
    R

    Is planned to unlock the provide for front app ?

  • LiveView Elixir doesn't work in Cloudron but does locally

    Moved
    10
    1 Votes
    10 Posts
    763 Views
    E

    Yes, makes sense, I am asking in the elixir forum. Thank you still for being here!

  • Cloudron update vs. installation - custom app

    Moved
    2
    1 Votes
    2 Posts
    200 Views
    BrutalBirdieB

    To answer your question truly I would need to see the code of the custom Cloudron app, how it is packaged.
    If you update an app with cloudron update the Dockerimage on the system and /app/code and all read only parts get updated.
    If your .env file is in a location where it is read write e.g. /app/data this will not be deleted on app update, thankfully!