fedimovies/README.md

166 lines
3.2 KiB
Markdown
Raw Normal View History

2023-04-08 19:29:03 +00:00
# Reef
2021-04-09 00:22:17 +00:00
2023-04-08 19:29:03 +00:00
Lively federated micro-blogging platform.
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
2023-02-27 13:28:34 +00:00
Features:
2022-02-08 01:36:40 +00:00
2023-02-27 13:28:34 +00:00
- Micro-blogging service (includes support for quote posts, custom emojis and more).
- Mastodon API.
2023-03-11 17:09:02 +00:00
- Account migrations (from one server to another). Identity can be detached from the server.
- Federation over Tor.
2021-04-09 00:22:17 +00:00
2023-02-27 13:28:34 +00:00
## Instances
2023-04-08 19:20:12 +00:00
- [FediList](http://demo.fedilist.com/instance?software=reef)
- [Fediverse Observer](https://reef.fediverse.observer/list)
2021-11-20 20:34:33 +00:00
2023-04-08 19:20:12 +00:00
Demo instance: https://nullpointer.social/ ([invite-only](https://nullpointer.social/about))
2022-04-13 10:43:19 +00:00
2022-09-13 20:38:50 +00:00
## Code
2023-04-08 19:29:03 +00:00
Server: https://code.caric.io/reef/reef (this repo)
2022-09-13 20:38:50 +00:00
2023-04-08 19:29:03 +00:00
Web client:
2022-09-13 20:38:50 +00:00
2021-04-09 00:22:17 +00:00
## Requirements
2022-12-15 16:58:18 +00:00
- Rust 1.56+ (when building from source)
2022-04-20 13:47:04 +00:00
- PostgreSQL 12+
Optional:
- IPFS node (see [guide](./docs/ipfs.md))
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.
Put any static files into the directory specified in configuration file. Building instructions for `mitra-web` frontend can be found at https://codeberg.org/silverpill/mitra-web#project-setup.
Start Mitra:
```shell
./mitra
```
An HTTP server will be needed to handle HTTPS requests. See the example of [nginx configuration file](./contrib/mitra.nginx).
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. See the example of [nginx configuration file](./contrib/mitra.nginx).
2023-03-11 17:09:02 +00:00
### Tor federation
See [guide](./docs/onion.md).
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
```
### 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)