FederatedCode documentation

Welcome to the very start of your FederatedCode journey! In this documentation you will find information on:

• An overview of FederatedCode

• Installation instructions

• Reference documentation about the FederatedCode concepts,

• How to make technical contributions to the project and the community

Getting Started

• FederatedCode Overview
  • Why FederatedCode?
  • What is FederatedCode?
• Installation
  • Run with Containers
  • Local development installation
• User Interface
• FAQs
  • Am I able to run FederatedCode on Windows?
• Contributing to FederatedCode
  • Do Your Homework
  • Ways to Contribute
  • Helpful Resources
• Changelog
  • v0.1.0 (January 7, 2025)

Tutorial

• Getting Started
  • Create Admin User
  • Log in to FederatedCode Admin
  • Create Service User
• Syncing ScanCode Metadata with FederatedCode
  • Fork the FederatedCode Data Package Scan Repository
  • Add Data Repository in FederatedCode
  • Sync Package Scan
  • Click on Packages link
  • Click on any PURL link
  • Package Activity
• Syncing VulnerableCode Metadata with FederatedCode
  • Fork the FederatedCode Data Vulnerablecode Repository
  • Add Data Repository in FederatedCode
  • Sync Vulnerablecode metadata
  • Click on Packages link
  • Click on any PURL link
  • Package Activity
• Subscribe to Package Updates (Remote)
  • Initial Setup (FederatedCode)
  • Initial Setup (PurlDB)
  • Update Package Scan (Git Repo)
  • Run Sync and Federate (FederatedCode)
  • Browse the Package Activity (PurlDB)
• Federating Package Activity and Repository Sync
  • Federating Package Activity
  • Notifying FederatedCode of Repository Changes

Reference Documentation

• Data Models
  • Actor
  • RemoteActor
  • Reputation
  • Service
  • Note
  • Package
  • Person
  • Follow
  • Repository
  • Vulnerability
  • Review
  • FederateRequest
  • SyncRequest
• JSON Schemas
  • Package
  • Vulnerability
• Command Line Interface
• REST API
  • Authentication
• Application Settings
  • DATABASE
  • FEDERATEDCODE_REQUIRE_AUTHENTICATION
  • FEDERATEDCODE_WORKSPACE_LOCATION
  • FEDERATEDCODE_LOG_LEVEL
  • TIME_ZONE

Indices and tables

• Index

• Search Page