-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
5 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,14 @@ | ||
Japella | ||
=== | ||
# japella | ||
|
||
An extensible chatbot application, built with containers connected to a message queue. | ||
|
||
Japella's architecture splits out the connections to different protocols (eg Telegram, Discord) into "adaptor" services, and all bot functionality is implemented in a separate service, meaning that the chatbot functionality can easily work with new protocols, by just creating a new adaptor, or, can relay chat messages across protocols, for example. | ||
|
||
=== Quickstart | ||
## Quickstart | ||
|
||
Japella is only distributed as a x86_64 Linux container. | ||
Japella is only distributed as a x86_64 Linux container, and requires a RabbitMQ server as the message queue. | ||
|
||
```` | ||
user@host: docker create docker.io/rabbitmq -P 5672:5672 --name rabbitmq | ||
user@host: docker create ghcr.io/jamesread/japella-adaptor-telegram --name japella-telegram | ||
```` |