---
title: Charmhub | Deploy IRC Bridge using Charmhub - The Open Operator Collection
description: Deploy the latest version of IRC Bridge on any cloud.
url: https://charmhub.io/irc-bridge/docs/tutorial-deploy-irc-bridge
---

# IRC Bridge

[Canonical IS DevOps](https://charmhub.io/publisher/canonical-is-devops "View all packages from Canonical IS DevOps")

* [Canonical IS DevOps](https://charmhub.io/publisher/canonical-is-devops "View all packages from Canonical IS DevOps")

Platform:

22.04

edge b7e97982

```
juju deploy irc-bridge --channel edge
```

[Learn to deploy on juju >](https://juju.is/docs/juju/manage-applications)

---

#### Contacts

##### Maintainers

+ [Launchpad Team](https://launchpad.net/~canonical-is-devops)

* [Submit a bug](https://github.com/canonical/irc-bridge-operator/issues)

---

Share your thoughts on this charm with the community on discourse.

[Join the discussion](https://discourse.charmhub.io/)

# Deploy IRC bridge

In this tutorial, we will deploy IRC Bridge, add configurations and integrate it
with other charms to set up a working Matrix application.

## [Requirements](https://charmhub.io/irc-bridge/docs/tutorial-deploy-irc-bridge#p-38224-requirements)

* A working station, e.g., a laptop, with amd64 architecture.

* Juju 3 installed and bootstrapped to a LXD and MicroK8s controller. You can accomplish

this process by using a [Multipass](https://multipass.run/) VM as outlined in this guide: [Set up / Tear down your test environment](https://canonical-juju.readthedocs-hosted.com/en/3.6/user/howto/manage-your-deployment/manage-your-deployment-environment/#set-things-up)

* [Synapse charm](https://charmhub.io/synapse) deployed. Refer to the [Synapse Getting Started](https://charmhub.io/synapse/docs/tutorial-getting-started) tutorial for step-by-step instructions.

When using a Multipass VM, make sure to replace IP addresses with the
VM IP in steps that assume you’re running locally. To get the IP address of the
Multipass instance run `multipass info my-juju-vm`.

### [Set up a tutorial model](https://charmhub.io/irc-bridge/docs/tutorial-deploy-irc-bridge#p-38224-set-up-a-tutorial-model)

To manage resources effectively and to separate this tutorial’s workload from
your usual work, create a new model using the following command.

```
juju add-model irc-bridge-tutorial
```

### [Deploy IRC bridge](https://charmhub.io/irc-bridge/docs/tutorial-deploy-irc-bridge#p-38224-deploy-irc-bridge)

```
juju deploy irc-bridge --channel edge
```

The tutorial uses the edge channel to get the latest updates on the
Matrix-Auth library.

### [Configure IRC bridge](https://charmhub.io/irc-bridge/docs/tutorial-deploy-irc-bridge#p-38224-configure-irc-bridge)

IRC Bridge has two mandatory configurations:

* `bridge_admins`: Matrix users that will be Bridge administrators.
* `bot_nickname`: nickname that will be used for creating the Bridge user.

Run the following command to set them.

```
juju configure irc-bridge bridge_admins=admin:example.com bot_nickname=ircappservice
```

`example.com` refers to the Synapse home server. If you used a different
one, update it accordingly.

### [Deploy and integrate PostgreSQL](https://charmhub.io/irc-bridge/docs/tutorial-deploy-irc-bridge#p-38224-deploy-and-integrate-postgresql)

IRC Bridge requires a PostgreSQL database.

Run the following commands to deploy PostgreSQL charm and relate it to the IRC
Bridge charm.

```
juju deploy postgresql-k8s --channel 14/stable
juju integrate irc-bridge postgresql
```

### [Deploy and integrate HAProxy](https://charmhub.io/irc-bridge/docs/tutorial-deploy-irc-bridge#p-38224-deploy-and-integrate-haproxy)

Synapse needs to communicate with IRC Bridge via an URL. The HAProxy charm will
be used as a proxy to expose the IRC bridge application.

Run the following command to deploy HAProxy and Self Signed Certificates.

```
juju deploy haproxy --channel 2.8/edge
juju deploy self-signed-certificates
juju integrate haproxy self-signed-certificates
juju integrate irc-bridge haproxy
```

### [Switch to Synapse in MicroK8s controller](https://charmhub.io/irc-bridge/docs/tutorial-deploy-irc-bridge#p-38224-switch-to-synapse-in-microk8s-controller)

Switch to the MicroK8s controller.

```
juju switch microk8s-localhost
```

`microk8s-localhost` is the MicroK8s controller.

The command `juju controllers` list all the existing controllers in the environment.

### [Create the bridge admin user](https://charmhub.io/irc-bridge/docs/tutorial-deploy-irc-bridge#p-38224-create-the-bridge-admin-user)

The user set in the `bridge_admins` configuration should be created in Synapse and will be used
for managing the bridge.

```
juju run synapse/0 register-user username=admin admin=yes
```

Save the password since it will be used in further steps.

### [Create an offer](https://charmhub.io/irc-bridge/docs/tutorial-deploy-irc-bridge#p-38224-create-an-offer)

Since IRC Bridge is running in a different model, the integration between them
should be done via an [Offer](https://canonical-juju.readthedocs-hosted.com/en/latest/user/reference/offer/#offer).

The following command will expose the Matrix Auth endpoint, allowing other
applications to integrate with it.

```
juju offer synapse:matrix-auth
```

### [Integrate IRC bridge with Synapse](https://charmhub.io/irc-bridge/docs/tutorial-deploy-irc-bridge#p-38224-integrate-irc-bridge-with-synapse)

Now that the user used by IRC is created and the offer is available, change it
back to the LXD controller to integrate IRC Bridge and Synapse.

```
juju switch localhost-localhost
```

`localhost-localhost` is the LXD controller.

The command `juju controllers` list all the existing controllers in the environment.

```
juju integrate irc-bridge microk8s-localhost:admin/synapse.matrix-auth
```

### [Check health endpoint](https://charmhub.io/irc-bridge/docs/tutorial-deploy-irc-bridge#p-38224-check-health-endpoint)

The IRC Bridge charm will configure the IRC Bridge once the integration is in
place. Check if the charm is active and idle using `juju status` command.

Then, find the HAProxy unit IP address and check if the /health endpoint returns
“OK”. This indicates that the IRC Bridge is active.

```
curl https://<HAProxy unit IP address>/irc-bridge-tutorial-irc-bridge/health
```

### [Interact with the bridge](https://charmhub.io/irc-bridge/docs/tutorial-deploy-irc-bridge#p-38224-interact-with-the-bridge)

Access Synapse via Element with the admin user created previously.

To interact with the Bridge, you can invite the user `ircappservice` to a room or sent a message.

Send a message to the user `ircappservice`. If a warning shows up, ignore and proceed.

The Bridge will show a help menu with all the options available. Try the following to guarantee
that the bridge is working.

```
!bridgeversion
```

To check all available options, send the following command:

```
!help
```

Screenshot example:

### [Join a IRC channel](https://charmhub.io/irc-bridge/docs/tutorial-deploy-irc-bridge#p-38224-join-a-irc-channel)

You can send a message to the user `ircappservice` like `!join #python` and
this will be interpreted as a command to join the [python](https://charmhub.io/tag/python) channel.

After this, you can join the room python that corresponds to the IRC python channel.

## [Clean up the environment](https://charmhub.io/irc-bridge/docs/tutorial-deploy-irc-bridge#p-38224-clean-up-the-environment)

Well done! You’ve successfully completed the Deploy IRC Bridge tutorial.
To remove the model environment you created during this tutorial,
use the following command.

```
juju destroy-model irc-bridge-tutorial
```

Refer to the “Clean up the environment” step in [Synapse Getting Started](https://charmhub.io/synapse/docs/tutorial-getting-started#p-29229-clean-up-the-environment) tutorial for detailed instructions on how to clean up the Synapse environment.

---