1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/wikijs_ynh.git synced 2024-09-03 20:36:09 +02:00
wikijs_ynh/conf/config.sample.yml

142 lines
4.7 KiB
YAML
Raw Normal View History

2019-01-29 21:56:56 +01:00
#######################################################################
# Wiki.js - CONFIGURATION #
#######################################################################
# Full documentation + examples:
2019-11-21 23:46:42 +01:00
# https://docs.requarks.io/install
2019-01-29 21:56:56 +01:00
# ---------------------------------------------------------------------
# Port the server should listen to
# ---------------------------------------------------------------------
port: __PORT__
2019-01-29 21:56:56 +01:00
# ---------------------------------------------------------------------
# Database
# ---------------------------------------------------------------------
# Supported Database Engines:
# - postgres = PostgreSQL 9.5 or later
2019-05-28 23:09:29 +02:00
# - mysql = MySQL 8.0 or later (5.7.8 partially supported, refer to docs)
2019-01-29 21:56:56 +01:00
# - mariadb = MariaDB 10.2.7 or later
# - mssql = MS SQL Server 2012 or later
# - sqlite = SQLite 3.9 or later
db:
2019-01-30 02:25:32 +01:00
type: postgres
2020-02-09 12:22:19 +01:00
2019-01-29 21:56:56 +01:00
# PostgreSQL / MySQL / MariaDB / MS SQL Server only:
2019-01-30 01:41:05 +01:00
host: localhost
port: 5432
2019-01-29 22:07:31 +01:00
user: __DB_NAME__
2019-01-29 21:56:56 +01:00
pass: __DB_PWD__
db: __DB_NAME__
2019-07-15 21:01:19 +02:00
ssl: false
2020-02-09 12:22:19 +01: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
2019-01-29 21:56:56 +01:00
# SQLite only:
storage: path/to/database.sqlite
2019-02-21 18:34:49 +01: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-02-09 12:22:19 +01:00
port: 3443
# Provider to use, possible values: custom, letsencrypt
provider: custom
2019-02-21 18:34:49 +01:00
2020-02-09 12:22:19 +01:00
# ++++++ For custom only ++++++
2019-02-21 18:34:49 +01: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-02-09 12:22:19 +01:00
# ++++++ For letsencrypt only ++++++
domain: wiki.yourdomain.com
subscriberEmail: admin@example.com
2019-03-17 22:28:09 +01:00
2019-05-28 23:09:29 +02:00
# ---------------------------------------------------------------------
# Database Pool Options
# ---------------------------------------------------------------------
# Refer to https://github.com/vincit/tarn.js for all possible options
pool:
# min: 2
# max: 10
2019-02-21 18:34:49 +01:00
# ---------------------------------------------------------------------
# IP address the server should listen to
# ---------------------------------------------------------------------
# Leave 0.0.0.0 for all interfaces
bindIP: 0.0.0.0
2019-01-29 21:56:56 +01:00
# ---------------------------------------------------------------------
# Log Level
# ---------------------------------------------------------------------
# Possible values: error, warn, info (default), verbose, debug, silly
logLevel: info
2019-05-28 23:09:29 +02:00
# ---------------------------------------------------------------------
# Upload Limits
# ---------------------------------------------------------------------
2019-06-23 01:31:54 +02:00
# If you're using a reverse-proxy in front of Wiki.js, you must also
2019-05-28 23:09:29 +02:00
# change your proxy upload limits!
uploads:
# Maximum upload size in bytes per file (default: 5242880 (5 MB))
maxFileSize: 5242880
2020-02-09 12:22:19 +01:00
# Maximum file uploads per request (default: 10)
2019-05-28 23:09:29 +02:00
maxFiles: 10
2019-06-23 01:31:54 +02:00
# ---------------------------------------------------------------------
# Offline Mode
# ---------------------------------------------------------------------
# If your server cannot access the internet. Set to true and manually
# download the offline files for sideloading.
offline: false
2019-11-21 23:46:42 +01:00
2020-04-25 23:14:43 +02:00
# ---------------------------------------------------------------------
# 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
# otherwise. You MUST be using PostgreSQL to use this feature.
ha: false
2019-11-21 23:46:42 +01:00
# ---------------------------------------------------------------------
# Data Path
# ---------------------------------------------------------------------
2020-02-09 12:22:19 +01:00
# Writeable data path used for cache and temporary user uploads.
2019-11-21 23:46:42 +01:00
dataPath: ./data