Skip to content
A chat server with OAuth2 authentication, persistent and searchable history, video and audio, markdown formatting, private and public rooms, stars, votes, embedded games, and many other features
JavaScript CSS HTML PLpgSQL Puppet Dockerfile Other
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
benchmark
docker
graphics
libs
plugins
sql
src
tests
themes
vagrant
views
.dockerignore
.eslintignore
.gitignore
.travis.yml
Dockerfile
README.md
Vagrantfile
bench.sh
config-default.js
docker-compose.yml
gulpfile.js
installation.md
kill.sh
license.md
main.js
package.json
restart.sh
start.sh
test.png
themes.md
yarn.lock

README.md

Miaou

A chat server with authentication, persistent and searchable history, rich markdown formatting, video, private rooms, conversation highlighting, plugins, persisted notifications, code and table rendering, specialized link boxing, github hooks, bots, and many other features.

screenshot

Build Status Chat on Miaou Chat on Miaou

Introduction/Gallery

You can see it in action or use it on https://miaou.dystroy.org (anybody can create a room for public or private use on this server).

Installing a server

If you want to install Miaou, the installation documentation is available here.

Don't hesitate to come ask us some advices in one of the dedicated chat rooms Chat on Miaou and Chat on Miaou (please note that they're currently more active between 8 and 19 GMT).

And if you run your own server, please tell us, we're always happy to learn about installations.

Contributing

As described in the help, Miaou is mostly coded in JavaScript.

Stuff includes node, PostgreSQL, OAuth2, socket.io, WebRTC, express, Bluebird, Redis, Pug, Passport.js, hu.js, jQuery, sass/scss, Uglify-js, gulp, jest, travis-ci, and nginx.

Many features are implemented as plugins, and that's where you should look first: Plugin developpement.

If you have the ability and will to contribute, come and discuss with us. The best landing place is usually the Miaou room where you can ping @dystroy or @Florian.

Help is welcome but remember:

  1. Come and discuss with us before to code
  2. And, always test yourself and run the test suite before doing a pull request.

License

Most of Miaou follows the MIT License. Exceptions are specified here.

Copyright (c) 2014 Denys Séguret <https://www.dystroy.org/>

You can’t perform that action at this time.