> Instance-agnostic share page for the Fediverse. **[Share₂Fedi]** (pronounced ‘share-to-fedi’) allows you to share stuff on Mastodon, Misskey, Friendica, and other federated social networks, instance-agnostic. Just type in the post text and the instance URL, and click ‘Post’! Or, open this page with the prefilled `text` URL parameter—it will be automatically inserted into the text field. The same goes for the `instance` and `lang` URL parameters. This can be used to build custom share buttons for the federated social networks: ```html Share on mastodon.xyz ``` The instance URL can be saved in your `localStorage` to be automatically appended if used later—handy! > [!IMPORTANT] > I know I provide [a Share₂Fedi instance](https://s2f.kytta.dev) for others to > use, but if you want to use Share₂Fedi for your share buttons, **please > consider self-hosting it**. Although it's free now, running my instance may > become too expensive for me in the future. ## Hosting ### Vercel, Netlify, Cloudflare Pages Share₂Fedi was designed to run on [Vercel](https://vercel.com/), but you can also run it on [Netlify](https://www.netlify.com/) or [Cloudflare Pages](https://pages.cloudflare.com/). To deploy it yourself (it's free!), you can use the following buttons: [](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fkytta%2Fshare2fedi) [](https://app.netlify.com/start/deploy?repository=https://github.com/kytta/share2fedi) To deploy to Cloudflare Pages, fork the repository and [follow the instructions](https://docs.astro.build/en/guides/deploy/cloudflare/#how-to-deploy-a-site-with-git). ### Host it yourself Self-hosting Share₂Fedi outside of SSR providers requires some extra setup: **Prerequisites:** modern Node.js (v18 is recommended), `pnpm`. You can host with Deno, but Node.js is still required to build Share₂Fedi. 1. Install dependencies. ```sh pnpm install ``` 2. Build. ```sh pnpm build ``` If you want to use Deno, add the `--s2f-use-deno` flag: ```sh pnpm build --s2f-use-deno ``` 3. Run server. > By default, this will only listen on localhost port 3000. To enable > listening on a certain host and/or port, set the `HOST` and `PORT` > environment variables, respectively. ```sh node dist/server/entry.mjs ``` In production, you might want to use a process manager, like [PM2](https://pm2.keymetrics.io/docs/usage/quick-start/): ```sh # Start the app, restart on file changes (except node_modules) pm2 start dist/server/entry.mjs --name "Share2Fedi" --watch --ignore-watch="node_modules" ``` > More information about self-hosting an Astro website with Node: > https://docs.astro.build/en/guides/integrations-guide/node/#standalone If you've built Share₂Fedi for Deno: ```sh deno run --allow-net --allow-read --allow-env ./dist/server/entry.mjs ``` > More information about self-hosting an Astro website with Deno: > https://docs.astro.build/en/guides/integrations-guide/deno/#usage 4. Set up a reverse proxy. Basically, you need to run a reverse proxy that would redirect all incoming requests to `localhost:3000`. Here's how to achieve this in various HTTP servers: 1. Apache ```apacheconf ProxyPass "/" "http://localhost:3000/" ``` 2. Nginx ```nginxconf location / { proxy_pass http://localhost:3000/; } ``` 3. Caddy ```caddy reverse_proxy :3000 ``` ### Docker If you _really_ have to use Docker, there is [a good guide on building Astro apps with Docker](https://docs.astro.build/en/recipes/docker/). **I will not** provide support for Docker-based deployments in the observable future. ## Contribute ### Source code TL;DR: `pnpm install && pnpm dev` See [contributing guide](CONTRIBUTING.md#improving-code) for instructions on how to contribute source code to the project, including adding new Fediverse projects. ### Translations Share₂Fedi uses Hosted Weblate for translations. [You can edit translations using it's practical interface.](https://hosted.weblate.org/engage/share2fedi/). You also could do it manually by editing files in `src/i18n/translations`, but this is NOT recommended. > [!NOTE] > New languages do not become automatically available. For this, a > separate change to our ad-hoc i18n engine has to be made. See > [contributing guide](CONTRIBUTING.md#translating) for instructions _We thank Weblate for providing Libre hosting!_ ## See also **[📯 Shareon](https://shareon.js.org)** (lightweight, stylish, and ethical share buttons) uses **Share₂Fedi** under the hood! ## Licence © 2020–2023 [Nikita Karamov]\ Licensed under the [GNU Affero General Public License v3.0 only][AGPL-3.0-only]. --- This project is hosted on GitHub: [AGPL-3.0-only]: https://spdx.org/licenses/AGPL-3.0-only.html [Nikita Karamov]: https://www.kytta.dev [Share₂Fedi]: https://s2f.kytta.dev/