fedimovies/README.md

200 lines
4.6 KiB
Markdown
Raw Normal View History

2021-04-09 00:22:17 +00:00
# Mitra
2022-09-30 18:44:20 +00:00
Federated micro-blogging platform and content subscription service.
2021-04-09 00:22:17 +00:00
2022-07-11 00:48:33 +00:00
Built on [ActivityPub](https://www.w3.org/TR/activitypub/) protocol, self-hosted, lightweight. Part of the [Fediverse](https://en.wikipedia.org/wiki/Fediverse).
2022-02-08 01:36:40 +00:00
2022-09-30 18:44:20 +00:00
Subscriptions provide a way to receive monthly payments from subscribers and to publish private content made exclusively for them.
Supported payment methods:
- [Monero](https://www.getmonero.org/get-started/what-is-monero/).
- [ERC-20](https://ethereum.org/en/developers/docs/standards/tokens/erc-20/) tokens (on Ethereum and other EVM-compatible blockchains).
Other features:
2022-02-08 01:36:40 +00:00
2022-09-01 12:47:00 +00:00
- [Sign-in with a wallet](https://eips.ethereum.org/EIPS/eip-4361).
2022-12-10 20:37:48 +00:00
- Account migrations (from one server to another).
2022-09-30 18:44:20 +00:00
- Donation buttons.
2022-07-11 00:48:33 +00:00
- Token-gated registration (can be used to verify membership in some group or to stop bots).
2021-04-09 00:22:17 +00:00
- Converting posts into NFTs.
2022-10-14 15:56:37 +00:00
- Saving posts to IPFS.
2021-04-09 00:22:17 +00:00
2022-09-19 17:58:10 +00:00
Demo instance: https://public.mitra.social/ ([invite-only](https://public.mitra.social/about))
2021-11-29 21:24:44 +00:00
2022-09-13 20:38:50 +00:00
Network stats: https://the-federation.info/mitra
2021-11-20 20:34:33 +00:00
2022-04-13 10:43:19 +00:00
Matrix chat: [#mitra:halogen.city](https://matrix.to/#/#mitra:halogen.city)
2022-09-13 20:38:50 +00:00
## Code
Server: https://codeberg.org/silverpill/mitra (this repo)
Web client: https://codeberg.org/silverpill/mitra-web
Ethereum contracts: https://codeberg.org/silverpill/mitra-contracts
2021-04-09 00:22:17 +00:00
## Requirements
- Rust 1.54+ (when building from source)
2022-04-20 13:47:04 +00:00
- PostgreSQL 12+
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)
2022-09-01 12:47:00 +00:00
- Monero node and Monero wallet (optional)
2021-04-09 00:22:17 +00:00
## Installation
### Building from source
Run:
```shell
cargo build --release --features production
```
This command will produce two binaries in `target/release` directory, `mitra` and `mitractl`.
2022-09-24 19:19:37 +00:00
Install PostgreSQL and create the database:
```sql
CREATE USER mitra WITH PASSWORD 'mitra';
CREATE DATABASE mitra OWNER mitra;
```
Create configuration file by copying `contrib/mitra_config.yaml` and configure the instance. Default config file path is `/etc/mitra/config.yaml`, but it can be changed using `CONFIG_PATH` environment variable.
Start Mitra:
```shell
./mitra
```
An HTTP server will be needed to handle HTTPS requests and serve the frontend. See the example of [nginx configuration file](./contrib/mitra.nginx).
Building instructions for `mitra-web` frontend can be found at https://codeberg.org/silverpill/mitra-web#project-setup.
To run Mitra as a systemd service, check out the [systemd unit file example](./contrib/mitra.service).
### Debian package
Download and install Mitra package:
```shell
dpkg -i mitra.deb
```
2022-09-24 19:19:37 +00:00
Install PostgreSQL and create the database:
```sql
CREATE USER mitra WITH PASSWORD 'mitra';
CREATE DATABASE mitra OWNER mitra;
```
Open configuration file `/etc/mitra/config.yaml` and configure the instance.
Start Mitra:
```shell
systemctl start mitra
```
An HTTP server will be needed to handle HTTPS requests and serve the frontend. See the example of [nginx configuration file](./contrib/mitra.nginx).
2022-09-24 19:19:37 +00:00
### Monero
Install Monero node or choose a [public one](https://monero.fail/).
Configure and start [monero-wallet-rpc](https://monerodocs.org/interacting/monero-wallet-rpc-reference/) daemon. Add `disable-rpc-login=1` to your `monero-wallet-rpc` config (currently RPC auth is not supported in Mitra).
2022-09-24 19:19:37 +00:00
Create a wallet for your instance.
Add blockchain configuration to `blockchains` array in your configuration file.
### Ethereum
Install Ethereum client or choose a JSON-RPC API provider.
Deploy contracts on the blockchain. Instructions can be found at https://codeberg.org/silverpill/mitra-contracts.
Add blockchain configuration to `blockchains` array in your configuration file.
2021-04-09 00:22:17 +00:00
## Development
2022-10-30 21:47:45 +00:00
See [CONTRIBUTING.md](./CONTRIBUTING.md)
2022-09-24 19:19:37 +00:00
### Start database server
2021-04-09 00:22:17 +00:00
```shell
2022-09-24 19:19:37 +00:00
docker-compose up -d
2021-04-09 00:22:17 +00:00
```
Test connection:
```shell
2022-03-05 12:48:30 +00:00
psql -h localhost -p 55432 -U mitra mitra
2021-04-09 00:22:17 +00:00
```
2022-09-24 19:19:37 +00:00
### Start Monero node and wallet server
(this step is optional)
```shell
2022-09-24 19:19:37 +00:00
docker-compose --profile monero up -d
```
2021-04-09 00:22:17 +00:00
### Run web service
Create config file, adjust settings if needed:
2021-04-09 00:22:17 +00:00
```shell
2021-04-09 00:22:17 +00:00
cp config.yaml.example config.yaml
```
Compile and run service:
```shell
2021-04-09 00:22:17 +00:00
cargo run
```
### Run CLI
```shell
2021-04-09 00:22:17 +00:00
cargo run --bin mitractl
```
2021-11-13 17:37:31 +00:00
### Run linter
```shell
2021-11-13 17:37:31 +00:00
cargo clippy
```
2021-10-10 09:55:33 +00:00
### Run tests
```shell
2021-10-10 09:55:33 +00:00
cargo test
```
2021-11-14 20:09:46 +00:00
## Federation
2022-04-13 10:43:19 +00:00
See [FEDERATION.md](./FEDERATION.md)
2021-11-14 20:09:46 +00:00
## Client API
2021-04-09 00:22:17 +00:00
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
2022-10-28 15:29:48 +00:00
[OpenAPI spec](./docs/openapi.yaml)
2021-12-03 15:29:50 +00:00
## CLI
`mitractl` is a command-line tool for performing instance maintenance.
2021-04-09 00:22:17 +00:00
[Documentation](./docs/mitractl.md)
2022-09-08 13:38:52 +00:00
2021-10-10 09:55:33 +00:00
## License
[AGPL-3.0](./LICENSE)
2022-04-13 10:43:19 +00:00
## Support
Monero: 8Ahza5RM4JQgtdqvpcF1U628NN5Q87eryXQad3Fy581YWTZU8o3EMbtScuioQZSkyNNEEE1Lkj2cSbG4VnVYCW5L1N4os5p