5eca863a5d
|
||
|---|---|---|
| .cargo | ||
| .github | ||
| .vscode | ||
| contrib | ||
| crates | ||
| docs | ||
| kitsune | ||
| kitsune-cli | ||
| kitsune-fe | ||
| kitsune-job-runner | ||
| lib | ||
| test-fixtures | ||
| web | ||
| xtask | ||
| .dockerignore | ||
| .gitignore | ||
| CODE_OF_CONDUCT.md | ||
| Cargo.lock | ||
| Cargo.toml | ||
| LICENSE | ||
| README.md | ||
| SECURITY.md | ||
| clippy.toml | ||
| config.docker.toml | ||
| config.example.toml | ||
| docker-compose.yml | ||
| flake.lock | ||
| flake.nix | ||
| module.nix | ||
| oranda.json | ||
| overlay.nix | ||
| rust-toolchain.toml | ||
README.md
kitsune
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).
Chat
Both chat options are bridged. Feel free to join whichever you're more comfortable with:
⚠ 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 ofdocs/: Documentation in form of an mdBookkitsune/: Main Kitsune server binarykitsune-cli/: Kitsune CLI binarykitsune-fe/: Kitsune frontend projectkitsune-job-runner/: Kitsune dedicated job runnerlib/: Libraries made for Kitsune but with no dependencies on Kitsune-specific code. Easily usable by other projectspublic/: Public web assetsweb/: Resources specific to the websitextask/: 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.