zeerooth / kitsune

🦊 ActivityPub-federated microblogging

Home Page:https://joinkitsune.org

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

kitsune

GitHub Workflow Status dependency status

Kitsune is an open-souce social media server utilising the ActivityPub protocol. Utilising the capabilities of ActivityPub, you can interact with people on Mastodon, Misskey, Akkoma, etc. Due to its decentralised nature, you can self-host Kitsune on your own hardware and still interact with everyone!

Kitsune itself is pretty lightweight and should run even on a Raspberry Pi (even though we haven't tested that yet).

Documentation

Chat

Both chat options are bridged. Feel free to join whichever you're more comfortable with:

Matrix Discord

âš  Disclaimer

This software is far from production-ready. Breaking changes might happen. So, as long as this disclaimer is here, make sure to double check all the changes before you update your installation.

Project structure

  • contrib/: Files for configuring Kitsune (Systemd, Caddy, etc.)
  • crates/: Sub-crates Kitsune consists of
  • kitsune/: Main Kitsune server binary
  • kitsune-cli/: Kitsune CLI binary
  • kitsune-fe/: Kitsune frontend project
  • kitsune-job-runner/: Kitsune dedicated job runner
  • lib/: Libraries made for Kitsune but with no dependencies on Kitsune-specific code. Easily usable by other projects
  • proto/: Any Protobuf definitions for the Kitsune project
  • public/: Public web assets
  • xtask/: Task-runner polyfill

Contributing

Contributions are very welcome. However, if you intend to change anything more than updating a dependency or fixing a small bug, please open an issue first. We would like to discuss any bigger changes before they are actually implemented.

Security

If you found a suspected security vulnerability, please refer to our security policy for more details.

Note on required libraries

We use Nix for handling our development dependencies. When in doubt, install Nix and run nix develop to get yourself a shell with all required dependencies and services (you might need to enable some unstable features).

License

Kitsune is licensed under the MIT license.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, shall be licensed as above, without any additional terms or conditions.

About

🦊 ActivityPub-federated microblogging

https://joinkitsune.org

License:MIT License


Languages

Language:Rust 86.3%Language:TypeScript 7.0%Language:Vue 3.2%Language:Nix 1.6%Language:PLpgSQL 0.8%Language:CSS 0.5%Language:HTML 0.4%Language:SCSS 0.1%Language:Lua 0.1%