2016-06-04 23:59:04 +05:00
`srnd.ini`
==========
2015-10-07 23:04:50 +05:00
2016-06-05 13:12:50 +05:00
`srnd.ini` is the configuration file for your NNTPChan node. Some configuration can be done initially through the web-interface (for now hopefully) but there is more that can be done by tweaking your `srnd.ini` file.
Below is the default state of the file. We will explain each section below.
````
[nntp]
instance_name=test.srndv2.tld
bind=127.0.0.1:1199
sync_on_start=1
allow_anon=0
allow_anon_attachments=0
allow_attachments=1
require_tls=1
anon_nntp=0
2016-06-20 20:18:19 +05:00
feeds=/etc/nntpchan/feeds.d
2016-06-05 13:12:50 +05:00
[pprof]
enable=0
bind=127.0.0.1:17000
[crypto]
tls-keyname=overchan
tls-hostname=!!put-hostname-or-ip-of-server-here
tls-trust-dir=certs
[articles]
store_dir=articles
incoming_dir=/tmp/articles
attachments_dir=webroot/img
thumbs_dir=webroot/thm
convert_bin=/usr/bin/convert
ffmpegthumbnailer_bin=/usr/bin/ffmpeg
sox_bin=/usr/bin/sox
compression=0
[database]
type=redis
schema=single
host=localhost
port=6379
user
password
[cache]
type=file
[frontend]
enable=1
allow_files=1
regen_on_start=0
regen_threads=1
bind=[::]:18000
name=web.srndv2.test
webroot=webroot
prefix=/
static_files=contrib
templates=contrib/templates/default
translations=contrib/translations
locale=en
domain=localhost
json-api=0
json-api-username=fucking-change-this-value
json-api-password=seriously-fucking-change-this-value
api-secret=RTZP5JZ2XGYCY===
````
##`[nntp]`
All NNTP server-related settings.
####instance_name
This is the name for your NNTP server. I don't really know what the point of it is, but hey its there (FIXME).
####bind
This is where you put the address and port that you would like the NNTP server to run on where `x` is the address and `y` is the port in `bind=x:y` .
####sync_on_start
* When this is set to `1` your NNTP server will sync articles with its peers on startup.
* When this is set to `0` then no syncing will take place on statup.
####allow_anon
* When this is set to `1` bluh.
* When this is set to `0` bluh.
####allow_anon_attachments
* When this is set to `1` bluh.
* When this is set to `0` bluh.
####allow_attachments
2016-06-19 10:12:33 +05:00
* When this is set to `1` posters may attach images to their posts.
2016-06-05 13:12:50 +05:00
* When this is set to `0` posters may not attach images to their posts.
####require_tls
* When this is set to `1` then any NNTP connection to this server will need to use TLS.
* When this is set to `0` then any NNTP connection to this server will not need to use TLS (but it could? - FIXME)
####anon_nntp
2016-06-19 10:12:33 +05:00
* 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.
2016-06-05 13:12:50 +05:00
2016-06-20 20:21:46 +05:00
####feeds
* Feeds configurations can optionally be stored in a directory of your choosing (the default is `feeds.d` in the working directory). Any ini files located in this directory will be loaded.
2016-06-20 20:18:19 +05:00
2016-06-05 13:12:50 +05:00
##`[pprof]`
All pprof-related settings.
####enable
2016-06-19 10:12:33 +05:00
* When this is set to `1` pprof is enabled.
* When this is set to `0` pprof is disabled.
2016-06-05 13:12:50 +05:00
####bind
2016-06-19 10:12:33 +05:00
* Bind to an address and port for use with `go tool pprof`
2016-06-17 17:51:00 +05:00
##`[frontend]`
#####minimize_html
* `0` : do not minimize HTML
* `1` : minimize HTML
2016-06-20 14:59:03 +05:00
##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` .
