mirror of
https://github.com/versia-pub/server.git
synced 2025-12-06 08:28:19 +01:00
257 lines
8.3 KiB
Markdown
257 lines
8.3 KiB
Markdown
<p align="center">
|
|
<a href="https://lysand.org"><img src="https://cdn-web.cpluspatch.com/lysand.webp" alt="Lysand Logo" height=130></a>
|
|
</p>
|
|
|
|
      [](code_of_conduct.md)
|
|
|
|
## What is this?
|
|
|
|
This is a project to create a federated social network based on the [Lysand](https://lysand.org) protocol. It is currently in beta phase, with basic federation and almost complete Mastodon API support.
|
|
|
|
This project aims to be a fully featured social network, with a focus on privacy, security, and performance. It implements the Mastodon API for support with clients that already support Mastodon or Pleroma.
|
|
|
|
> [!NOTE]
|
|
> This project is not affiliated with Mastodon or Pleroma, and is not a fork of either project. It is a new project built from the ground up.
|
|
|
|
## Features
|
|
|
|
- [x] Federation (partial)
|
|
- [x] Hyper fast (thousands of HTTP requests per second)
|
|
- [x] S3 or local media storage
|
|
- [x] Deduplication of uploaded files
|
|
- [x] Federation limits
|
|
- [x] Configurable defaults
|
|
- [x] Full regex-based filters for posts, users and media
|
|
- [x] Custom emoji support
|
|
- [x] Automatic image conversion to WebP or other formats
|
|
- [x] Scripting-compatible CLI with JSON and CSV outputs
|
|
- [ ] Moderation tools
|
|
- [x] Mastodon API support (partial)
|
|
|
|
## Screenshots
|
|
|
|
Here are some screenshots of Lysand's built-in web client. This client is built with Nuxt, and serves to allow users to log in or register. It is kept to only the actions that cannot be done with a Mastodon client, to simplify development. In the future, there will be a full-featured client.
|
|
|
|
### On Desktop
|
|
|
|
#### Welcome Page
|
|
|
|
|
|
|
|
#### Logging In
|
|
|
|
|
|
|
|
#### OAuth Confirmation
|
|
|
|
|
|
|
|
#### Registration Page
|
|
|
|
|
|
|
|
#### Home Timeline
|
|
|
|
|
|
|
|
### On Mobile
|
|
|
|
#### Logging In
|
|
|
|
<center>
|
|
<img src="assets/login_mobile.webp" alt="Logging In" width="300">
|
|
</center>
|
|
|
|
#### OAuth Confirmation
|
|
|
|
<center>
|
|
<img src="assets/redirect_mobile.webp" alt="OAuth Confirmation" width="300">
|
|
</center>
|
|
|
|
#### Registration Page
|
|
|
|
<center>
|
|
<img src="assets/register_mobile.webp" alt="Registration Page" width="300">
|
|
</center>
|
|
|
|
## Benchmarks
|
|
|
|
> [!NOTE]
|
|
> These benchmarks are not representative of real-world performance, and are only meant to be used as a rough guide. Load, and therefore performance, will vary depending on the server's hardware and software configuration, as well as user activity.
|
|
|
|
### Timeline Benchmarks
|
|
|
|
You may run the following command to benchmark the `/api/v1/timelines/home` endpoint:
|
|
|
|
```bash
|
|
TOKEN=token_here bun benchmark:timeline <request_count>
|
|
```
|
|
|
|
The `request_count` variable is optional and defaults to 100. `TOKEN` is your personal user token, used to login to the API.
|
|
|
|
On a quad-core laptop:
|
|
|
|
```
|
|
$ bun run benchmarks/timelines.ts 100
|
|
✓ All requests succeeded
|
|
✓ 100 requests fulfilled in 0.12611s
|
|
```
|
|
|
|
```
|
|
$ bun run benchmarks/timelines.ts 1000
|
|
✓ All requests succeeded
|
|
✓ 1000 requests fulfilled in 0.90925s
|
|
```
|
|
|
|
```
|
|
$ bun run benchmarks/timelines.ts 10000
|
|
✓ All requests succeeded
|
|
✓ 10000 requests fulfilled in 12.44852s
|
|
```
|
|
|
|
Lysand is extremely fast and can handle thousands of HTTP requests per second on a good server.
|
|
|
|
## How do I run it?
|
|
|
|
Please see the [installation guide](docs/installation.md) for more information on how to install Lysand.
|
|
|
|
## Contributing
|
|
|
|
Contributions are welcome! Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information.
|
|
|
|
## Planned Extra Features
|
|
|
|
- Send notifications to moderators when a report is received
|
|
- Email notifications on certain actions
|
|
|
|
## Federation
|
|
|
|
The following extensions are currently supported or being worked on:
|
|
- `org.lysand:custom_emojis`: Custom emojis
|
|
|
|
## API
|
|
|
|
Lysand implements the Mastodon API, with some extensions. The API is currently in early alpha, and is not recommended for use in production.
|
|
|
|
Working endpoints are:
|
|
|
|
- `/api/v1/accounts`
|
|
- `/api/v1/accounts/:id`
|
|
- `/api/v1/accounts/:id/statuses`
|
|
- `/api/v1/accounts/:id/follow`
|
|
- `/api/v1/accounts/:id/unfollow`
|
|
- `/api/v1/accounts/:id/block`
|
|
- `/api/v1/accounts/:id/unblock`
|
|
- `/api/v1/accounts/:id/mute`
|
|
- `/api/v1/accounts/:id/unmute`
|
|
- `/api/v1/accounts/:id/pin`
|
|
- `/api/v1/accounts/:id/unpin`
|
|
- `/api/v1/accounts/:id/note`
|
|
- `/api/v1/accounts/:id/remove_from_followers`
|
|
- `/api/v1/accounts/relationships`
|
|
- `/api/v1/accounts/update_credentials`
|
|
- `/api/v1/accounts/verify_credentials`
|
|
- `/api/v1/accounts/familiar_followers`
|
|
- `/api/v1/profile/avatar` (`DELETE`)
|
|
- `/api/v1/profile/header` (`DELETE`)
|
|
- `/api/v1/statuses/:id` (`GET`, `DELETE`)
|
|
- `/api/v1/statuses/:id/context`
|
|
- `/api/v1/statuses/:id/favourite`
|
|
- `/api/v1/statuses/:id/unfavourite`
|
|
- `/api/v1/statuses/:id/favourited_by`
|
|
- `/api/v1/statuses/:id/reblogged_by`
|
|
- `/api/v1/statuses/:id/reblog`
|
|
- `/api/v1/statuses/:id/unreblog`
|
|
- `/api/v1/statuses/:id/pin`
|
|
- `/api/v1/statuses/:id/unpin`
|
|
- `/api/v1/statuses`
|
|
- `/api/v1/timelines/public`
|
|
- `/api/v1/timelines/home`
|
|
- `/api/v1/apps`
|
|
- `/api/v1/instance`
|
|
- `/api/v1/custom_emojis`
|
|
- `/api/v1/apps/verify_credentials`
|
|
- `/oauth/authorize`
|
|
- `/oauth/token`
|
|
- `/api/v1/blocks`
|
|
- `/api/v1/mutes`
|
|
- `/api/v2/media`
|
|
- `/api/v1/notifications`
|
|
- `/api/v1/media/:id`
|
|
- `/api/v2/media`
|
|
- `/api/v1/favourites`
|
|
- `/api/v1/accounts/:id/followers`
|
|
- `/api/v1/accounts/:id/following`
|
|
- `/api/v2/search`
|
|
- `/api/v1/follow_requests`
|
|
- `/api/v1/follow_requests/:account_id/authorize`
|
|
- `/api/v1/follow_requests/:account_id/reject`
|
|
- `/api/v1/statuses/:id/mute`
|
|
- `/api/v1/statuses/:id/unmute`
|
|
- `/api/v1/statuses/:id` (`PUT`)
|
|
- `/api/v1/statuses/:id/source`
|
|
|
|
Endpoints left:
|
|
|
|
- `/api/v1/reports`
|
|
- `/api/v1/accounts/:id/lists`
|
|
- `/api/v1/follow_suggestions`
|
|
- `/api/v1/domain_blocks` (`GET`, `POST`, `DELETE`)
|
|
- `/api/v2/filters` (`GET`, `POST`)
|
|
- `/api/v2/filters/:id` (`GET`, `PUT`, `DELETE`)
|
|
- `/api/v2/filters/:filter_id/keywords` (`GET`, `POST`)
|
|
- `/api/v2/filters/keywords/:id` (`GET`, `PUT`, `DELETE`)
|
|
- `/api/v2/filters/:filter_id/statuses` (`GET`, `POST`)
|
|
- `/api/v2/filters/statuses/:id` (`GET`, `DELETE`)
|
|
- `/api/v1/endorsements`
|
|
- `/api/v1/featured_tags` (`GET`, `POST`)
|
|
- `/api/v1/featured_tags/:id` (`DELETE`)
|
|
- `/api/v1/featured_tags/suggestions`
|
|
- `/api/v1/preferences`
|
|
- `/api/v1/followed_tags`
|
|
- `/api/v2/suggestions`
|
|
- `/api/v1/suggestions/:account_id` (`DELETE`)
|
|
- `/api/v1/tags/:id`
|
|
- `/api/v1/tags/:id/follow`
|
|
- `/api/v1/tags/:id/unfollow`
|
|
- `/api/v1/statuses/:id/translate`
|
|
- `/api/v1/statuses/:id/bookmark`
|
|
- `/api/v1/statuses/:id/unbookmark`
|
|
- `/api/v1/statuses/:id/history`
|
|
- `/api/v1/polls/:id`
|
|
- `/api/v1/polls/:id/votes`
|
|
- `/api/v1/scheduled_statuses`
|
|
- `/api/v1/scheduled_statuses/:id` (`GET`, `PUT`, `DELETE`)
|
|
- `/api/v1/timelines/tag/:hashtag`
|
|
- `/api/v1/timelines/list/:list_id`
|
|
- `/api/v1/conversations`
|
|
- `/api/v1/conversations/:id`
|
|
- `/api/v1/conversations/:id/read`
|
|
- `/api/v1/lists` (`GET`, `POST`)
|
|
- `/api/v1/lists/:id` (`GET`, `PUT`, `DELETE`)
|
|
- `/api/v1/markers` (`GET`, `POST`)
|
|
- `/api/v1/lists/:id/accounts` (`GET`, `POST`, `DELETE`)
|
|
- `/api/v1/notifications/:id`
|
|
- `/api/v1/notifications/clear`
|
|
- `/api/v1/notifications/:id/dismiss`
|
|
- `/api/v2/instance`
|
|
- `/api/v1/instance/peers`
|
|
- `/api/v1/instance/activity`
|
|
- `/api/v1/instance/rules`
|
|
- `/api/v1/instance/domain_blocks`
|
|
- `/api/v1/instance/extended_description`
|
|
- `/api/v1/directory`
|
|
- `/api/v1/trends/tags`
|
|
- `/api/v1/trends/statuses`
|
|
- `/api/v1/trends/links`
|
|
- `/api/v1/announcements`
|
|
- `/api/v1/announcements/:id/dismiss`
|
|
- `/api/v1/announcements/:id/reactions/:name` (`PUT`, `DELETE`)
|
|
- Admin API
|
|
|
|
WebSocket Streaming API also needs to be added (and push notifications)
|
|
|
|
## License
|
|
|
|
This project is licensed under the [AGPL-3.0](LICENSE).
|