Files
wiki/config.sample.yml
T

140 lines
5.0 KiB
YAML

#######################################################################
# Wiki.js - CONFIGURATION #
#######################################################################
# Full documentation + examples:
# https://next.js.wiki/docs/install
# ---------------------------------------------------------------------
# Port the server should listen to
# ---------------------------------------------------------------------
port: 3000
# ---------------------------------------------------------------------
# Database
# ---------------------------------------------------------------------
# PostgreSQL 16 or later required
db:
host: localhost
port: 5432
user: postgres
pass: postgres
db: postgres
schema: wiki
ssl: false
# Optional
# -> Uncomment lines you need below and set `auto` to false
# -> Full list of accepted options: https://nodejs.org/api/tls.html#tls_tls_createsecurecontext_options
sslOptions:
auto: true
# rejectUnauthorized: false
# ca: path/to/ca.crt
# cert: path/to/cert.crt
# key: path/to/key.pem
# pfx: path/to/cert.pfx
# passphrase: xyz123
#######################################################################
# ADVANCED OPTIONS #
#######################################################################
# Do not change unless you know what you are doing!
# ---------------------------------------------------------------------
# IP address the server should listen to
# ---------------------------------------------------------------------
# Leave 0.0.0.0 for all interfaces
bindIP: 0.0.0.0
# ---------------------------------------------------------------------
# Logging
# ---------------------------------------------------------------------
# Possible values: error, warn, info (default), debug
logLevel: info
# Output format for logging, possible values: default, json
logFormat: default
# ---------------------------------------------------------------------
# Offline Mode
# ---------------------------------------------------------------------
# Set to true if your server cannot access the internet. Wiki.js then
# makes no request of its own to upstream services:
# - Icons: icon sets cannot be added, and only icons the wiki has
# already stored can be used. The interface's own icons are built in
# and unaffected.
# - Locales: nothing is downloaded. Install a locale by uploading its
# file instead (Admin > Locale).
# - Update checks: skipped.
# Services you configure yourself (authentication providers, storage
# targets, mail, Akismet) are still contacted, since you chose them.
offline: false
# ---------------------------------------------------------------------
# Data Path
# ---------------------------------------------------------------------
# Writeable data path used for cache and temporary user uploads.
dataPath: ./data
# ---------------------------------------------------------------------
# Icons
# ---------------------------------------------------------------------
# Icons are fetched from the Iconify API the first time they are used, then
# stored in the database and served by this instance. Point this at a
# self-hosted Iconify API to keep icon lookups inside your network.
icons:
apiUrl: 'https://api.iconify.design'
# ---------------------------------------------------------------------
# Body Parser Limit
# ---------------------------------------------------------------------
# Maximum size of API requests body that can be parsed, in bytes.
# Does not affect file uploads. (default: 5242880 (5mb))
bodyParserLimit: 5242880
# ---------------------------------------------------------------------
# Scheduler
# ---------------------------------------------------------------------
scheduler:
# Maximum number of workers to run background cpu-intensive jobs.
# Leave 'auto' for one fewer than the CPUs available to the process (at
# least 1), which respects a container's CPU limit.
workers: auto
# ---------------------------------------------------------------------
# Database Connection Pool
# ---------------------------------------------------------------------
# Passed as-is to the PostgreSQL connection pool (node-postgres) of
# each instance, so any of its options is accepted:
# https://node-postgres.com/apis/pool
#
# `max` (default 10) is the one worth knowing: with several instances
# behind a load balancer, each opens up to `max` connections, and the
# total must stay under the server's `max_connections`. Three of each
# instance's connections are held open for good (event, scheduler and
# collaboration listeners), so `max` must be well above 3 or queries
# will wait for a connection that never comes free.
# Worker threads ignore this and use one connection each.
# pool:
# max: 10
# ---------------------------------------------------------------------
# Dev Mode
# ---------------------------------------------------------------------
# Settings when running in dev mode only
dev:
dropSchema: false
logQueries: false
port: 3001
hmrClientPort: 3001