aboutsummaryrefslogtreecommitdiff
path: root/mautrix-whatsapp/README
diff options
context:
space:
mode:
Diffstat (limited to 'mautrix-whatsapp/README')
-rw-r--r--mautrix-whatsapp/README12
1 files changed, 12 insertions, 0 deletions
diff --git a/mautrix-whatsapp/README b/mautrix-whatsapp/README
new file mode 100644
index 0000000..f394a68
--- /dev/null
+++ b/mautrix-whatsapp/README
@@ -0,0 +1,12 @@
+A Matrix-WhatsApp puppeting bridge based on whatsmeow.
+
+The bridge requires a database and database user.
+
+```
+sudo -u postgres createuser --pwprompt mautrix-whatsapp
+sudo -u postgres createdb --owner=mautrix-whatsapp --encoding=UTF-8 mautrix-whatsapp
+```
+
+Next, configure the service by editing the '/etc/mautrix-whatsapp/config.yam'
+file before starting the service. Refer to the documentation for the project
+at https://docs.mau.fi/bridges/go/setup.html?bridge=whatsapp#configuring-and-running.