Configuration

openKB can be configured using a config.js file located: /routes/config.js or by using the /settings page of the admin panel.

The following settings are used by openKB:

Setting Description
num_top_results Sets the number of results shown on the home page
date_format Sets the global date formatting. Uses moment.js date formatting, see more here: http://momentjs.com/docs/#/displaying
show_view_count Shows the view count next to the results on the homepage and search
show_published_date Shows the published date next to the results on the homepage and search
sort_by The order to sort articles
website_title The title of your website
show_featured_articles Whether to show any articles set to featured in a sidebar
show_featured_in_article Whether to show any articles set to featured in a sidebar when viewing an article
featured_articles_count The number of featured articles shown
password_protect Setting to “true” will require a user to login before viewing ANY pages
show_kb_meta Whether to show article meta data including published date, last updated date, author etc
suggest_allowed If enabled non authenticated users can submit article suggestions for approval
show_author_email Controls whether the authors email address is displayed in the meta. Requires “Show article meta data” to be true.
enable_mermaid_charts Whether to allow Mermaid charts within articles
app_context Allows for the website to be run from a non root path. Eg: http://127.0.0.1:4444/openkb/
links_blank_page Controls whether links within articles open a new page (tab)
database The database type to use. See Database setup
Was this article helpful? Votes: 20
Article details:
Published date: 29/09/2015 8:48AM
Last updated: 14/09/2016 2:41PM (Mark)
Share article: 
Author: Mark Moffat
Permalink: http://openkb.markmoffat.com/kb/configuration
config | config.js | openkb |