Skip to content

Commit

Permalink
Update GETTING_STARTED.md
Browse files Browse the repository at this point in the history
Listed AWS instance spec that we know isn't sufficient.
  • Loading branch information
jchartrand committed Aug 2, 2024
1 parent 68f328f commit d970cb0
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/GETTING_STARTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,23 @@ into the Learner Credential Wallet. This setup will typically from a half day to

There are essentially four fundamental requirements:

#### A server with a domain name
#### 1. A server with a domain name

You'll need a server with a domain name to allow students to collect credentials. We use AWS for our test instance, but any will do, provided you can install Docker.

**IMPORTANT**: We use an AWS t3.xlarge instance with 30Gigs of storage for our testing, but the dashboard has also been deployed to an AWS t2.medium instance. If you find that your server is hanging up when starting the dashboard, consider upgrading your instance.
**IMPORTANT**: We use an AWS t3.xlarge instance with 30Gigs of storage for our testing, but the dashboard has also been deployed to an AWS t2.medium instance. We do know that it won't run on a t2.micro instance. If you find that your server is hanging up when starting the dashboard, consider upgrading your instance.

#### Docker
#### 2. Docker

You will need to have Docker running on your server. Docker provides [installation instructions](https://docs.docker.com/engine/install/) but you can typically also find online guides for your specific environment (e.g., AWS).

#### Mongo
#### 3. Mongo

The example version of the dashboard uses a pre-packaged Mongo instance, but for production you'll likely want your own instance running locally or in the cloud with something like [Mongo Atlas](https://www.mongodb.com/products/platform/atlas-database)

Mongo is used to store CSV uploads of the credentials you want to issue, including the email addresses of the recipients to allow sending email notifications, and to keep track of what's been issued and what's been collected.

#### SMTP mail server
#### 4. SMTP mail server

You'll need an SMTP mail server to send notifications to recipients. Any SMTP server is fine, for example, SendGrid or MailChimp. Sometimes (but not always) you can even use your own personal email account if your email provider allows direct SMTP sends. I've successfully used my MIT email address for example. Standard gmail accounts can supposedly also be used by changing a setting in your gmail account. At some point, however, you may hit limits on your personal email account, so do be careful. Whatever smtp service you end up using, you'll need three values for your SMTP service:

Expand Down

0 comments on commit d970cb0

Please sign in to comment.