feat: add AWS and arm64 support (#8)

* chore: update packages

* chore: remove blank issue template

* ci: exit on `1` when the return isn't `true`

* feat: arm64 architecture support

* feat: AWS support

* ci: fix bad finish

* ci: fix bad finish

* ci: fix bad finish

* ci: fix bad finish

* ci: fix bad finish

* ci: fix bad finish

.github/workflows/ci.yml

@@ -66,8 +66,9 @@ jobs:
       - name: 🧪 Testing Service - Upload
         run: npm run tests:upload
 
-      - name: 🧪 Testing Service - Virtual Hosts
-        run: npm run tests:virtual-hosts
+      # Temporarily removing due to limited storage space for GitHub Actions.
+      # - name: 🧪 Testing Service - Virtual Hosts
+      #   run: npm run tests:virtual-hosts
 
       - name: ✅ Finishing
         run: npm run tests:reset >/dev/null 2>&1 || true

README.md

@@ -61,6 +61,15 @@ const svps = new SVPS({
   },
 });
 
+/** For AWS */
+const svps = new SVPS({
+  access: {
+    host: '***.amazonaws.com',
+    username: 'ubuntu',
+    privateKey: fs.readFileSync('./your_rsa.pem'),
+  },
+});
+
 /** Available methods
  * svps.mount
  * svps.commands

package.json

@@ -7,19 +7,19 @@
     "svps": "bin/index.js"
   },
   "dependencies": {
-    "@types/ssh2": "^1.11.13",
+    "@types/ssh2": "^1.11.14",
     "ssh2": "^1.14.0"
   },
   "devDependencies": {
-    "@types/node": "^20.4.5",
-    "@typescript-eslint/eslint-plugin": "^6.2.0",
-    "@typescript-eslint/parser": "^6.2.0",
-    "eslint": "^8.46.0",
-    "eslint-import-resolver-typescript": "^3.5.5",
-    "eslint-plugin-import": "^2.28.0",
+    "@types/node": "^20.8.4",
+    "@typescript-eslint/eslint-plugin": "^6.7.5",
+    "@typescript-eslint/parser": "^6.7.5",
+    "eslint": "^8.51.0",
+    "eslint-import-resolver-typescript": "^3.6.1",
+    "eslint-plugin-import": "^2.28.1",
     "packages-update": "^1.2.1",
-    "prettier": "^3.0.0",
-    "typescript": "^5.1.6"
+    "prettier": "^3.0.3",
+    "typescript": "^5.2.2"
   },
   "scripts": {
     "build": "rm -rf ./bin ./lib ./tests && npx tsc",

resources/sources-list/18.04-arm.list

@@ -0,0 +1,4 @@
+deb http://ports.ubuntu.com/ubuntu-ports/ bionic main restricted universe multiverse
+deb http://ports.ubuntu.com/ubuntu-ports/ bionic-updates main restricted universe multiverse
+deb http://ports.ubuntu.com/ubuntu-ports/ bionic-backports main restricted universe multiverse
+deb http://ports.ubuntu.com/ubuntu-ports/ bionic-security main restricted universe multiverse

resources/sources-list/20.04-arm.list

@@ -0,0 +1,4 @@
+deb http://ports.ubuntu.com/ubuntu-ports/ focal main restricted universe multiverse
+deb http://ports.ubuntu.com/ubuntu-ports/ focal-updates main restricted universe multiverse
+deb http://ports.ubuntu.com/ubuntu-ports/ focal-backports main restricted universe multiverse
+deb http://ports.ubuntu.com/ubuntu-ports/ focal-security main restricted universe multiverse

resources/sources-list/22.04-arm.list

@@ -0,0 +1,4 @@
+deb http://ports.ubuntu.com/ubuntu-ports/ jammy main restricted universe multiverse
+deb http://ports.ubuntu.com/ubuntu-ports/ jammy-updates main restricted universe multiverse
+deb http://ports.ubuntu.com/ubuntu-ports/ jammy-backports main restricted universe multiverse
+deb http://ports.ubuntu.com/ubuntu-ports/ jammy-security main restricted universe multiverse

resources/sources-list/23.04-arm.list

@@ -0,0 +1,4 @@
+deb http://ports.ubuntu.com/ubuntu-ports/ lunar main restricted universe multiverse
+deb http://ports.ubuntu.com/ubuntu-ports/ lunar-updates main restricted universe multiverse
+deb http://ports.ubuntu.com/ubuntu-ports/ lunar-backports main restricted universe multiverse
+deb http://ports.ubuntu.com/ubuntu-ports/ lunar-security main restricted universe multiverse

src/lib/modules/basic-permissions.ts

@@ -8,13 +8,13 @@ export const basicPermissions = async (options: {
   const { remote, user, group } = options;
 
   if (user && group) {
-    await catchExec(`chown -R ${user}:${group} "${remote}"`);
-    await catchExec(`chmod -R 0775 "${remote}"`);
+    await catchExec(`sudo chown -R ${user}:${group} "${remote}"`);
+    await catchExec(`sudo chmod -R 0775 "${remote}"`);
   } else if (user) {
-    await catchExec(`chown -R ${user}: "${remote}"`);
-    await catchExec(`chmod -R 0755 "${remote}"`);
+    await catchExec(`sudo chown -R ${user}: "${remote}"`);
+    await catchExec(`sudo chmod -R 0755 "${remote}"`);
   } else if (group) {
-    await catchExec(`chown -R :${group} "${remote}"`);
-    await catchExec(`chmod -R 0775 "${remote}"`);
+    await catchExec(`sudo chown -R :${group} "${remote}"`);
+    await catchExec(`sudo chmod -R 0775 "${remote}"`);
   }
 };

src/lib/modules/commands.ts

@@ -61,12 +61,12 @@ export const setCommands = async (options: {
 
   const initialCommands = [
     /** Resolving `dpkg` and `apt` */
-    'rm -rf /var/lib/apt/lists/lock',
-    'rm -rf /var/lib/dpkg/lock',
-    'rm -rf /var/lib/dpkg/lock-frontend',
-    'rm -rf /var/cache/apt/archives/lock',
-    'echo "Y" | dpkg --configure -a',
-    'echo "debconf debconf/frontend select Noninteractive" | debconf-set-selections',
+    'sudo rm -rf /var/lib/apt/lists/lock',
+    'sudo rm -rf /var/lib/dpkg/lock',
+    'sudo rm -rf /var/lib/dpkg/lock-frontend',
+    'sudo rm -rf /var/cache/apt/archives/lock',
+    'echo "Y" | sudo dpkg --configure -a',
+    'echo "debconf debconf/frontend select Noninteractive" | sudo debconf-set-selections',
   ];
 
   if (verbose) console.log('# Initial Commands', '\n', initialCommands);

src/lib/modules/configs/node.ts

@@ -2,16 +2,23 @@ import { NODE } from '../../types/node.js';
 import { MOUNT } from '../../types/mount.js';
 
 export const setNode = (configs: MOUNT): Required<NODE> | null => {
-  if (!configs?.node || typeof configs?.node !== 'object') return null;
+  if (!configs?.node) return null;
+
+  const defaults: Required<NODE> = {
+    version: 18,
+    packages: [],
+  };
+
+  if (configs.node === true) return defaults;
 
   return {
     version:
       configs?.node && typeof configs.node.version === 'number'
         ? configs.node.version
-        : 18,
+        : defaults.version,
     packages:
       configs?.node && Array.isArray(configs.node.packages)
         ? configs.node.packages
-        : [],
+        : defaults.packages,
   };
 };

src/lib/modules/configs/php.ts

@@ -2,43 +2,53 @@ import { PHP } from '../../types/php.js';
 import { MOUNT } from '../../types/mount.js';
 
 export const setPHP = (configs: MOUNT): Required<PHP> | null => {
-  if (!configs?.php || typeof configs?.php !== 'object') return null;
+  if (!configs?.php) return null;
 
-  return {
+  const defaults: Required<PHP> = {
+    version: 8.2,
+    modules: [
+      'cli',
+      'common',
+      'bz2',
+      'curl',
+      'gmp',
+      'readline',
+      'sqlite3',
+      'xml',
+      'bcmath',
+      'gd',
+      'imagick',
+      'imap',
+      'intl',
+      'json',
+      'mbstring',
+      'mysql',
+      'opcache',
+      'soap',
+      'tidy',
+      'xmlrpc',
+      'xsl',
+      'zip',
+    ],
+    composer: true,
+  };
+
+  if (configs.php === true) return defaults;
+
+  const php: Required<PHP> = {
     version:
       configs?.php && typeof configs.php?.version === 'number'
         ? configs.php.version
-        : 8.2,
+        : defaults.version,
     modules:
       configs?.php && Array.isArray(configs.php?.modules)
         ? configs.php.modules
-        : [
-            'cli',
-            'common',
-            'bz2',
-            'curl',
-            'gmp',
-            'readline',
-            'sqlite3',
-            'xml',
-            'bcmath',
-            'gd',
-            'imagick',
-            'imap',
-            'intl',
-            'json',
-            'mbstring',
-            'mysql',
-            'opcache',
-            'soap',
-            'tidy',
-            'xmlrpc',
-            'xsl',
-            'zip',
-          ],
+        : defaults.modules,
     composer:
       configs?.php && typeof configs.php?.composer === 'boolean'
         ? configs.php.composer
-        : true,
+        : defaults.composer,
   };
+
+  return php;
 };

src/lib/modules/configs/users.ts

@@ -2,7 +2,7 @@ import { MOUNT } from '../../types/mount.js';
 import { REQUIRED_USER } from '../../types/users.js';
 import { forceArray } from '../force-array.js';
 
-export const setUsers = (configs: MOUNT) => {
+export const setUsers = (configs: MOUNT): REQUIRED_USER[] | null => {
   if (!configs?.users) return null;
 
   const mapUsers = forceArray(configs.users) as REQUIRED_USER[];

src/lib/tasks/index.ts

@@ -29,7 +29,7 @@ const createSVPS = () => {
 
   return class SVPS {
     constructor(options: {
-      /** Set the SSH access for one or more VPS */
+      /** Set the SSH access */
       access: ACCESS;
     }) {
       access = options.access;
@@ -93,13 +93,13 @@ const createSVPS = () => {
         const invalidVirtualHosts: VIRTUAL_HOST[] = [];
         const deployedVirtualHosts: VIRTUAL_HOST[] = [];
         const commands = [
-          'echo "debconf debconf/frontend select Noninteractive" | debconf-set-selections',
-          'mkdir -p /var/containers/images /var/containers/compositions /var/containers/domains /var/containers/databases',
-          'chmod 0755 /var/containers',
-          'chmod 0700 /var/containers/images',
-          'chmod 0700 /var/containers/compositions',
-          'chmod 0750 /var/containers/databases',
-          'chmod 0755 /var/containers/domains',
+          'echo "debconf debconf/frontend select Noninteractive" | sudo debconf-set-selections',
+          'sudo mkdir -p /var/containers/images /var/containers/compositions /var/containers/domains /var/containers/databases',
+          'sudo chmod 0755 /var/containers',
+          'sudo chmod 0700 /var/containers/images',
+          'sudo chmod 0700 /var/containers/compositions',
+          'sudo chmod 0750 /var/containers/databases',
+          'sudo chmod 0755 /var/containers/domains',
         ];
 
         if (!virtualHosts) {
@@ -146,11 +146,11 @@ const createSVPS = () => {
               ...commands,
               `echo "${sh.startTitle}Proxy Port: ${virtualHost.domain} on port ${virtualHost.port}${sh.endTitle}"`,
               ...createProxy(virtualHost),
-              'systemctl reload apache2',
+              'sudo systemctl reload apache2',
               sh.done,
             ]);
           });
-          commands.push('systemctl restart apache2');
+          commands.push('sudo systemctl restart apache2');
         }
 
         /** Basic Virtual Hosts Servers */
@@ -165,7 +165,7 @@ const createSVPS = () => {
               ...createBasicVirtualHost(virtualHost),
             ]);
           });
-          commands.push('systemctl restart apache2');
+          commands.push('sudo systemctl restart apache2');
         }
 
         if (deployedVirtualHosts.length === 0)

src/lib/tasks/steps/apache.ts

@@ -15,16 +15,16 @@ export default (configs: MOUNT) => {
 
   const commands = [
     `echo "${sh.startTitle}Setting up Apache2${sh.endTitle}"`,
-    'apt-get update',
-    'apt-get install apache2 -y',
-    'mkdir -p /var/www',
-    'rm -rf /var/www/html',
-    'mkdir -p /var/www/host',
+    'sudo apt-get update',
+    'sudo apt-get install apache2 -y',
+    'sudo mkdir -p /var/www',
+    'sudo rm -rf /var/www/html',
+    'sudo mkdir -p /var/www/host',
     `echo "${sh.startTitle}Setting up Rewrite Virtual Hosts${sh.endTitle}"`,
     `echo ${escapeQuotes(
       fs.readFileSync(normalize(default_000), 'utf-8')
-    )} | cat > /etc/apache2/sites-available/000-default.conf`,
-    'a2enmod proxy proxy_http rewrite headers expires',
+    )} | sudo tee /etc/apache2/sites-available/000-default.conf > /dev/null`,
+    'sudo a2enmod proxy proxy_http rewrite headers expires',
   ];
 
   if (!apache.accessFromIP) {
@@ -36,19 +36,19 @@ export default (configs: MOUNT) => {
       ...[
         `echo ${escapeQuotes(
           fs.readFileSync(normalize(htaccess), 'utf-8')
-        )} | cat > /var/www/host/.htaccess`,
+        )} | sudo tee /var/www/host/.htaccess > /dev/null`,
         `echo ${escapeQuotes(
           fs.readFileSync(normalize(_403), 'utf-8')
-        )} | cat > /var/www/host/403.html`,
-        'chmod 0755 /var/www/host',
+        )} | sudo tee /var/www/host/403.html > /dev/null`,
+        'sudo chmod 0755 /var/www/host',
       ],
     ]);
   }
 
   Object.assign(commands, [
     ...commands,
-    'systemctl restart apache2',
-    'systemctl reload apache2',
+    'sudo systemctl restart apache2',
+    'sudo systemctl reload apache2',
     sh.done,
   ]);
 

src/lib/tasks/steps/apt.ts

@@ -2,10 +2,10 @@ import sh from '../../modules/sh.js';
 
 export default () => [
   `echo "${sh.startTitle}Preparing the Environment${sh.endTitle}"`,
-  'apt-get update',
-  'DEBIAN_FRONTEND="noninteractive" apt -y -o Dpkg::Options::="--force-confdef" -o Dpkg::Options::="--force-confold" upgrade 2>/dev/null',
-  'apt-get autoremove -y --purge',
-  'apt-get clean -y',
-  'apt-get autoclean -y',
+  'sudo apt-get update',
+  'DEBIAN_FRONTEND="noninteractive" sudo apt -y -o Dpkg::Options::="--force-confdef" -o Dpkg::Options::="--force-confold" upgrade 2>/dev/null',
+  'sudo apt-get autoremove -y --purge',
+  'sudo apt-get clean -y',
+  'sudo apt-get autoclean -y',
   sh.done,
 ];

src/lib/tasks/steps/certificate.ts

@@ -18,7 +18,7 @@ export default (configs: MOUNT) => {
 
   const commands = [
     'echo "Generating Open SSL RSA Certificate..."',
-    `--catch openssl req -x509 -nodes -days ${certificate.days} -new -newkey rsa:${certificate.rsa} -keyout /etc/ssl/private/cert.pem -out /etc/ssl/private/cert.pem -subj "/C=${country}/ST=${state}/L=${location}/O=${organization}/OU=${organizationUnit}/CN=${commonName}"`,
+    `--catch sudo openssl req -x509 -nodes -days ${certificate.days} -new -newkey rsa:${certificate.rsa} -keyout /etc/ssl/private/cert.pem -out /etc/ssl/private/cert.pem -subj "/C=${country}/ST=${state}/L=${location}/O=${organization}/OU=${organizationUnit}/CN=${commonName}"`,
     sh.done,
   ];
 

src/lib/tasks/steps/crontab.ts

@@ -15,16 +15,15 @@ export default (configs: MOUNT, VPS: ACCESS) => {
   const crons = escapeQuotes(fs.readFileSync(normalize(crontab.path), 'utf-8'));
   const commands = [
     `echo "${sh.startTitle}Setting up cron jobs for '${VPS.username}'${sh.endTitle}"`,
-    'mkdir -p /var/spool/cron/crontabs/',
-    'apt-get update',
-    'apt-get install -y cron',
-    `echo ${crons} | ${append ? 'tee -a' : 'cat >'} /var/spool/cron/crontabs/${
+    'sudo mkdir -p /var/spool/cron/crontabs/',
+    'sudo apt-get update',
+    'sudo apt-get install -y cron',
+    `echo ${crons} | sudo tee${append ? ' -a' : ''} /var/spool/cron/crontabs/${
       VPS.username
-    }`,
+    } > /dev/null`,
   ];
 
-  if (!append) commands.push(`echo ${crons}`);
-
+  commands.push(`echo ${crons}`);
   commands.push(sh.done);
 
   return commands;