Merge pull request 'Update documentation' (#188) from zutart/teddit:main into main
Reviewed-on: https://codeberg.org/teddit/teddit/pulls/188
This commit is contained in:
teddit
commit
f6b74469d5
53
README.md
53
README.md
|
|
@ -31,34 +31,57 @@ Community instances:
|
|||
* [ibarajztopxnuhabfu7f...onion](http://ibarajztopxnuhabfu7fg6gbudynxofbnmvis3ltj6lfx47b6fhrd5qd.onion)
|
||||
* [xugoqcf2pftm76vbznx4...i2p](http://xugoqcf2pftm76vbznx4xuhrzyb5b6zwpizpnw2hysexjdn5l2tq.b32.i2p)
|
||||
|
||||
## TODO
|
||||
|
||||
* User trophies
|
||||
* "other discussions" feature
|
||||
* "Open on reddit" links
|
||||
* ... and lot of other small stuff
|
||||
|
||||
## Roadmap
|
||||
|
||||
* HLS video streaming? (Would require browser JavaScript)
|
||||
* User login, so people can use their Reddit account through teddit to comment and up/downvote posts etc.
|
||||
## Changelog
|
||||
|
||||
See ```CHANGELOG.md```
|
||||
## Installation
|
||||
|
||||
### Docker
|
||||
|
||||
Using [Docker and `docker-compose`](https://github.com/docker/compose):
|
||||
### Docker-compose method
|
||||
|
||||
```console
|
||||
wget https://codeberg.org/teddit/teddit/raw/branch/main/docker-compose.yml
|
||||
docker-compose build
|
||||
docker-compose up
|
||||
```
|
||||
|
||||
Teddit should now be running at <http://localhost:8080>.
|
||||
|
||||
Docker image is available at [https://hub.docker.com/r/teddit/teddit](https://hub.docker.com/r/teddit/teddit)
|
||||
Docker image is available at [https://hub.docker.com/r/teddit/teddit](https://hub.docker.com/r/teddit/teddit).
|
||||
|
||||
#### Environment Variables
|
||||
|
||||
The following variables may be set to customize your deployment at runtime.
|
||||
|
||||
| Variable | Description |
|
||||
|-|-|
|
||||
| domain | Defines URL for Teddit to use (i.e. teddit.domain.com). Defaults to **127.0.0.1** |
|
||||
| use_reddit_oauth | *Boolean* If true, "reddit_app_id" must be set with your own Reddit app ID. If false, Teddit uses Reddit's public API. Defaults to **false** |
|
||||
| cert_dir | Defines location of certificates if using HTTPS (i.e. /home/teddit/le/live/teddit.net). No trailing slash. |
|
||||
| theme | Automatically theme the user's browser experience. Options are *auto*, *dark*, *sepia*, or you can set *white* by setting the variable to empty ( '' ). Defaults to **auto** |
|
||||
| flairs_enabled | Enables the rendering of user and link flairs on Teddit. Defaults to **true** |
|
||||
| highlight_controversial | Enables controversial comments to be indicated by a typographical dagger (†). Defaults to **true** |
|
||||
| api_enabled | Teddit API feature. Might increase loads significantly on your instance. Defaults to **true** |
|
||||
| video_enabled | Enables video playback within Teddit. Defaults to **true** |
|
||||
| redis_enabled | Enables Redis caching. If disabled, does not allow for any caching of Reddit API calls. Defaults to **true** |
|
||||
| redis_db | Sets the redis DB name, if required |
|
||||
| redis_host | Sets the redis host location, if required. Defaults to **127.0.0.1** |
|
||||
| redis_password | Sets the redis password, if required |
|
||||
| redis_port | Sets the redis port, if required. Defaults to **6379** |
|
||||
| ssl_port | Sets the SSL port Teddit listens on. Defaults to **8088** |
|
||||
| nonssl_port | Sets the non-SSL port Teddit listens on. Defaults to **8080** |
|
||||
| listen_address | Sets the address Teddit listens for requests on. Defaults to **0.0.0.0** |
|
||||
| https_enabled | *Boolean* Sets whether or not to enable HTTPS for Teddit. Defaults to **false** |
|
||||
| redirect_http_to_https | *Boolean* Sets whether to force redirection from HTTP to HTTPS. Defaults to **false** |
|
||||
| redirect_www | *Boolean* Redirects from www to non-www URL. For example, if true, Teddit will redirect https://www.teddit.com to https://teddit.com. Defaults to **false** |
|
||||
| use_compression | *Boolean* If set to true, Teddit will use the [https://github.com/expressjs/compression](Node.js compression middleware) to compress HTTP requests with deflate/gzip. Defaults to **true** |
|
||||
| use_view_cache | *Boolean* If this is set to true, view template compilation caching is enabled. Defaults to **false** |
|
||||
| use_helmet | *Boolean* Recommended to be true when using https. Defaults to **false** |
|
||||
| use_helmet_hsts | *Boolean* Recommended to be true when using https. Defaults to **false** |
|
||||
| trust_proxy | *Boolean* Enable trust_proxy if you are using a reverse proxy like nginx or traefik. Defaults to **false** |
|
||||
| trust_proxy_address | Location of trust_proxy. Defaults to **127.0.0.1** |
|
||||
| nsfw_enabled | *Boolean* Enable NSFW (over 18) content. If false, a warning is shown to the user before opening any NSFW post. When the NFSW content is disabled, NSFW posts are hidden from subreddits and from user page feeds. Note: Users can set this to true or false from their preferences. Defaults to **true** |
|
||||
| post_comments_sort | Defines default sort preference. Options are *confidence* (default sorting option in Reddit), *top*, *new*, *controversal*, *old*, *random*, *qa*, *live*. Defaults to **confidence** |
|
||||
| reddit_app_id | If "use_reddit_oauth" config key is set to true, you have to obtain your Reddit app ID. For testing purposes it's okay to use this project's default app ID. Create your Reddit app here: https://old.reddit.com/prefs/apps/. Make sure to create an "installed app" type of app. Default is **ABfYqdDc9qPh1w** |
|
||||
|
||||
### Manual
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue