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

Improve README

Browse source
This commit is contained in:
Nikita Karamov 2023-03-19 12:39:39 +01:00
parent 2ad24a91da
commit 43e84ea53e
No known key found for this signature in database
GPG key ID: 41D6F71EE78E77CD
1 changed files with 15 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -58,22 +58,21 @@ Self-hosting **Share₂Fedi** outside of Vercel requires some extra setup:
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
> listening on a ceratin hostand/or port, set the `HOST` and `PORT` > listening on a ceratin host and/or port, set the `HOST` and `PORT`
> environment variables, respectively. > environment variables, respectively.
```sh ```sh
node dist/server/entry.mjs node dist/server/entry.mjs
``` ```
alternatively, if you want to run the process in the background: In production, you might want to use a process manager, like
[PM2](https://pm2.keymetrics.io/docs/usage/quick-start/):
```sh ```sh
pm2 start dist/server/entry.mjs --watch --ignore-watch="node_modules" # Start the app, restart on file changes (except node_modules)
pm2 start dist/server/entry.mjs --name "Share2Fedi" --watch --ignore-watch="node_modules"
``` ```
> You can find a summary for pm2 at:
> https://pm2.keymetrics.io/docs/usage/quick-start/
> 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
@ -103,6 +102,13 @@ Self-hosting **Share₂Fedi** outside of Vercel requires some extra setup:
reverse_proxy :3000 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.
## See also ## See also
**[📯 Shareon](https://shareon.js.org)** (lightweight, stylish, and ethical **[📯 Shareon](https://shareon.js.org)** (lightweight, stylish, and ethical
@ -110,13 +116,13 @@ share buttons) uses **Share₂Fedi** under the hood!
## Licence ## Licence
© 2020–2022 [Nikita Karamov]\ © 2020–2023 [Nikita Karamov]\
Licensed under the [GNU Affero General Public License, version 3][AGPL-3.0]. Licensed under the [GNU Affero General Public License v3.0 or later][AGPL-3.0].
--- ---
This project is hosted on GitHub: <https://github.com/kytta/share2fedi.git> This project is hosted on GitHub: <https://github.com/kytta/share2fedi.git>
[AGPL-3.0]: https://spdx.org/licenses/AGPL-3.0-only.html [AGPL-3.0]: https://spdx.org/licenses/AGPL-3.0-or-later.html
[Nikita Karamov]: https://www.kytta.dev [Nikita Karamov]: https://www.kytta.dev
[Share₂Fedi]: https://s2f.kytta.dev/ [Share₂Fedi]: https://s2f.kytta.dev/