cloudron 5.14.10 → 5.16.0

package/CHANGELOG.md

@@ -0,0 +1,44 @@
+
+[5.14.0]
+* Replace superagent module with own implementation.
+
+[5.14.1]
+* fix usage of request.attach
+
+[5.14.2]
+* superagent does not return stream anymore
+
+[5.14.3]
+* Handle case where info subcommand reveals no published versions
+* Add better error message if a URL with protocol was set as build repository
+
+[5.14.4]
+* fixes crash in safetydance when execSync returns null
+
+[5.14.5]
+* case insensitive compare
+
+[5.14.6]
+* Fix typo in appstore notifications
+
+[5.14.7]
+* Update base image in template
+
+[5.14.8]
+* Always send a request body on POST
+* Ensure we send an object on uninstall to enforce the expected content-type
+
+[5.14.9]
+* check image in docker registry instead of docker hub web page since docker hub is down
+
+[5.14.10]
+* Use custom namespace for our packages - @cloudron/manifest-format , @cloudron/superagent
+* add install `--memory-limit`
+
+[5.15.0]
+* decrypt-dir: option to disable filename decryption
+* Add `--env` to install
+
+[5.16.0]
+* build: output the selected Dockerfile name
+

package/bin/cloudron

@@ -56,6 +56,7 @@ backupCommand.command('decrypt <infile> <outfile>')
 backupCommand.command('decrypt-dir <indir> <outdir>')
     .description('Decrypt an encrypted directory')
     .option('--password <password>', 'password')
+    .option('--no-decrypt-filenames', 'Decrypt filenames [false]')
     .action(backupTools.decryptDir);
 
 backupCommand.command('decrypt-filename <path>')
@@ -111,7 +112,7 @@ envCommand.command('list')
     .action(actions.envList);
 
 envCommand.command('set <KEY=value...>')
-    .description('Set environment variables')
+    .description('Set environment variables. e.g X=1 Y=2')
     .option('--app <id>', 'App id')
     .action(actions.envSet);
 
@@ -173,6 +174,7 @@ program.command('install')
     .option('--no-sso', 'Disable Cloudron SSO [false]')
     .option('--debug [cmd...]', 'Enable debug mode', false)
     .option('--readonly', 'Mount filesystem readonly. Default is read/write in debug mode.')
+    .option('--env <KEY=value...>', 'Set environment variables. e.g X=1 Y=2')
     .action(actions.install);
 
 program.command('list')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cloudron",
-  "version": "5.14.10",
+  "version": "5.16.0",
   "license": "MIT",
   "description": "Cloudron Commandline Tool",
   "main": "main.js",
@@ -17,25 +17,25 @@
   },
   "author": "Cloudron Developers <support@cloudron.io>",
   "dependencies": {
-    "@cloudron/manifest-format": "^5.27.0",
+    "@cloudron/manifest-format": "^5.28.0",
     "@cloudron/superagent": "^1.0.0",
     "commander": "^13.1.0",
-    "debug": "^4.4.0",
+    "debug": "^4.4.1",
     "easy-table": "^1.2.0",
     "ejs": "^3.1.10",
-    "eventsource": "^3.0.6",
+    "eventsource": "^3.0.7",
     "micromatch": "^4.0.8",
-    "open": "^10.1.1",
+    "open": "^10.2.0",
     "safetydance": "^2.5.1",
-    "tar-fs": "^3.0.8"
+    "tar-fs": "^3.1.0"
   },
   "engines": {
     "node": ">= 18.x.x"
   },
   "devDependencies": {
-    "@eslint/js": "^9.25.1",
-    "eslint": "^9.25.1",
+    "@eslint/js": "^9.32.0",
+    "eslint": "^9.32.0",
     "expect.js": "^0.3.1",
-    "mocha": "^11.1.0"
+    "mocha": "^11.7.1"
   }
 }

package/src/actions.js

@@ -643,6 +643,16 @@ async function install(localOptions, cmd) {
 
         for (const port in ports) console.log(`Port ${port}: ${ports[port]}`);
 
+        // environment variables
+        const env = {};
+        if (options.env) {
+            options.env.forEach(envVar => {
+                const m = envVar.match(/(.*?)=(.*)/);
+                if (!m) return exit(`Expecting KEY=VALUE pattern. Got ${envVar}`);
+                env[m[1]] = m[2];
+            });
+        }
+
         const memoryLimit = options.memoryLimit ? parseMemoryLimit(options.memoryLimit) : 0;
 
         const data = {
@@ -655,7 +665,8 @@ async function install(localOptions, cmd) {
             aliasDomains,
             ports,
             accessRestriction: null,
-            memoryLimit
+            memoryLimit,
+            env
         };
 
         // the sso only applies for apps which allow optional sso
@@ -1227,10 +1238,12 @@ async function importApp(localOptions, cmd) {
             }
 
             if (backupKey) data.backupConfig.key = backupKey;
+        } else {
+            data.inPlace = true;
         }
 
         const request = createRequest('POST', `/api/v1/apps/${app.id}/import`, options);
-        const response = await request.send({});
+        const response = await request.send(data);
         if (response.status !== 202) return exit(`Failed to import app: ${requestError(response)}`);
 
         await waitForFinishInstallation(app.id, response.body.taskId, options);

package/src/backup-tools.js

@@ -262,11 +262,13 @@ async function decryptDir(inDir, outDir, options) {
     }
 
     const encryption = aesKeysFromPassword(options.password);
+    const decryptFilenames = options.decryptFilenames;
 
     const inDirAbs = path.resolve(process.cwd(), inDir);
     const outDirAbs = path.resolve(process.cwd(), outDir);
 
     const tbd = [ '' ]; // only has paths relative to inDirAbs
+    let errorCount = 0;
     while (true) {
         const cur = tbd.pop();
         const entries = fs.readdirSync(path.join(inDirAbs, cur), { withFileTypes: true });
@@ -279,29 +281,41 @@ async function decryptDir(inDir, outDir, options) {
                 continue;
             }
 
-            const encryptedFilePath = path.join(cur, entry.name);
-
-            const { error, decryptedFilePath } = decryptFilePath(encryptedFilePath, encryption);
-            if (error) throw error;
+            const fullPath = path.join(cur, entry.name);
+
+            let destPath = fullPath;
+            if (decryptFilenames) {
+                const { error, decryptedFilePath } = decryptFilePath(fullPath, encryption);
+                if (error) {
+                    console.warn(`Could not decrypt filename: ${error.message}`);
+                    errorCount++;
+                    continue;
+                }
+                destPath = decryptedFilePath;
+            }
 
-            console.log(`Decrypting ${decryptedFilePath}`);
+            console.log(`Decrypting ${destPath}`);
 
             const infile = path.join(inDirAbs, cur, entry.name);
             const inStream = fs.createReadStream(infile);
-            fs.mkdirSync(path.dirname(path.join(outDirAbs, decryptedFilePath)), { recursive: true });
-            const outfile = path.join(outDirAbs, decryptedFilePath);
+            fs.mkdirSync(path.dirname(path.join(outDirAbs, destPath)), { recursive: true });
+            const outfile = path.join(outDirAbs, destPath);
             const outStream = fs.createWriteStream(outfile);
             const decryptStream = new DecryptStream(encryption);
 
             const [decryptError] = await safe(stream.pipeline(inStream, decryptStream, outStream));
             if (decryptError) {
                 safe.fs.rmSync(outfile);
-                throw new Error(`Could not decrypt ${infile}: ${decryptError.message}`);
+                console.warn(`Could not decrypt ${infile}: ${decryptError.message}`);
+                ++errorCount;
             }
         }
 
         if (tbd.length === 0) break;
     }
+
+
+    if (errorCount) exit(`Failed to decrypt ${errorCount} files`);
 }
 
 async function decryptFilename(filePath, options) {

package/src/build-actions.js

@@ -25,7 +25,7 @@ const assert = require('assert'),
     stream = require('stream/promises'),
     superagent = require('@cloudron/superagent'),
     tar = require('tar-fs'),
-    url = require('url');
+    { URL } = require('url');
 
 function requestError(response) {
     if (response.status === 401 || response.status === 403) return 'Invalid token. Use cloudron build login again.';
@@ -86,11 +86,16 @@ async function followBuildLog(buildId, raw) {
     assert.strictEqual(typeof buildId, 'string');
     assert.strictEqual(typeof raw, 'boolean');
 
-    // EventSource always requires http
-    let tmp = url.parse(config.getBuildServiceConfig().url);
-    if (tmp.protocol !== 'https:' && tmp.protocol !== 'http:') tmp = url.parse('http://' + config.getBuildServiceConfig().url);
+    const rawUrl = config.getBuildServiceConfig().url;
+    let tmp;
+    try {
+        tmp = new URL(rawUrl);
+    } catch {
+        tmp = new URL(`http://${rawUrl}`);  // if it fails, prepend http://
+    }
+
+    const es = new EventSource(`${tmp.origin}/api/v1/builds/${buildId}/logstream?accessToken=${config.getBuildServiceConfig().token}`);
 
-    const es = new EventSource(`${tmp.href}api/v1/builds/${buildId}/logstream?accessToken=${config.getBuildServiceConfig().token}`);
     let prevId = null, prevWasStatus = false;
 
     es.addEventListener('message', function (e) {
@@ -195,16 +200,16 @@ async function buildLocal(manifest, sourceDir, appConfig, options) {
     }
 
     const dockerImage = `${appConfig.repository}:${tag}`;
-
-    console.log('Building locally as %s', dockerImage);
-    console.log();
-
     const buildArgsCmdLine = options.buildArg.map(function (a) { return `--build-arg "${a}"`; }).join(' ');
 
     let dockerfile = 'Dockerfile';
     if (options.file) dockerfile = options.file;
     else if (fs.existsSync(`${sourceDir}/Dockerfile.cloudron`)) dockerfile = 'Dockerfile.cloudron';
     else if (fs.existsSync(`${sourceDir}/cloudron/Dockerfile`)) dockerfile = 'cloudron/Dockerfile';
+
+    console.log(`Building ${dockerfile} locally as ${dockerImage}`);
+    console.log();
+
     execSync(`docker build ${!options.cache ? '--no-cache' : ''} -t ${dockerImage} -f ${dockerfile} ${buildArgsCmdLine} ${sourceDir}`, { stdio: 'inherit' });
 
     if (options.push) {
@@ -240,13 +245,20 @@ async function buildRemote(manifest, sourceDir, appConfig, options) {
 
     const dockerImage = `${appConfig.repository}:${tag}`;
 
-    console.log('Building %s', dockerImage);
+    let dockerfile = 'Dockerfile';
+    if (options.file) dockerfile = options.file;
+    else if (fs.existsSync(`${sourceDir}/Dockerfile.cloudron`)) dockerfile = 'Dockerfile.cloudron';
+    else if (fs.existsSync(`${sourceDir}/cloudron/Dockerfile`)) dockerfile = 'cloudron/Dockerfile';
+
+    const buildServiceConfig = config.getBuildServiceConfig();
+
+    console.log(`Building ${dockerfile} as ${dockerImage}`);
 
     const sourceArchiveFilePath = path.join(os.tmpdir(), path.basename(sourceDir) + '.tar.gz');
     const dockerignoreFilePath = path.join(sourceDir, '.dockerignore');
     const ignoreMatcher = dockerignoreMatcher(dockerignoreFilePath);
 
-    console.log('Uploading source tarball...');
+    console.log(`Uploading source tarball to ${buildServiceConfig.url} ...`);
 
     const tarStream = tar.pack(sourceDir, {
         ignore: function (name) {
@@ -258,11 +270,6 @@ async function buildRemote(manifest, sourceDir, appConfig, options) {
     const [tarError] = await safe(stream.pipeline(tarStream, sourceArchiveStream));
     if (tarError) return exit(`Could not tar: ${tarError.message}`);
 
-    let dockerfile = 'Dockerfile';
-    if (options.file) dockerfile = options.file;
-    else if (fs.existsSync(`${sourceDir}/Dockerfile.cloudron`)) dockerfile = 'Dockerfile.cloudron';
-    else if (fs.existsSync(`${sourceDir}/cloudron/Dockerfile`)) dockerfile = 'cloudron/Dockerfile';
-
     const buildArgsObject = {};
     options.buildArg.forEach(function (a) {
         const key = a.slice(0, a.indexOf('='));
@@ -270,7 +277,6 @@ async function buildRemote(manifest, sourceDir, appConfig, options) {
         buildArgsObject[key] = value;
     });
 
-    const buildServiceConfig = config.getBuildServiceConfig();
     const response = await superagent.post(`${buildServiceConfig.url}/api/v1/builds`)
         .query({ accessToken: buildServiceConfig.token, noCache: !options.cache, dockerfile: dockerfile, noPush: !options.push })
         .field('dockerImageRepo', appConfig.repository)