1
Step 1Open the server Apps tab
Select the tutorial-vps VPS, open the Apps tab, and start a new app deployment. Keep sensitive server details hidden before capturing or sharing screenshots.
Back to all templates
IPFS Kubo
Infrastructure512MB+ RAM
Reference implementation of the IPFS distributed file system - run your own node with gateway and API
infrastructurestorageipfskuboopen-sourceself-hosteddocker
Deploy IPFS Kubo in 3 Steps
1
Connect Your VPS
Add your server credentials to Server Compass
2
Select IPFS Kubo
Choose from our template library
3
Deploy & Configure
Fill in settings and click Deploy
No Docker knowledge required
Step-by-step deployment guide
Deploy IPFS Kubo on a VPS with Server Compass
Use the IPFS Kubo template in Server Compass to deploy a self-hosted IPFS node on your VPS, then verify the node ID and HTTP gateway.
About 10 minutesBrowser verified
2
Step 2Choose an app template
Click New App and choose the template deployment path so Server Compass can load the built-in catalog.
3
Step 3Search for IPFS Kubo
Use the template picker search to find IPFS Kubo in the Server Compass template catalog.
4
Step 4Select the IPFS Kubo template
Choose the IPFS Kubo template. Server Compass fills the Kubo service, HTTP gateway port, RPC API port, swarm port, and persistent data/export volumes.
5
Step 5Review the IPFS Kubo settings
Confirm the app name and compose service. In this run, the app was named ipfs-demo and used host port 4199.
6
Step 6Deploy IPFS Kubo
Review the generated compose settings, confirm the IPFS gateway/API/swarm ports are available, and click Deploy.
7
Step 7Watch the deployment progress
Keep the deployment modal open while Server Compass uploads the compose file, pulls the IPFS Kubo image, starts the container, and verifies the stack.
8
Step 8Confirm IPFS Kubo is running
After deployment finishes, return to the Apps tab and confirm the IPFS Kubo app is marked Running with its published gateway port available.
9
Step 9Verify IPFS Kubo with the API response
Use the Kubo CLI inside the container to read the node ID, add a small tutorial file, and fetch that file back through the HTTP gateway.
After IPFS Kubo Opens
- Do not expose the RPC API port publicly without reverse proxy authentication or VPN access.
- Open the swarm port if you want better peer connectivity.
- Pin important content explicitly so it remains available from your node.
- Back up the IPFS data volume before relying on the node for durable storage.
- Do not add private files to public IPFS unless they are encrypted first.
Verified Result
IPFS Kubo returned node identity details, added a tutorial file, and served it through the deployed HTTP gateway.
IPFS Kubo deployment questions
What does the IPFS Kubo template deploy?
It deploys the Kubo reference IPFS node with an HTTP gateway, RPC API, swarm listener, data volume, and export volume.
Which port did the tutorial use?
The tutorial used host port 4199, which maps to the IPFS HTTP gateway on container port 8080. The template also publishes the RPC API and swarm ports.
Does IPFS Kubo need setup after deployment?
No account setup is required. After deployment, use the WebUI or Kubo CLI to add files, pin content, and inspect peers.
Should this become a blog post?
No. The deployment guide should live on the IPFS Kubo template detail page and be linked from the reusable template deployment docs page.
After Deployment
After deploying IPFS Kubo with Server Compass, complete these steps to finish setup
1
Open the WebUI at http://YOUR_SERVER_IP:{{API_PORT}}/webui to confirm the node is running and has peers
2
Restrict the API by editing `/data/ipfs/config` API.HTTPHeaders.Access-Control-Allow-Origin (or front it with a reverse proxy)
3
Open swarm port {{SWARM_PORT}} on your firewall/router for inbound peer connections
4
Pin important content with `docker exec <container> ipfs pin add <CID>` to keep it cached locally
Need help? Check out our documentation for detailed guides.
IPFS Kubo FAQ
Common questions about self-hosting IPFS Kubo
How do I deploy IPFS Kubo with Server Compass?
Simply download Server Compass, connect to your VPS, and select IPFS Kubo from the templates list. Fill in the required configuration and click Deploy. The entire process takes under 3 minutes.
What are the system requirements for IPFS Kubo?
IPFS Kubo requires a minimum of 512MB RAM. We recommend a VPS with at least 1024MB RAM for optimal performance. Any modern Linux server with Docker support will work.
Can I migrate my existing IPFS Kubo data?
Yes! Server Compass provides volume mapping that allows you to import existing data. You can also use standard IPFS Kubo backup and restore procedures.
How do I update IPFS Kubo to the latest version?
Server Compass makes updates easy. Simply click the Update button in your deployment dashboard, and the latest IPFS Kubo image will be pulled and deployed with zero downtime.
Is IPFS Kubo free to self-host?
IPFS Kubo is open-source software. You only pay for your VPS hosting (typically $5-20/month) and optionally Server Compass ($29 one-time). No subscription fees or per-seat pricing.
Ready to Self-Host IPFS Kubo?
Download Server Compass and deploy IPFS Kubo to your VPS in under 3 minutes. No Docker expertise required.
Download Server Compass