Directus - Developer Guide

Welcome to the Directus AWS Deployment Guide. Seamlessly integrate Directus with AWS for scalable, secure, and automated operations. Directus is a powerful open-source data platform that wraps your database with a dynamic API and intuitive admin app, enabling real-time collaboration and content management for enterprise environments.

Empower your development teams with instant REST and GraphQL APIs, role-based access control, and flexible data modeling all within your own AWS infrastructure. Automate workflows, manage assets, and extend Directus with custom extensions, while maintaining full control over your data.

Let's get started and elevate your data management capabilities with Directus on AWS.

Prerequisites

Launching the AMI

Step 1: Find and Select 'Directus' AMI

1. Log in to your AWS Management Console.
2. Navigate to the 'Directus' in AWS Marketplace.

Step 2: Initial Setup & Configuration

1. Click the "Continue to Subscribe" button.
2. After subscribing, you will need to accept the terms and conditions. Click on "Accept Terms" to proceed.
3. Please wait for a few minutes while the processing takes place. Once it's completed, click on "Continue to Configuration".
4. Select the "CloudFormation script to deploy Directus" as the fulfilment option and choose your preferred region on the "Configure this software" page. Afterward, click the "Continue to Launch" button.
5. From the "Choose Action" dropdown menu in "Launch this software" page, select "Launch CloudFormation" and click "Launch" button.

Create CloudFormation Stack

Step 1: Create stack

1. Ensure the "Template is ready" radio button is selected under "Prepare template".
2. Click "Next".

Step 2: Specify stack options

Click "Next".

Step 3: Configure stack options

1. Choose "Roll back all stack resources" and "Delete all newly created resources" under the "Stack failure options" section.
2. Click "Next".

Step 4: Review

1. Review and verify the details you've entered.

2. Tick the box that says, "I acknowledge that AWS CloudFormation might create IAM resources with custom names".

3. Click "Submit".

Afterward, you'll be directed to the CloudFormation stacks page.

Please wait for 5-10 minutes until the stack has been successfully created.

Update DNS

Step 1: Copy IP Address

Copy the public IP labeled "PublicIp" in the "Outputs" tab.

Step 2: Update DNS

1. Go to AWS Route 53 and navigate to "Hosted Zones".
2. From there, click on Create record.

3. Add the record name and then paste the copied "PublicIp" into the "value" textbox.
4. Click "Save".

Access Directus

You can set up the Directus application through the "DashboardUrl" or "DashboardUrlIp" provided in the "Outputs" tab. This will allow you to create an Admin account, and all future accounts will be created through the Admin panel.

Enter all the required details and click on the "Create Account" button.

Important: You are now creating the Administrator Account for your Directus deployment. The email address and password you provide here will be used to manage your entire workspace, including inviting team members, configuring system settings, and maintaining overall access.

Make sure to choose a strong password and store your credentials securely, as they are critical for future access and team management.

Generate SSL Manually

Directus will automatically try to setup SSL based on provided domain name, if that domain is hosted on Route53. If its unsuccessful then you have to setup SSL manually.

Step 1: Copy IP Address

Proceed with the instructions outlined in the above "Update DNS" section, if you have not already done so.

Copy the Public IP address indicated as "PublicIp" in the "Outputs" tab.

Step 2: Log in to the server

1. Open the terminal and go to the directory where your private key is located.
2. Paste the following command into your terminal and press Enter:

ssh -i <your key name> ubuntu@<Public IP address>

3. Type "yes" and press Enter. This will log you into the server.

Step 3: Generate SSL

Paste the following command into your terminal and press Enter, and follow the instructions

sudo /root/certificate_generate_standalone.sh

Admin Email is acquiring for generate SSL certificates.

Check Server Logs

Step 1: Log in to the server

1. Open the terminal and go to the directory where your private key is located.
2. Paste the following command into your terminal and press Enter:

ssh -i <your key name> ubuntu@<Public IP address>

3. Type "yes" and press Enter. This will log you into the server.

Step 2: Check the logs

sudo docker ps

Select the correct container and check logs

sudo docker logs d1
sudo docker logs 43

Shutting Down Directus

1. Click the link labeled "Instance" in the "Resources" tab to access the EC2 instance, you will be directed to the Directus instance in EC2.

2. Select the Directus instance by marking the checkbox and click "Stop instance" from the "Instance state" dropdown. You can restart the instance at your convenience by selecting "Start instance".

Remove Directus

Delete the stack that has been created in the AWS Management Console under 'CloudFormation Stacks' by clicking the 'Delete' button.

Upgrades

When there is an upgrade, we will update the product with a newer version. You can check the product version in AWS Marketplace. If a newer version is available, you can remove the previous version and launch the product again using the newer version. Remember to backup the necessary server data before removing.

Troubleshoot

1. vCPU Quota Error

If you face the following error, please follow https://meetrix.io/blogs/increase-aws-vcpu-quota/ blog to increase vCPU quota.

2. Insufficient Capacity Error

If you face the following error (do not have sufficient <instance_type> capacity...) while creating the stack, try changing the region or try creating the stack at a later time.

3. API Dashboard Access Error

If you face the below error, when you try to access the API dashboard, please wait 5-10 minutes and then try.

4. Storage Full Error

Check whether the instance storage is full.

Log into the server and run the below command

df -h

If the root volume is between 90-100%, it is better to resize EBS volume. Please follow AWS documentation to increase the EBS volume.

Then reboot the instance and restart the Directus service.

Conclusion

The Meetrix Directus Deployment Guide is your go-to resource for seamlessly integrating Directus into your AWS environment. Whether you're a developer, system administrator, or IT leader, our guide provides clear, step-by-step instructions to ensure a secure, scalable, and production-ready setup.

Directus is a powerful open-source data platform built for high-trust environments, empowering teams with instant REST and GraphQL APIs, real-time data management, role-based access control, and flexible content modeling.

With the Meetrix Directus Deployment Guide, you'll unlock the full potential of Directus, enabling your organization to build efficient, secure, and self-hosted data management systems that scale with your infrastructure.

Technical Support

Reach out to Meetrix Support (aws@meetrix.io) for assistance with Directus issues.