This is a project to create a federated social network based on the [Lysand](https://lysand.org) protocol. It is currently in alpha phase, with basic federation and API support.
This project aims to be a fully featured social network, with a focus on privacy and security. It will implement 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.
> **Note**: We will not be offerring support to Windows or MacOS users. If you are using one of these operating systems, please use a virtual machine or container to run Lysand.
4. Copy the `config.toml.example` file to `config.toml` and fill in the values (you can leave most things to the default, but you will need to configure things such as the database connection)
Some CLI commands that return data as tables can be used in scripts. To do so, you can use the `--json` flag to output the data as JSON instead of a table, or even `--csv` to output the data as CSV. See `bun cli help` for more information.
Flags can be used in any order and anywhere in the script (except for the `bun cli` command itself). The command arguments themselves must be in the correct order, however.
The `bun prisma` commands allows you to use Prisma commands without needing to add in environment variables for the database config. Just run Prisma commands as you would normally, replacing `bunx prisma` with `bun prisma`.
> **Note**: Docker is currently broken, as Bun with Prisma does not work well with Docker yet for unknown reasons. The following instructions are for when this is fixed.
>
> These instructions will probably also work with Podman and other container runtimes.
-`banned_ips`: An array of strings representing banned IPv4 or IPv6 IPs. Wildcards, networks and ranges are supported. Example: `[ "192.168.0.*" ]` (empty array)
-`max_displayname_size`: The maximum size of a user's display name, in characters. Example: `30`
-`max_bio_size`: The maximum size of a user's bio, in characters. Example: `160`
-`max_note_size`: The maximum size of a user's note, in characters. Example: `500`
-`max_avatar_size`: The maximum size of a user's avatar image, in bytes. Example: `1048576` (1 MB)
-`max_header_size`: The maximum size of a user's header image, in bytes. Example: `2097152` (2 MB)
-`max_media_size`: The maximum size of a media attachment, in bytes. Example: `5242880` (5 MB)
-`max_media_attachments`: The maximum number of media attachments allowed per post. Example: `4`
-`max_media_description_size`: The maximum size of a media attachment's description, in characters. Example: `100`
-`max_username_size`: The maximum size of a user's username, in characters. Example: `20`
-`username_blacklist`: An array of strings representing usernames that are not allowed to be used by users. Defaults are from Akkoma. Example: `["admin", "moderator"]`
-`blacklist_tempmail`: Whether to blacklist known temporary email providers. Example: `true`
-`email_blacklist`: Additional email providers to blacklist. Example: `["example.com", "test.com"]`
-`url_scheme_whitelist`: An array of strings representing valid URL schemes. URLs that do not use one of these schemes will be parsed as text. Example: `["http", "https"]`
-`allowed_mime_types`: An array of strings representing allowed MIME types for media attachments. Example: `["image/jpeg", "image/png", "video/mp4"]`
### Defaults
-`visibility`: The default visibility for new notes. Example: `"public"`
-`language`: The default language for new notes. Example: `"en"`
-`avatar`: The default avatar URL. Example: `""` (empty string)
-`header`: The default header URL. Example: `""` (empty string)
-`use_tombstones`: Whether to use ActivityPub Tombstones instead of deleting objects. Example: `true`
-`fetch_all_collection_members`: Whether to fetch all members of collections (followers, following, etc) when receiving them. Example: `false`
-`reject_activities`: An array of instance domain names without "https" or glob patterns. Rejects all activities from these instances, simply doesn't save them at all. Example: `[ "mastodon.social" ]`
-`force_followers_only`: An array of instance domain names without "https" or glob patterns. Force posts from this instance to be followers only. Example: `[ "mastodon.social" ]`
-`discard_reports`: An array of instance domain names without "https" or glob patterns. Discard all reports from these instances. Example: `[ "mastodon.social" ]`
-`discard_deletes`: An array of instance domain names without "https" or glob patterns. Discard all deletes from these instances. Example: `[ "mastodon.social" ]`
-`discard_updates`: An array of instance domain names without "https" or glob patterns. Discard all updates (edits) from these instances. Example: `[]`
-`discard_banners`: An array of instance domain names without "https" or glob patterns. Discard all banners from these instances. Example: `[ "mastodon.social" ]`
-`discard_avatars`: An array of instance domain names without "https" or glob patterns. Discard all avatars from these instances. Example: `[ "mastodon.social" ]`
-`discard_follows`: An array of instance domain names without "https" or glob patterns. Discard all follow requests from these instances. Example: `[]`
-`force_sensitive`: An array of instance domain names without "https" or glob patterns. Force set these instances' media as sensitive. Example: `[ "mastodon.social" ]`
-`remove_media`: An array of instance domain names without "https" or glob patterns. Remove these instances' media. Example: `[ "mastodon.social" ]`
### Filters
-`note_filters`: An array of regex filters to drop notes from new activities. Example: `["(https?://)?(www\\.)?youtube\\.com/watch\\?v=[a-zA-Z0-9_-]+", "(https?://)?(www\\.)?youtu\\.be/[a-zA-Z0-9_-]+"]`
-`username_filters`: An array of regex filters to drop users from new activities based on their username. Example: `[ "^spammer-[a-z]" ]`
-`displayname_filters`: An array of regex filters to drop users from new activities based on their display name. Example: `[ "^spammer-[a-z]" ]`
-`bio_filters`: An array of regex filters to drop users from new activities based on their bio. Example: `[ "badword" ]`
-`emoji_filters`: An array of regex filters to drop users from new activities based on their emoji usage. Example: `[ ":bademoji:" ]`
### Logging
-`log_requests`: Whether to log all requests. Example: `true`
-`log_requests_verbose`: Whether to log request and their contents. Example: `false`
-`log_filters`: Whether to log all filtered objects. Example: `true`
### Ratelimits
-`duration_coeff`: The amount to multiply every route's duration by. Example: `1.0`
-`max_coeff`: The amount to multiply every route's max by. Example: `1.0`
### Custom Ratelimits
-`"/api/v1/timelines/public"`: An object representing a custom ratelimit for the specified API route. Example: `{ duration = 60, max = 200 }`
