Secure your software empower your team.
Table of Contents
This repository contains all the necessary tools and dependencies to develop on CodeClarity. It includes Docker containers, build scripts, and configuration files required to set up your local development environment.
This project is licensed under the AGPL-3.0-or-later license. You can find the full license details in the LICENSE file.
- curl: Used for downloading the setup script and dumps.
- make: Used for automating certain build and deployment tasks.
- golang >= 1.24 Used for plugins and downloadable here.
- Docker: A containerization platform. Installation instructions are available on the Docker website.
- Docker Compose: A tool for defining and running multi-container Docker applications. Installation instructions can be found here.
This script automates the cloning of the development environment repository and initiates the setup process.
curl -O https://raw.githubusercontent.com/CodeClarityCE/codeclarity-dev/main/setup.sh && sh setup.shPlease apply for an NVD API key here, and fill it in codeclarity-dev/.cloud/env/.env.makefile.
Run the command to update the knowledge DB:
make knowledge-updateYour development environment is now set up.
Once the initial configuration is complete, you no longer need to execute the setup script to start the platform.
Use make to list all the possible actions:
# —— 🦉 CodeClarity's Makefile 🦉 ——————————————————————————————————
help Outputs this help screen
# —— Commands for the dev env 💻 ———————————————————————————————————————————————————————————————
build Builds the Docker images
up Starts the Docker images
down Stops the Docker images
pull Pulls the Docker images
logs Displays the logs of the Docker images
# —— Commands to test production 🎯 ———————————————————————————————————————————————————————————————
build-prod Builds de production Docker images
up-prod Starts the Docker images in prod mode
down-prod Stops the Docker images in prod mode
# —— Commands to setup database 💾 ———————————————————————————————————————————————————————————————
knowledge-setup Creates the database
knowledge-update Updates the database
# ——
6ABA
Commands to dump and restore database 💾 ———————————————————————————————————————————————————————————————
download-dumps Downloads the database dump
dump-database Dumps the database
restore-database Restores the databaseYou can visit https://localhost:443 to start using the platform. You might need to accept the self-signed certificate generated by Caddy.
If you imported the dump we provide, you can connect using the following credentials:
- login:
john.doe@codeclarity.io - password:
ThisIs4Str0ngP4ssW0rd?
Now, follow this guide to create your first analysis!
If you'd like to contribute code or documentation, please see CONTRIBUTING.md for guidelines on how to do so.
Please report any issues with the setup process or other problems encountered while using this repository by opening a new issue in this project's GitHub page.