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 2 - Optionally Installing and Building CivicDuty from source

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

PreviousQuickstart 1 - Running The Docker StackNextAccessing CivicDuty Services

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

Requires the make tool to be installed on host

sudo apt -y install make

Requires Python 3.11.x to be installed on host

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
  • Get the python packages required to build the prefect docker container

git submodule update --init --recursive
  • Run the make file to build the prefect container from source

For x64 (Intel) run:

make docker

For arm64 (Aws Graviton, Apple Silicon, Raspberry PI etc.) run:

make docker-arm

Optional Steps

Change Postgres password in the configuration file versions.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