wikijs-fork/config.sample.yml

148 lines
4.8 KiB
YAML
Raw Normal View History

#######################################################################
# Wiki.js - CONFIGURATION #
#######################################################################
2017-12-17 04:41:16 +00:00
# Full documentation + examples:
2019-10-06 18:55:22 +00:00
# https://docs.requarks.io/install
2016-08-17 00:56:55 +00:00
# ---------------------------------------------------------------------
2018-05-28 18:46:55 +00:00
# Port the server should listen to
# ---------------------------------------------------------------------
2016-08-17 00:56:55 +00:00
2018-11-04 17:55:21 +00:00
port: 3000
2016-08-17 00:56:55 +00:00
# ---------------------------------------------------------------------
2017-10-22 17:30:16 +00:00
# Database
2017-10-22 17:24:43 +00:00
# ---------------------------------------------------------------------
# Supported Database Engines:
# - postgres = PostgreSQL 9.5 or later
# - mysql = MySQL 8.0 or later (5.7.8 partially supported, refer to docs)
2018-09-08 19:49:36 +00:00
# - mariadb = MariaDB 10.2.7 or later
# - mssql = MS SQL Server 2012 or later
# - sqlite = SQLite 3.9 or later
2017-10-22 17:24:43 +00:00
2017-10-22 17:30:16 +00:00
db:
type: postgres
2019-12-30 21:18:23 +00:00
# PostgreSQL / MySQL / MariaDB / MS SQL Server only:
2017-10-22 17:30:16 +00:00
host: localhost
port: 5432
user: wikijs
pass: wikijsrocks
db: wiki
2019-06-01 04:23:07 +00:00
ssl: false
2019-12-30 21:18:23 +00:00
# Optional - PostgreSQL / MySQL / MariaDB only:
# -> 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
# Optional - PostgreSQL only:
schema: public
# SQLite only:
storage: path/to/database.sqlite
2017-10-22 17:24:43 +00:00
2019-01-30 06:30:05 +00:00
#######################################################################
# ADVANCED OPTIONS #
#######################################################################
# Do not change unless you know what you are doing!
# ---------------------------------------------------------------------
# SSL/TLS Settings
# ---------------------------------------------------------------------
# Consider using a reverse proxy (e.g. nginx) if you require more
# advanced options than those provided below.
ssl:
enabled: false
2020-01-12 03:33:19 +00:00
port: 3443
2019-01-30 06:30:05 +00:00
2020-01-12 03:33:19 +00:00
# Provider to use, possible values: custom, letsencrypt
provider: custom
# ++++++ For custom only ++++++
2019-01-30 06:30:05 +00:00
# Certificate format, either 'pem' or 'pfx':
format: pem
# Using PEM format:
key: path/to/key.pem
cert: path/to/cert.pem
# Using PFX format:
pfx: path/to/cert.pfx
# Passphrase when using encrypted PEM / PFX keys (default: null):
passphrase: null
# Diffie Hellman parameters, with key length being greater or equal
# to 1024 bits (default: null):
dhparam: null
2020-01-12 03:33:19 +00:00
# ++++++ For letsencrypt only ++++++
domain: wiki.yourdomain.com
2020-01-12 18:23:01 +00:00
subscriberEmail: admin@example.com
# ---------------------------------------------------------------------
# Database Pool Options
# ---------------------------------------------------------------------
# Refer to https://github.com/vincit/tarn.js for all possible options
pool:
# min: 2
# max: 10
2019-01-30 06:30:05 +00:00
# ---------------------------------------------------------------------
# IP address the server should listen to
# ---------------------------------------------------------------------
# Leave 0.0.0.0 for all interfaces
bindIP: 0.0.0.0
2017-12-17 04:41:16 +00:00
# ---------------------------------------------------------------------
# Log Level
# ---------------------------------------------------------------------
# Possible values: error, warn, info (default), verbose, debug, silly
logLevel: info
# ---------------------------------------------------------------------
# Log Format
# ---------------------------------------------------------------------
# Output format for logging, possible values: default, json
logFormat: default
2019-06-22 00:54:09 +00:00
# ---------------------------------------------------------------------
# Offline Mode
# ---------------------------------------------------------------------
# If your server cannot access the internet. Set to true and manually
# download the offline files for sideloading.
offline: false
# ---------------------------------------------------------------------
# High-Availability
# ---------------------------------------------------------------------
# Set to true if you have multiple concurrent instances running off the
# same DB (e.g. Kubernetes pods / load balanced instances). Leave false
2020-04-20 00:26:26 +00:00
# otherwise. You MUST be using PostgreSQL to use this feature.
ha: false
# ---------------------------------------------------------------------
# Data Path
# ---------------------------------------------------------------------
2019-12-30 21:18:23 +00:00
# Writeable data path used for cache and temporary user uploads.
dataPath: ./data
# ---------------------------------------------------------------------
# Body Parser Limit
# ---------------------------------------------------------------------
# Maximum size of API requests body that can be parsed. Does not affect
# file uploads.
bodyParserLimit: 5mb