jackal
- 0 ratings
XMPP server with focus on stability, simple configuration and low resource consumption.
Deploy this app to Linode with a free $100 credit!
An XMPP server written in Go.
jackal is a free, open-source, high performance XMPP server which aims to be known for its stability, simple configuration and low resource consumption.
jackal supports the following features:
To start using jackal, install Go 1.19+ and run the following commands:
$ git clone git@github.com:ortuman/jackal.git
$ cd jackal
$ make install installctlThis will fetch the code and install jackal and jackalctl binaries into your $GOPATH/bin path.
By default the application will try to locate service configuration at config.yaml, but alternatively you can specify a custom configuration path either through command line.
$ jackal --config=/your-custom-path/your-config.yamlor environment variable:
$ env JACKAL_CONFIG_FILE=/your-custom-path/your-config.yaml jackalTo make it easy to install jackal via Helm in Kubernetes a chart has been included into this repository.
After customizing your own values.yaml file run the following command to install and configure all required components under jackal namespace.
sh ./helm/scripts/install.sh <your_custom_values>.yamlIn turn, an active chart can be updated by running the upgrade script as follows:
sh ./helm/scripts/upgrade.sh <your_custom_values>.yamlOn the other hand, you can also remove the jackal chart from your Kubernetes cluster by running the uninstall script:
sh ./helm/scripts/uninstall.shCreate a user and a database for that user:
CREATE ROLE jackal WITH LOGIN PASSWORD 'password';
CREATE DATABASE jackal;
GRANT ALL PRIVILEGES ON DATABASE jackal TO jackal;Download lastest version of the PostgreSQL schema from jackal Github repository.
wget https://raw.githubusercontent.com/ortuman/jackal/master/sql/postgres.up.psqlRun the postgres script file to create database schema:
psql --user jackal --password -f sql/postgres.up.psqlConfigure jackal to use PostgreSQL by editing the configuration file:
storage:
type: pgsql
pgsql:
host: 127.0.0.1:5432
user: jackal
password: password
database: jackalThat's it!
Your database is now ready to connect with jackal.
After completing database setup and starting jackal service you'll have to register a new user to be able to login. To do so, you can use
jackal command-line tool to create a new user proving name and password.
make installctl && jackalctl user add <user>:<password>The purpose of clustering is to be able to use several servers for fault-tolerance and scalability.
Since jackal is a distributed system, it needs a distributed data store like etcd to share its state across the entire cluster.
To properly run jackal in clustering mode make sure to add a cluster section configuration in each of your service nodes.
Here's an example of how this section should look like:
cluster:
type: kv
kv:
type: etcd
etcd:
endpoints:
- http://<etcd-host1>:<etcd-port1>
- http://<etcd-host2>:<etcd-port2>
...
port: your-cluster-node-port # default is 14369Note the defined port value will be used to perform cluster node communication, so make sure is reachable within your internal network.
The purpose of the extensibility framework is to provide an interface between jackal server and third-party external modules, thus offering the possibility of extending the functionality of the service for particular use cases. Extensibility gRPC API proto files can be found at jackal proto definitions repository.
The Docker deployment framework supports easy installation and configuration of jackal server.
You need to have Docker installed on your system before you can use a jackal Docker image. See Install Docker for instructions.
Download the jackal Docker image from the official Docker Hub library with this command:
docker pull ortuman/jackal:latestStart a new jackal Docker container with custom configuration.
docker run --name=jackal \
--mount type=bind,src=/path-on-host-machine/my-custom-config.yaml,dst=/jackal/config.yaml \
-p "5222:5222" \
-p "15280:15280" \ # used by jackalctl
-d ortuman/jackal:latestAlternatively, and with the purpose of facilitating service mounting, you can make use of docker-compose as follows:
docker-compose -f dockerfiles/docker-compose.yml upThis command will spin up a jackal server along with its dependencies on a docker network and start listening for incoming connections on port 5222.
Once up and running, don't forget to register one or more users using jackalctl.
The jackal developer community is vital to improving jackal future releases.
Contributions of all kinds are welcome: reporting issues, updating documentation, fixing bugs, improving unit tests, sharing ideas, and any other tips that may help the jackal community.
Help us keep jackal open and inclusive. Please read and follow our Code of Conduct.
jackal is licensed under the Apache 2 License. See LICENSE for the full license text.
If you have any suggestion or question:
Miguel Ángel Ortuño, JID: ortuman@jackal.im, email: ortuman@pm.me
Please login to review this project.
No reviews for this project yet.
Mobile messaging platform with a focus on performance and s…
Feature-rich and easy to configure XMPP server.
Real time collaboration (RTC) server.
Comments (0)
Please login to join the discussion on this project.