Skip to main content

Installation

Using Docker Compose#

Docker Compose is the easiest way to install and get started with Dega on your system locally.

Pre-requisites#

  • Currently the setup is only tested for development on Mac OS and Linux
  • Install and run Docker and Docker Compose

Clone the required repositories#

  • dega

        git clone https://github.com/factly/dega.git

Env files to be added#

  • Create config file with name config (and extension .env, .yml, .json) in server/ and add config variables (eg. below)

    MODE=development
# dependencies servicesKAVACH_URL=http://kavach-server:8000IMAGEPROXY_URL=http://127.0.0.1:7001KETO_URL=http://keto:4466NATS_URL=http://nats:4222KRATOS_PUBLIC_URL=http://kratos:4433IFRAMELY_URL=http://iframely:8061OATHKEEPER_HOST=oathkeeper:4455
GOOGLE_KEY=GOOGLE_KEY       # for google fact checks search
# database paramsDATABASE_HOST=postgres DATABASE_USER=postgresDATABASE_PASSWORD=postgresDATABASE_NAME=dega DATABASE_PORT=5432 DATABASE_SSL_MODE=disable
TEMPLATES_PATH=web/templates/*
DEFAULT_NUMBER_OF_MEDIA=10DEFAULT_NUMBER_OF_SPACES=2DEFAULT_NUMBER_OF_POSTS=10
CREATE_SUPER_ORGANISATION=true      # give SUPER_ORGANISATION_TITLE, DEFAULT_USER_EMAIL & DEFAULT_USER_PASSWORDSUPER_ORGANISATION_TITLE='Dega Administration'[email protected]DEFAULT_USER_PASSWORD=password
ENABLE_HUKZ=true        # include hukz in docker-compose and give HUKZ_URL, NATS_URL, NATS_USER_NAME & NATS_USER_PASSWORDENABLE_FEEDS=trueENABLE_SEARCH_INDEXING=true     # include meilisearch in docker-compost and give MEILI_KEY & MEILI_URL
MEILI_URL=http://meilisearch:7700MEILI_KEY=password
NATS_URL=nats://nats:4222NATS_USER_NAME=natsuserNATS_USER_PASSWORD=natspasswordHUKZ_URL=http://hukz:8000

  • Create a folder companion in root / and create .env file inside companion and add config variables (eg. below)

    COMPANION_GOOGLE_KEY=GOOGLE_KEYCOMPANION_GOOGLE_SECRET=GOOGLE_SECRETCOMPANION_AWS_ENDPOINT=http://localhost:9000COMPANION_AWS_BUCKET=degaCOMPANION_AWS_KEY=miniokeyCOMPANION_AWS_SECRET=miniosecretCOMPANION_DOMAIN=localhost:3020COMPANION_PROTOCOL=httpCOMPANION_DATADIR=/COMPANION_SELF_ENDPOINT=localhost:3020NODE_ENV=dev

Starting the application#

  • Execute the following command docker-compose command to start Dega

      docker-compose up

  • When the application is started using docker-compose, a directory with name factly will be created at the root level to perisit all the data

Access the application#

Once the application is up and running you should be able to access it using the following urls:

Stopping the application#

  • Execute the following command docker-compose command to stop Dega and all the components

      docker-compose down