Improve punctuation in bridge setup documentation
This commit is contained in:
parent
13e1bd6718
commit
d128603b06
GPG Key ID:
C7ECE9C6C36EC2E6
@ -73,7 +73,7 @@ docker run --rm -v `pwd`:/data:z dock.mau.dev/mautrix/discord
|
||||
|
||||
```yaml
|
||||
app_service_api:
|
||||
config_files:
|
||||
config_files:
|
||||
- "/etc/discord/registration.yaml"
|
||||
```
|
||||
|
||||
@ -103,29 +103,30 @@ docker compose logs mautrix-discord
|
||||
|
||||
## 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
|
||||
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
|
||||
- `!discord login` - Link your Discord account.
|
||||
- `!discord bridge <channel>` - Bridge a Discord channel.
|
||||
- `!discord list` - List available servers and channels.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
Common issues and solutions:
|
||||
|
||||
1. **Bridge Not Connecting**
|
||||
- Verify bot token is correct
|
||||
- Check if all required intents are enabled
|
||||
- Ensure bot has proper permissions in Discord
|
||||
- Verify bot token is correct.
|
||||
- Check if all required intents are enabled.
|
||||
- Ensure bot has proper permissions in Discord.
|
||||
|
||||
2. **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
|
||||
- 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
|
||||
- Check bridge logs for errors.
|
||||
- Verify Discord connection status.
|
||||
- Ensure proper permissions in both platforms.
|
||||
|
||||
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).
|
||||
|
||||
@ -61,7 +61,7 @@ bridge:
|
||||
public.your.domain.com: user # Replace with your domain
|
||||
your.domain.com: full
|
||||
"@yourusername:your.domain.com": admin # Replace with your Matrix ID
|
||||
|
||||
|
||||
# Add your Telegram API credentials
|
||||
telegram:
|
||||
api_id: 123456 # Replace with your api_id
|
||||
@ -89,7 +89,7 @@ docker run --rm -v `pwd`:/data:z dock.mau.dev/mautrix/telegram
|
||||
|
||||
```yaml
|
||||
app_service_api:
|
||||
config_files:
|
||||
config_files:
|
||||
- "/etc/telegram/registration.yaml"
|
||||
```
|
||||
|
||||
@ -119,13 +119,13 @@ You should see messages indicating the bridge has started successfully.
|
||||
|
||||
## Using the Bridge
|
||||
|
||||
1. Start a chat with `@telegrambot:your.domain.com` in your Matrix client
|
||||
2. Send the command `!tg login` to start the login process
|
||||
1. Start a chat with `@telegrambot:your.domain.com` in your Matrix client.
|
||||
2. Send the command `!tg login` to start the login process.
|
||||
3. Follow the bot's instructions to:
|
||||
- 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)
|
||||
- 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
|
||||
|
||||
@ -145,3 +145,9 @@ Common issues and solutions:
|
||||
- Verify bridge service is running.
|
||||
- Check bridge permissions in config.
|
||||
- Ensure Telegram session is still valid.
|
||||
|
||||
## Next Steps
|
||||
|
||||
- Proceed to set up the [Discord Bridge](../mautrix-discord/README.md).
|
||||
|
||||
For more detailed information about bridge features and configuration options, visit the [mautrix-telegram documentation](https://docs.mau.fi/bridges/general/docker-setup.html?bridge=telegram).
|
||||
|
||||
@ -8,6 +8,8 @@ Before starting, ensure that:
|
||||
- Dendrite is properly configured and running.
|
||||
- The `whatsapp` database was created during the initial setup.
|
||||
- You have your domain name ready.
|
||||
- You have access to a WhatsApp account with an active phone number.
|
||||
- Your phone has the WhatsApp app installed and working.
|
||||
|
||||
## Setup Steps
|
||||
|
||||
@ -43,7 +45,7 @@ appservice:
|
||||
hostname: 0.0.0.0 # Listen on all interfaces
|
||||
```
|
||||
|
||||
#### Bridge Permissions
|
||||
#### Bridge Settings
|
||||
```yaml
|
||||
bridge:
|
||||
permissions:
|
||||
@ -53,7 +55,7 @@ bridge:
|
||||
```
|
||||
|
||||
#### Database Connection
|
||||
Update the database URI to use the WhatsApp-specific database. For example:
|
||||
Update the database URI to use the WhatsApp-specific database:
|
||||
|
||||
```yaml
|
||||
# Original:
|
||||
@ -73,7 +75,7 @@ docker run --rm -v `pwd`:/data:z dock.mau.dev/mautrix/whatsapp
|
||||
|
||||
```yaml
|
||||
app_service_api:
|
||||
config_files:
|
||||
config_files:
|
||||
- "/etc/whatsapp/registration.yaml"
|
||||
```
|
||||
|
||||
@ -103,14 +105,37 @@ You should see messages indicating the bridge has started successfully.
|
||||
|
||||
## Using the Bridge
|
||||
|
||||
- Set up your WhatsApp account in Matrix by starting a chat with `@whatsappbot:your.domain.com`.
|
||||
- Follow the bot's instructions to link your WhatsApp account.
|
||||
- Once configured, you can proceed to set up the [Telegram Bridge](../mautrix-telegram/README.md).
|
||||
1. Start a chat with `@whatsappbot:your.domain.com` in your Matrix client.
|
||||
2. Send the command `!wa login` to start the login process.
|
||||
3. You will receive a QR code in the chat.
|
||||
4. Open WhatsApp on your phone:
|
||||
- Go to Menu or Settings.
|
||||
- Select "WhatsApp Web".
|
||||
- Scan the QR code displayed in Matrix.
|
||||
5. Wait for the confirmation message.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
If you encounter issues:
|
||||
- Verify all configuration files have the correct permissions.
|
||||
- Check the bridge logs using `docker compose logs mautrix-whatsapp`.
|
||||
- Ensure the database connection string is correct.
|
||||
- Verify the Dendrite configuration includes the correct path to the registration file.
|
||||
Common issues and solutions:
|
||||
|
||||
1. **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**
|
||||
- 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**
|
||||
- Verify WhatsApp connection status.
|
||||
- Check bridge permissions.
|
||||
- Ensure proper room creation.
|
||||
|
||||
## Next Steps
|
||||
|
||||
- Proceed to set up the [Telegram Bridge](../mautrix-telegram/README.md).
|
||||
|
||||
For more detailed information about bridge features and configuration options, visit the [mautrix-whatsapp documentation](https://docs.mau.fi/bridges/general/docker-setup.html?bridge=whatsapp).
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user