README
¶
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 to support other protocols as well.
See convos.chat for more details.
The backend is powered by Mojolicious, while the frontend is held together by the progressive JavaScript framework Svelte.
Quick start guide
See "Getting started" for other options 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 to http://localhost:3000 and start chatting.
Docker install
You can use the command below to pull and run convos:
docker pull ghcr.io/convos-chat/convos:alpha
mkdir -p $HOME/convos/data
docker run -it -p 8080:3000 -v $HOME/convos/data:/data ghcr.io/convos-chat/convos:alpha
Note that Nordaaker/convos and convos/convos will be around for a while, but the new official image is now hosted at GitHub.
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
main
"main" is for developers. It's mostly stable, but might require extra tools and packages to run. This branch might have outdated assets (JavaScript, CSS files), so it might not work properly.
stable
"stable" is the branch you should use, if you want to clone and run Convos. The JavaScript assets and the Perl code will be in sync here.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
daemon
Package daemon implements the "daemon" command which starts the Convos server.
|
Package daemon implements the "daemon" command which starts the Convos server. |
|
get
Package get implements the "get" command for the Convos CLI tool.
|
Package get implements the "get" command for the Convos CLI tool. |
|
recover
Package recoveraccount provides the command to recover data or reset passwords.
|
Package recoveraccount provides the command to recover data or reset passwords. |
|
version
Package version implements the "version" command, which shows version information about the Convos binary.
|
Package version implements the "version" command, which shows version information about the Convos binary. |
|
pkg
|
|
|
api
Package api provides primitives to interact with the openapi HTTP API.
|
Package api provides primitives to interact with the openapi HTTP API. |
|
auth
Package auth implements pluggable authentication
|
Package auth implements pluggable authentication |
|
bot
Package bot implements the bot manager and related functionality for Convos.
|
Package bot implements the bot manager and related functionality for Convos. |
|
bot/actions/gitea
Package gitea implements a bot action for Gitea/Forgejo webhooks.
|
Package gitea implements a bot action for Gitea/Forgejo webhooks. |
|
bot/actions/github
Package github implements a bot action that listens for GitHub webhook events
|
Package github implements a bot action that listens for GitHub webhook events |
|
config
Package config provides configuration management for the Convos application.
|
Package config provides configuration management for the Convos application. |
|
core
Package core implements the core business logic for Convos.
|
Package core implements the core business logic for Convos. |
|
embed
Package embed provides functionality to fetch and parse metadata from URLs for link previews.
|
Package embed provides functionality to fetch and parse metadata from URLs for link previews. |
|
handler
Package handler provides HTTP handlers for the Convos API.
|
Package handler provides HTTP handlers for the Convos API. |
|
irc
Package irc implements an IRC connection for Convos.
|
Package irc implements an IRC connection for Convos. |
|
password
Package password configures argon2 to be compatible with Perl Convos.
|
Package password configures argon2 to be compatible with Perl Convos. |
|
server
Package server implements the HTTP server for Convos, including API endpoints and SPA frontend.
|
Package server implements the HTTP server for Convos, including API endpoints and SPA frontend. |
|
storage
Package storage implements a file-based backend for Convos, compatible with Perl's Convos::Core::Backend::File.
|
Package storage implements a file-based backend for Convos, compatible with Perl's Convos::Core::Backend::File. |