CivicDuty Documentation
  • 👋Welcome to CiviDuty
  • 🏁Quickstart 1 - Running The Docker Stack
  • 🛠ī¸Quickstart 2 - Optionally Installing and Building CivicDuty from source
  • đŸ’ģAccessing CivicDuty Services
  • ℹī¸Further Resources
  • Group 1
    • 🏗ī¸Process Flow Development
      • ⚙ī¸Using the CiviCRM API (v4) in your Prefect Flows
        • ⚙ī¸Consuming CiviFlow Events
Powered by GitBook
On this page
  • Requirements
  • Step by Step Instructions
  • Optional Steps
  • Start the Stack
  • Stop the Stack

Was this helpful?

Edit on GitHub

Quickstart 1 - Running The Docker Stack

How to quickly get up and running with the CivicDuty Prefect Distro with Docker on Linux

PreviousWelcome to CiviDutyNextQuickstart 2 - Optionally Installing and Building CivicDuty from source

Last updated 1 year ago

Was this helpful?

Github Repo location

Requirements

Assuming Docker is running on a Linux OS such as Ubuntu, Debian or Redhat.

Docker should be installed on host, including docker-compose - Official Docker install instructions

These instructions were derived on a host running Debian 11 (bullseye) Linux distro .

Step by Step Instructions

  • Clone git repository from 

git clone https://lab.civicrm.org/ttaylor/civicduty

  • Navigate to newly created civicduty directory

cd civicduty

  • Create the .env configuration file from the template file versions.venv i.e.

For x64 (Intel) machines

cp versions.env .env

For arm64 machines (AWS Graviton/ Mac Silicon etc)

cp versions-arm.env .env

Optional Steps

Change Postgres password in the configuration file .venv i.e.

POSTGRES_PASSWORD=postgres-test

Start the Stack

In the directory that you installed civicduty to, run the following command:

./prefect.sh start

By default the stack will restart after the host is rebooted

Stop the Stack

In the directory that you installed civicduty to, run the following command:

./prefect.sh stop
🏁
https://lab.civicrm.org/ttaylor/civicduty
https://lab.civicrm.org/ttaylor/civicduty