Hasura GraphQL engine One-click App on DigitalOcean Marketplace¶

Step 1: Create a Hasura One-click Droplet¶

Click the button below to create a new Hasura GraphQL engine Droplet through the DigitalOcean Marketplace. For first time users, the link also contains a referral code with gives you $100 over days. A $5 droplet is good enough to support most workloads. (Ctrl+Click to open in a new tab)

Step 2: Open console¶

Once the Hasura GraphQL engine Droplet is ready, you can visit the Droplet IP to open the Hasura console, where you can create tables, explore GraphQL APIs etc. Note that it might take 1 or 2 minutes for everything to start running.

The Droplet IP is highlighted in the image below:

The Hasura console will be at:

http://<your_droplet_ip>/console

The GraphQL endpoint will be:

http://<your_droplet_ip>/v1/graphql

A Postgres database is also provisioned on the Droplet. Using the console, you can create a table on this Postgres instance and make your first GraphQL query.

Step 3: Create a table¶

Navigate to Data -> Add table on the console and create a table called profile with the following columns:

profile

Choose id as the Primary key and click the Add Table button.

Step 4: Insert sample data¶

Once the table is created, go to the Insert Row tab and insert some sample rows:

Thor
Iron Man
Hulk
Captain America
Black Widow

Step 5: Try out GraphQL¶

Switch to the GraphiQL tab on top and execute the following GraphQL query:

query {
  profile {
    id
    name
  }
}

Step 1: Connect to the Droplet via SSH¶

ssh root@<your_droplet_ip>

Step 2: Go to the /etc/hasura directory¶

cd /etc/hasura

Step 3: Set an admin secret¶

Edit docker-compose.yaml and un-comment the line that mentions admin secret key. Also change it to some unique secret:

vim docker-compose.yaml

...
# un-comment next line to add an admin secret key
HASURA_GRAPHQL_ADMIN_SECRET: <myadminsecretkey>
...

# type ESC followed by :wq to save and quit

Step 4: Update the container¶

docker-compose up -d

That’s it. Visit the console at http://<your_droplet_ip>/console and it should prompt for the admin secret key. Further API requests can be made by adding the following header:

X-Hasura-Admin-Secret: <myadminsecretkey>

Step 1: Add a record mapping¶

Go to your domain’s DNS dashboard and add an A record mapping the domain to the Droplet IP.

Step 2: Connect to the Droplet via SSH¶

ssh root@<your_droplet_ip>

Step 3: Go to the /etc/hasura directory¶

cd /etc/hasura

Step 4: Edit the Caddyfile and change :80 to your domain¶

vim Caddyfile

...
add_your-domain-here {
   proxy / graphql-engine:8080 {
      websocket
   }
}
...

# type ESC followed by :wq to save and quit

Step 5: Restart the container¶

docker-compose restart caddy

Go to https://<your_domain>/console to visit the Hasura console.

Step 1: Connect to the Droplet via SSH¶

ssh root@<your_droplet_ip>

Step 2: Go to the /etc/hasura directory¶

cd /etc/hasura

Step 3: Edit docker-compose.yaml and change the image tag to the latest one¶

vim docker-compose.yaml

...
graphql-engine:
   image: hasura/graphql-engine:latest_tag_here
...

# type ESC followed by :wq to save and quit

Step 4: Restart the container¶

docker-compose up -d

Step 1: Create a Postgres database¶

Create a new Postgres database from the DigitalOcean console, preferably in the same region as the Droplet.

Step 2: Get the database URL¶

Once the database is created, under the “Overview” tab, from the “Connection Details” section, choose “Connection string” from the dropdown. “Connection string” is the “Database URL”. Copy it.

Step 3: Connect to the Droplet via SSH¶

ssh root@<your_droplet_ip>

Step 4: Go to the /etc/hasura directory¶

cd /etc/hasura

Step 5: Edit docker-compose.yaml and change the database URL¶

vim docker-compose.yaml

...
# change the url to use a different database
HASURA_GRAPHQL_DATABASE_URL: <database-url>
...

# type ESC followed by :wq to save and quit

Similarly, the database URL can be changed to connect to any other Postgres database.

Step 1: Connect to the Droplet via SSH¶

ssh root@<your_droplet_ip>

Step 2: Go to the /etc/hasura directory¶

cd /etc/hasura

Step 3: Check logs¶

To checks logs for any container, use the following command:

docker-compose logs <container_name>

Where <container_name> is one of graphql-engine, postgres or caddy.