1
0
Fork 0
mirror of https://github.com/Nutomic/ibis.git synced 2024-11-21 22:01:09 +00:00
A federated online encyclopedia
Find a file
2024-10-15 15:20:32 +02:00
.github Add funding.yml with liberapay profile 2024-03-14 14:33:21 +01:00
assets Adds math parsing (#61) 2024-10-15 09:39:29 +02:00
config Switch back to cargo-watch as bacon is broken 2024-10-14 12:31:46 +02:00
migrations Fix problems with invalid apub ids 2024-03-11 13:40:03 +01:00
scripts Dont rebuild backend for css changes, move asset code into file 2024-10-15 11:35:00 +02:00
src Render markdown headings one level smaller (fixes #46) 2024-10-15 13:00:00 +02:00
tests Never use https in SSR mode, some more bug fixes 2024-03-08 14:29:29 +01:00
.gitignore simplify trunk setup 2024-01-11 16:21:44 +01:00
.leptosfmt.toml use default tab spaces 2024-04-02 11:53:29 +02:00
.rustfmt.toml Use nightly cargo fmt for better imports formatting 2024-03-05 16:38:07 +01:00
.woodpecker.yml Use plugin-release 2024-10-15 15:20:32 +02:00
build.rs Never use https in SSR mode, some more bug fixes 2024-03-08 14:29:29 +01:00
Cargo.lock Adds math parsing (#61) 2024-10-15 09:39:29 +02:00
Cargo.toml Version 0.1.2 2024-10-15 14:37:36 +02:00
config.toml Use include_str! to allow deployment as single binary 2024-02-28 18:31:46 +01:00
diesel.toml wip: Add diesel and postgres 2023-11-30 11:46:42 +01:00
LICENSE add agpl license 2023-11-15 01:38:16 +01:00
README.md Mention default dev user/pw in readme 2024-10-14 10:45:29 +02:00
Trunk.toml add scripts for watch/federate 2024-01-30 12:32:02 +01:00

About Ibis

Ibis is a federated online encyclopedia similar to Wikipedia. Users can read, create and edit articles seamlessly across instances. It uses the Activitypub protocol to connect users across different websites, similar to Mastodon or Lemmy. This ensures that there is no single point of control which may be used for global censorship. Instead each Ibis instance is independent and controlled by its admin. Admins can decide which rules to enforce, which content to allow and which instances to connect with. Users who are unhappy with the rules can easily setup their own Ibis instance with their own rules.

The project uses the same technology as Lemmy and benefits from lessons learned during its development. It is currently in a proof of concept stage. Core features are already working, including creation and editing of articles, full federation and a basic frontend. You can see it in action on ibis.wiki. However more work is needed to get the project ready for production use, to add features like moderation tools, user account management, media support, article discussions and better web design. Contributions are welcome!

Read the Project Announcement for more information.

Name

The Ibis is a bird which is related to the Egyptian god of knowledge and science.

Development

First install PostgreSQL and setup the development database:

psql -c "CREATE USER ibis WITH PASSWORD 'ibis' SUPERUSER;" -U postgres
psql -c "CREATE DATABASE ibis WITH OWNER ibis;" -U postgres

You need to install cargo, trunk and cargo watch. Run ./scripts/watch.sh which automatically rebuilds the project after changes. Then open the site at 127.0.0.1:8080. Then login with user ibis and password ibis.

By default the frontend runs on port 8080, which can be changed with env var TRUNK_SERVE_PORT. The backend port is 8081 and can be changed with IBIS_BACKEND_PORT.

Federation

Main objects in terms of federation are the Instance and Article. Each article belongs to a single origin instance, the one where it was originally created. Articles have a collection of Edits a custom ActivityPub type containing a diff. The text of any article can be built by starting from empty string and applying all associated edits in order. Instances can synchronize their articles with each other, and follow each other to receive updates about articles. Edits are done with diffs which are generated on the backend, and allow for conflict resolution similar to git. Editing also works over federation. In this case an activity Update/Edit is sent to the origin instance. If the diff applies cleanly, the origin instance sends the new text in an Update/Article activity to its followers. In case there is a conflict, a Reject activity is sent back, the editor needs to resolve and resubmit the edit.

License

AGPL