forked from FoundKeyGang/FoundKey
improve docs files
This commit is contained in:
parent
ee2860e894
commit
ae1e7883e7
3 changed files with 10 additions and 3 deletions
|
@ -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.
|
See the [changelog](./CHANGELOG.md) and [roadmap](./ROADMAP.md) for more on what's changed and future plans.
|
||||||
|
|
||||||
## Documentation
|
## 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
|
## Contributing
|
||||||
If you're interested in helping out with the project, please read the [contributing guide](./CONTRIBUTING.md).
|
If you're interested in helping out with the project, please read the [contributing guide](./CONTRIBUTING.md).
|
||||||
|
|
|
@ -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.
|
|
|
@ -64,6 +64,13 @@ adduser --disabled-password --disabled-login foundkey
|
||||||
- Make sure you set the PostgreSQL and Redis settings correctly.
|
- 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.
|
- 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
|
||||||
|
|
||||||
Build foundkey with the following:
|
Build foundkey with the following:
|
||||||
|
|
Loading…
Reference in a new issue