MinPluto/share2fedi
Archived
1
Fork 0
Code Issues Pull requests Activity

Update README

Browse source
This commit is contained in:
Nikita Karamov 2023-08-28 00:31:43 +02:00
parent ea5db41462
commit 1b9388a6fb
No known key found for this signature in database
GPG key ID: 41D6F71EE78E77CD
1 changed files with 22 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
README.md
View file

@ -2,9 +2,10 @@
> Instance-agnostic share page for the Fediverse. > Instance-agnostic share page for the Fediverse.
**[Share₂Fedi]** allows you to share stuff on Mastodon, GoToSocial, Pleroma, and **[Share₂Fedi]** (pronounced ‘share-to-fedi’) allows you to share stuff on
other federated social networks, instance-agnostic. Just type in the post text Mastodon, GoToSocial, Pleroma, and other federated social networks,
and the instance URL, and click ‘Post!’ 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 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` URL automatically inserted into the text field. The same goes for the `instance` URL
@ -12,9 +13,7 @@ parameter. This can be used to build custom share buttons for the federated
social networks: social networks:
```html ```html
<a <a href="https://s2f.kytta.dev/?text=Hello%20world!&instance=mastodon.xyz">
href="https://s2f.kytta.dev/?text=Hello%20world!&instance=https%3A%2F%2Fmastodon.xyz"
>
Share on mastodon.xyz Share on mastodon.xyz
</a> </a>
``` ```
@ -41,7 +40,8 @@ To deploy to Cloudflare Pages, fork the repo and
Self-hosting **Share₂Fedi** outside of Vercel requires some extra setup: Self-hosting **Share₂Fedi** outside of Vercel requires some extra setup:
**Prerequisites:** modern Node.js (v16 or later), `pnpm`. **Prerequisites:** modern Node.js (v16 or later), `pnpm`. You can host with
Deno, but Node.js is still required.
1. Install dependencies. 1. Install dependencies.
@ -55,6 +55,12 @@ Self-hosting **Share₂Fedi** outside of Vercel requires some extra setup:
pnpm build pnpm build
``` ```
If you want to use Deno, add the `--s2f-use-deno` flag:
```sh
pnpm build --s2f-use-deno
```
3. Run server. 3. Run server.
> By default, this will only listen on localhost port 3000. To enable > By default, this will only listen on localhost port 3000. To enable
@ -76,6 +82,15 @@ Self-hosting **Share₂Fedi** outside of Vercel requires some extra setup:
> More information about self-hosting an Astro website with Node: > More information about self-hosting an Astro website with Node:
> https://docs.astro.build/en/guides/integrations-guide/node/#standalone > 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. 4. Set up a reverse proxy.
Basically, you need to run a reverse proxy that would redirect all incoming Basically, you need to run a reverse proxy that would redirect all incoming