This repository has been archived on 2024-05-13. You can view files and clone it, but cannot push or open issues or pull requests.
share2fedi/README.md
Nikita Karamov 6b332252c0
Fix README
2021-11-04 18:20:24 +01:00

2.1 KiB
Raw Blame History

toot

Cross-instance share page for Mastodon

toot allows you to share stuff on Mastodon, cross-instance. Just put in your post text and the instance URL and click Toot!

And if you open this page with text URL parameter, it will be auto-inserted in the text field. The same goes for the instance URL parameter. This can be used to build custom share buttons for Mastodon:

<a href="https://toot.kytta.dev/?text=Hello%20world!&instance=https%3A%2F%2Fmastodon.xyz">
  Share on Mastodon
</a>

The instance URL can be saved in your localStorage to be automatically appended later — handy!

Hosting

One-click Vercel deploy

For now, toot is a tad bit vendor-locked to run on Vercel. To deploy it yourself, you can use the following button:

Deploy with Vercel

Host it yourself

Self-hosting toot outside of Vercel requires some extra setup:

  1. Make sure you have got Node.js v12 or later as well as pnpm installed

  2. Build the static part of toot:

    pnpm install    # to install dependencies
    pnpm run build  # to build the website
    
  3. Run the backend server for the form:

    node api/toot.js
    
  4. Set up a reverse proxy from localhost:8000 to /api/toot

See also

📯 shareon — lightweight, stylish and ethical share buttons — use toot under the hood!

Licence

AGPL-3.0 © 2020-2021, Nikita Karamov

The toot logo is based on Mastodons Simple logo, licensed under AGPL-3.0.

The repo banner includes Mastodons Full logo, licensed under AGPL-3.0.


The source code is being hosted on GitHub, with mirrors on GitLab and Codeberg.