Prerequisites

  • Integration apps configured
  • Backend and Frontend environment variables set up

Deployment

Step 1: Setting Up Your GitHub Access Token for Cloning

1.1. Obtain Your Cloning Access Token

  • Reach out to the Duckie team for your cloning_access_token
  • You can contact us at founders@duckie.ai

1.2. Set Up the Token on Your Machine

Once you have received your cloning_access_token, follow these steps to set it up:

  1. Enter the following command, replacing your_cloning_access_token_here with the actual token you received:

    export GITHUB_TOKEN=your_cloning_access_token_here
    
  2. To verify that the token has been set correctly, you can echo the variable: This should display your token.

    echo $GITHUB_TOKEN
    

Step 2: Configuring the Environment Variables

To configure your application correctly, you need to set up environment variables using a .env file. Follow these steps to create and populate your .env file on your machine.

  1. Navigate to the root directory for the Duckie application deployment
  2. Create two new files named .backend.env and .frontend.env
  3. Paste the contents of the configuration files from the Frontend and Backend sections into your .frontend.env and .backend.env files

Step 3: Deploying the Duckie Application

3.1. Running the Deployment Script

  1. Copy and paste the following command into your terminal:

    curl -sSL https://duckie-public-dist.s3.amazonaws.com/duckie-selfhost-deploy.sh | sudo -E bash -s install
    
  2. Press Enter to run the command

  3. It will take ~2 minutes for Duckie to start

3.2. Upgrading the Duckie Application

  1. Copy and paste the following command into your terminal:

    curl -sSL https://duckie-public-dist.s3.amazonaws.com/duckie-selfhost-deploy.sh | sudo -E bash -s upgrade
    
  2. Press Enter to run the command

  3. It will take ~2 minutes for Duckie to start

Step 4: Accessing the Duckie Application

  • Open your web browser and navigate to the Frontend URL you set up in the .frontend.env file
  • You should see the Duckie application interface

To learn more about using Duckie, you can visit the Using Duckie page.