gochan/gochan
1
0
Fork 0
mirror of https://github.com/Eggbertx/gochan.git synced 2025-08-08 19:36:24 -07:00
Code Releases Activity

Automatically update configuration documentation

Browse source
This commit is contained in:
Eggbertx 2025-03-08 07:25:27 +00:00 • committed by github-actions[bot]
parent 8ec6b64b1b
commit 1cb0cfb004
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
config.md
View file

@ -33,8 +33,6 @@ FirstPage |[]string |No |["index.html", "fir
Username |string |No | |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 |No |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 |No |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 |No |false |Lockdown prevents users from posting if true Default: false
LockdownMessage |string |No |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 |No |Gochan |SiteName is the name of the site, displayed in the title and front page header Default: Gochan
SiteSlogan |string |No | |SiteSlogan is the community slogan displayed on the front page below the site name
MaxRecentPosts |int |No |15 |MaxRecentPosts is the number of recent posts to display on the front page Default: 15
@ -51,6 +49,8 @@ InheritGlobalStyles |bool |Yes |true
Styles |[]Style |Yes | |Styles is a list of Gochan themes with Name and Filename fields, choosable by the user
DefaultStyle |string |Yes |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 |Yes | |Banners is a list of banners to display on the board's front page, with Filename, Width, and Height fields
Lockdown |bool |Yes |false |Lockdown prevents users from posting if true Default: false
LockdownMessage |string |Yes |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
DateTimeFormat |string |Yes |Mon, January 02, 2006 3:04:05 PM |DateTimeFormat is the human readable format to use for showing post timestamps. See [the official documentation](https://pkg.go.dev/time#Time.Format) for more information. Default: Mon, January 02, 2006 3:04:05 PM
ShowPosterID |bool |Yes |false |ShowPosterID determines whether to show the generated thread-unique poster ID in the post header (not yet implemented) Default: false
EnableSpoileredImages |bool |Yes |true |EnableSpoileredImages determines whether to allow users to spoiler images (not yet implemented) Default: true
@ -62,7 +62,7 @@ ThreadsPerPage |int |Yes |20
EnableGeoIP |bool |Yes |false |EnableGeoIP shows a dropdown box allowing the user to set their post flag as their country Default: false
EnableNoFlag |bool |Yes |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 |Yes | |CustomFlags is a list of non-geoip flags with Name (viewable to the user) and Flag (flag image filename) fields
MaxPostLength |int |Yes |2000 |MaxPostLength is the maximum number of characters allowed in a post Default: 2000
MaxMessageLength |int |Yes |2000 |MaxMessageLength is the maximum number of characters allowed in a post Default: 2000
ReservedTrips |map[string]string |Yes | |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 |Yes |20 |ThreadsPerPage is the number of threads to display per page Default: 20
RepliesOnBoardPage |int |Yes |3 |RepliesOnBoardPage is the number of replies to display on the board page Default: 3