cloudron 7.0.2 → 7.0.4

package/bin/cloudron

@@ -165,6 +165,7 @@ program.command('install')
     .option('-a, --alias-domains [domain,...]', 'Alias domains')
     .option('-m, --memory-limit [domain,...]', 'Memory Limit (e.g 1.5G, 512M)')
     .option('--appstore-id <appid[@version]>', 'Use app from the store')
+    .option('--versions-url <url>', 'Install community app from CloudronVersions.json URL')
     .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.')

package/bin/cloudron-build

@@ -33,9 +33,9 @@ program.command('build', { isDefault: true })
     .option('--tag <docker image tag>', 'Docker image tag. Note that this does not include the repository name')
     .action(buildActions.build);
 
-program.command('clear')
-    .description('Clears build information')
-    .action(buildActions.clear);
+program.command('reset')
+    .description('Reset build configuration for this directory')
+    .action(buildActions.reset);
 
 program.command('info')
     .description('Print build information')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cloudron",
-  "version": "7.0.2",
+  "version": "7.0.4",
   "license": "MIT",
   "description": "Cloudron Commandline Tool",
   "type": "module",

package/src/actions.js

@@ -103,35 +103,13 @@ async function stopActiveTask(app, options) {
     if (response.status !== 204) throw `Failed to stop active task: ${requestError(response)}`;
 }
 
-async function selectAppWithRepository(repository, options) {
-    assert.strictEqual(typeof repository, 'string');
-    assert.strictEqual(typeof options, 'object');
-
-    const response = await createRequest('GET', '/api/v1/apps', options);
-    if (response.status !== 200) throw new Error(`Failed to install app: ${requestError(response)}`);
-
-    const matchingApps = response.body.apps.filter(function (app) {
-        return !app.appStoreId && app.manifest.dockerImage.startsWith(repository); // never select apps from the store
-    });
-
-    if (matchingApps.length === 0) return [ ];
-    if (matchingApps.length === 1) return matchingApps[0];
-
-    console.log();
-    console.log('Available apps using same repository %s:', repository);
-    matchingApps.sort(function (a, b) { return a.fqdn < b.fqdn ? -1 : 1; });
-    matchingApps.forEach(function (app, index) {
-        console.log('[%s]\t%s', index, app.fqdn);
-    });
-
-    let index;
-    while (true) {
-        index = parseInt(await readline.question('Choose app [0-' + (matchingApps.length-1) + ']: ', {}), 10);
-        if (isNaN(index) || index < 0 || index > matchingApps.length-1) console.log('Invalid selection');
-        else break;
-    }
+function saveCwdAppId(appId, manifestFilePath) {
+    if (!manifestFilePath) return;
 
-    return matchingApps[index];
+    const sourceDir = path.dirname(manifestFilePath);
+    const cwdConfig = config.getCwdConfig(sourceDir);
+    cwdConfig.appId = appId;
+    config.setCwdConfig(sourceDir, cwdConfig);
 }
 
 // appId may be the appId or the location
@@ -140,20 +118,19 @@ async function getApp(options) {
 
     const app = options.app || null;
 
-    if (!app) { // determine based on repository name given during 'build'
+    if (!app) {
         const manifestFilePath = locateManifest();
-
         if (!manifestFilePath) throw new Error(NO_APP_FOUND_ERROR_STRING);
 
         const sourceDir = path.dirname(manifestFilePath);
-        const appConfig = config.getAppBuildConfig(sourceDir);
+        const cwdConfig = config.getCwdConfig(sourceDir);
 
-        if (!appConfig.repository) throw new Error(NO_APP_FOUND_ERROR_STRING);
+        if (!cwdConfig.appId) throw new Error(NO_APP_FOUND_ERROR_STRING);
 
-        const [error, result] = await safe(selectAppWithRepository(appConfig.repository, options));
-        if (error || result.length === 0) return null;
+        const response = await createRequest('GET', `/api/v1/apps/${cwdConfig.appId}`, options);
+        if (response.status !== 200) throw new Error(NO_APP_FOUND_ERROR_STRING);
 
-        return result;
+        return response.body;
     } else if (app.match(/.{8}-.{4}-.{4}-.{4}-.{8}/)) {  // it is an id
         const response = await createRequest('GET', `/api/v1/apps/${app}`, options);
         if (response.status !== 200) throw new Error(`Failed to get app: ${requestError(response)}`);
@@ -554,34 +531,46 @@ async function install(localOptions, cmd) {
     const options = cmd.optsWithGlobals();
 
     try {
-        const result = await getManifest(options.appstoreId || '');
-        const { manifest, manifestFilePath } = result;
-
+        let manifest = null, manifestFilePath = null, versionsUrl = null;
         let sourceArchiveFilePath = null; // will be set if we need to send a tarball
 
-        if (!manifest.dockerImage) { // not a manifest from appstore
-            const sourceDir = path.dirname(manifestFilePath);
-            const image = options.image || config.getAppBuildConfig(sourceDir).dockerImage;
+        if (options.versionsUrl) {
+            const [url, version] = options.versionsUrl.split('@');
+            const request = createRequest('GET', `/api/v1/community/app?url=${encodeURIComponent(url)}&version=${encodeURIComponent(version || 'latest')}`, options);
+            const response = await request;
+            if (response.status !== 200) return exit(`Failed to get community app: ${requestError(response)}`);
 
-            if (!image) {
-                console.log('No build detected. This package will be built on the server.');
+            manifest = response.body.manifest;
+            versionsUrl = response.body.versionsUrl;
+        } else {
+            const result = await getManifest(options.appstoreId || '');
+            manifest = result.manifest;
+            manifestFilePath = result.manifestFilePath;
 
-                const dockerignoreFilePath = path.join(sourceDir, '.dockerignore');
-                const ignoreMatcher = dockerignoreMatcher(dockerignoreFilePath);
+            if (!manifest.dockerImage) { // not a manifest from appstore
+                const sourceDir = path.dirname(manifestFilePath);
+                const image = options.image || config.getCwdConfig(sourceDir).dockerImage;
 
-                const tarStream = tar.pack(sourceDir, {
-                    ignore: function (name) {
-                        return ignoreMatcher(name.slice(sourceDir.length + 1)); // make name as relative path
-                    }
-                });
+                if (!image) {
+                    console.log('No build detected. This package will be built on the server.');
 
-                sourceArchiveFilePath = path.join(os.tmpdir(), `cloudron-source-${Date.now()}.tar`);
-                const sourceArchiveStream = fs.createWriteStream(sourceArchiveFilePath);
+                    const dockerignoreFilePath = path.join(sourceDir, '.dockerignore');
+                    const ignoreMatcher = dockerignoreMatcher(dockerignoreFilePath);
 
-                const [tarError] = await safe(stream.pipeline(tarStream, sourceArchiveStream));
-                if (tarError) return exit(`Could not create source archive: ${tarError.message}`);
-            } else {
-                manifest.dockerImage = image;
+                    const tarStream = tar.pack(sourceDir, {
+                        ignore: function (name) {
+                            return ignoreMatcher(name.slice(sourceDir.length + 1)); // make name as relative path
+                        }
+                    });
+
+                    sourceArchiveFilePath = path.join(os.tmpdir(), `cloudron-source-${Date.now()}.tar`);
+                    const sourceArchiveStream = fs.createWriteStream(sourceArchiveFilePath);
+
+                    const [tarError] = await safe(stream.pipeline(tarStream, sourceArchiveStream));
+                    if (tarError) return exit(`Could not create source archive: ${tarError.message}`);
+                } else {
+                    manifest.dockerImage = image;
+                }
             }
         }
 
@@ -600,10 +589,10 @@ async function install(localOptions, cmd) {
                     const tmp = kv.split('=');
                     secondaryDomains[tmp[0]] = await selectDomain(tmp[1], options);
                 }
-            } else {
+            } else if (manifest) {
                 secondaryDomains = await querySecondaryDomains(null /* existing app */, manifest, options);
             }
-        } else if (manifest.httpPorts) { // just put in defaults
+        } else if (manifest && manifest.httpPorts) { // just put in defaults
             for (const env in manifest.httpPorts) {
                 secondaryDomains[env] = await selectDomain(manifest.httpPorts[env].defaultValue, options);
             }
@@ -629,10 +618,10 @@ async function install(localOptions, cmd) {
                     if (isNaN(parseInt(tmp[1], 10))) return; // disable the port
                     ports[tmp[0]] = parseInt(tmp[1], 10);
                 });
-            } else {
+            } else if (manifest) {
                 ports = await queryPortBindings(null /* existing app */, manifest);
             }
-        } else { // just put in defaults
+        } else if (manifest) { // just put in defaults
             const allPorts = Object.assign({}, manifest.tcpPorts, manifest.udpPorts);
             for (const portName in allPorts) {
                 ports[portName] = allPorts[portName].defaultValue;
@@ -655,7 +644,6 @@ async function install(localOptions, cmd) {
 
         const data = {
             appStoreId: options.appstoreId || '', // note case change
-            manifest: options.appstoreId ? null : manifest, // cloudron ignores manifest anyway if appStoreId is set
             location: domainObject.subdomain, // LEGACY
             subdomain: domainObject.subdomain,
             domain: domainObject.domain,
@@ -667,8 +655,14 @@ async function install(localOptions, cmd) {
             env
         };
 
+        if (versionsUrl) {
+            data.versionsUrl = versionsUrl;
+        } else {
+            data.manifest = options.appstoreId ? null : manifest; // cloudron ignores manifest anyway if appStoreId is set
+        }
+
         // the sso only applies for apps which allow optional sso
-        if (manifest.optionalSso) data.sso = options.sso;
+        if (manifest && manifest.optionalSso) data.sso = options.sso;
 
         if (options.debug) { // 'true' when no args.  otherwise, array
             const debugCmd = options.debug === true ? [ '/bin/bash', '-c', 'echo "Repair mode. Use the webterminal or cloudron exec to repair. Sleeping" && sleep infinity' ] : options.debug;
@@ -680,7 +674,7 @@ async function install(localOptions, cmd) {
             options.wait = false; // in debug mode, health check never succeeds
         }
 
-        if (!options.appstoreId && manifest.icon) {
+        if (!options.appstoreId && !options.versionsUrl && manifest && manifest.icon) {
             let iconFilename = manifest.icon.slice(0, 7) === 'file://' ? manifest.icon.slice(7) : manifest.icon;
             iconFilename = path.resolve(path.dirname(manifestFilePath), iconFilename); // resolve filename wrt manifest
             data.icon = safe.fs.readFileSync(iconFilename, { encoding: 'base64' });
@@ -720,6 +714,8 @@ async function install(localOptions, cmd) {
 
         const appId = response.body.id;
 
+        saveCwdAppId(appId, manifestFilePath);
+
         console.log('App is being installed.');
 
         if (!options.wait) return;
@@ -841,7 +837,7 @@ async function update(localOptions, cmd) {
 
         if (!manifest.dockerImage) { // not a manifest from appstore
             const sourceDir = path.dirname(manifestFilePath);
-            const image = options.image || config.getAppBuildConfig(sourceDir).dockerImage;
+            const image = options.image || config.getCwdConfig(sourceDir).dockerImage;
 
             if (!image) {
                 console.log('No docker image detected. Creating source archive from this folder.');
@@ -900,6 +896,8 @@ async function update(localOptions, cmd) {
         }
         if (response.status !== 202) return exit(`Failed to update app: ${requestError(response)}`);
 
+        saveCwdAppId(app.id, manifestFilePath);
+
         process.stdout.write('\n => ' + 'Waiting for app to be updated ');
 
         await waitForFinishInstallation(app.id, response.body.taskId, options);
@@ -1007,6 +1005,14 @@ async function uninstall(localOptions, cmd) {
         await waitForTask(response.body.taskId, options);
         const response2 = await createRequest('GET', `/api/v1/apps/${app.id}`, options);
         if (response2.status === 404) {
+            const manifestFilePath = locateManifest();
+            if (manifestFilePath) {
+                const sourceDir = path.dirname(manifestFilePath);
+                const cwdConfig = config.getCwdConfig(sourceDir);
+                delete cwdConfig.appId;
+                config.setCwdConfig(sourceDir, cwdConfig);
+            }
+
             console.log('\n\nApp %s successfully uninstalled.', app.fqdn);
         } else if (response2.body.installationState === 'error') {
             console.log('\n\nApp uninstallation failed.\n');

package/src/appstore-actions.js

@@ -235,7 +235,7 @@ async function verifyManifest(localOptions, cmd) {
     const manifest = result.manifest;
 
     const sourceDir = path.dirname(manifestFilePath);
-    const appConfig = config.getAppBuildConfig(sourceDir);
+    const appConfig = config.getCwdConfig(sourceDir);
 
     // image can be passed in options for buildbot
     if (options.image) {
@@ -282,7 +282,7 @@ async function upload(localOptions, cmd) {
     const manifest = result.manifest;
 
     const sourceDir = path.dirname(manifestFilePath);
-    const appConfig = config.getAppBuildConfig(sourceDir);
+    const appConfig = config.getCwdConfig(sourceDir);
 
     // image can be passed in options for buildbot
     if (options.image) {

package/src/build-actions.js

@@ -202,7 +202,7 @@ async function buildLocal(manifest, sourceDir, appConfig, options) {
 
     appConfig.dockerImage = dockerImage;
     appConfig.dockerImageSha256 = match[1]; // stash this separately for now
-    config.setAppBuildConfig(sourceDir, appConfig);
+    config.setCwdConfig(sourceDir, appConfig);
 }
 
 async function buildRemote(manifest, sourceDir, appConfig, options, buildServiceConfig) {
@@ -272,7 +272,7 @@ async function buildRemote(manifest, sourceDir, appConfig, options, buildService
 
     appConfig.dockerImage = dockerImage;
     // appConfig.dockerImageSha256 = match[1]; // stash this separately for now
-    config.setAppBuildConfig(sourceDir, appConfig);
+    config.setCwdConfig(sourceDir, appConfig);
 
     console.log(`Docker image: ${dockerImage}`);
     console.log('\nBuild successful');
@@ -293,8 +293,13 @@ async function build(localOptions, cmd) {
     const manifest = result.manifest;
     const sourceDir = path.dirname(manifestFilePath);
 
-    const appConfig = config.getAppBuildConfig(sourceDir);
+    const appConfig = config.getCwdConfig(sourceDir);
     const buildServiceConfig = getEffectiveBuildServiceConfig(options);
+    if (buildServiceConfig.type === 'remote' && buildServiceConfig.url) {
+        console.log('Building using remote build service at %s', buildServiceConfig.url);
+    } else {
+        console.log('Building locally with Docker.');
+    }
 
     let repository = appConfig.repository;
     if (!repository || options.repository) {
@@ -310,13 +315,15 @@ async function build(localOptions, cmd) {
         if (parts.length > 1) exit(`repository should not be a URL. Try again without ${parts[0]}://`);
 
         appConfig.repository = repository;
-        config.setAppBuildConfig(sourceDir, appConfig);
+        config.setCwdConfig(sourceDir, appConfig);
     }
 
     appConfig.gitCommit = execSync('git rev-parse HEAD', { encoding: 'utf8' }).trim(); // when the build gets saved, save the gitCommit also
     if (buildServiceConfig.type === 'remote' && buildServiceConfig.url) {
+        console.log('Building using remote build service at %s', buildServiceConfig.url);
         await buildRemote(manifest, sourceDir, appConfig, options, buildServiceConfig);
     } else {
+        console.log('Building locally with Docker.');
         await buildLocal(manifest, sourceDir, appConfig, options);
     }
 }
@@ -377,16 +384,25 @@ async function push(localOptions, cmd) {
     if (buildStatus !== 'success') return exit('Failed to push app. See log output above.');
 }
 
-async function clear(/* localOptions, cmd */) {
-    // const options = cmd.optsWithGlobals();
-
-    // try to find the manifest of this project
+async function reset(/* localOptions, cmd */) {
     const manifestFilePath = helper.locateManifest();
     if (!manifestFilePath) return exit('No CloudronManifest.json found');
 
     const sourceDir = path.dirname(manifestFilePath);
+    const cwdConfig = config.getCwdConfig(sourceDir);
+
+    if (!cwdConfig.repository && !cwdConfig.dockerImage) return console.log('Nothing to reset.');
+
+    const answer = await readline.question('Clear saved repository, image, and build info for this directory? [y/N] ', {});
+    if (answer.toLowerCase() !== 'y') return;
+
+    delete cwdConfig.repository;
+    delete cwdConfig.dockerImage;
+    delete cwdConfig.dockerImageSha256;
+    delete cwdConfig.gitCommit;
 
-    config.unsetAppBuildConfig(sourceDir);
+    config.setCwdConfig(sourceDir, cwdConfig);
+    console.log('Build configuration reset.');
 }
 
 async function info(localOptions, cmd) {
@@ -401,7 +417,7 @@ async function info(localOptions, cmd) {
     if (!manifestFilePath) return exit();
 
     const sourceDir = path.dirname(manifestFilePath);
-    const appConfig = config.getAppBuildConfig(sourceDir);
+    const appConfig = config.getCwdConfig(sourceDir);
 
     console.log('Build info');
     if (appConfig?.dockerImage) {
@@ -420,7 +436,7 @@ export default {
     logs,
     status,
     push,
-    clear,
+    reset,
     info,
     dockerignoreMatcher
 };

package/src/config.js

@@ -60,9 +60,9 @@ function setAppStoreToken(value) {
     set(['appStore', appStoreOrigin().replace('https://', ''), 'token'], value);
 }
 
-const getAppBuildConfig = (p) => get(['apps', p]) || {};
-const setAppBuildConfig = (p, c) => set(['apps', p], c);
-const unsetAppBuildConfig = (p) => unset(['apps', p]);
+const getCwdConfig = (p) => get(['apps', p]) || {};
+const setCwdConfig = (p, c) => set(['apps', p], c);
+const unsetCwdConfig = (p) => unset(['apps', p]);
 
 const getBuildServiceConfig = () => get('buildService') || {};
 const setBuildServiceConfig = (c) => set('buildService', c);
@@ -94,9 +94,9 @@ export {
     appStoreOrigin,
 
     // per app
-    getAppBuildConfig,
-    setAppBuildConfig,
-    unsetAppBuildConfig,
+    getCwdConfig,
+    setCwdConfig,
+    unsetCwdConfig,
 
     // build service
     getBuildServiceConfig,

package/src/versions-actions.js

@@ -41,7 +41,14 @@ async function init(/*localOptions, cmd*/) {
     if (fs.existsSync(versionsFilePath)) return exit(`${path.relative(process.cwd(), versionsFilePath)} already exists.`);
 
     await writeVersions(versionsFilePath, { stable: true, versions: {} });
-    console.log(`Created ${path.relative(process.cwd(), versionsFilePath)}. Use "cloudron versions add" to add a version.`);
+    console.log(`Created ${path.relative(process.cwd(), versionsFilePath)}.`);
+
+    const result = manifestFormat.parseFile(manifestFilePath);
+    if (!result.error) {
+        ensurePublishFields(result.manifest, manifestFilePath);
+    }
+
+    console.log('\nUse "cloudron versions add" to add a version.');
 }
 
 async function resolveManifest(manifest, baseDir) {
@@ -69,6 +76,92 @@ async function resolveManifest(manifest, baseDir) {
     }
 }
 
+function createStubFile(filePath, content) {
+    if (fs.existsSync(filePath)) return false;
+    fs.writeFileSync(filePath, content, 'utf8');
+    return true;
+}
+
+function ensurePublishFields(manifest, manifestFilePath) {
+    const baseDir = path.dirname(manifestFilePath);
+    const rawManifest = JSON.parse(fs.readFileSync(manifestFilePath, 'utf8'));
+    const added = [];
+    const created = [];
+
+    const defaultFields = {
+        id: 'com.example.app',
+        title: '',
+        author: '',
+        tagline: '',
+        website: '',
+        contactEmail: '',
+        iconUrl: '',
+        packagerName: '',
+        packagerUrl: '',
+        minBoxVersion: '9.1.0',
+    };
+
+    for (const [key, defaultValue] of Object.entries(defaultFields)) {
+        if (rawManifest[key]) continue;
+
+        rawManifest[key] = defaultValue;
+        manifest[key] = defaultValue;
+        added.push(key);
+    }
+
+    if (!rawManifest.description) {
+        rawManifest.description = 'file://DESCRIPTION.md';
+        manifest.description = 'file://DESCRIPTION.md';
+        added.push('description');
+        if (createStubFile(path.join(baseDir, 'DESCRIPTION.md'), 'Describe your app here.\n')) {
+            created.push('DESCRIPTION.md');
+        }
+    }
+
+    if (!rawManifest.changelog) {
+        rawManifest.changelog = 'file://CHANGELOG';
+        manifest.changelog = 'file://CHANGELOG';
+        added.push('changelog');
+        const version = rawManifest.version || '0.1.0';
+        if (createStubFile(path.join(baseDir, 'CHANGELOG'), `[${version}]\n* Initial release\n`)) {
+            created.push('CHANGELOG');
+        }
+    }
+
+    if (!rawManifest.postInstallMessage) {
+        rawManifest.postInstallMessage = 'file://POSTINSTALL.md';
+        manifest.postInstallMessage = 'file://POSTINSTALL.md';
+        added.push('postInstallMessage');
+        if (createStubFile(path.join(baseDir, 'POSTINSTALL.md'), 'Post-installation instructions.\n')) {
+            created.push('POSTINSTALL.md');
+        }
+    }
+
+    if (!rawManifest.tags || rawManifest.tags.length === 0) {
+        rawManifest.tags = ['uncategorized'];
+        manifest.tags = ['uncategorized'];
+        added.push('tags');
+    }
+
+    if (!rawManifest.mediaLinks || rawManifest.mediaLinks.length === 0) {
+        rawManifest.mediaLinks = ['https://example.com/screenshot.png'];
+        manifest.mediaLinks = ['https://example.com/screenshot.png'];
+        added.push('mediaLinks');
+    }
+
+    if (added.length === 0) return;
+
+    fs.writeFileSync(manifestFilePath, JSON.stringify(rawManifest, null, 2) + '\n', 'utf8');
+
+    console.log(`\nAdded missing fields to ${path.relative(process.cwd(), manifestFilePath)}: ${added.join(', ')}`);
+    if (created.length > 0) {
+        console.log(`Created stub files: ${created.join(', ')}`);
+    }
+    console.log('\nEdit the following fields in CloudronManifest.json before publishing:');
+    console.log('  id, title, author, tagline, website, contactEmail, iconUrl, packagerName, packagerUrl');
+    console.log('  tags, mediaLinks, DESCRIPTION.md, CHANGELOG, POSTINSTALL.md');
+}
+
 async function addOrUpdate(localOptions, cmd) {
     const isUpdate = cmd.parent.args[0] === 'update';
     const versionsFilePath = await locateVersions();
@@ -85,7 +178,7 @@ async function addOrUpdate(localOptions, cmd) {
     const manifest = result.manifest;
 
     const sourceDir = path.dirname(manifestFilePath);
-    const appConfig = config.getAppBuildConfig(sourceDir);
+    const appConfig = config.getCwdConfig(sourceDir);
 
     if (options.image) {
         manifest.dockerImage = options.image;