Skip to main content

Installation

Using Docker Compose#

Docker Compose is the easiest way to install and get started with VidCheck 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#

    git clone https://github.com/factly/kavach-server.git kavach/kavach-server    git clone https://github.com/factly/kavach-web.git kavach/kavach-web

The folder structure after cloning the above repositories should look like the following:

    .    ├── README.md    ├── docker-compose.yml    ├── kavach    ├── kratos    ├── client    ├── server    ├── oathkeeper    └── pg-init-scripts

Env file to be added#

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

    DATABASE_HOST=postgres DATABASE_USER=postgresDATABASE_PASSWORD=postgresDATABASE_NAME=vidcheck DATABASE_PORT=5432 DATABASE_SSL_MODE=disable
KETO_URL=http://keto:4466KAVACH_URL=http://kavach-server:8000OATHKEEPER_HOST=oathkeeper:4455KRATOS_PUBLIC_URL=http://kratos:4433DEGA_URL=http://dega-server:8000DEGA_INTEGRATION=false
IFRAMELY_URL=http://iframely:8061MEILI_KEY=passwordMEILI_URL=http://meilisearch:7700IMAGEPROXY_URL=http://127.0.0.1:7001
TEMPLATES_PATH=web/templates/*
SUPER_ORGANISATION_TITLE='VidCheck Administration'DEFAULT_NUMBER_OF_MEDIA=10DEFAULT_NUMBER_OF_SPACES=2DEFAULT_NUMBER_OF_VIDEOS=10CREATE_SUPER_ORGANISATION=true[email protected]DEFAULT_USER_PASSWORD=2ssad32sadADSd@!@4

Starting the application#

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

      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 Vidcheck and all the components

      docker-compose down