Contributing to OSINT Framework

Contributions are extremely welcome and are the primary way the framework stays current with the latest OSINT resources. The most common way to contribute is by adding a new free and public resource.

How to Add a New Resource

The process for adding a new resource is straightforward, as all the framework's data is stored in the public/arf.json file.

1. Set up the Project Locally

Before making changes, it's a good idea to run the project on your machine to test your additions. Please follow the guide on the Installation & Local Setup page.

2. Fork and Clone the Repository

Fork the official repository to your own GitHub account, then clone it to your local machine.

3. Create a New Branch

Create a descriptive branch for your changes:

git checkout -b add-new-resource-example

4. Edit public/arf.json

This is the core of your contribution.

  • Open the public/arf.json file in a text editor.
  • Navigate to the appropriate category where your new resource should be listed.
  • Add a new JSON object for your resource. Ensure it follows the correct format.

Your new entry should look like this:

{
  "name": "Example Name",
  "type": "url",
  "url": "http://example.com"
}
  • Important: If you are adding your entry after another one within a children array, you must add a comma , to the closing brace } of the preceding item.

5. Test Your Changes

Run npm start and check your local version of the framework at http://localhost:8000 to ensure your new link appears correctly and the JSON is still valid.

6. Commit and Push

Commit your changes with a clear message and push them to your forked repository.

git add public/arf.json
git commit -m "Add Example Name to framework"
git push origin add-new-resource-example

7. Submit a Pull Request

Go to the original OSINT-Framework repository on GitHub and open a pull request from your new branch. Provide a brief description of the resource you are adding.

Thank you for helping improve the OSINT Framework!