Cinny

At a Glance:

Cinny is an open-source Matrix client designed for a simple, elegant, and secure instant messaging experience, which can be self-hosted by serving its static files or running a provided Docker image.

Overview:

Cinny is a Matrix client focused on providing a simple, elegant, and secure interface for instant messaging. The project's main goal is to deliver a modern messaging application that is easy for people to use. For those who wish to manage their own access, Cinny supports self-hosting by serving the application's files from a web server or by deploying it via a pre-built Docker image available on DockerHub and GitHub Container Registry. Developers can also build the application locally from source.

Key Decision Points:

• Deployment as a static web app: Cinny is distributed as a tarball of static files, which can be served with any preferred webserver, such as Nginx or Caddy.

• Docker support: A Docker image is provided for containerized deployment, built from source and served with Nginx on port 80.

• Configuration: Default homeservers are defined in a config.json file, requiring manual configuration for custom server setups.

• SDK Migration: The project is actively replacing the matrix-js-sdk with its own SDK, and is not accepting pull requests during this transition period.

Core Features:

• Simple and elegant interface: The UI is designed primarily for ease of use, with a focus on a secure and modern experience.

• Self-hosting: The client can be self-hosted by downloading the release tarball and serving the dist/ directory.

• Configurable default homeserver: The initial homeserver and explore pages are set via a config.json file.

• Hash routing: An optional hash routing mode (using /#/ in the URL) is available to simplify deployment by avoiding complex webserver redirect configurations.

• Subdirectory deployment: The application can be rebuilt to support deployment on a subdirectory path by modifying the base configuration.

Use Cases:

• Self-hosters: Individuals who prefer to host their own Matrix web client can easily serve Cinny from their own infrastructure.

• Developers: A developer can run Cinny locally for development or contribution purposes, with guidance provided for using Node.js version managers.

Open-Source Alternative Value:

As an open-source Matrix client, Cinny allows users to self-host their communication interface by serving it from their own infrastructure or running it via Docker. This gives users control over the client deployment and access, without depending on a third-party hosted web application. The client's configuration through a simple JSON file allows administrators to define the default server connection for their instance.