fedimovies/README.md

158 lines
2.3 KiB
Markdown
Raw Normal View History

2021-04-09 00:22:17 +00:00
# Mitra
Federated social network with smart contracts.
2022-02-08 01:36:40 +00:00
Built on [ActivityPub](https://activitypub.rocks/) protocol, self-hosted, lightweight.
Unique features enabled by blockchain integration:
2021-04-09 00:22:17 +00:00
- Sign-in with Ethereum.
- Proving membership with a token.
2022-02-08 01:36:40 +00:00
- Paid subscriptions.
2021-04-09 00:22:17 +00:00
- Converting posts into NFTs.
2021-10-10 09:55:33 +00:00
Smart contracts repo: https://codeberg.org/silverpill/mitra-contracts
2021-11-29 21:24:44 +00:00
Frontend repo: https://codeberg.org/silverpill/mitra-web
2021-11-20 20:34:33 +00:00
Matrix chat: [#mitra:halogen.city](https://matrix.to/#/#mitra:halogen.city)
Demo instance: https://mitra.social/ (invite-only)
2021-04-09 00:22:17 +00:00
## Requirements
- Rust 1.51+
2022-01-02 13:38:40 +00:00
- PostgreSQL 10.2+
2022-01-11 23:02:56 +00:00
- IPFS node (optional, see [guide](./docs/ipfs.md))
2021-04-09 00:22:17 +00:00
- Ethereum node (optional)
## Development
### Create database
```
docker-compose up
```
Test connection:
```
psql -h localhost -p 5432 -U mitra mitra
```
### Run web service
2021-11-26 22:37:20 +00:00
Generate instance key:
```
cargo run --bin mitractl generate-rsa-key
```
Create config file, set `instance_rsa_key`, adjust other settings if needed:
2021-04-09 00:22:17 +00:00
```
cp config.yaml.example config.yaml
```
Compile and run service:
```
cargo run
```
### Run CLI
```
cargo run --bin mitractl
```
2021-11-13 17:37:31 +00:00
### Run linter
```
cargo clippy
```
2021-10-10 09:55:33 +00:00
### Run tests
```
cargo test
```
2021-04-09 00:22:17 +00:00
### Build for production
```
cargo build --release
```
2021-11-14 20:09:46 +00:00
## Federation
The following activities are supported:
- Accept(Follow)
- Reject(Follow)
- Undo(Follow)
2021-11-14 20:09:46 +00:00
- Create(Note)
- Delete(Note)
2021-11-14 20:09:46 +00:00
- Like(Note)
- Undo(Like)
- Announce(Note)
2021-12-16 23:00:52 +00:00
- Undo(Announce)
2021-11-14 20:09:46 +00:00
- Follow(Person)
- Update(Person)
And these additional standards:
- [Http Signatures](https://datatracker.ietf.org/doc/html/draft-cavage-http-signatures)
- [NodeInfo](https://nodeinfo.diaspora.software/)
- [WebFinger](https://webfinger.net/)
## Client API
2021-04-09 00:22:17 +00:00
### Mastodon API
2022-02-08 01:36:40 +00:00
Most methods are similar to Mastodon API, but Mitra is not fully compatible.
2021-04-09 00:22:17 +00:00
[OpenAPI spec](./docs/openapi.yaml) (incomplete)
2021-12-03 15:29:50 +00:00
2021-04-09 00:22:17 +00:00
## CLI commands
Generate RSA private key:
```
mitractl generate-rsa-key
```
Generate invite code:
2021-04-09 00:22:17 +00:00
```
mitractl generate-invite-code
2021-04-09 00:22:17 +00:00
```
List generated invites:
2021-09-25 20:46:19 +00:00
```
mitractl list-invite-codes
2021-09-25 20:46:19 +00:00
```
Delete profile:
2021-04-09 00:22:17 +00:00
```
mitractl delete-profile -i 55a3005f-f293-4168-ab70-6ab09a879679
2021-04-09 00:22:17 +00:00
```
Delete post:
2021-04-09 00:22:17 +00:00
```
mitractl delete-post -i 55a3005f-f293-4168-ab70-6ab09a879679
2021-04-09 00:22:17 +00:00
```
Generate ethereum address:
```
mitractl generate-ethereum-address
```
2021-10-10 09:55:33 +00:00
## License
[AGPL-3.0](./LICENSE)