128 lines
6.4 KiB
Markdown
128 lines
6.4 KiB
Markdown
# Cinny
|
||
<p>
|
||
<a href="https://github.com/ajbura/cinny/releases">
|
||
<img alt="GitHub release downloads" src="https://img.shields.io/github/downloads/ajbura/cinny/total?logo=github&style=social"></a>
|
||
<a href="https://hub.docker.com/r/ajbura/cinny">
|
||
<img alt="DockerHub downloads" src="https://img.shields.io/docker/pulls/ajbura/cinny?logo=docker&style=social"></a>
|
||
<a href="https://fosstodon.org/@cinnyapp">
|
||
<img alt="Follow on Mastodon" src="https://img.shields.io/mastodon/follow/106845779685925461?domain=https%3A%2F%2Ffosstodon.org&logo=mastodon&style=social"></a>
|
||
<a href="https://twitter.com/intent/follow?screen_name=cinnyapp">
|
||
<img alt="Follow on Twitter" src="https://img.shields.io/twitter/follow/cinnyapp?logo=twitter&style=social"></a>
|
||
<a href="https://cinny.in/#sponsor">
|
||
<img alt="Sponsor Cinny" src="https://img.shields.io/opencollective/all/cinny?logo=opencollective&style=social"></a>
|
||
</p>
|
||
|
||
A Matrix client focusing primarily on simple, elegant and secure interface.
|
||
The main goal is to have an instant messaging application that is easy on
|
||
people and has a modern touch.
|
||
- [Roadmap](https://github.com/orgs/cinnyapp/projects/1)
|
||
- [Contributing](./CONTRIBUTING.md)
|
||
|
||
> [!IMPORTANT]
|
||
We are currently in the process of [replacing] the matrix-js-sdk with our
|
||
own SDK. As a result, we will not be accepting any pull requests until
|
||
further notice. Thank you for your understanding.
|
||
|
||
[replacing]: https://github.com/cinnyapp/cinny/issues/257#issuecomment-3714406704
|
||
|
||
<img align="center" src="https://raw.githubusercontent.com/cinnyapp/cinny-site/main/assets/preview2-light.png" height="380">
|
||
|
||
## Getting started
|
||
The web app is available at [app.cinny.in] and gets updated on each new
|
||
release. The `dev` branch is continuously deployed at [dev.cinny.in]
|
||
but keep in mind that it could have things broken.
|
||
|
||
You can also download our desktop app from the [cinny-desktop repository].
|
||
|
||
[app.cinny.in]: https://app.cinny.in
|
||
[dev.cinny.in]: https://dev.cinny.in
|
||
[cinny-desktop repository]: https://github.com/cinnyapp/cinny-desktop
|
||
|
||
## Contributing and Developing
|
||
|
||
If you have any ideas, issues, etc. regarding Cinny, or would like to
|
||
contribute to Cinny through pull requests, please check out our
|
||
["Contributing to Cinny"](CONTRIBUTING.md) document. Those who would like
|
||
to get involved with Cinny's development as well should also read the
|
||
["Developing Cinny"](HACKING.md) document for more technical details.
|
||
|
||
## Self-hosting
|
||
To host Cinny on your own, simply download the tarball from
|
||
[GitHub releases], and serve the files from `dist/` using your preferred
|
||
webserver. Alternatively, you can just pull the docker image from
|
||
[DockerHub] or [GitHub Container Registry].
|
||
|
||
* The default homeservers and explore pages are defined in [`config.json`](config.json).
|
||
|
||
* You need to set up redirects to serve the assests. Example configurations;
|
||
[netlify](netlify.toml), [nginx](contrib/nginx/cinny.domain.tld.conf),
|
||
[caddy](contrib/caddy/caddyfile).
|
||
* If you have trouble configuring redirects you can
|
||
[enable hash routing](config.json#L35) — the url in the browser will have
|
||
a `/#/` between the domain and open channel (ie. `app.cinny.in/#/home/`
|
||
instead of `app.cinny.in/home/`) but you won't have to configure your webserver.
|
||
|
||
* To deploy on subdirectory, you need to rebuild the app youself after
|
||
updating the `base` path in [`build.config.ts`](build.config.ts).
|
||
* For example, if you want to deploy on `https://cinny.in/app`, then
|
||
set `base: '/app'`.
|
||
|
||
[GitHub releases]: https://github.com/cinnyapp/cinny/releases/latest
|
||
[DockerHub]: https://hub.docker.com/r/ajbura/cinny
|
||
[GitHub Container Registry]: https://github.com/cinnyapp/cinny/pkgs/container/cinny
|
||
|
||
<details><summary><b>PGP Public Key to verify tarball</b></summary>
|
||
|
||
```
|
||
-----BEGIN PGP PUBLIC KEY BLOCK-----
|
||
|
||
mQGNBGJw/g0BDAC8qQeLqDMzYzfPyOmRlHVEoguVTo+eo1aVdQH2X7OELdjjBlyj
|
||
6d6c1adv/uF2g83NNMoQY7GEeHjRnXE4m8kYSaarb840pxrYUagDc0dAbJOGaCBY
|
||
FKTo7U1Kvg0vdiaRuus0pvc1NVdXSxRNQbFXBSwduD+zn66TI3HfcEHNN62FG1cE
|
||
K1jWDwLAU0P3kKmj8+CAc3h9ZklPu0k/+t5bf/LJkvdBJAUzGZpehbPL5f3u3BZ0
|
||
leZLIrR8uV7PiV5jKFahxlKR5KQHld8qQm+qVhYbUzpuMBGmh419I6UvTzxuRcvU
|
||
Frn9ttCEzV55Y+so4X2e4ZnB+5gOnNw+ecifGVdj/+UyWnqvqqDvLrEjjK890nLb
|
||
Pil4siecNMEpiwAN6WSmKpWaCwQAHEGDVeZCc/kT0iYfj5FBcsTVqWiO6eaxkUlm
|
||
jnulqWqRrlB8CJQQvih/g//uSEBdzIibo+ro+3Jpe120U/XVUH62i9HoRQEm6ADG
|
||
4zS5hIq4xyA8fL8AEQEAAbQdQ2lubnlBcHAgPGNpbm55YXBwQGdtYWlsLmNvbT6J
|
||
AdQEEwEIAD4CGwMFCwkIBwIGFQoJCAsCBBYCAwECHgECF4AWIQSRri2MHidaaZv+
|
||
vvuUMwx6UK/M8wUCZqEDwAUJFvwIswAKCRCUMwx6UK/M877qC/4lxXOQIoWnLLkK
|
||
YiRCTkGsH6NdxgeYr6wpXT4xuQ45ZxCytwHpOGQmO/5up5961TxWW8D1frRIJHjj
|
||
AZGoRCL3EKEuY8nt3D99fpf3DvZrs1uoVAhiyn737hRlZAg+QsJheeGCmdSJ0hX5
|
||
Yud8SE+9zxLS1+CEjMrsUd/RGre/phme+wNXfaHfREAC9ewolgVChPIbMxG2f+vs
|
||
K8Xv52BFng7ta9fgsl1XuOjpuaSbQv6g+4ONk/lxKF0SmnhEGM3dmIYPONxW47Yf
|
||
atnIjRra/YhPTNwrNBGMmG4IFKaOsMbjW/eakjWTWOVKKJNBMoDdRcYYWIMCpLy8
|
||
AQUrMtQEsHSnqCwrw818S5A6rrhcfVGk36RGm0nOy6LS5g5jmqaYsvbCcBGY9B2c
|
||
SUAVNm17oo7TtEajk8hcSXoZod1t++pyjcVKEmSn3nFK7v5m3V+cPhNTxZMK459P
|
||
3x1Ucqj/kTqrxKw6s2Uknuk0ajmw0ljV+BQwgL6maguo9BKgCNW5AY0EYnD+DQEM
|
||
ANOu/d6ZMF8bW+Df9RDCUQKytbaZfa+ZbIHBus7whCD/SQMOhPKntv3HX7SmMCs+
|
||
5i27kJMu4YN623JCS7hdCoXVO1R5kXCEcneW/rPBMDutaM472YvIWMIqK9Wwl5+0
|
||
Piu2N+uTkKhe9uS2u7eN+Khef3d7xfjGRxoppM+xI9dZO+jhYiy8LuC0oBohTjJq
|
||
QPqfGDpowBwRkkOsGz/XVcesJ1Pzg4bKivTS9kZjZSyT9RRSY8As0sVUN57AwYul
|
||
s1+eh00n/tVpi2Jj9pCm7S0csSXvXj8v2OTdK1jt4YjpzR0/rwh4+/xlOjDjZEqH
|
||
vMPhpzpbgnwkxZ3X8BFne9dJ3maC5zQ3LAeCP5m1W0hXzagYhfyjo74slJgD1O8c
|
||
LDf2Oxc5MyM8Y/UK497zfqSPfgT3NhQmhHzk83DjXw3I6Z3A3U+Jp61w0eBRI1nx
|
||
H1UIG+gldcAKUTcfwL0lghoT3nmi9JAbvek0Smhz00Bbo8/dx8vwQRxDUxlt7Exx
|
||
NwARAQABiQG8BBgBCAAmAhsMFiEEka4tjB4nWmmb/r77lDMMelCvzPMFAmahA9IF
|
||
CRb8CMUACgkQlDMMelCvzPPQgQv/d5/z+fxgKqgfhQX+V49X4WgTVxZ/CzztDoJ1
|
||
XAq1dzTNEy8AFguXIo6eVXPSpMxec7ZreN3+UPQBnCf3eR5YxWNYOYKmk0G4E8D2
|
||
KGUJept7TSA42/8N2ov6tToXFg4CgzKZj0fYLwgutly7K8eiWmSU6ptaO8aEQBHB
|
||
gTGIOO3h6vJMGVycmoeRnHjv4wV84YWSVFSoJ7cY0he4Z9UznJBbE/KHZjrkXsPo
|
||
N+Gg5lDuOP5xjKzM5SogV9lhxBAhMWAg3URUF15yruZBiA8uV1FOK8sal/9C1G7V
|
||
M6ygA6uOZqXlZtcdA94RoSsW2pZ9eLVPsxz2B3Zko7tu11MpNP/wYmfGTI3KxZBj
|
||
n/eodvwjJSgHpGOFSmbNzvPJo3to5nNlp7wH1KxIMc6Uuu9hgfDfwkFZgV2bnFIa
|
||
Q6gyF548Ub48z7Dz83+WwLgbX19ve4oZx+dqSdczP6ILHRQomtrzrkkP2LU52oI5
|
||
mxFo+ioe/ABCufSmyqFye0psX3Sp
|
||
=WtqZ
|
||
-----END PGP PUBLIC KEY BLOCK-----
|
||
```
|
||
</details>
|
||
|
||
## License
|
||
Cinny Project
|
||
Copyright © 2024–present Ajay Bura
|
||
https://cinny.in
|
||
|
||
Cinny is licensed under the GNU Affero General Public License,
|
||
Version 3 of the License (AGPL-3.0-only).
|
||
You may obtain a copy of the License at https://www.gnu.org/licenses/agpl-3.0.html |