|
|
||
|---|---|---|
| .github | ||
| src | ||
| .env.sample | ||
| .envrc | ||
| .git-blame-ignore-revs | ||
| .gitignore | ||
| Cargo.lock | ||
| Cargo.toml | ||
| CHANGELOG.md | ||
| cliff.toml | ||
| default.nix | ||
| flake.lock | ||
| flake.nix | ||
| fly.toml | ||
| LICENSE-APACHE | ||
| LICENSE-MIT | ||
| README.md | ||
| release.toml | ||
| rust-toolchain.toml | ||
| shell.nix | ||
linkleaner 
Telegram bot to replace social media links with their improved preview variants. The mapping of supported link types to what services are used to "fix" these links is given below.
| Link type | Fix mechanism |
|---|---|
| Accelerated Mobile Pages (AMP) | AmputatorBot |
| instagramez (embedez) | |
| Medium | LibMedium |
| FxReddit | |
| TikTok | fxTikTok |
| Twitter / X | TweetFix |
| YouTube Shorts | Rewrite URL to normal YouTube player |
Development
There are no external dependencies other than a nightly Rust compiler.
I personally use Nix to manage my development environment, but the repository
also contains a rust-toolchain.toml for use with Rustup containing the exact
version of Rust nightly the project is tested with.
Deployment
fly.io (recommended)
My personal copy of linkleaner is hosted on fly.io and the release workflow is designed to facilitate that.
To get set up, refer to the environment variables defined in the .env.sample file and set them on fly.io itself with the real values.
The bundled fly.toml is not a template and refers to my own deployment, make sure to swap
out app for your own unique name. You can keep the image the same if you wish to keep in
sync with upstream releases, or push your own Docker image.
Docker
The release CI pushes the ghcr.io/msfjarvis/linkleaner:latest image to GitHub Container Registry
which can be pulled periodically for the latest code. You can run this image directly with
the environment variables from .env.sample since it has a configured entrypoint.