diff --git a/doc/feeds.md b/doc/feeds.md index 2900fbd..9fd7268 100644 --- a/doc/feeds.md +++ b/doc/feeds.md @@ -179,3 +179,7 @@ This WILL be the nntpchan pastebin, but it's not implemented yet ctl=1 Allows you to recieve moderation notifications from other boards, it's also used for decentralized moderation + +##Alternative config location + +If you would like to have your feeds.ini somewhere other than in the working directory, you can set the `SRND_FEEDS_INI_PATH` environment variable. For example, if you would like to use `/etc/nntpchan/meems.ini`, edit `~/.profile` and add `export SRND_FEEDS_INI_PATH=/etc/nntpchan/meems.ini`. diff --git a/doc/srnd.md b/doc/srnd.md index 784280a..3a6139a 100644 --- a/doc/srnd.md +++ b/doc/srnd.md @@ -95,7 +95,7 @@ This is where you put the address and port that you would like the NNTP server t ####allow_attachments -* When this is set to `1` posters my attach images to their posts. +* When this is set to `1` posters may attach images to their posts. * When this is set to `0` posters may not attach images to their posts. ####require_tls @@ -105,8 +105,8 @@ This is where you put the address and port that you would like the NNTP server t ####anon_nntp -* When this is set to `1` bluh. -* When this is set to `0` bluh. +* When this is set to `1`, the SRNdv2 server will send unauthenticated peers its articles. +* When this is set to `0`, peers will need to be authenticated to sync articles. ##`[pprof]` @@ -114,9 +114,21 @@ All pprof-related settings. ####enable -* When this is set to `1` bluh. -* When this is set to `0` bluh. +* When this is set to `1` pprof is enabled. +* When this is set to `0` pprof is disabled. ####bind -FIXME +* Bind to an address and port for use with `go tool pprof` + +##`[frontend]` + +#####minimize_html +* `0`: do not minimize HTML +* `1`: minimize HTML + +##Placing configuration elsewhere + +By default, `srnd.ini` must be placed in the working directory (wherever you have the `srndv2` binary). If you want to place the `srnd.ini` config file elsewhere, you can define an environment varialbe in the `~/.profile` for the user that runs `srndv2`. + +If you would like to use, for example, `/etc/nntpchan/my_srnd_config.ini`, simply add `export SRND_INI_PATH=/etc/nntpchan/my_srnd_config.ini` to `~/.profile`.