Initial mautrix-signal Cloudron package

README.md

@@ -1,2 +1,95 @@
-# mautrix-signal-cloudron
+# Mautrix-Signal Bridge for Cloudron
 
+This is a Cloudron package for the [mautrix-signal](https://github.com/mautrix/signal) Matrix bridge.
+
+## Features
+
+- Bridge between Matrix and Signal Messenger
+- Two-way messaging with media support
+- Group chat support
+- End-to-bridge encryption
+- Automatic Cloudron integration
+
+## Building
+
+Build the package using the Cloudron build service:
+
+```bash
+cloudron build --set-build-service builder.docker.due.ren \
+  --build-service-token e3265de06b1d0e7bb38400539012a8433a74c2c96a17955e \
+  --set-repository andreasdueren/mautrix-signal \
+  --tag 1.0.0
+```
+
+## Installing
+
+Install on your Cloudron:
+
+```bash
+cloudron install --location signal.matrix.due.ren \
+  --image andreasdueren/mautrix-signal:1.0.0
+```
+
+## Setup
+
+After installation:
+
+1. Access the app data directory to get the registration file:
+   ```bash
+   cloudron exec --app signal.matrix.due.ren
+   cat /app/data/registration.yaml
+   ```
+
+2. Copy the registration file content to your Matrix homeserver's configuration directory
+
+3. Add the registration to your homeserver configuration (e.g., in Synapse's `homeserver.yaml`):
+   ```yaml
+   app_service_config_files:
+     - /path/to/signal-registration.yaml
+   ```
+
+4. Restart your Matrix homeserver
+
+5. Start a chat with `@signalbot:due.ren` in your Matrix client
+
+6. Follow the authentication instructions to link your Signal account
+
+## Viewing Logs
+
+To view the application logs:
+
+```bash
+cloudron logs --app signal.matrix.due.ren -f
+```
+
+## Configuration
+
+The bridge configuration is located at `/app/data/config.yaml` inside the app. You can edit it by:
+
+```bash
+cloudron exec --app signal.matrix.due.ren
+nano /app/data/config.yaml
+```
+
+After making changes, restart the app from the Cloudron dashboard.
+
+## Troubleshooting
+
+### Bridge not connecting to homeserver
+
+Check that:
+- The registration file is correctly configured in your homeserver
+- The homeserver has been restarted after adding the registration
+- The app is running (check logs)
+
+### Authentication issues
+
+Make sure you're messaging `@signalbot:due.ren` (replace `due.ren` with your actual base domain).
+
+## Documentation
+
+For more information, visit the [official mautrix-signal documentation](https://docs.mau.fi/bridges/go/signal/index.html).
+
+## License
+
+This Cloudron package is licensed under the same terms as mautrix-signal (AGPL-3.0).