OctoBase
๐ OctoBase is the open-source database behind AFFiNE, local-first, yet collaborative. A light-weight, scalable, data engine written in Rust.
- 2.1k
- Rust
- AGPL-3.0
- 21 mo ago
Self-hosted IPFS storage node for application file delivery, with bounded disk usage, deterministic replication, repair, health checkpoints, and a REST API
Repo Adamant-im/ipfs-node, read from GitHub 1 d ago. Adamant-im has not joined Take My Repo.
Adamant-im/ipfs-node is a public repo on GitHub by Adamant-im. Self-hosted IPFS storage node for application file delivery, with bounded disk usage, deterministic replication, repair, health checkpoints, and a REST API. It declares the GPL-3.0 license on GitHub. It is written mainly in TypeScript, has 308 stars and last changed on 2026-09-30. Nobody has reviewed it on Take My Repo yet, which says nothing about its quality. Read from GitHub on 2026-11-21.
In the maintainer's words. Shown from GitHub; Take My Repo does not keep a copy.
Self-hosted IPFS storage node for application file delivery, with bounded disk usage, deterministic replication, repair, health checkpoints, and a REST API.
It is a standalone Node.js service: an in-process Helia node and a libp2p host behind an Express REST API. It is not a wrapper around Kubo, it does not expose a Kubo-compatible API, and it is not an IPFS gateway. A deployment is a set of nodes that know each other by multiaddr and exchange blocks, replicas, and health attestations only with each other.
Built and maintained by the ADAMANT developer community and cryptofoundry. Want custom crypto software, bots, payments or blockchain infrastructure built by engineers with production blockchain experience? Tell us what to build.
identify and
ping are registeredADAMANT Messenger runs this node in production for attachment delivery, and is the reference deployment. It is one adopter, not the purpose of the project โ see the adopter page.
Details: https://ipfs-node.docs.adamant.im/guide/use-cases
Comparison with Kubo, Kubo plus IPFS Cluster, a custom Helia application, managed pinning providers, and object storage: https://ipfs-node.docs.adamant.im/guide/comparison
Read this before choosing an architecture around the node.
$HOME/<storeFolder>
(#30)A controlled peer topology avoids the public DHT and public gateways and reduces public exposure of content-routing metadata, but it does not by itself make a deployment private, anonymous, trustless, or censorship-proof. Availability still depends on independent nodes, independent operators, replication settings, and deployer choices.
.nvmrc, so nvm use selects itgit clone https://github.com/Adamant-im/ipfs-node.git
cd ipfs-node
nvm use
npm ci
npm run build
node dist/index.js
npm ci must run install scripts. Helia depends on @libp2p/webrtc, whose node-datachannel
native module downloads a prebuilt binary from GitHub releases. npm 12 blocks that download unless
the package is listed in package.json allowScripts; this repository already lists it.
Installing with --ignore-scripts, or on a host that cannot reach GitHub releases, produces a tree
that fails at startup. See Dependency notes.
Copy config.default.json5 to config.json5 before starting. Its peer list points at the ADAMANT
production mesh, so a deployment that is not joining ADAMANT must replace nodes,
peerDiscovery.bootstrap, and cors.allowedOrigins. Empty peer lists run a standalone node.
The process can also be managed with PM2:
npm install --global pm2
pm2 start dist/index.js --name="IPFS node"
Full guide: https://ipfs-node.docs.adamant.im/guide/quick-start
docker volume create ipfs-node-data
docker run -d \
--name ipfs-node \
--restart unless-stopped \
--stop-timeout 20 \
-v ipfs-node-data:/data \
-v "$PWD/config.json5:/app/config.json5:ro" \
-p 127.0.0.1:4000:4000 \
-p 4001:4001 \
ghcr.io/adamant-im/ipfs-node:<version>
Take <version> from the releases page: every
release publishes an immutable version tag, a stable release also moves latest, and a prerelease
publishes its version tag only.
The image ships no configuration; mount one at /app/config.json5. HOME is /data, so a single
/data volume holds the blockstore, datastore, peer identity, pin set, lifecycle registry, repair
cursor, and health checkpoint. docker/config.example.json5 is a standalone starting point and
docker/docker-compose.yml is a minimal evaluation stack.
Full guide: https://ipfs-node.docs.adamant.im/guide/docker
Copy config.default.json5 to config.json5 and replace every deployment-specific value.
The config file is selected by the IPFS_NODE_CONFIG environment variable, or by the first CLI
argument when the variable is not set. Both select config.<name>.json5; with neither,
config.json5 is used. node dist/index.js test1 and IPFS_NODE_CONFIG=test1 node dist/index.js
are equivalent.
The whole configuration is validated at startup: a missing file, invalid JSON5, or a field with the
wrong type aborts the process with a message naming the offending field. storage, replication,
and health are optional and every option falls back to a documented default, so an existing
configuration file keeps working.
Generate the administrative secret before enabling operator endpoints:
openssl rand -hex 32
A missing or empty adminApiKey fails closed: administrative routes return
503 Service not configured. Known placeholder values and secrets shorter than 32 characters
prevent startup.
Every option, default, and cross-field rule, plus the migration notes for autoPeeringPeriod,
cors.originRegexps, and the /api/node/info to /api/node/details move:
https://ipfs-node.docs.adamant.im/guide/configuration
| Class | Routes | Policy |
|---|---|---|
| Public | GET /, GET /api/node/health, GET /api/node/info |
No authentication. /info is the sanitized legacy PWA/iOS contract |
| Public file transfer | POST /api/file/upload, GET /api/file/:cid |
No authentication; endpoint-specific rate limits and upload limits apply |
| Public storage state | GET /api/file/:cid/status, GET /api/storage/metrics, GET /api/storage/policy |
No authentication; no filename or peer topology is exposed |
| Administrative | GET /api/node/details, POST /api/file/:cid/confirm, POST /api/file/:cid/unpin, all /api/storage/* writes, all /api/helia/*, all /api/libp2p/* |
A matching x-api-key header is required |
| Peer protocols | libp2p /adamant/replication/1.0.0 and /adamant/health/1.0.0, not HTTP routes |
Authenticated by the libp2p handshake. Health attestations and durable replication operations are accepted only from peers listed in nodes; open cache remains bounded like a public read |
| Disabled by default | all /api/debug/* |
Not mounted unless enableDebugApi is true; still requires x-api-key |
| Authenticated user | None | The service has no end-user identity or session layer |
CORS is a browser control and is never treated as authentication. Exact app://
origins can be listed for a desktop client; they are not in the default set.
GET /api/helia/routing/findProviders/:cid no longer exists: provider lookup requires content
routing, and this deployment intentionally runs none.
Upload remains public for compatibility with direct Messenger clients. The service has no safe channel for distributing an upload secret and does not implement a short-lived signing protocol. Public upload is constrained by per-client request limits, per-file size, per-request file count, filename sanitization, and the deployment proxy.
This is an explicit compatibility decision, not an authorization guarantee. A deployment that
requires signed upload authorization must enforce it at a trusted gateway until a client-compatible
signing protocol is designed. Files of any content type are accepted, but downloads are served as
application/octet-stream attachments with content sniffing disabled.
The multipart contract accepts files parts only. Text fields are rejected with a controlled
400 Bad Request.
An interrupted upload leaves no blocks behind: each request owns a session that records the blocks it created, and a rejected, aborted, or partially failed request removes exactly those. Blockstore growth is bounded by the disk reserve, the aggregate request size, the concurrency limit, and the collection watermarks.
Security, privacy, TLS, proxy, and exposure guidance: https://ipfs-node.docs.adamant.im/guide/security
The node forms a controlled mesh with the peers listed in nodes and peerDiscovery.bootstrap.
libp2p is configured explicitly and the Helia defaults are not merged in, so the node runs:
identify and ping services onlyThere is no DHT, no mDNS discovery, no circuit relay, no NAT traversal, and no HTTP gateway routing. Blocks are exchanged with known peers over bitswap, so block requests never leave the configured peer set and no CID is disclosed to a public gateway.
The node is composed from createHeliaLight, withLibp2pLight, and withBitswap rather than
createHelia, because createHelia merges its default libp2p configuration into whatever is passed
in. Keeping it would silently add mDNS, the public IPFS bootstrap list, kad-DHT, AutoNAT, AutoTLS,
UPnP, circuit relay, and WebRTC/WebSocket transports.
The libp2p private key is stored in the datastore under /pkcs8/self, so a node keeps its peer
identity across restarts as long as its store directory is preserved.
Architecture, trust boundaries, and protocol detail: https://ipfs-node.docs.adamant.im/guide/architecture
The Node.js process serves HTTP and does not terminate TLS. Bind it to a private interface or
firewall it so clients can reach it only through a correctly configured HTTPS reverse proxy. The
proxy must replace untrusted forwarding headers and forward requests to the configured serverPort.
Never expose the application port directly to the internet.
npm run security:audit
npm run security:semgrep
The audit fails on every high or critical production advisory. There are no accepted exceptions.
Use npm run security:audit:raw to inspect the unfiltered npm result.
helia depends on @helia/libp2p, which depends on @libp2p/webrtc even though WebRTC is never
configured here. That pulls two things into the tree:
node-datachannel, a native module whose prebuilt binary is downloaded from GitHub releases
during npm install. npm 12 runs that script only because allowScripts names the package.
.npmrc sets strict-allow-scripts=true, so a new unreviewed install script fails npm ci
instead of silently skipping. An installer that reaches the npm registry but not GitHub
releases, or one run with --ignore-scripts, produces a tree that fails at startup, so
--ignore-scripts is suitable only for auditing and for building the documentation site, not
for running or testingreact-native-webrtc, and through it react-native and its Metro bundler, in the development
tree onlynpm run security:audit scopes the audit with --omit=dev --omit=peer and reports no findings.
Running a bare npm audit --omit=dev additionally surfaces advisories against Metro and its
image-size dependency; Metro is a React Native build tool that this service never loads. Re-check
these when Helia is upgraded.
The stable client, lifecycle, and node-health contract is OpenAPI 3.1. Worked examples, status-code tables, and the generated endpoint reference are on the documentation site:
GET /api/node/health always returns 200; consumers must inspect state, which is starting,
ready, stale, or degraded. height is a persisted, monotonic checkpoint that advances only
when every prerequisite passes and freezes on failure, and it is comparable between nodes only when
their membership.version matches. Health semantics and alerting:
https://ipfs-node.docs.adamant.im/operations/monitoring
npm run dev
npm run lint
npm run format
npm run typecheck
npm test
npm test compiles src and test to dist-test and then runs the unit and integration suites
with Node's built-in test runner against config.test.json5, which has no bootstrap peers and
listens on loopback with an OS-assigned port.
Three TypeScript configurations share one set of compiler options:
| File | Purpose |
|---|---|
tsconfig.json |
Type-checks src and test. Emits nothing; this is what editors use |
tsconfig.build.json |
Builds src into dist for npm run build |
tsconfig.test.json |
Builds src and test into dist-test for npm test |
Pass no file arguments to tsc. Naming a file on the command line makes TypeScript ignore
tsconfig.json entirely, so outDir is not applied and the project's lib, module, and
moduleResolution settings are replaced by defaults.
The documentation site is built from docs/:
npm run docs:dev
npm run docs:build
docs/reference/endpoints.md and docs/public/openapi.yaml are generated from docs/openapi.yaml
and must not be edited by hand. The build fails on a broken internal link, a missing generated API
reference, or a missing custom-domain file.
npm ci
npm run build
npm run lint
npm run format
npm run typecheck
npm test
npm run docs:build
npm run security:audit
npm run security:semgrep
git diff --check
To exercise the container:
docker build -t ipfs-node:local .
./scripts/docker-smoke-test.sh ipfs-node:local
Issues and pull requests are welcome. Conventions, checks, and the documentation workflow are in AGENTS.md and on the contributing page. Report suspected vulnerabilities privately through GitHub security advisories rather than in a public issue.
GPL-3.0. Copyright (c) ADAMANT Foundation and contributors.
Adamant-im/ipfs-node is a public repo on GitHub by Adamant-im. Self-hosted IPFS storage node for application file delivery, with bounded disk usage, deterministic replication, repair, health checkpoints, and a REST API.
It declares the GPL-3.0 license on GitHub.
Its maker tagged it for macOS, Windows and Linux, or as Docker or cross-platform. That is declared by the maker; Take My Repo has not tested it.
Open "Take it" on its page: Take My Repo writes an install plan for your machine and hands it to your AI agent (Claude Code, Codex or Cursor), which asks you before each step. Take My Repo has not tested it on any machine.
Its last change on GitHub was on 2026-09-30. GitHub counts 7 open issues and pull requests. Take My Repo does not judge from that whether it is maintained.
Nobody has reviewed it on Take My Repo yet, which says nothing about its quality.
A list of Free Software network services and web applications which can be hosted on your own servers
A fast, cross-platform binary package manager built on OCI registries. Turn Docker Hub, GHCR, or any OCI-compliant registry into a binary distribution platform โ zero extra infrastructure

Free self-hosted liquidity bot for token issuers who want to improve CEX market quality without sending tokens, funds, or API keys to a third-party market maker.
ADAMANT Decentralized Messenger and Crypto Wallet. Progressive Web Application (PWA) for Web, Tor, Android, macOS, Windows, and Linux.

Self-hosted Ethereum transaction indexer for native ETH and ERC-20 transfers with PostgreSQL and PostgREST
Command-line and JSON-RPC tool for interacting with the ADAMANT blockchain

This page is also available as structured data, with the same sources and dates.
/api/v1/resources/gh/Adamant-im/ipfs-nodeTake My Repo has not tested this on your machine. Requirements come from the project's own documentation.