Add quick start documentation (#124)

* Start improving quick start documentation

* Documentation tweaks

.env.example

@@ -1,5 +1,5 @@
 APP_SECRET=Ck7Rt1uiy5WGbrTFj1HBjymbBoA6zqih
-BASE_URL=http://localhost
+BASE_URL=http://localhost:3000
 UI_PORT=3000
 
 DB_CLIENT=mysql2
@@ -14,8 +14,8 @@ REDIS_HOST=127.0.0.1
 REDIS_PORT=6379
 
 STORAGE_DRIVER=local
-STORAGE_BASE_URL=http://localhost/uploads
+STORAGE_BASE_URL=http://localhost:3000/uploads
 
 AUTH_DRIVER=basic
-AUTH_BASIC_USERNAME=parcelvoy
+AUTH_BASIC_EMAIL=test@parcelvoy.com
 AUTH_BASIC_PASSWORD=password

README.md

@@ -38,7 +38,7 @@ docker compose up -d # run the Docker container
 Login to the web app at http://localhost:3000 by entering the default credentials found in the copied `.env` file.
 
 ```
-AUTH_BASIC_USERNAME=parcelvoy
+AUTH_BASIC_EMAIL=test@parcelvoy.com
 AUTH_BASIC_PASSWORD=password
 ```
 

docs/docs/advanced/authentication.md

@@ -45,4 +45,10 @@ AUTH_BASIC_PASSWORD=password
 ### Google Workspace
 You can utilize either SAML or OpenID to connect to your Google Account. We'll be highlighting how to setup SAML as it is slightly easier than OpenID to configure.
 
+1. Open the admin console for Google Workspace (https://admin.google.com)
+2. Navigate to Apps -> Web and mobile apps
+3. Click `Add app` and from the dropdown select `Add custom SAML app`
+4. Enter an app name and select an optional logo
+5. The SSO URL -> 
+
 ***Instructions coming soon.***

docs/docs/deploy/aws-ec2.md

@@ -25,17 +25,26 @@ sudo yum install -y docker-compose-plugin
 docker compose version
 ```
 
-4. Install Parcelvoy by running the following:
+4. Download Parcelvoy configuration:
 ```
 mkdir parcelvoy && cd parcelvoy
-wget https://raw.githubusercontent.com/parcelvoy/parcelvoy/master/{.env,docker-compose.yaml}
-docker compose up -d # run the Docker container
+wget https://raw.githubusercontent.com/parcelvoy/parcelvoy/master/{.env.example,docker-compose.yaml}
 ```
 
 5. Setup environment variables
 ```
-sudo vim .env
+mv .env.example .env
 ```
-The database and queue come pre-configured but SSO needs to be setup. Pick your authentication approach and set the required environment variables.
 
+For default installations, security is set to `basic` which only allows for a single user. Before proceeding please update the email, password and app secret to not be their default values.
+
+```
+APP_SECRET=//Please pick a random value at least 16 characters in length
+AUTH_BASIC_EMAIL=test@parcelvoy.com
+AUTH_BASIC_PASSWORD=password
+```
+
+This file also lets you use a separate database, change what queue is being used or setup SSO.
+
+By default the port is configured to use `3000` for the UI and API. You can modify this by setting `UI_PORT`.
 6. Setup security groups

docs/docs/overview/quick-start.md

@@ -1 +1,54 @@
-# Quick Start
+# Quick Start
+You can run Parcelvoy locally or in the cloud easily using Docker. For this quickstart we will be using Docker Compose, but you can also provide each of the components yourself.
+
+We'll run you through the basics of how to get up and running quickly, for more specific installation steps on different platforms please check out our deployment section.
+
+## Requirements
+- An instance or virtual machine running Linux with at least 4GB of RAM
+- Docker and Docker Compose are installed and available
+
+## Installation
+
+### 1. Download Parcelvoy
+Copy our latest `docker-compose.yml` and `.env.example` file onto your machine:
+
+```
+mkdir parcelvoy && cd parcelvoy
+wget https://raw.githubusercontent.com/parcelvoy/parcelvoy/master/{.env.example,docker-compose.yml}
+mv .env.example .env
+```
+
+### 2. Setup Environment Variables
+An example environment variables file was downloaded to act as a base for the Docker Compose deployment. The first step is to copy this to `.env`
+```
+mv .env.example .env
+```
+
+For default installations, security is set to `basic` which only allows for a single user. Before proceeding please update the email, password and app secret to not be their default values.
+
+```
+APP_SECRET=//Please pick a random value at least 16 characters in length
+AUTH_BASIC_EMAIL=test@parcelvoy.com
+AUTH_BASIC_PASSWORD=password
+```
+
+### 3. Startup Docker Compose
+```
+docker compose up -d # run the Docker container
+```
+
+## Usage
+Once Docker Compose boots up, it will start the initial database migration to get everything up and running. This should only take a minute, after which you are ready to go!
+
+You can login to the web app at [http://localhost:3000](http://localhost:3000) by entering the default credentials you set in your `.env` file.
+
+### Onboarding
+After login, you'll be prompted to go through onboarding. This will get you setup with your first project. 
+
+### Integrations
+Parcelvoy at its core is an orchestration service that lets you determine how, when and to whom to send messages. Different mediums of messages as well as different platforms require integrations in order for them to work. 
+
+Check out our [providers](../providers) section for instructions on how to get each one setup.
+
+### How To
+For more indepth tutorials on all of the functionality in Parcelvoy, make sure to checkout our [How To](../how-to) section.