MatrixGW/README.md
Pierre HUBERT 0b16fd2202
Some checks failed
continuous-integration/drone/push Build is failing
continuous-integration/drone/tag Build is failing
Release v1.0.0
2025-03-04 19:32:56 +01:00

38 lines
1009 B
Markdown

# Matrix Gateway
[![Build Status](https://drone.communiquons.org/api/badges/pierre/MatrixGW/status.svg)](https://drone.communiquons.org/pierre/MatrixGW)
Project that expose a simple API to make use of Matrix API. It acts as a Matrix client (like Element for example)
**Known limitations**:
- Supports only a limited subset of Matrix API
- Does not support E2E encryption
- Does not support spaces
Project written in Rust. Releases are published on Docker Hub.
## Docker image options
```bash
docker run --rm -it docker.io/pierre42100/matrix_gateway --help
```
## Setup dev environment
```
mkdir -p storage/postgres storage/synapse storage/minio
docker compose up
```
URLs:
* Element: http://localhost:8080/
* Synapse: http://localhost:8448/
* OpenID configuration: http://127.0.0.1:9001/dex/.well-known/openid-configuration
* Minio console: http://localhost:9002/
Auto-created Matrix accounts:
* `admin1` : `admin1`
* `user1` : `user1`
Minio administration credentials: `minioadmin` : `minioadmin`