The purpose of TruSpace is to make collaboration on documents between several stakeholders more efficient while making the respective data sovereign to all participants. It uses AI to support document interpretation and decentralization to stay in control of your data.
- 🆓 100% open-source, sovereign and self-hostable - no cloud provider needed
- 🔄 Fully decentralized storage using IPFS: Automatic sync of data between trusted IPFS nodes/partners (private or public setup)
- 🧠 Local AI interpretation of documents using Ollama + Open Web UI using customisable pre-defined prompts
- 🗂️ Workspace-based organization of content and participants
- 🧪 Play around in a sandbox demo environment
- 💻 Install TruSpace locally
- 🌐 Connect to other TruSpace nodes
- 📚 Check out architecture, guides, details
To check how TruSpace works, get to the sandbox installation at https://truspace.dev, register a new user, login and start playing with private and public workspaces! It's an experiment-sandbox, so your data might get deleted occasionally.
For a very quick and easy TruSpace setup on your local machine using localhost, run:
git clone git@github.com:openkfw/TruSpace.git
cd TruSpace
./start.shinstall_basic_2x.mp4
Please open to see the expected results with screenshots
-
Open frontend in your browser at http://localhost:3000 to see the login screen:
-
Click on "Register" to create a new user account. Fill out the required fields. The user account is local, your data is not going anywhere.
-
After the submission, the app takes you back to the login screen, and from there to the dashboard.
If something doesn't work, check that all containers are running with docker ps. They should show these containers:
| CONTAINER ID | IMAGE | COMMAND | CREATED | STATUS | PORTS | NAMES |
|---|---|---|---|---|---|---|
| 14f... | ghcr.io/open-webui/open-webui:main | "bash start.sh" | 26 minutes ago | Up 26 minutes (healthy) | 0.0.0.0:3333->8080/tcp | truspace-webui-1 |
| 412... | ipfs/ipfs-cluster:latest | "/usr/bin/tini -- /u…" | 26 minutes ago | Up 26 minutes | 0.0.0.0:9094->9094/tcp, 0.0.0.0:9096-9097->9096-9097/tcp, 9095/tcp | cluster0 |
| 7b4... | truspace-backend | "sh ./entrypoint.sh" | 26 minutes ago | Up 26 minutes | 0.0.0.0:8000->8000/tcp | truspace-backend-1 |
| 783... | truspace-frontend | "sh startup.sh" | 26 minutes ago | Up 26 minutes (healthy) | 0.0.0.0:3000->3000/tcp, :::3000->3000/tcp | truspace-frontend-1 |
| 590... | ipfs/kubo:release | "/sbin/tini -- /usr/…" | 26 minutes ago | Up 26 minutes (healthy) | 0.0.0.0:4001->4001/tcp, 0.0.0.0:5001->5001/tcp, 4001/udp, 0.0.0.0:8080->8080/tcp, 8081/tcp | ipfs0 |
Note
For more details on the installation, feel free to check out our detailed installation guide here.
You have a TruSpace node running and would like to connect to another (private) network to sync the TruSpace data? It's simple - but you need to exchange some configuration values in order to have a secure private connection.
We have created an automated way to connect your TruSpace IPFS node to another TruSpace IPFS node using 2 scripts:
scripts/fetch-connection.sh: This script fetches the necessary connection details from the target node (find the script here)scripts/connectPeer-automatic.sh: This script connects your local TruSpace IPFS node to the target node using the fetched details (find the script here)
In an ideal environment, these commands are all you need to connect to another TruSpace node:
# On you target node, run and create encrypted connection details:
./scripts/fetch-connection.sh -e
# On your local node, store the received connection files in the root TruSpace directory, then run:
./scripts/connectPeer-automatic.sh .connection .connection.passwordconnect_automatic_2x.mp4
For more manual control, we also provide a manual setup option further with scripts/connectPeer-manually.sh
./scripts/connectPeer-manually.sh <peer_ip> <ipfs_peer_id> <cluster_peer_id> <ipfs_container_id> <cluster_container_id> [swarm_key_path] [cluster_secret_path]Note
For more details on the how the connection to other IPFS nodes works, please read the detailed guide here.
An extensive user guide with screenshots is available in the folder User Guide. You can also check out our demo video on YouTube!
For a guide on how to set up a development environment, contribute code, report issues and submit pull requests, please refer to the Developer Guide.
An extensive admin guide with screenshots is available in the folder Admin Guide
This project uses a set of environment variables to configure its frontend, backend, IPFS, and AI components.
For a complete reference and description of all variables, see ENVIRONMENT_VARIABLES.md
| Layer | Technologies |
|---|---|
| Frontend |  |
| Backend |  |
| Decentralized storage | |
| User Database |  |
| LLM Engine | |
| AI API and RAG | |
| Containerization | |
In the overview, you can see how the components work together. The UI and API is part of this repository and provides the interface and the translation to other services. Once you start TruSpace, it pulls and connects to containers from Open Web UI (for AI processing) and IPFS/IPFS-Cluster to persist the data. The respective ports are outlined in the image.
The data model has a hierarchical structure of workspaces, documents and metadata. They are linked using UUIDs in the metadata-fields of the IPFS files. Each data entry is a single (small) file to avoid merge conflicts in the IPFS network, e.g. in case of network split. The concept is outlined in the visual representation of the Data model
The specific fields are described in backend/src/types/interfaces/truspace.ts
- Ideally, each organization runs its own node
- Nodes automatically replicate documents and metadata (e.g. chats, versions, AI perspectives) within the network
- Pinning is orchestrated via IPFS Cluster to ensure data availability
- Fault-tolerant and censorship-resistant architecture
- Sensitive data (e.g. login credentials) is stored encrypted in SQLite on the local node
- Documents are synced only to trusted IPFS peers, IPFS can be configured as private network by default
- All inter-node communications are encrypted
- Documents are encrypted with workspace ID
We welcome contributions! Please read the CONTRIBUTING.md and the Developer Guide for:
- Setting up a development environment
- Reporting issues and submitting pull requests
- Code style guidelines
To inspire contributers and make it easier to get started, we have visualized our 2 main goals for TruSpace in the near future and respective features that will help us get there:
This project is licensed under the GNU General Public License v3.0. See the LICENSE file for details.
- User guide: User Guide
- Developer guide: Developer Guide
- Admin guide: Admin Guide
- Discussions: GitHub Discussions
- Report issues: GitHub Issues
- Intro Story to get what it's about: Medium Blog