Update setup instructions and bridge services in README and config files
This commit is contained in:
parent
0280e965c1
commit
2b6930fb49
GPG Key ID:
C7ECE9C6C36EC2E6
37
README.md
37
README.md
@ -58,22 +58,21 @@ client_api:
|
||||
recaptcha_api_js_url: ""
|
||||
```
|
||||
|
||||
4. Start Dendrite (only the DB and the monolith!):
|
||||
4. Start the core services:
|
||||
|
||||
```sh
|
||||
docker compose up -d postgres monolith
|
||||
```
|
||||
|
||||
5. Run `setup-db.sh`:
|
||||
5. Once PostgreSQL is up, create the bridge databases:
|
||||
|
||||
```sh
|
||||
./setup-db.sh
|
||||
```
|
||||
|
||||
This script will create three new databases: `whatsapp`, `telegram`, and `discord`. These will be used later for the bridges.
|
||||
|
||||
6. Verify the setup by navigating to `http://your-ip-address:8008` in your browser. You should see a screen similar to this:
|
||||
This script will create three new databases: `whatsapp`, `telegram`, and `discord`. These will be used by the bridges.
|
||||
|
||||
6. Verify the Dendrite setup by navigating to `http://your-ip-address:8008` in your browser.
|
||||
|
||||
|
||||
7. Create your first user using the provided script:
|
||||
@ -83,19 +82,31 @@ This script will create three new databases: `whatsapp`, `telegram`, and `discor
|
||||
```
|
||||
|
||||
The script will:
|
||||
- Prompt you for a username
|
||||
- Ask if the user should be an admin
|
||||
- Create the account in your Dendrite server
|
||||
- Prompt you for a username.
|
||||
- Ask if the user should be an admin.
|
||||
- Create the account in your Dendrite server.
|
||||
|
||||
You can run this script multiple times to create additional users as needed.
|
||||
|
||||
## That's It!
|
||||
## Bridge Setup
|
||||
|
||||
Dendrite is now up and running! You can proceed with setting up the media management and bridges:
|
||||
Each bridge starts in a stopped state and will only run once properly configured. You can configure the bridges in any order:
|
||||
|
||||
1. Configure the bridge(s) you want to use:
|
||||
- [WhatsApp Bridge Setup](./config/mautrix-whatsapp/README.md)
|
||||
- [Telegram Bridge Setup](./config/mautrix-telegram/README.md)
|
||||
- [Discord Bridge Setup](./config/mautrix-discord/README.md)
|
||||
|
||||
2. Start configured bridges:
|
||||
```sh
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
Each bridge will only start if its configuration files exist. Bridges without configuration will remain stopped, which is normal.
|
||||
|
||||
## Media Management
|
||||
|
||||
For information about managing media storage and retention:
|
||||
- [Media Management](./MEDIA_MANAGEMENT.md)
|
||||
- [WhatsApp Bridge](./config/mautrix-whatsapp/README.md)
|
||||
- [Telegram Bridge](./config/mautrix-telegram/README.md)
|
||||
- [Discord Bridge](./config/mautrix-discord/README.md)
|
||||
|
||||
**Note**: When configuring each bridge, you'll need to use the Database URI that was displayed during the setup process. Make sure you have saved it somewhere secure!
|
||||
|
||||
@ -77,15 +77,13 @@ app_service_api:
|
||||
- "/etc/discord/registration.yaml"
|
||||
```
|
||||
|
||||
## Starting the Bridge
|
||||
|
||||
1. Start the Discord bridge service:
|
||||
6. Start the bridge service:
|
||||
|
||||
```sh
|
||||
docker compose up -d mautrix-discord
|
||||
```
|
||||
|
||||
2. Restart Dendrite to load the new bridge configuration:
|
||||
7. Restart Dendrite to load the new bridge configuration:
|
||||
|
||||
```sh
|
||||
docker compose restart monolith
|
||||
@ -93,40 +91,44 @@ docker compose restart monolith
|
||||
|
||||
## Verifying the Setup
|
||||
|
||||
1. Check if the bridge is running:
|
||||
Check if the bridge is running:
|
||||
|
||||
```sh
|
||||
docker compose logs mautrix-discord
|
||||
```
|
||||
|
||||
2. Verify the bot is online in Discord
|
||||
You should see messages indicating the bridge has started successfully. If the configuration files aren't present, the service will remain stopped - this is normal and prevents unnecessary restarts.
|
||||
|
||||
## Using the Bridge
|
||||
|
||||
1. Start a chat with `@discordbot:your.domain.com` in your Matrix client.
|
||||
2. Use the OAuth URL you generated earlier to add the bot to your Discord server.
|
||||
3. Use the following commands to start bridging:
|
||||
- `!discord login` - Link your Discord account.
|
||||
- `!discord bridge <channel>` - Bridge a Discord channel.
|
||||
- `!discord list` - List available servers and channels.
|
||||
2. Follow the bot's instructions to:
|
||||
- Set up a Discord bot account.
|
||||
- Add the bot to your server.
|
||||
- Link your Discord account.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
Common issues and solutions:
|
||||
1. **Bridge Not Starting**
|
||||
- Verify that both config.yaml and registration.yaml exist.
|
||||
- Check file permissions.
|
||||
- Review logs with `docker compose logs mautrix-discord`.
|
||||
|
||||
1. **Bridge Not Connecting**
|
||||
2. **Bot Connection Issues**
|
||||
- Verify bot token is correct.
|
||||
- Check if all required intents are enabled.
|
||||
- Ensure bot has proper permissions in Discord.
|
||||
|
||||
2. **Channel Bridging Issues**
|
||||
3. **Channel Bridging Issues**
|
||||
- Verify bot has access to the channel.
|
||||
- Check if the channel type is supported.
|
||||
- Ensure proper permissions in both Discord and Matrix.
|
||||
|
||||
3. **Message Delivery Problems**
|
||||
- Check bridge logs for errors.
|
||||
- Verify Discord connection status.
|
||||
- Ensure proper permissions in both platforms.
|
||||
4. **Message Delivery Problems**
|
||||
- Check bridge permissions in config.
|
||||
- Verify room configuration.
|
||||
- Ensure Discord connection is active.
|
||||
|
||||
## Next Steps
|
||||
|
||||
For more detailed information about bridge features and configuration options, visit the [mautrix-discord documentation](https://docs.mau.fi/bridges/general/docker-setup.html?bridge=discord).
|
||||
|
||||
@ -93,15 +93,13 @@ app_service_api:
|
||||
- "/etc/telegram/registration.yaml"
|
||||
```
|
||||
|
||||
## Starting the Bridge
|
||||
|
||||
1. Start the Telegram bridge service:
|
||||
6. Start the bridge service:
|
||||
|
||||
```sh
|
||||
docker compose up -d mautrix-telegram
|
||||
```
|
||||
|
||||
2. Restart Dendrite to load the new bridge configuration:
|
||||
7. Restart Dendrite to load the new bridge configuration:
|
||||
|
||||
```sh
|
||||
docker compose restart monolith
|
||||
@ -109,13 +107,13 @@ docker compose restart monolith
|
||||
|
||||
## Verifying the Setup
|
||||
|
||||
1. Check if the bridge is running:
|
||||
Check if the bridge is running:
|
||||
|
||||
```sh
|
||||
docker compose logs mautrix-telegram
|
||||
```
|
||||
|
||||
You should see messages indicating the bridge has started successfully.
|
||||
You should see messages indicating the bridge has started successfully. If the configuration files aren't present, the service will remain stopped - this is normal and prevents unnecessary restarts.
|
||||
|
||||
## Using the Bridge
|
||||
|
||||
@ -125,16 +123,14 @@ You should see messages indicating the bridge has started successfully.
|
||||
- Provide your phone number.
|
||||
- Enter the verification code sent to your Telegram app.
|
||||
- Complete two-factor authentication if enabled.
|
||||
4. Proceed to set up the [Discord Bridge](../mautrix-discord/README.md).
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
Common issues and solutions:
|
||||
|
||||
1. **Bridge Not Starting**
|
||||
- Check logs: `docker compose logs mautrix-telegram`.
|
||||
- Verify database connection string.
|
||||
- Ensure API credentials are correct.
|
||||
- Verify that both config.yaml and registration.yaml exist.
|
||||
- Check file permissions.
|
||||
- Review logs with `docker compose logs mautrix-telegram`.
|
||||
- Verify API credentials are correct.
|
||||
|
||||
2. **Login Issues**
|
||||
- Confirm your phone number format (including country code).
|
||||
|
||||
@ -79,15 +79,13 @@ app_service_api:
|
||||
- "/etc/whatsapp/registration.yaml"
|
||||
```
|
||||
|
||||
## Starting the Bridge
|
||||
|
||||
1. Start the WhatsApp bridge service:
|
||||
6. Start the bridge service:
|
||||
|
||||
```sh
|
||||
docker compose up -d mautrix-whatsapp
|
||||
```
|
||||
|
||||
2. Restart Dendrite to load the new bridge configuration:
|
||||
7. Restart Dendrite to load the new bridge configuration:
|
||||
|
||||
```sh
|
||||
docker compose restart monolith
|
||||
@ -95,13 +93,13 @@ docker compose restart monolith
|
||||
|
||||
## Verifying the Setup
|
||||
|
||||
1. Check if the bridge is running:
|
||||
Check if the bridge is running:
|
||||
|
||||
```sh
|
||||
docker compose logs mautrix-whatsapp
|
||||
```
|
||||
|
||||
You should see messages indicating the bridge has started successfully.
|
||||
You should see messages indicating the bridge has started successfully. If the configuration files aren't present, the service will remain stopped - this is normal and prevents unnecessary restarts.
|
||||
|
||||
## Using the Bridge
|
||||
|
||||
@ -116,20 +114,23 @@ You should see messages indicating the bridge has started successfully.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
Common issues and solutions:
|
||||
1. **Bridge Not Starting**
|
||||
- Verify that both config.yaml and registration.yaml exist.
|
||||
- Check file permissions.
|
||||
- Review logs with `docker compose logs mautrix-whatsapp`.
|
||||
|
||||
1. **QR Code Issues**
|
||||
2. **QR Code Issues**
|
||||
- Make sure your phone can properly scan the QR code.
|
||||
- Request a new QR code with `!wa login`.
|
||||
- Ensure your phone has a stable internet connection.
|
||||
|
||||
2. **Connection Problems**
|
||||
3. **Connection Problems**
|
||||
- Check if WhatsApp is properly connected on your phone.
|
||||
- Verify bridge service is running.
|
||||
- Check bridge logs for errors.
|
||||
- Try logging out and back in.
|
||||
|
||||
3. **Message Delivery Issues**
|
||||
4. **Message Delivery Issues**
|
||||
- Verify WhatsApp connection status.
|
||||
- Check bridge permissions.
|
||||
- Ensure proper room creation.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user