versia-pub/server
2
0
Fork 0
mirror of https://github.com/versia-pub/server.git synced 2025-12-06 08:28:19 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity
Powerful, configurable and modular federated server using the Versia Protocol
45 commits 3 branches 14 tags 23 MiB
TypeScript 98.2%
Shell 0.8%
Nix 0.8%
Dockerfile 0.2%
Find a file
Jesse Wierzbinski 012f4b6f5b Add 2 more endpoints (mute and unmute)
2023-09-22 11:41:05 -10:00
database Add 2 more endpoints (mute and unmute) 2023-09-22 11:41:05 -10:00
pages Rename project to Lysand 2023-09-14 19:08:59 -10:00
server/api Add 2 more endpoints (mute and unmute) 2023-09-22 11:41:05 -10:00
tests Add 2 more endpoints (mute and unmute) 2023-09-22 11:41:05 -10:00
types Implement WebFinger, rework TS 2023-09-12 10:48:10 -10:00
utils Add new follow API endpoint 2023-09-21 17:18:05 -10:00
.eslintrc.cjs Add stricter ESLint rules 2023-09-12 14:29:13 -10:00
.gitignore Add logging options 2023-09-14 17:21:38 -10:00
.prettierrc Add stricter ESLint rules 2023-09-12 14:29:13 -10:00
bun.lockb guh 2023-09-14 15:22:27 -10:00
index.ts Add new API endpoint (accounts/verify_credentials) 2023-09-21 16:15:12 -10:00
LICENSE Add better README 2023-09-14 15:42:56 -10:00
package.json Rename project to Lysand 2023-09-14 19:08:59 -10:00
README.md Add 2 more endpoints (mute and unmute) 2023-09-22 11:41:05 -10:00
tsconfig.json Implement WebFinger, rework TS 2023-09-12 10:48:10 -10:00
uno.config.ts guh 2023-09-14 15:22:27 -10:00

README.md

Lysand

What is this?

This is a project to create a federated social network based on the ActivityPub standard. It is currently in early alpha phase, with very 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.

How do I run it?

Requirements

  • The Bun Runtime, version 0.8 or later (use of the latest version is recommended)
  • A PostgreSQL database
  • (Optional but recommended) A Linux-based operating system

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.

Installation

  1. Clone this repository
git clone https://github.com/CPlusPatch/lysand.git
  1. Install the dependencies
bun install

  1. Set up a PostgreSQL database

  2. 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)

Running

To run the server, simply run the following command:

bun start

Contributing

Contributions are welcome! Please see the CONTRIBUTING.md file for more information.

Federation

Warning

: Federation has not been tested outside of automated tests. It is not recommended to use this software in production.

Lysand is currently able to federate basic Note objects with Create, Update and Delete activities supported. (as well as Accept and Reject, but with no tests)

Planned federation features are:

  • Activities: Follow, Block, Undo, Announce, Like, Dislike, Flag, Ignore and more
  • Objects: Emoji and more

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/: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/update_credentials
  • /api/v1/accounts/verify_credentials
  • /api/v1/statuses
  • /api/v1/apps
  • /api/v1/apps/verify_credentials
  • /oauth/authorize
  • /oauth/token

License

This project is licensed under the AGPL-3.0.