How to build (custom) apps using the docker-registry
-
Since I was documenting what I was doing to debug errors, here's a short how-to for people who want to use the docker-registry app with authentication to build their own apps. Before submitting I realized that @girish already made a post here, but that was without the registry so I'm posting it either way
Prerequisites:
A machine that has both, docker and the cloudron cli installed and of course one or two Cloudrons for the apps to build and/or install
Docker: https://docs.docker.com/engine/install/ubuntu/
Cloudron CLI: https://docs.cloudron.io/custom-apps/cli/How to build apps and push to your Docker-Registry
install the docker-registry app on a cloudron (if possible don't use a production server), e.g. docker.example.com (you might want to create a dedicated user to work with it). Add the URL and docker credentials to your target cloudron in Settings / Private Docker Registry
Optional: use the Cloudron Build Service
install the Build Service app, e.g. https://build.example.com, open the terminal or file manager of the app and enter your docker credentials in
/app/data/docker.json. After those changes reboot the build service app to make sure the correct registry is in there. You can directly login to your build service (no trailing slash in the url! see https://docs.cloudron.io/apps/build-service/ for more information) via
$cloudron build --set-build-service(enter https://build.example.com)clone any repo you want to build
$git clone https://git.cloudron.io/cloudron/lamp-appcwd into the cloned git directory
$cd lamp-app/With local build
login to the docker-registry with your credentials (as non root user you might need to use sudo when issuing docker commands)
$docker login docker.example.combuild the thing (use custom lamp-app:tags if you want specific tag names)
$docker build -t docker.example.com/lamp-app .push to the registry - this does not work without logging in first
$docker push docker.example.com/lamp-appinstall on your target cloudron after logging in via
cloudron login
$cloudron install --image docker.example.com/lamp-appWith the Build Service
If you're using the build service, you can just run
$cloudron buildand enter your docker-repo (e.g.docker.example.com/lamp-app)
and after logging in to your cloudron
$cloudron install --image docker.example.com/lamp-appIf you updated an app, you can use
cloudron updateto push a new version for an existing app.Cheers, M
@msbt
🦾
+1 -
Since I was documenting what I was doing to debug errors, here's a short how-to for people who want to use the docker-registry app with authentication to build their own apps. Before submitting I realized that @girish already made a post here, but that was without the registry so I'm posting it either way
Prerequisites:
A machine that has both, docker and the cloudron cli installed and of course one or two Cloudrons for the apps to build and/or install
Docker: https://docs.docker.com/engine/install/ubuntu/
Cloudron CLI: https://docs.cloudron.io/custom-apps/cli/How to build apps and push to your Docker-Registry
install the docker-registry app on a cloudron (if possible don't use a production server), e.g. docker.example.com (you might want to create a dedicated user to work with it). Add the URL and docker credentials to your target cloudron in Settings / Private Docker Registry
Optional: use the Cloudron Build Service
install the Build Service app, e.g. https://build.example.com, open the terminal or file manager of the app and enter your docker credentials in
/app/data/docker.json. After those changes reboot the build service app to make sure the correct registry is in there. You can directly login to your build service (no trailing slash in the url! see https://docs.cloudron.io/apps/build-service/ for more information) via
$cloudron build --set-build-service(enter https://build.example.com)clone any repo you want to build
$git clone https://git.cloudron.io/cloudron/lamp-appcwd into the cloned git directory
$cd lamp-app/With local build
login to the docker-registry with your credentials (as non root user you might need to use sudo when issuing docker commands)
$docker login docker.example.combuild the thing (use custom lamp-app:tags if you want specific tag names)
$docker build -t docker.example.com/lamp-app .push to the registry - this does not work without logging in first
$docker push docker.example.com/lamp-appinstall on your target cloudron after logging in via
cloudron login
$cloudron install --image docker.example.com/lamp-appWith the Build Service
If you're using the build service, you can just run
$cloudron buildand enter your docker-repo (e.g.docker.example.com/lamp-app)
and after logging in to your cloudron
$cloudron install --image docker.example.com/lamp-appIf you updated an app, you can use
cloudron updateto push a new version for an existing app.Cheers, M
@msbt Nice guide!
There is something that I miss tho.
I like to run my cloudron apps local first so I can see if everything is working as intended.
This only works to a certain level for example this can't work if a database addon is used.
But everything before that step can be tested locally.A full local test suite would be awesome, so I the developer don't have to push every test and deploy it.
For example this is how I do some local testing before I push my image.
Needed software is
jqfor json parsing,docker,bash,sedScript explained with words:
- Get the ID and version Tag from the
CloudronManifest.jsonand use them for docker build. - Create local folders for
/tmp/app/dataand/runso I can emulate cloudrons readonly behavior. - Cleanup local folders so every test is fresh and clean
- Build the docker image with Data from
CloudronManifest.json - Run the freshly build Image in readonly mode with local test folders and an interactive bash session so I can debug / test some stuff.
#!/bin/bash set -x ID=$(jq -r ".id" CloudronManifest.json) VERSION=$(jq -r ".version" CloudronManifest.json') echo "=> Create Test Data dir" mkdir -p ./cloudron_test/data ./cloudron_test/tmp ./cloudron_test/run echo "=> Cleanup Test Data" rm -rf ./cloudron_test/data/* ./cloudron_test/tmp/* ./cloudron_test/run/* echo "=> Build test image" docker build -t dr.cloudron.dev/$ID:$VERSION . echo "=> Run $VERSION tag of build image of $ID" docker run -ti --read-only \ --volume $(pwd)/cloudron_test/data:/app/data:rw \ --volume $(pwd)/cloudron_test/tmp:/tmp:rw \ --volume $(pwd)/cloudron_test/run:/run:rw \ dr.cloudron.dev/$ID:$VERSION \ bash - Get the ID and version Tag from the
-
@msbt Nice guide!
There is something that I miss tho.
I like to run my cloudron apps local first so I can see if everything is working as intended.
This only works to a certain level for example this can't work if a database addon is used.
But everything before that step can be tested locally.A full local test suite would be awesome, so I the developer don't have to push every test and deploy it.
For example this is how I do some local testing before I push my image.
Needed software is
jqfor json parsing,docker,bash,sedScript explained with words:
- Get the ID and version Tag from the
CloudronManifest.jsonand use them for docker build. - Create local folders for
/tmp/app/dataand/runso I can emulate cloudrons readonly behavior. - Cleanup local folders so every test is fresh and clean
- Build the docker image with Data from
CloudronManifest.json - Run the freshly build Image in readonly mode with local test folders and an interactive bash session so I can debug / test some stuff.
#!/bin/bash set -x ID=$(jq -r ".id" CloudronManifest.json) VERSION=$(jq -r ".version" CloudronManifest.json') echo "=> Create Test Data dir" mkdir -p ./cloudron_test/data ./cloudron_test/tmp ./cloudron_test/run echo "=> Cleanup Test Data" rm -rf ./cloudron_test/data/* ./cloudron_test/tmp/* ./cloudron_test/run/* echo "=> Build test image" docker build -t dr.cloudron.dev/$ID:$VERSION . echo "=> Run $VERSION tag of build image of $ID" docker run -ti --read-only \ --volume $(pwd)/cloudron_test/data:/app/data:rw \ --volume $(pwd)/cloudron_test/tmp:/tmp:rw \ --volume $(pwd)/cloudron_test/run:/run:rw \ dr.cloudron.dev/$ID:$VERSION \ bash@brutalbirdie btw, you can get raw strings from jq directly without having to strip quotes with the
-roption:ID=$(jq -r ".id" CloudronManifest.json) VERSION=$(jq -r ".version" CloudronManifest.json)This does one better than just stripping quotes since it will also decode other escaped characters (not that that applies in this case).
- Get the ID and version Tag from the
-
@brutalbirdie btw, you can get raw strings from jq directly without having to strip quotes with the
-roption:ID=$(jq -r ".id" CloudronManifest.json) VERSION=$(jq -r ".version" CloudronManifest.json)This does one better than just stripping quotes since it will also decode other escaped characters (not that that applies in this case).
@infogulch RTFM myself
nice catch, thanks for that. -
R rxlict referenced this topic on
