2021-01-30 08:25:48 -05:00
< h1 align = "center" > < img src = "assets/logo.svg" width = "128" height = "128" alt = "toot" > < / h1 >
2020-09-23 09:08:21 -05:00
2021-01-30 09:12:32 -05:00
> Cross-instance share page for Mastodon
2020-09-23 11:39:38 -05:00
2021-05-13 07:24:32 -05:00
[toot] allows you to share stuff on Mastodon, cross-instance. Just put in your post text and the instance URL and click ‘ Toot!’
2021-01-30 09:12:32 -05:00
2021-05-13 07:24:32 -05:00
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:
2020-09-23 11:39:38 -05:00
```html
2021-11-04 12:01:45 -05:00
< a href = "https://toot.kytta.dev/?text=Hello%20world!&instance=https%3A%2F%2Fmastodon.xyz" >
2021-05-13 07:24:32 -05:00
Share on Mastodon
2020-09-23 11:39:38 -05:00
< / a >
```
2021-05-13 07:24:32 -05:00
The instance URL can be saved in your `localStorage` to be automatically appended later — handy!
2021-01-30 09:12:32 -05:00
2021-08-28 09:03:58 -05:00
## Hosting
### One-click Vercel deploy
For now, toot is a tad bit vendor-locked to run on
[Vercel ](https://vercel.com/ ). To deploy it yourself, you can use the following
button:
[![Deploy with Vercel ](https://vercel.com/button )](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FNickKaramoff%2Ftoot)
### Host it yourself
Self-hosting toot outside of Vercel requires some extra setup:
2021-11-04 12:20:24 -05:00
1. Make sure you have got Node.js v12 or later as well as pnpm installed
2021-08-28 09:03:58 -05:00
2. Build the static part of toot:
```sh
2021-11-04 12:20:24 -05:00
pnpm install # to install dependencies
pnpm run build # to build the website
2021-08-28 09:03:58 -05:00
```
3. Run the backend server for the form:
```sh
node api/toot.js
```
4. Set up a reverse proxy from `localhost:8000` to `/api/toot`
2021-01-30 09:12:32 -05:00
## See also
**[📯 shareon](https://shareon.js.org)** — lightweight, stylish and ethical share buttons — use [toot] under the hood!
2020-09-23 12:59:55 -05:00
2021-05-13 07:24:32 -05:00
## Licence
2020-09-23 12:59:55 -05:00
2021-05-13 07:24:32 -05:00
[AGPL-3.0 ](https://spdx.org/licenses/AGPL-3.0-only.html ) © 2020-2021, Nikita Karamov
2020-09-23 12:59:55 -05:00
2021-05-13 07:24:32 -05:00
The ‘ toot’ logo is based on Mastodon’ s ‘ Simple’ logo, licensed under [AGPL-3.0 ](https://www.gnu.org/licenses/agpl-3.0.html ).
2021-01-29 18:48:40 -05:00
2021-05-13 07:24:32 -05:00
The repo banner includes Mastodon’ s ‘ Full’ logo, licensed under [AGPL-3.0 ](https://www.gnu.org/licenses/agpl-3.0.html ).
2020-09-23 11:39:38 -05:00
2021-08-29 07:10:23 -05:00
----
The source code is being hosted
on [GitHub ](https://github.com/NickKaramoff/toot ), with mirrors
2021-11-04 12:01:45 -05:00
on [GitLab ](https://gitlab.com/kytta/toot )
and [Codeberg ](https://codeberg.org/kytta/toot ).
2021-08-29 07:10:23 -05:00
2021-11-04 12:01:45 -05:00
[toot]: https://toot.kytta.dev