deploy.sh 0.2.0 → 2.0.0

package/website/docs/api/lib/helpers/cli.js.md

@@ -0,0 +1,193 @@
+<a name="CLI"></a>
+
+## CLI
+
+**Kind**: global class
+
+- [CLI](#CLI)
+  - [new CLI(options)](#new_CLI_new)
+  - [.createBundle(directory)](#CLI.createBundle) ⇒ <code>Promise</code>
+  - [.removeBundle(directory)](#CLI.removeBundle) ⇒ <code>Promise</code>
+  - [.uploadBundle(options)](#CLI.uploadBundle) ⇒ <code>Promise</code>
+  - [.login(options)](#CLI.login) ⇒ <code>Promise</code>
+  - [.register(options)](#CLI.register) ⇒ <code>Promise</code>
+  - [.logout(options)](#CLI.logout) ⇒ <code>Promise</code>
+  - [.getLogs(options)](#CLI.getLogs) ⇒ <code>Promise</code>
+  - [.getDeployments(options)](#CLI.getDeployments) ⇒ <code>Promise</code>
+  - [.deleteDeployment(options)](#CLI.deleteDeployment) ⇒ <code>Promise</code>
+  - [.getUserDetails()](#CLI.getUserDetails) ⇒ <code>Promise</code>
+  - [.cacheCredentials(options)](#CLI.cacheCredentials) ⇒ <code>Promise</code>
+  - [.getCredentials()](#CLI.getCredentials) ⇒ <code>Promise</code>
+
+<a name="new_CLI_new"></a>
+
+### new CLI(options)
+
+the cli instance that holds all options and methods to talk to the deploy.sh service
+
+| Param               | Type                | Description                                                                                  |
+| ------------------- | ------------------- | -------------------------------------------------------------------------------------------- |
+| options             | <code>Object</code> | contains defaults and overrides                                                              |
+| options.url         | <code>String</code> | the url of the remote deploy.sh service                                                      |
+| options.application | <code>String</code> | the deployed application name to alter                                                       |
+| options.mongo       | <code>String</code> | the mongo connection string used by deploy.sh service when running `deploy serve --mongo ''` |
+
+<a name="CLI.createBundle"></a>
+
+### CLI.createBundle(directory) ⇒ <code>Promise</code>
+
+creates a bundle to send to the server for deployment
+
+**Kind**: static method of [<code>CLI</code>](#CLI)
+
+| Param     | Type                | Description                                   |
+| --------- | ------------------- | --------------------------------------------- |
+| directory | <code>String</code> | the directory that is to be turned into a tar |
+
+<a name="CLI.removeBundle"></a>
+
+### CLI.removeBundle(directory) ⇒ <code>Promise</code>
+
+removes the bundle from the given directory
+
+**Kind**: static method of [<code>CLI</code>](#CLI)
+
+| Param     | Type                | Description       |
+| --------- | ------------------- | ----------------- |
+| directory | <code>String</code> | path to directory |
+
+<a name="CLI.uploadBundle"></a>
+
+### CLI.uploadBundle(options) ⇒ <code>Promise</code>
+
+Deals with uploading a specified bundle
+
+**Kind**: static method of [<code>CLI</code>](#CLI)
+
+| Param          | Type                | Description                           |
+| -------------- | ------------------- | ------------------------------------- |
+| options        | <code>Object</code> |                                       |
+| options.name   | <code>String</code> | the name of the specified application |
+| options.bundle | <code>Stream</code> | a file stream of the tar              |
+
+<a name="CLI.login"></a>
+
+### CLI.login(options) ⇒ <code>Promise</code>
+
+calls the login api to get a token to persist for future requests
+
+**Kind**: static method of [<code>CLI</code>](#CLI)
+
+| Param            | Type                | Description                          |
+| ---------------- | ------------------- | ------------------------------------ |
+| options          | <code>Object</code> |                                      |
+| options.username | <code>String</code> | username of the account              |
+| options.password | <code>String</code> | password associated with the account |
+
+<a name="CLI.register"></a>
+
+### CLI.register(options) ⇒ <code>Promise</code>
+
+prompts the user to register account
+
+**Kind**: static method of [<code>CLI</code>](#CLI)
+
+| Param            | Type                | Description                          |
+| ---------------- | ------------------- | ------------------------------------ |
+| options          | <code>Object</code> |                                      |
+| options.username | <code>String</code> | username of the account              |
+| options.password | <code>String</code> | password associated with the account |
+
+<a name="CLI.logout"></a>
+
+### CLI.logout(options) ⇒ <code>Promise</code>
+
+calls the logout api to invalidate token
+
+**Kind**: static method of [<code>CLI</code>](#CLI)
+
+| Param            | Type                | Description                       |
+| ---------------- | ------------------- | --------------------------------- |
+| options          | <code>Object</code> |                                   |
+| options.token    | <code>String</code> | token to make authenticated calls |
+| options.username | <code>String</code> | username linked to the token      |
+
+<a name="CLI.getLogs"></a>
+
+### CLI.getLogs(options) ⇒ <code>Promise</code>
+
+gets the application logs
+
+**Kind**: static method of [<code>CLI</code>](#CLI)
+
+| Param            | Type                | Description                       |
+| ---------------- | ------------------- | --------------------------------- |
+| options          | <code>Object</code> |                                   |
+| options.token    | <code>String</code> | token to make authenticated calls |
+| options.username | <code>String</code> | username linked to the token      |
+| options.name     | <code>String</code> | name of the deployment            |
+
+<a name="CLI.getDeployments"></a>
+
+### CLI.getDeployments(options) ⇒ <code>Promise</code>
+
+gets the user's deployed applications
+
+**Kind**: static method of [<code>CLI</code>](#CLI)
+
+| Param            | Type                | Description                       |
+| ---------------- | ------------------- | --------------------------------- |
+| options          | <code>Object</code> |                                   |
+| options.token    | <code>String</code> | token to make authenticated calls |
+| options.username | <code>String</code> | username linked to the token      |
+| [options.name]   | <code>String</code> | name of the deployment            |
+
+<a name="CLI.deleteDeployment"></a>
+
+### CLI.deleteDeployment(options) ⇒ <code>Promise</code>
+
+deletes the specified deployment
+
+**Kind**: static method of [<code>CLI</code>](#CLI)
+
+| Param            | Type                | Description                       |
+| ---------------- | ------------------- | --------------------------------- |
+| options          | <code>Object</code> |                                   |
+| options.token    | <code>String</code> | token to make authenticated calls |
+| options.username | <code>String</code> | username linked to the token      |
+| options.name     | <code>String</code> | name of the deployment            |
+
+<a name="CLI.getUserDetails"></a>
+
+### CLI.getUserDetails() ⇒ <code>Promise</code>
+
+gets the user details
+
+**Kind**: static method of [<code>CLI</code>](#CLI)
+
+| Param            | Type                | Description                       |
+| ---------------- | ------------------- | --------------------------------- |
+| options.token    | <code>String</code> | token to make authenticated calls |
+| options.username | <code>String</code> | username linked to the token      |
+
+<a name="CLI.cacheCredentials"></a>
+
+### CLI.cacheCredentials(options) ⇒ <code>Promise</code>
+
+persists the token and username locally
+
+**Kind**: static method of [<code>CLI</code>](#CLI)
+
+| Param            | Type                | Description                       |
+| ---------------- | ------------------- | --------------------------------- |
+| options          | <code>Object</code> |                                   |
+| options.token    | <code>String</code> | token to make authenticated calls |
+| options.username | <code>String</code> | username linked to the token      |
+
+<a name="CLI.getCredentials"></a>
+
+### CLI.getCredentials() ⇒ <code>Promise</code>
+
+gets the token and username that were persisted locally
+
+**Kind**: static method of [<code>CLI</code>](#CLI)

package/website/docs/api/lib/helpers/util.js.md

@@ -0,0 +1,65 @@
+<a name="module_lib/helpers/util"></a>
+
+## lib/helpers/util
+
+- [lib/helpers/util](#module_lib/helpers/util)
+  - _static_
+    - [.mk](#module_lib/helpers/util.mk) ⇒ <code>Promise</code>
+  - _inner_
+    - [~getPort()](#module_lib/helpers/util..getPort) ⇒ <code>Promise</code>
+    - [~hash(length)](#module_lib/helpers/util..hash) ⇒ <code>String</code>
+    - [~contains(arr, contains)](#module_lib/helpers/util..contains) ⇒ <code>Boolean</code>
+
+<a name="module_lib/helpers/util.mk"></a>
+
+### lib/helpers/util.mk ⇒ <code>Promise</code>
+
+makes a directory recursively
+
+**Kind**: static constant of [<code>lib/helpers/util</code>](#module_lib/helpers/util)
+
+| Param     | Type                | Description              |
+| --------- | ------------------- | ------------------------ |
+| directory | <code>String</code> | path to future directory |
+
+<a name="module_lib/helpers/util..getPort"></a>
+
+### lib/helpers/util~getPort() ⇒ <code>Promise</code>
+
+gets an open port
+
+**Kind**: inner method of [<code>lib/helpers/util</code>](#module_lib/helpers/util)  
+<a name="module_lib/helpers/util..hash"></a>
+
+### lib/helpers/util~hash(length) ⇒ <code>String</code>
+
+gets a lowercase random string with specified length
+
+**Kind**: inner method of [<code>lib/helpers/util</code>](#module_lib/helpers/util)
+
+| Param  | Type                | Description                               |
+| ------ | ------------------- | ----------------------------------------- |
+| length | <code>Number</code> | the specified length of the random string |
+
+<a name="module_lib/helpers/util..contains"></a>
+
+### lib/helpers/util~contains(arr, contains) ⇒ <code>Boolean</code>
+
+contains is a function that takes an array and see if the condition matches
+
+**Kind**: inner method of [<code>lib/helpers/util</code>](#module_lib/helpers/util)  
+**Returns**: <code>Boolean</code> - - responds back with a boolean value
+
+| Param    | Type               | Description                                       |
+| -------- | ------------------ | ------------------------------------------------- |
+| arr      | <code>Array</code> | array to check with rules                         |
+| contains | <code>Array</code> | rules to make sure the arr contains the following |
+
+**Example**
+
+```js
+contains(
+  ["index.html", "main.css"],
+  ["index.html", "!Dockerfile", "!package.json"]
+);
+```

package/website/docs/api/lib/models/deployment.js.md

@@ -0,0 +1,171 @@
+<a name="Deployment"></a>
+
+## Deployment
+
+**Kind**: global class  
+**Properties**
+
+| Name      | Type                | Description                             |
+| --------- | ------------------- | --------------------------------------- |
+| id        | <code>String</code> | the container id                        |
+| name      | <code>String</code> | the name of the deployment              |
+| port      | <code>Number</code> | the port that the container has exposed |
+| subdomain | <code>String</code> | the subdomain of the application        |
+| directory | <code>String</code> | the directory of tared application      |
+| username  | <code>String</code> | the username who owns the deployment    |
+
+- [Deployment](#Deployment)
+  - [new Deployment()](#new_Deployment_new)
+  - [.update(options)](#Deployment.update) ⇒ <code>Promise</code>
+  - [.del(name)](#Deployment.del) ⇒ <code>Promise</code>
+  - [.proxy(subdomain)](#Deployment.proxy) ⇒ <code>Promise</code>
+  - [.decorate(deployment)](#Deployment.decorate) ⇒ <code>Promise</code>
+  - [.get(options)](#Deployment.get) ⇒ <code>Promise</code>
+  - [.getAll()](#Deployment.getAll) ⇒ <code>Promise</code>
+  - [.start([name])](#Deployment.start) ⇒ <code>Promise</code>
+  - [.stop([name])](#Deployment.stop) ⇒ <code>Promise</code>
+  - [.logs(name, token, username)](#Deployment.logs) ⇒ <code>Promise</code>
+  - [.remove(name)](#Deployment.remove) ⇒ <code>Promise</code>
+
+<a name="new_Deployment_new"></a>
+
+### new Deployment()
+
+Deployment definition
+
+<a name="Deployment.update"></a>
+
+### Deployment.update(options) ⇒ <code>Promise</code>
+
+updates a deployment
+
+**Kind**: static method of [<code>Deployment</code>](#Deployment)
+
+| Param            | Type                | Description                                  |
+| ---------------- | ------------------- | -------------------------------------------- |
+| options          | <code>Object</code> |                                              |
+| options.name     | <code>String</code> | the name of the deployment                   |
+| options.username | <code>String</code> | the username associated with this deployment |
+
+<a name="Deployment.del"></a>
+
+### Deployment.del(name) ⇒ <code>Promise</code>
+
+deletes the specified deployment from the user
+
+**Kind**: static method of [<code>Deployment</code>](#Deployment)
+
+| Param            | Type                | Description                                    |
+| ---------------- | ------------------- | ---------------------------------------------- |
+| name             | <code>String</code> | the name of the deployment                     |
+| options.token    | <code>String</code> | the token for the user who owns the deployment |
+| options.username | <code>String</code> | the username associated with this deployment   |
+
+<a name="Deployment.proxy"></a>
+
+### Deployment.proxy(subdomain) ⇒ <code>Promise</code>
+
+express middleware to proxy to correct container
+
+**Kind**: static method of [<code>Deployment</code>](#Deployment)
+
+| Param     | Type                | Description                                       |
+| --------- | ------------------- | ------------------------------------------------- |
+| subdomain | <code>String</code> | the subdomain for the application being requested |
+
+<a name="Deployment.decorate"></a>
+
+### Deployment.decorate(deployment) ⇒ <code>Promise</code>
+
+decorates a deployment with the correct data on get
+
+**Kind**: static method of [<code>Deployment</code>](#Deployment)
+
+| Param      | Type                                   | Description           |
+| ---------- | -------------------------------------- | --------------------- |
+| deployment | [<code>Deployment</code>](#Deployment) | a deployment instance |
+
+<a name="Deployment.get"></a>
+
+### Deployment.get(options) ⇒ <code>Promise</code>
+
+gets a specific deployment for the specified user
+
+**Kind**: static method of [<code>Deployment</code>](#Deployment)
+
+| Param            | Type                 | Description                                    |
+| ---------------- | -------------------- | ---------------------------------------------- |
+| options          | <code>Object</code>  |                                                |
+| options.name     | <code>String</code>  | the name of the deployment                     |
+| options.token    | <code>String</code>  | the token for the user who owns the deployment |
+| options.username | <code>String</code>  | the username associated with this deployment   |
+| option.create    | <code>Boolean</code> | create a deployment if not found               |
+
+<a name="Deployment.getAll"></a>
+
+### Deployment.getAll() ⇒ <code>Promise</code>
+
+gets all deployments for the specified user
+
+**Kind**: static method of [<code>Deployment</code>](#Deployment)
+
+| Param            | Type                | Description                                    |
+| ---------------- | ------------------- | ---------------------------------------------- |
+| options.token    | <code>String</code> | the token for the user who owns the deployment |
+| options.username | <code>String</code> | the username associated with this deployment   |
+
+<a name="Deployment.start"></a>
+
+### Deployment.start([name]) ⇒ <code>Promise</code>
+
+starts a container or all containers
+
+**Kind**: static method of [<code>Deployment</code>](#Deployment)
+
+| Param            | Type                | Description                                             |
+| ---------------- | ------------------- | ------------------------------------------------------- |
+| [name]           | <code>String</code> | to start a specific container a name property is needed |
+| options.token    | <code>String</code> | the token for the user who owns the deployment          |
+| options.username | <code>String</code> | the username associated with this deployment            |
+
+<a name="Deployment.stop"></a>
+
+### Deployment.stop([name]) ⇒ <code>Promise</code>
+
+stops a container or all containers
+
+**Kind**: static method of [<code>Deployment</code>](#Deployment)
+
+| Param              | Type                | Description                                            |
+| ------------------ | ------------------- | ------------------------------------------------------ |
+| [name]             | <code>String</code> | to stop a specific container a name property is needed |
+| [options.token]    | <code>String</code> | the token for the user who owns the deployment         |
+| [options.username] | <code>String</code> | the username associated with this deployment           |
+
+<a name="Deployment.logs"></a>
+
+### Deployment.logs(name, token, username) ⇒ <code>Promise</code>
+
+retrieves from a given instance
+
+**Kind**: static method of [<code>Deployment</code>](#Deployment)
+
+| Param    | Type                | Description                                    |
+| -------- | ------------------- | ---------------------------------------------- |
+| name     | <code>String</code> | instance name                                  |
+| token    | <code>String</code> | the token for the user who owns the deployment |
+| username | <code>String</code> | the username associated with this deployment   |
+
+<a name="Deployment.remove"></a>
+
+### Deployment.remove(name) ⇒ <code>Promise</code>
+
+removes a specific container, will stop and cleanup all necessary files
+
+**Kind**: static method of [<code>Deployment</code>](#Deployment)
+
+| Param            | Type                | Description                                    |
+| ---------------- | ------------------- | ---------------------------------------------- |
+| name             | <code>String</code> | the name of the container                      |
+| options.token    | <code>String</code> | the token for the user who owns the deployment |
+| options.username | <code>String</code> | the username associated with this deployment   |

package/website/docs/api/lib/models/request.js.md

@@ -0,0 +1,67 @@
+<a name="Request"></a>
+
+## Request
+
+**Kind**: global class  
+**Properties**
+
+| Name           | Type                | Description                                                   |
+| -------------- | ------------------- | ------------------------------------------------------------- |
+| subdomain      | <code>String</code> | the subdomain of the request                                  |
+| url            | <code>String</code> | the url that was being accessed                               |
+| time           | <code>Number</code> | the time it took to access the resource                       |
+| method         | <code>String</code> | the http verb that describes the request                      |
+| statusCode     | <code>String</code> | the statusCode associated with the request                    |
+| userAgent      | <code>String</code> | the userAgent that access the resource                        |
+| referer        | <code>String</code> | the referer that the user was at before accessing the address |
+| acceptLanguage | <code>String</code> | browser based language preferences                            |
+
+- [Request](#Request)
+  - [new Request()](#new_Request_new)
+  - [.log(req, res, next)](#Request.log)
+  - [.count(subdomain)](#Request.count) ⇒ <code>Promise</code>
+  - [.del(subdomain)](#Request.del) ⇒ <code>Promise</code>
+
+<a name="new_Request_new"></a>
+
+### new Request()
+
+Request definition
+
+<a name="Request.log"></a>
+
+### Request.log(req, res, next)
+
+express middleware that logs requests
+
+**Kind**: static method of [<code>Request</code>](#Request)
+
+| Param | Type                  | Description             |
+| ----- | --------------------- | ----------------------- |
+| req   | <code>Object</code>   | express request object  |
+| res   | <code>Object</code>   | express response object |
+| next  | <code>function</code> | callback function       |
+
+<a name="Request.count"></a>
+
+### Request.count(subdomain) ⇒ <code>Promise</code>
+
+returns the amount of requests for the specified subdomain
+
+**Kind**: static method of [<code>Request</code>](#Request)
+
+| Param     | Type                | Description                                             |
+| --------- | ------------------- | ------------------------------------------------------- |
+| subdomain | <code>string</code> | the subdomain of which to get the count of requests for |
+
+<a name="Request.del"></a>
+
+### Request.del(subdomain) ⇒ <code>Promise</code>
+
+removes all entries associated with a particular subdomain
+
+**Kind**: static method of [<code>Request</code>](#Request)
+
+| Param     | Type                | Description                                   |
+| --------- | ------------------- | --------------------------------------------- |
+| subdomain | <code>String</code> | the subdomain that the entries are related to |

package/website/docs/api/lib/models/user.js.md

@@ -0,0 +1,92 @@
+<a name="User"></a>
+
+## User
+
+**Kind**: global class  
+**Properties**
+
+| Name     | Type                | Description                               |
+| -------- | ------------------- | ----------------------------------------- |
+| username | <code>String</code> | a string that defines the user's accounts |
+| password | <code>String</code> | a password for the user                   |
+| [token]  | <code>String</code> | an access token                           |
+
+- [User](#User)
+  - [new User()](#new_User_new)
+  - [.authenticateMiddleware(req, res, next)](#User.authenticateMiddleware)
+  - [.authenticate(token, username)](#User.authenticate) ⇒ <code>Promise</code>
+  - [.logout(token, username)](#User.logout) ⇒ <code>Promise</code>
+  - [.login(username, password)](#User.login) ⇒ <code>Promise</code>
+  - [.register(username, password)](#User.register) ⇒ <code>Promise</code>
+
+<a name="new_User_new"></a>
+
+### new User()
+
+User definition
+
+<a name="User.authenticateMiddleware"></a>
+
+### User.authenticateMiddleware(req, res, next)
+
+middleware to verify the username and token are valid, will then set the user to req.user
+
+**Kind**: static method of [<code>User</code>](#User)
+
+| Param | Type                  | Description                       |
+| ----- | --------------------- | --------------------------------- |
+| req   | <code>Object</code>   | express request                   |
+| res   | <code>Object</code>   | express response                  |
+| next  | <code>function</code> | callback to go to next middleware |
+
+<a name="User.authenticate"></a>
+
+### User.authenticate(token, username) ⇒ <code>Promise</code>
+
+verify the username and token are valid
+
+**Kind**: static method of [<code>User</code>](#User)
+
+| Param    | Type                | Description                            |
+| -------- | ------------------- | -------------------------------------- |
+| token    | <code>String</code> | the token associated with the username |
+| username | <code>String</code> | the username of the user               |
+
+<a name="User.logout"></a>
+
+### User.logout(token, username) ⇒ <code>Promise</code>
+
+logs out a user by deleting their token
+
+**Kind**: static method of [<code>User</code>](#User)
+
+| Param    | Type                | Description                            |
+| -------- | ------------------- | -------------------------------------- |
+| token    | <code>String</code> | the token associated with the username |
+| username | <code>String</code> | the username of the user               |
+
+<a name="User.login"></a>
+
+### User.login(username, password) ⇒ <code>Promise</code>
+
+logs in a user and returns
+
+**Kind**: static method of [<code>User</code>](#User)
+
+| Param    | Type                | Description                                |
+| -------- | ------------------- | ------------------------------------------ |
+| username | <code>String</code> | the username of the user who is logging in |
+| password | <code>String</code> | the password associated with the user      |
+
+<a name="User.register"></a>
+
+### User.register(username, password) ⇒ <code>Promise</code>
+
+registers a user
+
+**Kind**: static method of [<code>User</code>](#User)
+
+| Param    | Type                | Description                                |
+| -------- | ------------------- | ------------------------------------------ |
+| username | <code>String</code> | the username of the user who is logging in |
+| password | <code>String</code> | the password associated with the user      |

package/website/docs/intro.md

@@ -0,0 +1,57 @@
+---
+sidebar_position: 1
+title: "Intro"
+---
+
+## Getting Started
+
+Firstly we must install `deploy.sh`.
+
+```bash
+npm install deploy.sh -g
+```
+
+### What you'll need
+
+- [Node.js](https://nodejs.org/en/download/) version 14 or above:
+  - When installing Node.js, you are recommended to check all checkboxes related to dependencies.
+- [Docker](https://docs.docker.com/get-docker/) is how deploy.sh runs and is required to start new applications
+- [Mongo](https://docs.mongodb.com/manual/administration/install-community/) is required to store application state and logs
+
+## Starting deploy.sh server
+
+In order to deploy your applications you will need to spin up a deploy.sh server
+
+```bash
+deploy server
+```
+
+```bash
+% deploy serve
+✔ Started 0 deployment(s) successfully
+⛅️ deploy.sh is running on port 5000
+```
+
+## Start your site
+
+In order to do anything you must first go through the registration process by running:
+
+```
+deploy register
+```
+
+For this example I am going to use the folder in `examples/docker` in <https://github.com/gabrielcsapo/deploy.sh>.
+
+```bash
+deploy
+```
+
+![../static/img/intro/deploy.png](../static/img/intro/deploy.png)
+
+To look at the logs from the docker container itself, simply run `deploy logs`
+
+```bash
+deploy logs
+```
+
+![../static/img/intro/logs.png](../static/img/intro/logs.png)