|
| 1 | +# solidpod |
| 2 | + |
| 3 | +> The easiest way to run a Solid pod. Zero configuration, just works. |
| 4 | +
|
| 5 | +[](https://www.npmjs.com/package/solidpod) |
| 6 | +[](LICENSE) |
| 7 | + |
| 8 | +**solidpod** is the simplest wrapper to run your own [Solid](https://solidproject.org) pod server. |
| 9 | + |
| 10 | +## 🚀 Quick Start |
| 11 | + |
| 12 | +```bash |
| 13 | +# Run instantly with npx (no installation required!) |
| 14 | +npx solidpod |
| 15 | + |
| 16 | +# That's it! Your Solid pod is running at http://localhost:5444 |
| 17 | +``` |
| 18 | + |
| 19 | +## ✨ What You Get |
| 20 | + |
| 21 | +- ✅ **Zero configuration** - Just works |
| 22 | +- ✅ **Solid Protocol** - Full spec compliance |
| 23 | +- ✅ **WebID Authentication** - Decentralized identity |
| 24 | +- ✅ **Passkey Support** - Modern passwordless auth |
| 25 | +- ✅ **WebSocket Notifications** - Real-time updates |
| 26 | +- ✅ **JSON-LD Native** - First-class linked data support |
| 27 | + |
| 28 | +## 📦 Installation |
| 29 | + |
| 30 | +### No Installation (Recommended) |
| 31 | + |
| 32 | +```bash |
| 33 | +npx solidpod |
| 34 | +``` |
| 35 | + |
| 36 | +### Global Installation |
| 37 | + |
| 38 | +```bash |
| 39 | +npm install -g solidpod |
| 40 | +solidpod |
| 41 | +``` |
| 42 | + |
| 43 | +## 🎮 Usage |
| 44 | + |
| 45 | +```bash |
| 46 | +# Start with defaults |
| 47 | +solidpod |
| 48 | + |
| 49 | +# Custom port |
| 50 | +solidpod --port 8080 |
| 51 | + |
| 52 | +# Custom data directory |
| 53 | +solidpod --root /var/pods |
| 54 | + |
| 55 | +# Multi-user mode |
| 56 | +solidpod --multiuser |
| 57 | + |
| 58 | +# Disable authentication |
| 59 | +solidpod --no-auth |
| 60 | + |
| 61 | +# Show help |
| 62 | +solidpod --help |
| 63 | +``` |
| 64 | + |
| 65 | +## 📖 How It Works |
| 66 | + |
| 67 | +solidpod is a thin wrapper around [jspod](https://github.com/JavaScriptSolidServer/jspod), which itself wraps [JavaScriptSolidServer](https://github.com/JavaScriptSolidServer/JavaScriptSolidServer). |
| 68 | + |
| 69 | +**Layers:** |
| 70 | +``` |
| 71 | +solidpod → jspod → JavaScriptSolidServer |
| 72 | +``` |
| 73 | + |
| 74 | +Each layer adds convenience: |
| 75 | +- **JavaScriptSolidServer**: Full-featured Solid server implementation |
| 76 | +- **jspod**: Beautiful CLI with sensible defaults |
| 77 | +- **solidpod**: Most user-friendly name for instant discovery |
| 78 | + |
| 79 | +## 🌟 First Run |
| 80 | + |
| 81 | +**Step 1**: Run the command |
| 82 | +```bash |
| 83 | +npx solidpod |
| 84 | +``` |
| 85 | + |
| 86 | +**Step 2**: Open http://localhost:5444 in your browser |
| 87 | + |
| 88 | +**Step 3**: Register with your device's passkey (fingerprint, Face ID, etc.) |
| 89 | + |
| 90 | +**Step 4**: Start using your pod! |
| 91 | + |
| 92 | +## 📚 Learn More |
| 93 | + |
| 94 | +- **Solid Project**: https://solidproject.org |
| 95 | +- **Solid Protocol**: https://solidproject.org/TR/protocol |
| 96 | +- **WebID**: https://www.w3.org/2005/Incubator/webid/spec |
| 97 | + |
| 98 | +## 🤝 Contributing |
| 99 | + |
| 100 | +Contributions welcome! This package is intentionally minimal - just a friendly wrapper. |
| 101 | + |
| 102 | +## 📄 License |
| 103 | + |
| 104 | +MIT - see [LICENSE](./LICENSE) |
| 105 | + |
| 106 | +## 🙏 Credits |
| 107 | + |
| 108 | +Built on [jspod](https://github.com/JavaScriptSolidServer/jspod) and [JavaScriptSolidServer](https://github.com/JavaScriptSolidServer/JavaScriptSolidServer). |
| 109 | + |
| 110 | +--- |
| 111 | + |
| 112 | +**Made with ❤️ for the Solid community** |
| 113 | + |
| 114 | +*"Your pod, instantly"* |
0 commit comments