IPFS Setup Action is a free, open-source tool for developers who need a working IPFS node inside an automated test run. It is a GitHub Action, not a desktop program you open by hand, so it lives in your repository's workflow files rather than on your computer. Its job is to install and initialize go-ipfs on whatever runner executes your pipeline, including Windows, macOS and Linux.
Before you rely on it, note two things. The latest version is 0.6.0, and the last code update was on July 3, 2023, more than two years ago, so treat the project as stale and test it carefully before trusting it with important pipelines. Windows support is listed as likely rather than confirmed, so check the releases page for the build you plan to use.
What Is IPFS and Why Tests Need It
InterPlanetary File System, usually called IPFS, is a peer-to-peer protocol for storing and sharing files. Instead of asking a server for a file by its location, you ask the network for content by its cryptographic identifier, often called a content identifier or CID. Identical content gets the same CID, so a file's identity depends on its data rather than on where it is hosted.
This model matters for developers building decentralized apps. Their code may generate CIDs, pin content, or fetch files from peers. Running those paths against a real IPFS node in a test catches problems that mocks often miss, such as malformed CIDs or content that never reached the node.
go-ipfs is the Go implementation of IPFS that this action installs. The project is also known as Kubo today, so you will see both names in documentation and search results.
Who Should Use It and Common Scenarios
The action fits teams that maintain an application relying on IPFS and want its behavior checked on every commit. Typical users include developers of decentralized websites, file-sharing tools and blockchain-adjacent apps that keep some data off-chain.
A realistic scenario: a pull request changes how an app pins uploaded images. The workflow starts an IPFS node through this action, the test uploads a sample image, retrieves it by CID, and asserts that the bytes match. If the change breaks retrieval, the pipeline fails before the code is merged.
Another scenario is cross-platform verification. A library that writes files differently on Windows and Linux can be tested on both runners with the same setup step, so path and line-ending bugs surface early. The action is a test harness, not a substitute for production infrastructure.
Key Terms Behind IPFS Testing
Pinning tells an IPFS node to keep a piece of content instead of discarding it during routine cleanup. In a test, pinning checks that data you expect to persist really stays available on the node you control.
Peers are other nodes your instance connects to. A test environment is usually isolated from the public network, so behavior can differ from real-world peer discovery. Passing tests therefore show that your code works with a local node, not how quickly content would load across the whole network.
CI runners are also ephemeral. A runner is created for one job and discarded afterward, so anything your test stores on that node disappears with it. That is usually what you want for a clean, repeatable check, but you should save important results elsewhere.
Key features
Cross-Platform Runner Setup
Built for Testing DApps
Open Source and Free
How to install IPFS Setup Action on Windows
- 1
Get the Release
Download only from the official website or the project's GitHub Releases page. Pick the version you intend to use, 0.6.0 being the latest listed, and read the release notes before adding it to a workflow.
- 2
Verify the File
Compare the SHA-256 checksum of any downloaded archive with the value published on the release page. If the project publishes a signature instead, verify that. If no checksum or signature is published, do not use the file.
-
Add It to a Workflow
There is no separate installer to run on your PC. Add a step that uses the action to a workflow file under .github/workflows in your repository, and choose a Windows runner if you want to test on Windows. The action installs and initializes go-ipfs when the job starts.
System requirements
- A GitHub repository with GitHub Actions enabled
- A Windows, macOS or Linux runner, depending on which platform your tests target
- Nothing to install on your own computer for the action itself
How to use IPFS Setup Action
Once the workflow file is in place, the action handles setup and your job handles the checks. Here is a practical order of work.
- Create a workflow file in the .github/workflows folder of your repository.
- Check out your repository code as the first step, so the tests have your application.
- Add a step that uses the IPFS Setup Action, and pin the version you reviewed rather than a floating reference.
- Run your tests in a later step, and call IPFS commands such as adding a file and retrieving it by its CID.
- Assert that the returned content matches what you uploaded.
- Push a branch and open the Actions tab to read the logs, which show whether go-ipfs started correctly.
- Repeat on other runners if your application targets several operating systems.
Pros & cons
- Free and open source
- Sets up go-ipfs on Windows, macOS and Linux runners
- Focused on testing decentralized applications
- Source code is public for review
- Simple to add to an existing GitHub workflow
- Last code update was July 3, 2023
- Windows support is listed as likely rather than confirmed
- Works only inside GitHub Actions, not as a desktop program
- Not suitable for running a persistent IPFS node
Is IPFS Setup Action safe?
The project's last code update was on July 3, 2023, more than two years ago, so treat it as unmaintained until you confirm otherwise. Review the action's code and your workflow before running it, because any action in a pipeline can access repository contents and secrets available to that job. Download only from the official website or GitHub Releases, check the SHA-256 checksum or signature, and avoid third-party mirrors. Limit the permissions granted to your workflow, pin a specific version, and recheck the latest version on the official website before adopting it for anything important.
- Official source only. Download from github.com/ibnesayeed/setup-ipfs. Ignore ads and lookalike domains.
- Check the SHA-256. Compare the installer hash with the value the developer publishes before running it.
- Never share your seed phrase. No developer, support agent or website — including CryptApps — will ever ask for it.
Alternatives
IPFS Setup Action differs from the other tools in this group mainly by where it runs. IPFS Desktop keeps an IPFS node in your system tray for everyday use, and Kubo is the reference node you would run yourself for a long-lived setup. Peergos focuses on end-to-end encrypted file storage and sharing for people, and Pinner CLI is a command-line tool for pinning content. This action is narrower: it prepares a temporary go-ipfs instance inside a CI job so tests can run against it. If you need a node that stays online on your machine, choose one of the others. If you need a repeatable test environment, this is the more direct fit.
Specifications
- Price
- Free
- Type
- Open source
- License
- —
- Latest version
- 0.6.0
- Last update
- 3 Jul 2023
- Windows support
- Likely (builds for Windows; check releases)
- Source code
- github.com/ibnesayeed/setup-ipfs
Frequently asked questions
No, it is a GitHub Action rather than a standalone Windows application. You add it to a workflow file in a GitHub repository, and GitHub's runners install and start go-ipfs when the job runs. Nothing is installed on your PC in the usual sense, so there is no installer to double-click.
It is listed as supporting Windows, but that support is marked as likely rather than fully confirmed. Check the releases page and run a test workflow on a Windows runner before depending on it. Windows is one of three platforms the action targets, alongside macOS and Linux.
It is open source, so its code can be reviewed, but it has not been updated since July 2023. Get it only from the project's official GitHub releases, verify the SHA-256 checksum, and review the workflow permissions it runs with. Treat it as a test tool rather than a trusted production component.
The last code update was on July 3, 2023, more than two years ago as of 2026. The latest listed version is 0.6.0. That suggests limited ongoing development, so check the recent commits and open issues yourself before relying on it for important pipelines.
Add a step that uses the action to a GitHub workflow file, then run your tests in later steps. Those tests can call IPFS commands such as adding a file and retrieving it by its content identifier. Check the Actions logs to confirm the node started before your checks run.
Yes, the action is free and open source, and its source code is published on GitHub. Any costs come from your GitHub account and plan, since GitHub Actions usage is billed separately from the action itself. Using the action does not require a paid license.
Verdict
IPFS Setup Action suits developers who maintain an application using IPFS and want a quick, cross-platform go-ipfs environment inside GitHub Actions. It is free, open source and easy to add to a workflow. The caveats are real, though: the last code update came in July 2023, Windows support is listed as likely rather than confirmed, and it does nothing outside CI. Pilot it on a non-critical pipeline first, and consider the alternatives if you need an always-on node.