Skip to content

Latest commit

 

History

History
100 lines (79 loc) · 4.48 KB

README.md

File metadata and controls

100 lines (79 loc) · 4.48 KB
Raw

Kavach

Prerequisites

    • Install and run Docker and Docker Compose

Setting up the ENV & Config files

  • Copy the config/config.env.example to config/config.env and change the relevant values as needed.
  • Copy the config/companion/env.example to config/companion/env and change the relevant values as needed.
  • Copy the config/web/config.js to web/public and change the relevant values as needed.

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 volumes will be created at the root directory of the project to perisit any stateful data.

Access the application

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

Service URL
Kavach Web http://127.0.0.1:4455/.factly/kavach/web/auth/login
Kavach Server http://127.0.0.1:4455/.factly/kavach/server/
Swagger: http://localhost:5001/swagger/index.html
Postgres http://localhost:27017
Username: postgres
Password: postgres
Imgproxy http://localhost:8080
Companion http://localhost:3020
Minio API: http://localhost:9000
Console: http://localhost:9000
Username: miniokey
Password: miniosecret
Mailslurper Dashboard: http://localhost:4436
Service: http://localhost:4437
Kratos Public API: http://localhost:4433
Admin API: http://localhost:4434
Keto Read: http://localhost:4466
Write: http://localhost:4467
Metrics: http://localhost:4468
Oathkeeper Proxy: http://localhost:4455
API: http://localhost:4456
Rules: http://localhost:4456/rules

Stopping the application

  • Execute the following docker-compose command to stop Kavach and all the components without removing them or their volumes.

      docker-compose stop

  • Execute the following docker-compose command to:

    • Stop the containers and removes them
    • Delete volumes, networks, and the images used to start the containers.
    • This completely tears down the environment and freeing up resources.
      docker-compose stop

Setting up the email server

  • Create a mailgun account.
  • On the dashboard click on one of the sending domains.
  • Select the SMTP method for sending the email.
  • In kratos config file, add the smtp connection URI. Format of the URI is smtp://username:[email protected]:port/?skip_ssl_verify=true
  • Example : smtp://[email protected]:[email protected]:587/?skip_ssl_verify=true

Environment variables - Kavach-web

  • PUBLIC_URL=http://127.0.0.1:4455/.factly/kavach/web : used for customising URL for kavach-web
  • REACT_APP_KAVACH_TITLE=Kavach : helps in customising the title on the login screen.
  • REACT_APP_LOGO_URL={some_image_url} : helps in customising the logo on the login screen.
  • REACT_APP_KRATOS_PUBLIC_URL=http://127.0.0.1:4455/.ory/kratos/public : used for customising the public URL in kratos-config i.e. the common part for all the self-service endpoints.
  • REACT_APP_COMPANION_URL=http://127.0.0.1:3020 : used for the location of third party storage
  • REACT_APP_API_URL=http://127.0.0.1:4455/.factly/kavach/server : used for customising server endpoint for kavach-web.
  • REACT_APP_ENABLE_MULTITENANCY=true/false : it is used to activate the multitenancy feature of kavach.

For enabling OIDC

    methods:
      oidc:
        enabled: true
        config:
          providers:
            - id: github
              provider: github 
              client_id: github-client-id
              client_secret: github-client-secret
              mapper_url: file:///etc/config/kratos/oidc.github.jsonnet
              scope:
                - user:email

            - id: google 
              provider: google
              client_id: google-client-id
              client_secret: google-client-secret
              mapper_url: file:///etc/config/kratos/oidc.google.jsonnet
              scope:
                - email
                - profile