npm - deploy.sh - Versions diffs - 1.0.0 → 3.0.0 - Mend

deploy.sh 1.0.0 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (161) hide show

package/.claude/settings.local.json +36 -0
package/.github/ISSUE_TEMPLATE/bug_report.yml +105 -0
package/.github/ISSUE_TEMPLATE/config.yml +5 -0
package/.github/ISSUE_TEMPLATE/feature_request.yml +56 -0
package/.github/workflows/ci.yml +29 -0
package/.github/workflows/pages.yml +48 -0
package/.oxfmtrc.json +7 -0
package/.oxlintrc.json +11 -0
package/LICENSE +183 -183
package/README.md +99 -11
package/app/actions/deployments.ts +82 -0
package/app/actions/metrics.ts +13 -0
package/app/root.tsx +60 -0
package/app/routes/dashboard/detail/history.tsx +73 -0
package/app/routes/dashboard/detail/layout.tsx +125 -0
package/app/routes/dashboard/detail/logs.tsx +85 -0
package/app/routes/dashboard/detail/overview.tsx +119 -0
package/app/routes/dashboard/detail/requests.tsx +163 -0
package/app/routes/dashboard/detail/resources.tsx +268 -0
package/app/routes/dashboard/detail/shared.tsx +59 -0
package/app/routes/dashboard/index.tsx +360 -0
package/app/routes/dashboard/layout.tsx +30 -0
package/app/routes/docs/architecture.tsx +155 -0
package/app/routes/docs/cli.tsx +122 -0
package/app/routes/docs/deploying.tsx +105 -0
package/app/routes/docs/index.tsx +104 -0
package/app/routes/docs/layout.tsx +58 -0
package/app/routes/home.tsx +134 -0
package/app/routes/root.client.tsx +46 -0
package/app/routes.ts +21 -0
package/app/styles.css +15 -0
package/app/theme.css +134 -0
package/bin/deploy.js +360 -110
package/docs-site/404.html +33 -0
package/docs-site/home.tsx +130 -0
package/docs-site/index.html +35 -0
package/docs-site/layout.tsx +57 -0
package/docs-site/main.tsx +41 -0
package/docs-site/shell.tsx +34 -0
package/docs-site/styles.css +4 -0
package/drizzle.config.js +8 -0
package/examples/docker/Dockerfile +5 -0
package/examples/docker/server.js +18 -0
package/examples/node/package.json +7 -0
package/examples/node/pnpm-lock.yaml +9 -0
package/examples/node/server.js +12 -0
package/examples/static/index.html +48 -0
package/package.json +41 -55
package/public/favicon.ico +0 -0
package/react-router-vite/entry.browser.tsx +49 -0
package/react-router-vite/entry.rsc.single.tsx +7 -0
package/react-router-vite/entry.rsc.tsx +36 -0
package/react-router-vite/entry.ssr.tsx +29 -0
package/react-router-vite/plugin.ts +114 -0
package/react-router-vite/types.d.ts +11 -0
package/react-router.config.ts +5 -0
package/server/api.test.ts +344 -0
package/server/api.ts +445 -0
package/server/docker.ts +268 -0
package/server/index.ts +17 -0
package/server/metrics-collector.ts +29 -0
package/server/schema.ts +56 -0
package/server/store.test.ts +278 -0
package/server/store.ts +398 -0
package/tsconfig.json +21 -0
package/vite.config.ts +45 -0
package/vite.docs.config.ts +31 -0
package/.eslintignore +0 -5
package/.eslintrc +0 -23
package/.travis.yml +0 -9
package/.tryitout +0 -48
package/CHANGELOG.md +0 -56
package/bin/deploy-delete.js +0 -11
package/bin/deploy-deploy.js +0 -31
package/bin/deploy-list.js +0 -32
package/bin/deploy-login.js +0 -39
package/bin/deploy-logout.js +0 -12
package/bin/deploy-logs.js +0 -19
package/bin/deploy-open.js +0 -19
package/bin/deploy-register.js +0 -40
package/bin/deploy-server.js +0 -5
package/bin/deploy-whoami.js +0 -12
package/docs/code/CLI.html +0 -2901
package/docs/code/Deployment.html +0 -2469
package/docs/code/Request.html +0 -906
package/docs/code/User.html +0 -1219
package/docs/code/classifier.js.html +0 -121
package/docs/code/deploy.js.html +0 -122
package/docs/code/fonts/OpenSans-Bold-webfont.eot +0 -0
package/docs/code/fonts/OpenSans-Bold-webfont.svg +0 -1830
package/docs/code/fonts/OpenSans-Bold-webfont.woff +0 -0
package/docs/code/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
package/docs/code/fonts/OpenSans-BoldItalic-webfont.svg +0 -1830
package/docs/code/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
package/docs/code/fonts/OpenSans-Italic-webfont.eot +0 -0
package/docs/code/fonts/OpenSans-Italic-webfont.svg +0 -1830
package/docs/code/fonts/OpenSans-Italic-webfont.woff +0 -0
package/docs/code/fonts/OpenSans-Light-webfont.eot +0 -0
package/docs/code/fonts/OpenSans-Light-webfont.svg +0 -1831
package/docs/code/fonts/OpenSans-Light-webfont.woff +0 -0
package/docs/code/fonts/OpenSans-LightItalic-webfont.eot +0 -0
package/docs/code/fonts/OpenSans-LightItalic-webfont.svg +0 -1835
package/docs/code/fonts/OpenSans-LightItalic-webfont.woff +0 -0
package/docs/code/fonts/OpenSans-Regular-webfont.eot +0 -0
package/docs/code/fonts/OpenSans-Regular-webfont.svg +0 -1831
package/docs/code/fonts/OpenSans-Regular-webfont.woff +0 -0
package/docs/code/fonts/OpenSans-Semibold-webfont.eot +0 -0
package/docs/code/fonts/OpenSans-Semibold-webfont.svg +0 -1830
package/docs/code/fonts/OpenSans-Semibold-webfont.ttf +0 -0
package/docs/code/fonts/OpenSans-Semibold-webfont.woff +0 -0
package/docs/code/fonts/OpenSans-SemiboldItalic-webfont.eot +0 -0
package/docs/code/fonts/OpenSans-SemiboldItalic-webfont.svg +0 -1830
package/docs/code/fonts/OpenSans-SemiboldItalic-webfont.ttf +0 -0
package/docs/code/fonts/OpenSans-SemiboldItalic-webfont.woff +0 -0
package/docs/code/helpers_cli.js.html +0 -315
package/docs/code/helpers_util.js.html +0 -194
package/docs/code/index.html +0 -66
package/docs/code/models_deployment.js.html +0 -515
package/docs/code/models_request.js.html +0 -158
package/docs/code/models_user.js.html +0 -198
package/docs/code/module-lib_classifier.html +0 -246
package/docs/code/module-lib_deploy.html +0 -350
package/docs/code/module-lib_helpers_util.html +0 -707
package/docs/code/scripts/linenumber.js +0 -25
package/docs/code/scripts/prettify/Apache-License-2.0.txt +0 -202
package/docs/code/scripts/prettify/lang-css.js +0 -2
package/docs/code/scripts/prettify/prettify.js +0 -28
package/docs/code/styles/jsdoc-default.css +0 -692
package/docs/code/styles/prettify-jsdoc.css +0 -111
package/docs/code/styles/prettify-tomorrow.css +0 -132
package/docs/example.gif +0 -0
package/docs/example.mov +0 -0
package/docs/index.html +0 -4463
package/docs/logo.png +0 -0
package/docs/logo.pxm +0 -0
package/docs/logo@2x.png +0 -0
package/docs/main.css +0 -162
package/docs/main.js +0 -53
package/index.js +0 -55
package/jsdoc.json +0 -27
package/lib/classifier.js +0 -61
package/lib/deploy.js +0 -62
package/lib/helpers/cli.js +0 -255
package/lib/helpers/util.js +0 -134
package/lib/models/deployment.js +0 -455
package/lib/models/request.js +0 -98
package/lib/models/user.js +0 -138
package/lib/server.js +0 -165
package/lib/static/not-found.html +0 -30
package/lib/static/page-could-not-load.html +0 -30
package/lib/static/static-server.js +0 -69
package/test/fixtures/docker/Dockerfile +0 -5
package/test/fixtures/docker/index.js +0 -12
package/test/fixtures/node/index.js +0 -8
package/test/fixtures/node/package.json +0 -15
package/test/fixtures/static/index.html +0 -14
package/test/fixtures/static/main.css +0 -7
package/test/fixtures/static/out.gifcd +0 -0
package/test/fixtures/unknown/.gitkeep +0 -0
package/test/lib/classifier.js +0 -51
package/test/lib/helpers/util.js +0 -47

package/docs/code/Deployment.html DELETED Viewed

@@ -1,2469 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="utf-8">
-    <meta name="viewport" content="width=device-width,initial-scale=1">
-    <title>Deployment - Documentation</title>
-    <script src="scripts/prettify/prettify.js"></script>
-    <script src="scripts/prettify/lang-css.js"></script>
-    <!--[if lt IE 9]>
-      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
-    <![endif]-->
-    <link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
-    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
-    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
-</head>
-<body>
-<input type="checkbox" id="nav-trigger" class="nav-trigger" />
-<label for="nav-trigger" class="navicon-button x">
-  <div class="navicon"></div>
-</label>
-<label for="nav-trigger" class="overlay"></label>
-<nav>
-    <li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading">Classes</li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="CLI.html">CLI</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="CLI.html#.cacheCredentials">cacheCredentials</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="CLI.html#.createBundle">createBundle</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="CLI.html#.deleteDeployment">deleteDeployment</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="CLI.html#.getCredentials">getCredentials</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="CLI.html#.getDeployments">getDeployments</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="CLI.html#.getLogs">getLogs</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="CLI.html#.getUserDetails">getUserDetails</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="CLI.html#.login">login</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="CLI.html#.logout">logout</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="CLI.html#.register">register</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="CLI.html#.removeBundle">removeBundle</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="CLI.html#.uploadBundle">uploadBundle</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Deployment.html">Deployment</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Deployment.html#.decorate">decorate</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Deployment.html#.del">del</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Deployment.html#.get">get</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Deployment.html#.getAll">getAll</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Deployment.html#.logs">logs</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Deployment.html#.proxy">proxy</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Deployment.html#.remove">remove</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Deployment.html#.start">start</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Deployment.html#.stop">stop</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Deployment.html#.update">update</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Request.html">Request</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Request.html#.count">count</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Request.html#.del">del</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Request.html#.log">log</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="User.html">User</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="User.html#.authenticate">authenticate</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="User.html#.authenticateMiddleware">authenticateMiddleware</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="User.html#.login">login</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="User.html#.logout">logout</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="User.html#.register">register</a></span></li><li class="nav-heading">Modules</li><li class="nav-heading"><span class="nav-item-type type-module">M</span><span class="nav-item-name"><a href="module-lib_classifier.html">lib/classifier</a></span></li><li class="nav-heading"><span class="nav-item-type type-module">M</span><span class="nav-item-name"><a href="module-lib_deploy.html">lib/deploy</a></span></li><li class="nav-heading"><span class="nav-item-type type-module">M</span><span class="nav-item-name"><a href="module-lib_helpers_util.html">lib/helpers/util</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-lib_helpers_util.html#.mk">mk</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-lib_helpers_util.html#~contains">contains</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-lib_helpers_util.html#~getPort">getPort</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-lib_helpers_util.html#~hash">hash</a></span></li>
-</nav>
-<div id="main">
-    <h1 class="page-title">Deployment</h1>
-<section>
-<header>
-        <h2>
-        Deployment
-        </h2>
-</header>
-<article>
-    <div class="container-overview">
-<div class="section-method">
-    <h4 class="name" id="Deployment"><span class="type-signature"></span>new Deployment<span class="signature">()</span><span class="type-signature"></span></h4>
-<div class="description">
-    <p>Deployment definition</p>
-</div>
-    <h5 class="subsection-title">Properties:</h5>
-<table class="props">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>id</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last"><p>the container id</p></td>
-        </tr>
-        <tr>
-                <td class="name"><code>name</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last"><p>the name of the deployment</p></td>
-        </tr>
-        <tr>
-                <td class="name"><code>port</code></td>
-            <td class="type">
-<span class="param-type"><code>Number</code></span>
-            </td>
-            <td class="description last"><p>the port that the container has exposed</p></td>
-        </tr>
-        <tr>
-                <td class="name"><code>subdomain</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last"><p>the subdomain of the application</p></td>
-        </tr>
-        <tr>
-                <td class="name"><code>directory</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last"><p>the directory of tared application</p></td>
-        </tr>
-        <tr>
-                <td class="name"><code>username</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last"><p>the username who owns the deployment</p></td>
-        </tr>
-    </tbody>
-</table>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="models_deployment.js.html">models/deployment.js</a>, <a href="models_deployment.js.html#line35">line 35</a>
-    </li></ul></dd>
-</dl>
-</div>
-    </div>
-        <h3 class="subsection-title">Methods</h3>
-<div class="section-method">
-    <h4 class="name" id=".decorate"><span class="type-signature">(static) </span>decorate<span class="signature">(deployment)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
-<div class="description">
-    <p>decorates a deployment with the correct data on get</p>
-</div>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="models_deployment.js.html">models/deployment.js</a>, <a href="models_deployment.js.html#line158">line 158</a>
-    </li></ul></dd>
-</dl>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>deployment</code></td>
-            <td class="type">
-<span class="param-type"><code><a href="Deployment.html">Deployment</a></code></span>
-            </td>
-            <td class="description last">
-                <p>a deployment instance</p>
-            </td>
-        </tr>
-    </tbody>
-</table>
-<div class="section-returns">
-<h5>Returns:</h5>
-<dl class="param-type">
-    <dt>
-        Type:
-    </dt>
-    <dd>
-<span class="param-type"><code>Promise</code></span>
-    </dd>
-</dl>
-</div>
-</div>
-<div class="section-method">
-    <h4 class="name" id=".del"><span class="type-signature">(static) </span>del<span class="signature">(name)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
-<div class="description">
-    <p>deletes the specified deployment from the user</p>
-</div>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="models_deployment.js.html">models/deployment.js</a>, <a href="models_deployment.js.html#line84">line 84</a>
-    </li></ul></dd>
-</dl>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>name</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>the name of the deployment</p>
-            </td>
-        </tr>
-        <tr>
-                <td class="name"><code>options.token</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>the token for the user who owns the deployment</p>
-            </td>
-        </tr>
-        <tr>
-                <td class="name"><code>options.username</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>the username associated with this deployment</p>
-            </td>
-        </tr>
-    </tbody>
-</table>
-<div class="section-returns">
-<h5>Returns:</h5>
-<dl class="param-type">
-    <dt>
-        Type:
-    </dt>
-    <dd>
-<span class="param-type"><code>Promise</code></span>
-    </dd>
-</dl>
-</div>
-</div>
-<div class="section-method">
-    <h4 class="name" id=".get"><span class="type-signature">(static) </span>get<span class="signature">(options)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
-<div class="description">
-    <p>gets a specific deployment for the specified user</p>
-</div>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="models_deployment.js.html">models/deployment.js</a>, <a href="models_deployment.js.html#line182">line 182</a>
-    </li></ul></dd>
-</dl>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>options</code></td>
-            <td class="type">
-<span class="param-type"><code>Object</code></span>
-            </td>
-            <td class="description last">
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>name</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>the name of the deployment</p>
-            </td>
-        </tr>
-        <tr>
-                <td class="name"><code>token</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>the token for the user who owns the deployment</p>
-            </td>
-        </tr>
-        <tr>
-                <td class="name"><code>username</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>the username associated with this deployment</p>
-            </td>
-        </tr>
-    </tbody>
-</table>
-            </td>
-        </tr>
-        <tr>
-                <td class="name"><code>option.create</code></td>
-            <td class="type">
-<span class="param-type"><code>Boolean</code></span>
-            </td>
-            <td class="description last">
-                <p>create a deployment if not found</p>
-            </td>
-        </tr>
-    </tbody>
-</table>
-<div class="section-returns">
-<h5>Returns:</h5>
-<dl class="param-type">
-    <dt>
-        Type:
-    </dt>
-    <dd>
-<span class="param-type"><code>Promise</code></span>
-    </dd>
-</dl>
-</div>
-</div>
-<div class="section-method">
-    <h4 class="name" id=".getAll"><span class="type-signature">(static) </span>getAll<span class="signature">()</span><span class="type-signature"> &rarr; {Promise}</span></h4>
-<div class="description">
-    <p>gets all deployments for the specified user</p>
-</div>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="models_deployment.js.html">models/deployment.js</a>, <a href="models_deployment.js.html#line215">line 215</a>
-    </li></ul></dd>
-</dl>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>options.token</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>the token for the user who owns the deployment</p>
-            </td>
-        </tr>
-        <tr>
-                <td class="name"><code>options.username</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>the username associated with this deployment</p>
-            </td>
-        </tr>
-    </tbody>
-</table>
-<div class="section-returns">
-<h5>Returns:</h5>
-<dl class="param-type">
-    <dt>
-        Type:
-    </dt>
-    <dd>
-<span class="param-type"><code>Promise</code></span>
-    </dd>
-</dl>
-</div>
-</div>
-<div class="section-method">
-    <h4 class="name" id=".logs"><span class="type-signature">(static) </span>logs<span class="signature">(name, token, username)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
-<div class="description">
-    <p>retrieves from a given instance</p>
-</div>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="models_deployment.js.html">models/deployment.js</a>, <a href="models_deployment.js.html#line372">line 372</a>
-    </li></ul></dd>
-</dl>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>name</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>instance name</p>
-            </td>
-        </tr>
-        <tr>
-                <td class="name"><code>token</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>the token for the user who owns the deployment</p>
-            </td>
-        </tr>
-        <tr>
-                <td class="name"><code>username</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>the username associated with this deployment</p>
-            </td>
-        </tr>
-    </tbody>
-</table>
-<div class="section-returns">
-<h5>Returns:</h5>
-<dl class="param-type">
-    <dt>
-        Type:
-    </dt>
-    <dd>
-<span class="param-type"><code>Promise</code></span>
-    </dd>
-</dl>
-</div>
-</div>
-<div class="section-method">
-    <h4 class="name" id=".proxy"><span class="type-signature">(static) </span>proxy<span class="signature">(subdomain)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
-<div class="description">
-    <p>express middleware to proxy to correct container</p>
-</div>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="models_deployment.js.html">models/deployment.js</a>, <a href="models_deployment.js.html#line115">line 115</a>
-    </li></ul></dd>
-</dl>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>subdomain</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>the subdomain for the application being requested</p>
-            </td>
-        </tr>
-    </tbody>
-</table>
-<div class="section-returns">
-<h5>Returns:</h5>
-<dl class="param-type">
-    <dt>
-        Type:
-    </dt>
-    <dd>
-<span class="param-type"><code>Promise</code></span>
-    </dd>
-</dl>
-</div>
-</div>
-<div class="section-method">
-    <h4 class="name" id=".remove"><span class="type-signature">(static) </span>remove<span class="signature">(name)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
-<div class="description">
-    <p>removes a specific container, will stop and cleanup all necessary files</p>
-</div>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="models_deployment.js.html">models/deployment.js</a>, <a href="models_deployment.js.html#line417">line 417</a>
-    </li></ul></dd>
-</dl>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>name</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>the name of the container</p>
-            </td>
-        </tr>
-        <tr>
-                <td class="name"><code>options.token</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>the token for the user who owns the deployment</p>
-            </td>
-        </tr>
-        <tr>
-                <td class="name"><code>options.username</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>the username associated with this deployment</p>
-            </td>
-        </tr>
-    </tbody>
-</table>
-<div class="section-returns">
-<h5>Returns:</h5>
-<dl class="param-type">
-    <dt>
-        Type:
-    </dt>
-    <dd>
-<span class="param-type"><code>Promise</code></span>
-    </dd>
-</dl>
-</div>
-</div>
-<div class="section-method">
-    <h4 class="name" id=".start"><span class="type-signature">(static) </span>start<span class="signature">(name<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
-<div class="description">
-    <p>starts a container or all containers</p>
-</div>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="models_deployment.js.html">models/deployment.js</a>, <a href="models_deployment.js.html#line307">line 307</a>
-    </li></ul></dd>
-</dl>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th>Attributes</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>name</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-                <td class="attributes">
-                    &lt;optional><br>
-                </td>
-            <td class="description last">
-                <p>to start a specific container a name property is needed</p>
-            </td>
-        </tr>
-        <tr>
-                <td class="name"><code>options.token</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-                <td class="attributes">
-                </td>
-            <td class="description last">
-                <p>the token for the user who owns the deployment</p>
-            </td>
-        </tr>
-        <tr>
-                <td class="name"><code>options.username</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-                <td class="attributes">
-                </td>
-            <td class="description last">
-                <p>the username associated with this deployment</p>
-            </td>
-        </tr>
-    </tbody>
-</table>
-<div class="section-returns">
-<h5>Returns:</h5>
-<dl class="param-type">
-    <dt>
-        Type:
-    </dt>
-    <dd>
-<span class="param-type"><code>Promise</code></span>
-    </dd>
-</dl>
-</div>
-</div>
-<div class="section-method">
-    <h4 class="name" id=".stop"><span class="type-signature">(static) </span>stop<span class="signature">(name<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
-<div class="description">
-    <p>stops a container or all containers</p>
-</div>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="models_deployment.js.html">models/deployment.js</a>, <a href="models_deployment.js.html#line339">line 339</a>
-    </li></ul></dd>
-</dl>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th>Attributes</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>name</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-                <td class="attributes">
-                    &lt;optional><br>
-                </td>
-            <td class="description last">
-                <p>to stop a specific container a name property is needed</p>
-            </td>
-        </tr>
-        <tr>
-                <td class="name"><code>options.token</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-                <td class="attributes">
-                    &lt;optional><br>
-                </td>
-            <td class="description last">
-                <p>the token for the user who owns the deployment</p>
-            </td>
-        </tr>
-        <tr>
-                <td class="name"><code>options.username</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-                <td class="attributes">
-                    &lt;optional><br>
-                </td>
-            <td class="description last">
-                <p>the username associated with this deployment</p>
-            </td>
-        </tr>
-    </tbody>
-</table>
-<div class="section-returns">
-<h5>Returns:</h5>
-<dl class="param-type">
-    <dt>
-        Type:
-    </dt>
-    <dd>
-<span class="param-type"><code>Promise</code></span>
-    </dd>
-</dl>
-</div>
-</div>
-<div class="section-method">
-    <h4 class="name" id=".update"><span class="type-signature">(static) </span>update<span class="signature">(options)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
-<div class="description">
-    <p>updates a deployment</p>
-</div>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="models_deployment.js.html">models/deployment.js</a>, <a href="models_deployment.js.html#line46">line 46</a>
-    </li></ul></dd>
-</dl>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>options</code></td>
-            <td class="type">
-<span class="param-type"><code>Object</code></span>
-            </td>
-            <td class="description last">
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>name</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>the name of the deployment</p>
-            </td>
-        </tr>
-        <tr>
-                <td class="name"><code>username</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>the username associated with this deployment</p>
-            </td>
-        </tr>
-    </tbody>
-</table>
-            </td>
-        </tr>
-    </tbody>
-</table>
-<div class="section-returns">
-<h5>Returns:</h5>
-<dl class="param-type">
-    <dt>
-        Type:
-    </dt>
-    <dd>
-<span class="param-type"><code>Promise</code></span>
-    </dd>
-</dl>
-</div>
-</div>
-</article>
-</section>
-</div>
-<br class="clear">
-<footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
-</footer>
-<script>prettyPrint();</script>
-<script src="scripts/linenumber.js"></script>
-</body>
-</html>