CanDoItAll.IPFS.Engine 0.1.18

CanDoItAll.IPFS

CanDoItAll.IPFS provides an embedded IPFS engine, reusable IPFS contracts, a typed .NET client, and a Blazor node-control application for operating a local or remote node.

Ownership

This repository owns:

• the reusable CanDoItAll.IPFS.Client, CanDoItAll.IPFS.Core, and CanDoItAll.IPFS.Engine packages;
• the maintained embedded IPFS engine and its HTTP API;
• the NodeControl application and its repository-specific Docker and release tooling.

This repository does not own:

• the IPFS protocol specification or public IPFS network;
• the CanDoItAll.Components.* packages, which are consumed from nuget.org;
• cross-repository standards and orchestration, which are maintained in CanDoItAll.SharedInfo.

Projects And Packages

Install the public packages directly from nuget.org:

dotnet add package CanDoItAll.IPFS.Client
dotnet add package CanDoItAll.IPFS.Core
dotnet add package CanDoItAll.IPFS.Engine

Requirements

• .NET SDK 10.0.302, with compatible patch roll-forward as pinned by global.json.
• Access to nuget.org for package restore.
• Docker Desktop or a compatible Docker Engine for container validation and local container workflows.

Build And Test

Run from the repository root:

dotnet restore .\CanDoItAll.IPFS.slnx --configfile .\NuGet.config
dotnet build .\CanDoItAll.IPFS.slnx --configuration Release --no-restore
dotnet test .\CanDoItAll.IPFS.slnx --configuration Release --no-build

Run NodeControl

Set a development passphrase and node repository path in the shell that starts the app:

$env:IPFS_PASS = "Choose-A-Strong-Local-Passphrase"
$env:IPFS_PATH = "C:\ipfs-data\local-node"
dotnet run --project .\src\CanDoItAll.IPFS.NodeControl\CanDoItAll.IPFS.NodeControl.csproj --framework net10.0

The control app can connect to a configured remote endpoint or start the local engine when the configured target resolves to this machine and no node is listening. On Windows, use --framework net10.0-windows to run the desktop/tray variant.

Important configuration:

• IPFS_PASS unlocks the local engine repository.
• IPFS_PATH selects the local node repository path.
• IPFS_NODE_API_URL overrides the engine API bind URL.
• src/CanDoItAll.IPFS.NodeControl/appsettings.json contains NodeControl defaults.

Containers

The canonical Compose model is a loopback-only local development stack:

Copy-Item .env.example .env
# Replace the placeholder IPFS_PASS in the ignored .env file.
docker compose --env-file .env config --quiet
docker compose --env-file .env up -d --build --wait --wait-timeout 120
docker compose --env-file .env down

Default endpoints:

• NodeControl UI: http://127.0.0.1:5093
• IPFS node API: http://127.0.0.1:5001
• IPFS gateway: http://127.0.0.1:5001/ipfs/{cid}

Normal teardown preserves named volumes. Destructive volume reset is intentionally not part of the normal workflow. See container operations and backup and restore.

After the .NET unit tests and container smoke validation pass, pushes to main publish commit-tagged Linux images to GitHub Container Registry:

• ghcr.io/fyziktom/candoitall-ipfs-node:sha-<commit>
• ghcr.io/fyziktom/candoitall-ipfs-node-control:sha-<commit>

Tags named v<version> additionally publish the immutable semantic version tag.

Documentation

• Architecture and ownership
• Container operations
• Backup and restore
• Contributing
• Security

Packaging And Releases

Preview or produce all public NuGet packages through the repository-owned entry point:

.\tools\deployment\nugets\Build-NuGets.ps1 -WhatIf
.\tools\deployment\nugets\Build-NuGets.ps1 `
    -Configuration Release `
    -Version 0.1.15 `
    -OutputDirectory .\artifacts\packages

The command restores, builds, tests, and packs without publishing. Publishing to a package source is a separate, explicitly authorized operation.

Build standalone NodeControl/engine release bundles with:

.\tools\deployment\Build-Release.ps1 -WhatIf
.\tools\deployment\Build-Release.ps1

Acknowledgements

CanDoItAll.IPFS is developed and maintained by fyziktom. It builds on Richard Schneider's original net-ipfs-engine, net-ipfs-core, and net-ipfs-http-client projects. Many thanks to Richard Schneider and the upstream contributors for making that foundation available.

Since that foundation, this repository has been substantially extended and modernized across the protocol libraries, embedded engine, typed HTTP client, NodeControl UI, security, tests, packaging, and container deployment. Development continues here as the independently maintained CanDoItAll IPFS implementation.

License And Contributions

This repository uses the MIT License. The current work is copyright (c) 2026 fyziktom; Richard Schneider's original 2018 copyright notice is retained for the upstream foundation. Additional copied-source attribution is recorded in THIRD-PARTY-NOTICES.md.

Code contributions are limited to partners explicitly approved by the maintainer. Unsolicited pull requests are not accepted. See CONTRIBUTING.md and contact the fyziktom account on LinkedIn before preparing or opening a pull request.