Skip to content

httpjamesm/matrix-tiktok

Repository files navigation

matrix-tiktok

Matrix Go Docker

A Matrix bridge for TikTok Messages. Intended for usage with Beeper.

Features

  • Messages
    • Text
    • Images
    • Videos
    • Stickers
    • Voice Notes
    • TikToks
  • Reactions
  • Typing indicators
  • Mark conversation as read
  • Replies
  • Read receipts
  • Group chats
  • Delete message for everyone

Running

Docker (GHCR)

Container images are published to GitHub Container Registry:

ghcr.io/httpjamesm/matrix-tiktok

Use the image tag that matches the GitHub release you want (for example v1.0.0). Mount your bbctl-generated config at /data/config.yaml:

docker pull ghcr.io/httpjamesm/matrix-tiktok:<tag>
docker run --rm \
  -v /path/to/config.yaml:/data/config.yaml:ro \
  ghcr.io/httpjamesm/matrix-tiktok:<tag>

With Beeper’s default homeserver.websocket setup you usually do not need to publish an appservice port; add -p host:container only if your config uses inbound appservice HTTP instead of the websocket.

From source

1. Install bbctl

Install bbctl from Beeper's documentation.

Run bbctl login to log into your Beeper account.

2. Generate configuration

Run bbctl config --type bridgev2 -o config.yaml sh-tiktok to create a configuration in the project root directory.

3. Run with config

Run go run cmd/matrix-tiktok/main.go -c config.yaml.

4. Login

Send an invitation to @sh-tiktokbot:beeper.local on Beeper and send "login".

Sign into TikTok Messages, grab your cookie string, and paste it in.

Legal Disclaimer

This project involves reverse engineering TikTok's private API for the sole purpose of enabling interoperability with the Matrix protocol. No TikTok source code, assets, or copyrighted materials are reproduced or distributed by this project.

This project is legally protected by both Canadian and United States law. Attempts to take down this project are illegal and may incur substantial indemnity costs to you.

Read more

About

TikTok DMs Matrix bridge

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages