<aside> 💡

Approximate Time Required: 40 minutes (10 min setup, 30 min to run the automated script.)

</aside>

Follow these instructions to install DocSpring Enterprise on AWS using Convox. These instructions will set up a highly-available and auto-scaling EKS (Kubernetes) cluster to run the DocSpring application. The script will also set up Postgres (RDS), Redis (ElastiCache), and an S3 bucket for file storage. Convox creates Terraform config to set up all of your resources. Once your Convox Rack is set up, you can use the terraform CLI tool to manage your infrastructure and store your config in a git repo.

These instructions use the free and open source convox/rack project to set up your cluster and provision resources. Convox also provides an optional “hosted console” service that you can sign up for at https://convox.com. This hosted console is completely optional, and your deployment does not require any of these features. See our docs about the Convox Console for more information.

Requirements

• An AWS account with administrator permissions.
• An API token for DocSpring’s Docker Registry. You should have received this API token via email.

Setup Instructions

Install the Convox and AWS CLI tools

Run the following commands on Mac OS:

brew install convox awscli
convox --version    # Should be at least 3.18.6
aws --version       # Should be at least 2.15.54

• Convox installation instructions for other platforms: https://docs.convox.com/introduction/installation
• AWS CLI installation instructions for other platforms: https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html

Install Ruby >= 2.5 and Bundler

Ensure that you have a recent version of Ruby (2.x or 3.x) and Bundler installed.

ruby --version        # Should be at least 2.5 (3.x is also fine.)
bundler --version     # Should be at least 1.0.0

• Ruby installation instructions: https://www.ruby-lang.org/en/documentation/installation
• After installing Ruby, run: gem install bundler

Create a temporary AWS access key for an admin user