There are 4 options how to run mastodon-twitter-sync:
- Recommended: Precompiled executable binaries from the release page (If the binaries do not work on your system you will have to use Docker or compile the program yourself.)
- Docker
- Compiling yourself (takes a bit of time with the Rust compiler)
- Packages for Linux distributions
Download the executable archive for your operating system platform from the release page and run it in an directory where the configuration and cache files will be stored.
mkdir mastodon-twitter-sync
cd mastodon-twitter-sync
tar xzf /path/to/downloaded/mastodon-twitter-sync-x86_64-unknown-linux-gnu.tar.gz
./mastodon-twitter-sync
Follow the text instructions to enter API keys.
You need to have Docker installed on your system, then you can use the published Docker image.
The following commands create a directory where the settings file and cache files will be stored. Then we use a Docker volume from that directory to store them persistently.
mkdir mastodon-twitter-sync
cd mastodon-twitter-sync
docker run -it --rm -v "$(pwd)":/data klausi/mastodon-twitter-sync
Follow the text instructions to enter API keys.
Use that Docker command as a replacement for ./mastodon-twitter-sync in the examples in this README.
This will install Rust and setup API access to Mastodon and Twitter. Follow the text instructions to enter API keys.
curl https://sh.rustup.rs -sSf | sh
source ~/.cargo/env
git clone https://github.com/klausi/mastodon-twitter-sync.git
cd mastodon-twitter-sync
cargo run --release
Follow the text instructions to enter API keys.
Use the cargo run --release -- command as a replacement for ./mastodon-twitter-sync in the examples in this README.
Packaging status
If your distribution has packaged mastodon-twitter-sync, you can use that package for the installation.
You can use pacman to install from the community repository:
pacman -S mastodon-twitter-sync