A Matrix-Twitter DM puppeting bridge
File Explorer
Download Latest Version (.zip)- bug.md
- config.yml
- enhancement.md
- go.yml
- stale.yml
- icon.svg
- main.go
- convert.go
- convert_test.go
- backfill.go
- backfill_test.go
- capabilities.go
- castle_token.js
- castle_token_webview.go
- chatinfo.go
- chatsync.go
- chatsync_test.go
- client.go
- client_connect_test.go
- config.go
- connector.go
- connector_test.go
- conversationdata.go
- conversationdata_test.go
- dbmeta.go
- dbmeta_test.go
- directmedia.go
- example-config.yaml
- handlematrix.go
- handletwit.go
- human_errors.go
- ids.go
- ids_test.go
- keybackup.go
- keystore.go
- login.go
- login_live_probe_test.go
- login_test.go
- mention_entities_test.go
- msgconv.go
- public_key_test.go
- push.go
- receipt_test.go
- startchat.go
- url_attachments.go
- xchat_gap.go
- xchat_gap_test.go
- xchat_reconnect.go
- xchat_reconnect_test.go
- encrypt.go
- client.go
- dleq.go
- oprf.go
- oprf_test.go
- hash.go
- hash_test.go
- client.go
- requests.go
- shamir.go
- shamir_test.go
- errors.go
- types.go
- client.go
- config.go
- errors.go
- types.go
- cookies.go
- cookies_test.go
- animation.go
- keymanager.go
- keys.go
- message.go
- secretstream.go
- signature.go
- token.go
- transaction.go
- xchat.go
- endpoints.go
- form.go
- jot.go
- json.go
- thrift.go
- thrift_codec.go
- account.go
- inbox.go
- media.go
- messaging.go
- search.go
- stream.go
- xchat.go
- entities.go
- event.go
- http.go
- messaging.go
- user.go
- xchat.go
- html.go
- html_test.go
- methods.go
- account.go
- castle_token.go
- client.go
- errors.go
- headers.go
- headers_test.go
- http.go
- jot_client.go
- login_jetfuel.go
- login_jetfuel_live_probe_test.go
- login_web.go
- login_web_test.go
- media.go
- messaging.go
- plaintext_send_test.go
- polling.go
- search.go
- session_loader.go
- stream_client.go
- websocket.go
- xchat_convert.go
- xchat_processor.go
- xchat_receipt_test.go
- xchat_send.go
- xchat_send_test.go
- .dockerignore
- .editorconfig
- .gitignore
- .gitlab-ci.yml
- .pre-commit-config.yaml
- build.sh
- CHANGELOG.md
- docker-run.sh
- Dockerfile
- Dockerfile.ci
- go.mod
- go.sum
- LICENSE
- LICENSE.exceptions
- README.md
- ROADMAP.md
# Installation Guide
1. Get the code
git clone https://github.com/mautrix/twitter
Downloads the entire project code from GitHub to your computer.
cd twitter
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t twitter .
Builds a runnable image based on the Dockerfile.
docker run -p 8080:80 twitter
Runs the built image as an actual container.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
3. Go
MediumPrerequisites
go build ./...
Compiles the Go program into an executable.
go run .
Runs the Go program directly without a separate build step.
If the build finishes without errors, it worked. If you used go run ., check the terminal output.
// repository documentation
Was this content helpful?
(0 ratings)