fork of https://f-hub.org/XMPP/xmpp-discord-bridge

Crashcourse in Codeberg's markdown renderer.

+22 -6
+22 -6
README.md
··· 15 15 16 16 ## Install 17 17 18 + --- 19 + 18 20 ⚠️ This is how I set it up on Debian Bookworm. If you need help adapting it to your distribution, please open an issue or ask for help on [Jabber](xmpp:bridging@joinjabber.org?join). 19 21 20 22 ⚠️ This guide also does not use a "venv" (virtual environment). I had an issue running it in its own "venv". If someone wants to troubleshoot it, contributions are welcome. 23 + 24 + --- 21 25 22 26 1. Install needed dependencies. 23 27 24 - sudo apt install git python3-full pip cmake 28 + ```shell 29 + sudo apt install git python3-full pip cmake 30 + ``` 25 31 26 32 2. Create a new system user to run it under. 27 33 28 - sudo adduser --system --home /var/lib/xmpp-discord-bridge xmpp-discord-bridge 34 + ```shell 35 + sudo adduser --system --home /var/lib/xmpp-discord-bridge xmpp-discord-bridge 36 + ``` 29 37 30 38 3. Now open a shell as that user. 31 39 32 - sudo -u xmpp-discord-bridge -s 40 + ```shell 41 + sudo -u xmpp-discord-bridge -s 42 + ``` 33 43 34 44 4. Run: 35 45 36 - cd && git clone "https://codeberg.org/queer-spark/xmpp-discord-bridge.git" && cd xmpp-discord-bridge && python3 -m pip install . --user --break-system-packages && cd 46 + ```shell 47 + cd && git clone "https://codeberg.org/queer-spark/xmpp-discord-bridge.git" && cd xmpp-discord-bridge && python3 -m pip install . --user --break-system-packages && cd 48 + ``` 37 49 38 50 5. Create and edit `~/config.toml`. Refer to [example.toml](example.toml) for options. 39 51 ··· 41 53 42 54 7. Copy the service file to systemd's system directory. 43 55 44 - sudo cp /var/lib/xmpp-discord-bridge/xmpp-discord-bridge/optional/xmpp-discord-bridge.service /etc/systemd/system/ 56 + ```shell 57 + sudo cp /var/lib/xmpp-discord-bridge/xmpp-discord-bridge/optional/xmpp-discord-bridge.service /etc/systemd/system/ 58 + ``` 45 59 46 60 8. Read through the [XMPP](#xmpp) and [Discord](#discord) sections and make sure the listed requirements are met. 47 61 48 62 9. Start and enable the bridge. 49 63 50 - sudo systemctl enable --now xmpp-discord-bridge.service 64 + ```shell 65 + sudo systemctl enable --now xmpp-discord-bridge.service 66 + ``` 51 67 52 68 ### XMPP 53 69