From ae1e7883e761bf73faded848eb5f2171fdf760a1 Mon Sep 17 00:00:00 2001 From: Johann150 Date: Fri, 3 Mar 2023 23:46:45 +0100 Subject: [PATCH] improve docs files --- README.md | 4 +++- docs/default-reaction.md | 2 -- docs/install.md | 7 +++++++ 3 files changed, 10 insertions(+), 3 deletions(-) delete mode 100644 docs/default-reaction.md diff --git a/README.md b/README.md index 3832b2071..68f629c74 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,9 @@ FoundKey is a free and open source microblogging server compatible with Activity See the [changelog](./CHANGELOG.md) and [roadmap](./ROADMAP.md) for more on what's changed and future plans. ## Documentation -FoundKey's documentation is a work in progress. In the meantime, much of the documentation on the [Misskey Hub](https://misskey-hub.net/) will also apply to FoundKey. +FoundKey's documentation is a work in progress, which can be found in the `docs/` folder. + +In the meantime, much of the documentation on the [Misskey Hub](https://misskey-hub.net/) will also apply to FoundKey. ## Contributing If you're interested in helping out with the project, please read the [contributing guide](./CONTRIBUTING.md). diff --git a/docs/default-reaction.md b/docs/default-reaction.md deleted file mode 100644 index ff2d86f2c..000000000 --- a/docs/default-reaction.md +++ /dev/null @@ -1,2 +0,0 @@ -# Changing the default Reaction -You can change the default reaction that is used when an ActivityPub "Like" is received from '👍' to '⭐' by changing the boolean value `meta.useStarForReactionFallback` in the databse respectively. \ No newline at end of file diff --git a/docs/install.md b/docs/install.md index 330c28633..f55cf0046 100644 --- a/docs/install.md +++ b/docs/install.md @@ -64,6 +64,13 @@ adduser --disabled-password --disabled-login foundkey - Make sure you set the PostgreSQL and Redis settings correctly. - Use a strong password for the PostgreSQL user and take note of it since it'll be needed later. +### Reverse proxy +For production use and for HTTPS termination you will have to use a reverse proxy. +There are instructions for setting up [nginx](./nginx.md) for this purpose. + +### Changing the default Reaction +You can change the default reaction that is used when an ActivityPub "Like" is received from '👍' to '⭐' by changing the boolean value `meta.useStarForReactionFallback` in the databse respectively. + ## Build FoundKey Build foundkey with the following: