Skip to content
README.md 1.87 KiB
Newer Older
Legoktm's avatar
Legoktm committed
fedi-share
==========

A landing page to ask a user for their Fediverse instance before sending them there.

Built in mind to be privacy-friendly, no data is stored on the server, if you ask
it to remember your instance's domain it'll be stored on your browser.

Everything is contained in a single HTML file to make it easy to audit. You're also
welcome to copy it and host your own instance, pursuant to the license.

Legoktm's avatar
Legoktm committed
The main instance is deployed at <https://fedi-share.toolforge.org/>.

## URL format

Legoktm's avatar
Legoktm committed
Generate a link like `https://fedi-share.toolforge.org/?text=Your post here`
TheDJ's avatar
TheDJ committed
You can pass a url via `https://fedi-share.toolforge.org/?url=https://example.com`
The url will be appended to any text passed via the `text` parameters

Add hashtags via the hashtags parameters as a comma separated list of tags.
Spaces in hashtags will be autoconverted to CamelCase and other punctuation is not allowed.
`https://fedi-share.toolforge.org/?url=https://example.com&hashtags=tag1,tag2`

If your text contains newlines or other weird characters, you can also JSON-encode the string
and pass it in via the `?json=` parameter. For example, `?json=%22foo%5Cnbar%5Cn%23baz%22`.
For integration with Wikimedia wikis, you can use [Module:Fedi-share](https://commons.wikimedia.org/wiki/Module:Fedi-share)
to generate links.

Legoktm's avatar
Legoktm committed
## Future ideas
Can we read the text out of the fragment instead of using a query parameter? That would prevent
the server from even knowing the text.

Would also be nice if it was prettier, etc.

## Motivation
We needed to replace the Twitter share buttons on the [Commons Picture of the Year contest](https://commons.wikimedia.org/wiki/Commons:Picture_of_the_Year).

Legoktm's avatar
Legoktm committed
## License
fedi-share is available under the AGPL v3 or any later version, see COPYING for more details.
TheDJ's avatar
TheDJ committed

The fediverse icon is licensed CC-0 and sourced from https://commons.wikimedia.org/wiki/File:Fediverse_logo_proposal.svg