diff --git a/Dockerrun.aws.json b/Dockerrun.aws.json new file mode 100644 index 000000000..7cdb1b7b6 --- /dev/null +++ b/Dockerrun.aws.json @@ -0,0 +1,16 @@ +{ + "AWSEBDockerrunVersion": "1", + "Authentication": { + "Bucket": "elasticbeanstalk-us-east-1-925176737378", + "Key": "docker/.dockercfg" + }, + "Image": { + "Name": "nylas/k2", + "Update": "true" + }, + "Ports": [ + { + "ContainerPort": "5100" + } + ] +} diff --git a/README.md b/README.md index 47160fad6..21d9803c6 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,34 @@ # K2 - Sync Engine Experiment -# Initial Setup +# Initial Setup: -1. Download https://toolbelt.heroku.com/ +## New Computer (Mac): -``` -brew install redis -nvm install 6 -npm install -``` +1. Install [Homebrew](http://brew.sh/) +1. Install [VirtualBox 5+](https://www.virtualbox.org/wiki/Downloads) +1. Install [Docker for Mac](https://docs.docker.com/docker-for-mac/) +1. Install [NVM](https://github.com/creationix/nvm) `brew install nvm` +1. Install Node 6+ via NVM: `nvm install 6` -# Running locally +## New to AWS: + +1. Install [Elastic Beanstalk CLI](http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/eb-cli3-install.html#eb-cli3-install-osx): `brew install awsebcli` +1. Install [AWS CLI](https://aws.amazon.com/cli/): `brew install awscli` + 1. Add your AWS IAM Security Credentials to `aws configure`. + 1. These are at Console Home -> IAM -> Users -> {{Your Name}} -> Security + Credentials. Note that your private key was only shown unpon creation. If + you've lost your private key you have to deactivate your old key and + create a new one. +1. Get the K2 team private SSH key. (Ignore this when we have a Bastion Host). Ask someone on K2 for a copy of the private SSH key. Copy it to your ~/.ssh folder. + 1. `chmod 400 ~/.ssh/k2-keypair.pem` + 1. `ssh i ~/.ssh/k2-keypair.pem some-ec2-box-we-own.amazonaws.com` +1. Connect to Elastic Beanstalk instances: `eb init`. Select correct region. Select correct application. + + +# Developing Locally: ``` npm start ``` -## Auth an account - -``` -curl -X POST -H "Content-Type: application/json" -d '{"email":"inboxapptest2@fastmail.fm", "name":"Ben Gotow", "provider":"imap", "settings":{"imap_username":"inboxapptest1@fastmail.fm","imap_host":"mail.messagingengine.com","imap_port":993,"smtp_host":"mail.messagingengine.com","smtp_port":0,"smtp_username":"inboxapptest1@fastmail.fm", "smtp_password":"trar2e","imap_password":"trar2e","ssl_required":true}}' "http://localhost:5100/auth?client_id=123" -``` +# Deploying