Convos - Multiuser chat application

Convos is a multiuser chat application that runs in your web browser.

The supported chat protocol is currently IRC, but Convos can be extended tosupport other protocols as well.

See convos.chat for more details.

The backend is powered by Mojolicious, while thefrontend is held together by the progressive JavaScript frameworkSvelte.

Quick start guide

See "Getting started" for otheroptions and more information.

Install locally

curl https://convos.chat/install.sh | sh -
./convos/script/convos daemon

That's it! After the two commands above, you can point your browser tohttp://localhost:3000 and start chatting.

Docker install

You can use the command below to pull and run convos:

docker pull convos/convos:stable
mkdir -p $HOME/convos/data
docker run -it -p 8080:3000 -v $HOME/convos/data:/data convos/convos:stable

Note that Nordaaker/convos will be aroundfor a while, but the new official image is "convos/convos".

How to make a release

Notes for developers so a new release is made in a proper way.

# Update with the recent changes and make sure the timestamp is proper
$EDITOR Changes

# Build the production assets and update and check that all the files
# have the correct version information
./script/convos build release

Branch overview

alpha

THe "alpha" branch branchwill be force pushed to when we need to make a new docker build with workingassets, but with experimental features. Example:

git checkout -b user/some-feature
$EDITOR assets/store/Conversation.js
./script/convos build
git add .
git commit -a -m "made some experimental changes"
git push origin -f user/some-feature:alpha

master

"master" is fordevelopers. It's mostly stable, but might require extra tools and packages torun. This branch might have outdated assets (JavaScript, CSS files), so itmight not work properly.

stable

"stable" is the branch youshould use, if you want to clone and run Convos. The JavaScript assets and thePerl code will be in sync here.

www.convos.chat

"www.convos.chat" is the sourcefor http://convos.chat, which is powered by the built-in CMSIn Convos.