From 77a72c57701630a48365be9ba204bc7c35b550eb Mon Sep 17 00:00:00 2001 From: wzeth Date: Fri, 17 Jun 2016 12:51:00 +0000 Subject: [PATCH 1/4] document frontend minimize_html feature --- doc/srnd.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/srnd.md b/doc/srnd.md index 784280a..0c03a8a 100644 --- a/doc/srnd.md +++ b/doc/srnd.md @@ -120,3 +120,9 @@ All pprof-related settings. ####bind FIXME + +##`[frontend]` + +#####minimize_html +* `0`: do not minimize HTML +* `1`: minimize HTML From b73c219e6b52153dcdac75ce3beb6ec37269173f Mon Sep 17 00:00:00 2001 From: wzeth Date: Sun, 19 Jun 2016 01:12:33 -0400 Subject: [PATCH 2/4] clarified anon_nntp and pprof --- doc/srnd.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/srnd.md b/doc/srnd.md index 0c03a8a..21a43e8 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,12 +114,12 @@ 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]` From e6967a75e76486a2fe6a11f3a87f2cac13bf26e6 Mon Sep 17 00:00:00 2001 From: wzeth Date: Mon, 20 Jun 2016 09:59:03 +0000 Subject: [PATCH 3/4] document custom config locations --- doc/srnd.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/srnd.md b/doc/srnd.md index 21a43e8..3a6139a 100644 --- a/doc/srnd.md +++ b/doc/srnd.md @@ -126,3 +126,9 @@ All pprof-related settings. #####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`. From 3cc04a6cad62567bd13a472f355eb37cefe9df3a Mon Sep 17 00:00:00 2001 From: wzeth Date: Mon, 20 Jun 2016 10:09:24 +0000 Subject: [PATCH 4/4] document SRND_FEEDS_INI_PATH environment variable --- doc/feeds.md | 4 ++++ 1 file changed, 4 insertions(+) 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`.