config.md

Configuration

See gochan.example.json for an example gochan.json.

Make sure gochan has read-write permission for DocumentRoot and LogDir and read permission for TemplateDir

Field	Type	Default	Info
ListenAddress	string		ListenAddress is the IP address or domain name that the server will listen on
Port	int	80	Port is the port that the server will listen on Default: 80
UseFastCGI	bool	false	UseFastCGI tells the server to listen on FastCGI instead of HTTP if true Default: false
DocumentRoot	string		DocumentRoot is the path to the directory that contains the served static files
TemplateDir	string		TemplateDir is the path to the directory that contains the template files
LogDir	string		LogDir is the path to the directory that contains the log files. It must be writable by the server and will be created if it doesn't exist
Plugins	[]string		Plugins is a list of paths to plugins to be loaded on startup. In Windows, only .lua plugins are supported. In Unix, .so plugins are also supported, but they must be compiled with the same Go version as the server and must be compiled in plugin mode
WebRoot	string	/	WebRoot is the base URL path that the server will serve files and generated pages from. Default: /
SiteHost	string		SiteHost is the publicly accessible domain name or IP address of the site, e.g. "example.com" used for anti-spam checking
CheckRequestReferer	bool	true	CheckRequestReferer tells the server to validate the Referer header from requests to prevent CSRF attacks. Default: true
Verbose	bool		Verbose currently is not used and may be removed, to be replaced with more granular logging options
RandomSeed	string		RandomSeed is a random string used for generating secure tokens. It will be generated if not set and must not be changed
DBtype	string		DBtype is the type of SQL database to use. Currently supported values are "mysql", "postgres", and "sqlite3"
DBhost	string		DBhost is the hostname or IP address of the SQL server, or the path to the SQLite database file. To connect to a MySQL database, set DBhost to "x.x.x.x:3306" (replacing x.x.x.x with your database server's IP or domain) or a different port, if necessary. You can also use a UNIX socket if you have it set up, like "unix(/var/run/mysqld/mysqld.sock)". To connect to a PostgreSQL database, set DBhost to the IP address or hostname. Using a UNIX socket may work as well, but it is currently untested.
DBname	string		DBname is the name of the SQL database to connect to
DBusername	string		DBusername is the username to use when authenticating with the SQL server
DBpassword	string		DBpassword is the password to use when authenticating with the SQL server
DBprefix	string		DBprefix is the prefix to add to table names in the database. It is not requried but may be useful if you need to share a database. Once you set it and do the initial setup, do not change it, as gochan will think the tables are missing and try to recreate them.
DBTimeoutSeconds	int	15	DBTimeoutSeconds sets the timeout for SQL queries in seconds, 0 means no timeout. Default: 15
DBMaxOpenConnections	int	10	DBMaxOpenConnections is the maximum number of open connections to the database connection pool. Default: 10
DBMaxIdleConnections	int	10	DBMaxIdleConnections is the maximum number of idle connections to the database connection pool. Default: 10
DBConnMaxLifetimeMin	int	3	DBConnMaxLifetimeMin is the maximum lifetime of a connection in minutes. Default: 3
FirstPage	[]string	["index.html", "firstrun.html", "1.html"]	FirstPage is a list of possible filenames to look for if a directory is requested Default: ["index.html", "firstrun.html", "1.html"]
Username	string		Username is the name of the user that the server will run as, if set, or the current user if empty or unset. It must be a valid user on the system if it is set
CookieMaxAge	string	1y	CookieMaxAge is the parsed max age duration of cookies, e.g. "1 year 2 months 3 days 4 hours" or "1y2mo3d4h". Default: 1y
StaffSessionDuration	string	3mo	StaffSessionDuration is the parsed max age duration of staff session cookies, e.g. "1 year 2 months 3 days 4 hours" or "1y2mo3d4h". Default: 3mo
Lockdown	bool	false	Lockdown prevents users from posting if true Default: false
LockdownMessage	string	This imageboard has temporarily disabled posting. We apologize for the inconvenience	LockdownMessage is the message displayed to users if they try to cretae a post when the site is in lockdown Default: This imageboard has temporarily disabled posting. We apologize for the inconvenience
SiteName	string	Gochan	SiteName is the name of the site, displayed in the title and front page header Default: Gochan
SiteSlogan	string		SiteSlogan is the community slogan displayed on the front page below the site name
MaxRecentPosts	int	15	MaxRecentPosts is the number of recent posts to display on the front page Default: 15
RecentPostsWithNoFile	bool	false	RecentPostsWithNoFile determines whether to include posts with no file in the recent posts list Default: false
EnableAppeals	bool	true	EnableAppeals determines whether to allow users to appeal bans Default: true
MinifyHTML	bool	true	MinifyHTML tells the server to minify HTML output before sending it to the client Default: true
MinifyJS	bool	true	MinifyJS tells the server to minify JavaScript and JSON output before sending it to the client Default: true
GeoIPType	string		GeoIPType is the type of GeoIP database to use. Currently only "mmdb" is supported, though other types may be provided by plugins
GeoIPOptions	map[string]any		GeoIPOptions is a map of options to pass to the GeoIP plugin
Captcha	CaptchaConfig		Captcha options for spam prevention. Currently only hcaptcha is supported
FingerprintVideoThumbnails	bool	false	FingerprintVideoThumbnails determines whether to use video thumbnails for image fingerprinting. If false, the video file will not be checked by fingerprinting filters Default: false
FingerprintHashLength	int	16	FingerprintHashLength is the length of the hash used for image fingerprinting Default: 16
Type	string		Type is the type of captcha to use. Currently only "hcaptcha" is supported
OnlyNeededForThreads	bool		OnlyNeededForThreads determines whether to require a captcha only when creating a new thread, or for all posts
SiteKey	string		SiteKey is the public key for the captcha service. Usage depends on the captcha service
AccountSecret	string		AccountSecret is the secret key for the captcha service. Usage depends on the captcha service
InheritGlobalStyles	bool	true	InheritGlobalStyles determines whether to use the global styles in addition to the board's styles, as opposed to only the board's styles Default: true
Styles	[]Style		Styles is a list of Gochan themes with Name and Filename fields, choosable by the user
DefaultStyle	string	pipes.css	DefaultStyle is the filename of the default style to use for the board or the site. If it is not set, the first style in the Styles list will be used Default: pipes.css
Banners	[]PageBanner		Banners is a list of banners to display on the board's front page, with Filename, Width, and Height fields
DateTimeFormat	string	Mon, January 02, 2006 3:04:05 PM	DateTimeFormat is the human readable format to use for showing post timestamps. See the official documentation for more information. Default: Mon, January 02, 2006 3:04:05 PM
ShowPosterID	bool	false	ShowPosterID determines whether to show the generated thread-unique poster ID in the post header (not yet implemented) Default: false
EnableSpoileredImages	bool	true	EnableSpoileredImages determines whether to allow users to spoiler images (not yet implemented) Default: true
EnableSpoileredThreads	bool	true	EnableSpoileredThreads determines whether to allow users to spoiler threads (not yet implemented) Default: true
Worksafe	bool	true	Worksafe determines whether the board is worksafe or not. If it is set to true, threads cannot be marked NSFW Default: true
Cooldowns	BoardCooldowns		Cooldowns is used to prevent spamming by setting the number of seconds the user must wait before creating new threads or replies
RenderURLsAsLinks	bool	true	RenderURLsAsLinks determines whether to render URLs as clickable links in posts Default: true
ThreadsPerPage	int	20	ThreadsPerPage is the number of threads to display per page Default: 20
EnableGeoIP	bool	false	EnableGeoIP shows a dropdown box allowing the user to set their post flag as their country Default: false
EnableNoFlag	bool	false	EnableNoFlag allows the user to post without a flag. It is only used if EnableGeoIP or CustomFlags is true Default: false
CustomFlags	[]geoip.Country		CustomFlags is a list of non-geoip flags with Name (viewable to the user) and Flag (flag image filename) fields
MaxPostLength	int	2000	MaxPostLength is the maximum number of characters allowed in a post Default: 2000
ReservedTrips	map[string]string		ReservedTrips is used for reserving secure tripcodes. It should be a map of input strings to output tripcode strings. For example, if you have {"abcd":"WXYZ"} and someone posts with the name Name##abcd, their name will instead show up as Name!!WXYZ on the site.
ThreadsPerPage	int	20	ThreadsPerPage is the number of threads to display per page Default: 20
RepliesOnBoardPage	int	3	RepliesOnBoardPage is the number of replies to display on the board page Default: 3
StickyRepliesOnBoardPage	int	1	StickyRepliesOnBoardPage is the number of replies to display on the board page for sticky threads Default: 1
NewThreadsRequireUpload	bool	false	NewThreadsRequireUpload determines whether to require an upload to create a new thread Default: false
EnableCyclicThreads	bool	true	EnableCyclicThreads allows users to create threads that have a maximum number of replies before the oldest reply is deleted Default: true
CyclicThreadNumPosts	int	500	CyclicThreadNumPost determines the number of posts a cyclic thread can have before the oldest post is deleted Default: 500
BanColors	map[string]string		BanColors is a list of colors to use for the ban message with the staff name as the key. If the staff name is not found in the list, the default style color will be used.
BanMessage	string	USER WAS BANNED FOR THIS POST	BanMessage is the default message shown on a post that a user was banned for Default: USER WAS BANNED FOR THIS POST
EmbedWidth	int	200	EmbedWidth is the width of embedded external videos Default: 200
EmbedHeight	int	164	EmbedHeight is the height of embedded external videos Default: 164
EnableEmbeds	bool	false	EnableEmbeds determines whether to allow embedding of external videos. It is not yet implemented Default: false
ImagesOpenNewTab	bool	true	ImagesOpenNewTab determines whether to open images in a new tab when an image link is clicked Default: true
NewTabOnExternalLinks	bool	true	NewTabOnExternalLinks determines whether to open external links in a new tab Default: true
DisableBBcode	bool	false	DisableBBcode will disable BBCode to HTML conversion if true Default: false
AllowDiceRerolls	bool	false	AllowDiceRerolls determines whether to allow users to edit posts to reroll dice Default: false
RejectDuplicateImages	bool	false	RejectDuplicateImages determines whether to reject images that have already been uploaded Default: false
ThumbWidth	int	200	ThumbWidth is the maximum width that thumbnails in the top thread post will be scaled down to Default: 200
ThumbHeight	int	200	ThumbHeight is the maximum height that thumbnails in the top thread post will be scaled down to Default: 200
ThumbWidthReply	int	125	ThumbWidthReply is the maximum width that thumbnails in thread replies will be scaled down to Default: 125
ThumbHeightReply	int	125	ThumbHeightReply is the maximum height that thumbnails in thread replies will be scaled down to Default: 125
ThumbWidthCatalog	int	50	ThumbWidthCatalog is the maximum width that thumbnails on the board catalog page will be scaled down to Default: 50
ThumbHeightCatalog	int	50	ThumbHeightCatalog is the maximum height that thumbnails on the board catalog page will be scaled down to Default: 50
AllowOtherExtensions	map[string]string		AllowOtherExtensions is a map of file extensions to use for uploads that are not images or videos The key is the extension (e.g. ".pdf") and the value is the filename of the thumbnail to use in /static
StripImageMetadata	string		StripImageMetadata sets what (if any) metadata to remove from uploaded images using exiftool. Valid values are "", "none" (has the same effect as ""), "exif", or "all" (for stripping all metadata)
ExiftoolPath	string		ExiftoolPath is the path to the exiftool command. If unset or empty, the system path will be used to find it

Example options for GeoIPOptions:

"GeoIPType": "mmdb",
"GeoIPOptions": {
	"dbLocation": "/usr/share/geoip/GeoIP2.mmdb",
	"isoCode": "en" // optional
}

CustomFlags is an array with custom post flags, selectable via dropdown. The Flag value is assumed to be a file in /static/flags/. Example:

"CustomFlags": [
	{"Flag":"california.png", "Name": "California"},
	{"Flag":"cia.png", "Name": "CIA"},
	{"Flag":"lgbtq.png", "Name": "LGBTQ"},
	{"Flag":"ms-dos.png", "Name": "MS-DOS"},
	{"Flag":"stallman.png", "Name": "Stallman"},
	{"Flag":"templeos.png", "Name": "TempleOS"},
	{"Flag":"tux.png", "Name": "Linux"},
	{"Flag":"windows9x.png", "Name": "Windows 9x"}
]

PageBanner

PageBanner represents the filename and dimensions of a banner image to display on board and thread pages

Field	Type	Info
Filename	string	Filename is the name of the image file to display as seen by the browser
Width	int	Width is the width of the image in pixels
Height	int	Height is the height of the image in pixels

BoardCooldowns

Field	Type	Default	Info
NewThread	int	30	NewThread is the number of seconds the user must wait before creating new threads. Default: 30
Reply	int	7	NewReply is the number of seconds the user must wait after replying to a thread before they can create another reply. Default: 7
ImageReply	int	7	NewImageReply is the number of seconds the user must wait after replying to a thread with an upload before they can create another reply. Default: 7

geoip.Country

Country represents the country data (or custom flag data) used by gochan.

Field	Type	Info
Flag	string	Flag is the country abbreviation for standard geoip countries, or the filename accessible in /static/flags/{flag} for custom flags
Name	string	Name is the configured flag name that shows up in the dropdown box and the image alt text