Relay.md enables multiplayer obsidian, a note taking software for your personal knowledge base that does not come with any means to communicate notes.

The software in this repository represents the backend and website that offers an API and user interface. Integration with Obsidian itself requires the installation of the relay.md plugin.

The software is configured in a way that allows deploying as microservices. The required services are:

• web: This service provides the website where people can register, login and manage teams and topics
• api: This service provides the application programming interface to the obsidian plugin and allows for posting, editing and deleting of notes and embeds.

You can start your local development environment using docker-compose:

docker-compose up

If you encounter a bug, please file an issue to let us know. Alternatively, please feel free to contribute a bug fix directly. If you are planning to contribute changes that involve significant design choices, please open an issue for discussion instead.

Test are implemented using pytest. After configuring your virtual environment and installing the dependencies, you can run the unittests with

python3 -m pytest

The relay.md backend software is licensed under AGPLv3. The full license can be found here.