https://github.com/bitxenia/astrawiki
Decentralized p2p read-write wiki on IPFS
https://github.com/bitxenia/astrawiki
collaborative decentralized distributed ipfs libp2p p2p peer-to-peer wiki wikipedia
Last synced: 5 months ago
JSON representation
Decentralized p2p read-write wiki on IPFS
- Host: GitHub
- URL: https://github.com/bitxenia/astrawiki
- Owner: bitxenia
- License: mit
- Created: 2024-12-28T20:07:35.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-04-23T15:32:11.000Z (5 months ago)
- Last Synced: 2025-04-23T15:51:01.959Z (5 months ago)
- Topics: collaborative, decentralized, distributed, ipfs, libp2p, p2p, peer-to-peer, wiki, wikipedia
- Language: TypeScript
- Homepage: https://bitxenia.eth.link
- Size: 402 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Astrawiki
The Bitxenia Astrawiki node is an implementation of a client for a decentralized peer-to-peer read-write wiki within the [IPFS](https://ipfs.tech) ecosystem. It leverages technologies such as [OrbitDB](https://github.com/orbitdb/orbitdb) for the database and [LibP2P](https://github.com/libp2p/js-libp2p) for peer-to-peer communication between collaborators. With this node, users can connect to an existing wiki or create their own, allowing to create, read, and edit articles in a collaborative manner.
The implementation focuses on providing a decentralized, distributed, and collaborative alternative to existing wikis. For this reason, only the collaborative nodes are responsible for the availability and persistence of the wiki.
To achieve true decentralization, all nodes that make up the wiki share the same responsibilities, making it easy to create or maintain a wiki separate from the one provided by Bitxenia. Additionally, no wiki depends on its original creators.
By using OrbitDB as a database, any user can create and edit articles in real-time.
A _frontend_ client can be built using the node to make the wiki more accessible. The node can be used locally or from a web application. At Bitxenia, we provide our own [web client](https://github.com/bitxenia/astrawiki-web), but users are free to create their own if desired.
## Install
```sh
npm install @bitxenia/astrawiki
```
## Usage
Using the `createAstrawikiNode` init function you can create and connect the node to a wiki.
```ts
import { createAstrawikiNode } from "@bitxenia/astrawiki";
const node = await createAstrawikiNode({
wikiName: "bitxenia-wiki",
});
const articleList = await node.getArticleList();
console.log(articleList);
```
Use the [Getting Started](https://github.com/bitxenia/astrawiki/tree/main/docs/getting_started.md) guide for an initial introduction to the Astrawiki node usage.
## Documentation
You can find more advanced topics in our [docs](https://github.com/bitxenia/astrawiki/tree/main/docs).
## Development
**Clone and install dependencies:**
```sh
git clone git@github.com:bitxenia/astrawiki.git
cd astrawiki
npm install
```
### Run Tests
```sh
npm run test
```
### Build
```sh
npm run build
```
## Contribute
Contributions welcome! Please check out the issues.
## Troubleshooting
### The node cannot receive incoming connections and, as a result, cannot collaborate.
If the node is set to collaborate and it fails to do so, the reason should most likely be a port issue. The `LibP2P` implementation uses `UPnP` to automatically open ports and detect the public IP. If the modem is outdated, you will need to manually open the ports and specify the public IP when creating the node in the `createAstrawikiNode` init function.
The ports that need to be opened manually are:
- `40001` used to receive `TCP` incoming connections.
- `40002` used to receive `WebSocket` incoming connections.
- `40003` used to receive `WebSocketSecure` upgraded by `autoTLS` incoming connections.
If this does not work, your ISP may be using Double NAT, which prevents incoming connections. In this case, you may need to contact your ISP to request a solution.
## Other implementations
- https://github.com/bitxenia/astrawiki-eth
## License
MIT (LICENSE-MIT / http://opensource.org/licenses/MIT)