@webqit/webflo 0.11.40 → 0.11.41

package/README.md

@@ -186,7 +186,7 @@ cd my-app
 
 With [npm available on your terminal](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm), run the following command to install Webflo to your project:
 
-> System Requirements: Node.js 14.0 or later
+> System Requirements: Node.js 18.0 (having stable Fetch API support) or later
 
 ```shell
 npm i @webqit/webflo

package/docker/Dockerfile

@@ -0,0 +1,43 @@
+# Base installations
+# (Node 18 is the minimum required version: stable Fetch API, etc)
+FROM node:18-alpine
+RUN apk add git
+RUN apk add certbot
+
+# Refer to https://www.digitalocean.com/community/tutorials/how-to-build-a-node-js-application-with-docker
+# By default, the Docker Node image includes a non-root node user that we can use to avoid running the application container as root.
+USER node
+
+# Create the working directory with node-user permissions
+RUN mkdir -p /home/node/www/app && chown -R node:node /home/node/www
+WORKDIR /home/node/www
+
+# Adding this COPY instruction before running npm install or copying the application code allows you to take advantage of Docker’s caching mechanism.
+COPY -chown=node:node package*.json ./
+
+# Install
+RUN npm install
+# If you are building your code for production
+# RUN npm ci --only=production
+
+# Copy application code with node-user permissions
+COPY --chown=node:node . .
+
+# Install Webflo and friends globally
+RUN npm install @webqit/webflo -g
+RUN npm install @webqit/oohtml-cli -g
+RUN npm install pm2 -g
+
+# The deployment directory
+WORKDIR /home/node/www/app
+
+# To auto-start app (flags optional), we would add...
+# CMD ["webflo", "start"]
+
+# To build the image locally...
+# docker build --no-cache -t webflo ./docker
+
+# To publish to docker hub...
+# docker login -u webqit
+# docker tag webflo webqit/webflo
+# docker push webqit/webflo

package/docker/README.md

@@ -0,0 +1,91 @@
+# Webflo Container
+
+This is simply a node.js container with the `@webqit/webflo` framework installed. Once started, any webflo app can be deployed into the container from any git repository.
+
+## Usage
+
+This container image lives on Docker Hub and can be pulled to a local machine or a remote Virtual Machine (VM) on any cloud platform.
+
++ [To Use Locally](#to-use-locally)
++ [To Use In the Cloud](#to-use-in-the-cloud)
+* [To Deploy An App From Any Repo](#to-deploy-an-app-from-any-repo)
+
+### To Use Locally
+
+Ensure you have docker installed on your computer and run the following command from any location on your terminal:
+
+```shell
+docker pull webqit/webflo:latest
+```
+
+The above command pulls the `webqit/webflo` image to your local machine. (But this can be automatically done by docker on running any docker commands that reference the `webqit/webflo` image.)
+
+Next is to use the following commands to start the container and the Webflo runtime. In each case, the first part of the command starts the container, while the second part (from `webflo start`) starts the application.
+
+#### To Start
+
+Start the container using `docker run`; map a port (e.g `80`) of your host machine to `3000` of the container; optionally, give your container a name; reference `webqit/webflo` as the image to use; and lastly, start webflo using `webflo start`.
+
+```shell
+docker run -d -p 80:3000 --name my-app webqit/webflo webflo start
+```
+
+> Unless a port has been explicitly set via `webflo config server`, webflo *HTTP* port defaults to `3000` or the value specified in an environmental variable named `PORT`. If a `PORT` variable has been defined, then port mapping above would now need to use that variable: `-p 80:${PORT}`.
+
+Visit [localhost](http://localhost) to view your app. 
+
+#### To Run In HTTPS Mode
+
+To run Webflo apps in HTTPS inside a container, you basically need to map the appropriate SSL port from the host machine to a custom port in the container.
+
+Below, we're now mapping port `443` to an application-level port defined as `${SSL_PORT}`.
+
+```shell
+docker run -d -p 80:${PORT} 443:${SSL_PORT} --name my-app webqit/webflo webflo start
+```
+
+> Unless an SSL port has been explicitly set via `webflo config server`, webflo *HTTPS* port defaults to `0` (no HTTPS) or the value specified in an environmental variable named `SSL_PORT`.
+
+If you will be managing your SSL certificates in the host machine, you would also need to *bind-mount* the appropriate certificate volume from the host to the container.
+
+Below, we're now mapping the directory `/etc/letsencrypt/` - the default location for `letsencrypt` certificates - to an equivalent directory in the container.
+
+```shell
+docker run -d -p 80:${PORT} 443:${SSL_PORT} -v /etc/letsencrypt/:/etc/letsencrypt/ --name my-app webqit/webflo webflo start
+```
+
+> Webflo lets you generate `letsencrypt` certificates with the `webflo generate:cert <domain1,domain2,etc>` command. Just be sure to have your app running in HTTP mode to enable the process handle certbot's `http` challenge.
+
+#### To Start In Dev Mode
+
+Webflo's *dev* mode is the perfect mode for developing locally. All you do is append the `--env=dev --watch` flags to your webflo commands. [(Learn more)](#)
+
+```shell
+docker run -d -p 80:3000 --name my-app webqit/webflo webflo start --env=dev --watch
+```
+
+In *dev* mode, webflo automatically restarts as you make changes to your codebase. But since webflo now lives inside a container, you'll need to *bind* the directory of your source code on your host machine to the `/home/node/www/app` directory of the container.
+
+```shell
+docker run -d -v /Users/me/my-app:/home/node/www/app -p 80:3000 --name my-app webqit/webflo webflo start --env=dev --watch
+```
+
+### To Use In the Cloud
+
+TODO
+
+### To Deploy An App From Any Repo
+
+Whether running locally or in the cloud, webflo can easily take your application from any git repo. This follows webflo's normal `deploy` command.
+
+Simply point docker at your container (using `docker exec [container-name]`) and execute the `webflo deploy` command.
+
+```shell
+docker exec my-app webflo deploy https://github.com/me/my-app.git
+```
+
+If you will need to install any npm dependencies, you would run `npm install` from within your container.
+
+```shell
+docker exec my-app npm install
+```

package/docker/package.json

@@ -0,0 +1,3 @@
+{
+    "name": "webqit/webflo-docker"
+}

package/package.json

@@ -12,7 +12,7 @@
     "vanila-javascript"
   ],
   "homepage": "https://webqit.io/tooling/webflo",
-  "version": "0.11.40",
+  "version": "0.11.41",
   "license": "MIT",
   "repository": {
     "type": "git",

package/src/config-pi/deployment/Origins.js

@@ -31,6 +31,7 @@ export default class Origins extends Dotfile {
         return this.merge({
             entries: [{
                 host: hostname,
+                access_token: '',
                 repo: origin,
                 branch: 'master',
                 tag: 'root',
@@ -74,6 +75,12 @@ export default class Origins extends Dotfile {
                         choices: CHOICES.host,
                         validation: ['input', 'important'],
                     },
+                    {
+                        name: 'access_token',
+                        type: 'text',
+                        message: 'Enter your Personal Acess Token at host (if exists)',
+                        validation: ['input', 'important'],
+                    },
                     {
                         name: 'repo',
                         type: 'text',

package/src/config-pi/deployment/{Virtualization.js → Proxy.js}

@@ -4,16 +4,16 @@
  */
 import { Dotfile } from '@webqit/backpack';
 
-export default class Virtualization extends Dotfile {
+export default class Proxy extends Dotfile {
 
     // Base name
     get name() {
-        return 'virtualization';
+        return 'proxy';
     }
 
     // @desc
     static get ['@desc']() {
-        return 'Layout virtualization config.';
+        return 'Layout proxy config.';
     }
 
     // Defaults merger

package/src/config-pi/deployment/index.js

@@ -5,7 +5,7 @@
 import Env from './Env.js';
 import Layout from  './Layout.js';
 import Origins from  './Origins.js';
-import Virtualization from  './Virtualization.js';
+import Proxy from  './Proxy.js';
 
 /**
  * @exports
@@ -14,5 +14,5 @@ export {
     Env,
     Layout,
     Origins,
-    Virtualization,
+    Proxy,
 }

package/src/config-pi/runtime/Server.js

@@ -19,10 +19,10 @@ export default class Server extends Dotfile {
     // Defaults merger
     withDefaults(config) {
         return this.merge({
-            port: process.env.port || 3000,
+            port: process.env.PORT || 3000,
             domains: [],
             https: {
-                port: 0,
+                port: process.env.SSL_PORT || 0,
                 domains: [],
                 keyfile: '/etc/letsencrypt/live/[domain]/privkey.pem',
                 certfile: '/etc/letsencrypt/live/[domain]/fullchain.pem',

package/src/deployment-pi/origins/index.js

@@ -55,6 +55,7 @@ export async function deploy(origin) {
         }
     }
     // ---------------
+    const accessToken = origin.access_token;
     const isDeployPathSet = origin.deploy_path;
     origin.deploy_path = Path.join(cx.CWD || '', origin.deploy_path || '.');
     // ---------------
@@ -72,8 +73,8 @@ export async function deploy(origin) {
     await git.init();
 
     const hosts = {
-        github: 'https://github.com',
-        bitbucket: 'https://bitbucket.org',
+        github: `https://${ accessToken ? accessToken + '@' : '' }github.com`,
+        bitbucket: `https://${ accessToken ? accessToken + '@' : '' }bitbucket.org`,
     };
     const url = origin.url || hosts[origin.host] + '/' + origin.repo + '.git';
 

package/src/runtime-pi/server/Runtime.js

@@ -58,10 +58,10 @@ export default class Runtime extends _Runtime {
             const parseDomains = domains => _arrFrom(domains).reduce((arr, str) => arr.concat(str.split(',')), []).map(str => str.trim()).filter(str => str);
             const selectDomains = (serverDefs, matchingPort = null) => serverDefs.reduce((doms, def) => doms.length ? doms : (((!matchingPort || def.port === matchingPort) && parseDomains(def.domains || def.hostnames)) || []), []);
             // ---------------
-            this.vhosts = new Map;
-            if (this.cx.config.deployment.Virtualization) {
-                const vhosts = await (new this.cx.config.deployment.Virtualization(this.cx)).read();
-                await Promise.all((vhosts.entries || []).map(async vhost => {
+            this.proxied = new Map;
+            if (this.cx.config.deployment.Proxy) {
+                const proxied = await (new this.cx.config.deployment.Proxy(this.cx)).read();
+                await Promise.all((proxied.entries || []).map(async vhost => {
                     let cx, hostnames = parseDomains(vhost.hostnames), port = vhost.port, proto = vhost.proto;
                     if (vhost.path) {
                         cx = this.cx.constructor.create(this.cx, Path.join(this.cx.CWD, vhost.path));
@@ -77,7 +77,7 @@ export default class Runtime extends _Runtime {
                         proto || (proto = port === cx.server.https.port ? 'https' : 'http');
                     }
                     hostnames.length || (hostnames = ['*']);
-                    this.vhosts.set(hostnames.sort().join('|'), { cx, hostnames, port, proto });
+                    this.proxied.set(hostnames.sort().join('|'), { cx, hostnames, port, proto });
                 }));
             }
             // ---------------
@@ -118,7 +118,7 @@ export default class Runtime extends _Runtime {
                 });
                 // -------
                 addSSLContext(this.cx.server, domains);
-                for (const [ /*id*/, vhost ] of this.vhosts) {
+                for (const [ /*id*/, vhost ] of this.proxied) {
                     vhost.cx && addSSLContext(vhost.cx.server, vhost.hostnames);
                 }
             }
@@ -170,9 +170,9 @@ export default class Runtime extends _Runtime {
                 } else {
                     this.cx.logger.info(`> Server not running! No port specified.`);
                 }
-                if (this.vhosts.size) {
+                if (this.proxied.size) {
                     this.cx.logger.info(`> Reverse proxy active.`);
-                    for (let [ id, def ] of this.vhosts) {
+                    for (let [ id, def ] of this.proxied) {
                         this.cx.logger.info(`> ${ id } >>> ${ def.port }`);
                     }
                 }
@@ -234,7 +234,7 @@ export default class Runtime extends _Runtime {
         const hosts = [];
         this.servers.forEach(server => hosts.push(...server.domains));
         // ------------
-        for (const [ /*id*/, vhost ] of this.vhosts) {
+        for (const [ /*id*/, vhost ] of this.proxied) {
             if (vhost.hostnames.includes(url.hostname) || (vhost.hostnames.includes('*') && !hosts.includes('*'))) {
                 return this.proxyGo(vhost, url, init);
             }