Repository files navigation

We've made selt-hosting Beeper bridges infinitely easier! We recommend using our new toolbridge-manager rather than this old method.

If you're just looking to install Beeper, you can get ithere. If you're a developer wanting to contribute or if you want to self-host Beeper on your own infrastructure, read on.

Read the fullFAQ

Beeper is built on top of an open source chat protocol calledMatrix. When we started building Beeper, we made a fundamental decision to open source the majority of our backend code and provide you with the option to self-host Beeper. We chose to do this because:

• We want you to be able to inspect the source code that Beeper uses to connect to other chat networks
• We want to contribute to the Matrix ecosystem
• We want to provide great libraries for others to develop open source Matrix bridges

Our infrastructure stack is composed of:

Beeper Clients

• NativeiOS andAndroid clients (closed source forks ofElement iOS andAndroid)
• Mac OS,Windows andLinux clients (closed source forks ofElement Web/Desktop)

Matrix Homeserver

• Synapse

Open Source, Beeper-maintained Matrix bridges

Open source, community maintained Matrix bridges, Beeper sponsored

What is a Matrix bridge?Learn more

Self hosting Beeper is possible, but not an easy task right now. It requires experience and/or willingness to learn Linux system administration.

Note: only open source Matrix clients like Element or SchildiChat can connect to a self-hosted system at this time. Beeper clients require a Beeper account and use Beeper’s infrastructure.

1. Purchase a domain

   1. We recommend Google Domains
   2. Insert this domain (egselfhostbeeper.com) wherever<insert_domain> is shown in these instructions.

2. Select a hosting provider

   1. We recommend a 2GB RAM 50GB disk Digital Ocean Droplet
   2. Record the Droplet IP to use in next step

3. Configure DNS

   Type	Host	Priority	Weight	Port	Target
   A	matrix	-	-	-	droplet-ip

   • Test your domain to make sure it’s pointing at the Droplet IP
     • nslookup -type=A matrix.<insert_domain>

4. Install necessary tools on your desktop/laptop

   Mac OSbrew install git pwgenLinuxapt install git pwgen

5. Download playbook to your desktop/laptop

   git clone https://github.com/spantaleev/matrix-docker-ansible-deploy.git && cd matrix-docker-ansible-deploy

6. Configure the installationmkdir inventory/host_vars/matrix.<insert_domain>

7. wget https://raw.githubusercontent.com/beeper/self-host/main/vars.yml

8. cp vars.yml inventory/host_vars/matrix.<insert_domain>/vars.yml

9. openinventory/host_vars/matrix.<insert_domain>/vars.yml in a text editor

   1. Insert your<insert_domain> in line 12
   2. Enter a real email address in line 27 and 40
   3. Wherever<create_secretkey> shows up (eg line 22), switch back to your terminal, runpwgen -s 64 1 and insert that key into the file
   4. Disable any bridges you do not want (saves RAM!) or enable Telegram by following instructions on Line 52
   5. Save the file.

10. cp examples/hosts inventory/hosts

11. Openinventory/hosts in a text editor

    1. Replace<your_domain> with your domain
    2. Replaceyour-server's external IP address> with Droplet IP
    3. add the following to the hosts file:ansible_connection=community.docker.nsenter. The hosts file shold now look like this:

[matrix_servers] matrix.YOUR.DOMAIN ansible_host=YOUR_SERVERS_IP ansible_connection=local ansible_ssh_user=root ansible_connection=community.docker.nsenter

12. Install docker and make sure it is started

    Mac OS - Follow instructionshttps://docs.docker.com/desktop/install/mac-install

    Linux - Follow instructionshttps://docs.docker.com/desktop/install/linux-install/#generic-installation-steps

13. Run Ansible in docker from the/matrix-docker-ansible-deploy directory. If this doesn't work, check theplaybook instructions.

    docker run -it --rm \-w /work \-v`pwd`:/work \-v$HOME/.ssh/id_rsa:/root/.ssh/id_rsa:ro \--entrypoint=/bin/sh \docker.io/devture/ansible:2.13.6-r0-1

14. Your terminal should now show/work, then issue these commands

    1. git config --global --add safe.directory /work
    2. make roles
    3. ansible-playbook -i inventory/hosts setup.yml --tags=install-all,ensure-matrix-users-created,start
    4. Your server is now installed! Check that everything is workingansible-playbook -i inventory/hosts setup.yml --tags=self-check
       1. ignore the errors about federation
    • Additional configurationhttps://github.com/spantaleev/matrix-docker-ansible-deploy/blob/master/docs/configuring-playbook.md#other-configuration-options
    • Note that if you remove components from vars.yml, or if we switch some component from being installed by default to not being installed by default anymore, you'd need to run the setup command with --tags=setup-all instead of --tags=install-all. See Playbook tags introduction****

    e. Create your user account, change the command to include your preferred username (<insert_username) and password (<your_password>).

    ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=<insert_username> password=<your_password> admin=yes' --tags=register-user

15. In a browser, open our recommended Matrix client,https://app.schildi.chat/#/login

    1. Click ‘Edit’ andhttps://matrix.<your_domain> into the homeserver field, eghttps://matrix.beeptest.org then click Continue
    2. Sign in with your username/password created in step 14e

16. Set up each bridge

    

    1. Click the + icon, then type in@whatsappbot:<your_domain> into the search bar and wait for a suggestion to appear, then click on it, then click Done. This will start a chat with the ‘bridge bot’ and provide you with a console to login and setup the bridge
    2. Click the Whatsapp Bridge Bot chat in the left panel, then send the messagehelp in the chat to see the list of commands. Each bridge has a slightly different sign in command, but it is usuallylogin,link, orlogin-qr
    3. Repeat Step 16 for each bridge you would like to configure (eg@instagrambot:<your_domain>)
    4. Great! Now all your bridges are set up

17. Set up mobile apps

• Android -SchildiChat
• iOS - Recommended apps:Element orFluffyChat

18. Advanced and optional! Enable federation

• Add a rootA record to your DNS pointing at your Droplet IP
• Modifyvars.yml tomatrix_nginx_proxy_base_domain_serving_enabled: true, then re-run the Ansible script
• Confirm it’s working athttps://federationtester.matrix.org/
• How to upgrade your installation later
  • https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/master/docs/maintenance-upgrading-services.md#upgrading-the-matrix-services

We would love to hear what you think about Beeper and our open source software. We hang out at #beeper:beeper.com on Matrix, or create an issue in this repository.