misskey/.config/example.yml

116 lines
2.4 KiB
YAML
Raw Normal View History

# Final accessible URL seen by a user.
url: https://example.tld/
### Port and TLS settings ######################################
#
# Misskey supports two deployment options for public.
#
# Option 1: With Reverse Proxy
#
# +----- https://example.tld/ ------------+
# +------+ |+-------------+ +----------------+|
# | User | ---> || Proxy (443) | ---> | Misskey (3000) ||
# +------+ |+-------------+ +----------------+|
# +---------------------------------------+
2018-07-14 10:09:55 -07:00
#
2018-11-04 03:08:31 -08:00
# You need to setup reverse proxy. (eg. nginx)
# You do not define 'https' section.
# Option 2: Standalone
2018-07-14 10:09:55 -07:00
#
# +- https://example.tld/ -+
# +------+ | +---------------+ |
# | User | ---> | | Misskey (443) | |
# +------+ | +---------------+ |
# +------------------------+
#
# You need to run Misskey as root.
# You need to set Certificate in 'https' section.
# To use option 1, uncomment below line.
# port: 3000 # A port that your Misskey server should listen.
# To use option 2, uncomment below lines.
# port: 443
2018-07-14 10:15:45 -07:00
#
# https:
# # path for certification
# key: /etc/letsencrypt/live/example.tld/privkey.pem
# cert: /etc/letsencrypt/live/example.tld/fullchain.pem
2018-07-14 10:09:55 -07:00
################################################################
2018-07-14 07:20:30 -07:00
mongodb:
host: localhost
port: 27017
2018-07-14 10:29:50 -07:00
db: misskey
2018-07-14 06:42:44 -07:00
user: example-misskey-user
pass: example-misskey-pass
2018-07-23 09:58:11 -07:00
drive:
storage: 'db'
# OR
2018-07-24 16:01:12 -07:00
# storage: 'minio'
2018-07-23 09:58:11 -07:00
# bucket:
# prefix:
# config:
# endPoint:
# port:
2018-08-13 09:57:52 -07:00
# useSSL:
2018-07-23 09:58:11 -07:00
# accessKey:
# secretKey:
2018-07-26 01:42:08 -07:00
# S3 example
# storage: 'minio'
# bucket: bucket-name
# prefix: files
# config:
# endPoint: s3-us-west-2.amazonaws.com
# region: us-west-2
2018-08-13 09:57:52 -07:00
# useSSL: true
2018-07-26 01:42:08 -07:00
# accessKey: XXX
# secretKey: YYY
# S3 example (with CDN, custom domain)
# storage: 'minio'
# bucket: drive.example.com
# prefix: files
# baseUrl: https://drive.example.com
# config:
# endPoint: s3-us-west-2.amazonaws.com
# region: us-west-2
2018-08-13 09:57:52 -07:00
# useSSL: true
2018-07-26 01:42:08 -07:00
# accessKey: XXX
# secretKey: YYY
2018-11-05 13:24:31 -08:00
# If enabled:
# The first account created is automatically marked as Admin.
autoAdmin: true
2018-07-14 07:06:46 -07:00
#
# Below settings are optional
#
2018-10-10 23:50:27 -07:00
# Redis
#redis:
# host: localhost
# port: 6379
# pass: example-pass
2018-07-14 10:22:02 -07:00
# Elasticsearch
2018-10-10 23:50:27 -07:00
#elasticsearch:
# host: localhost
# port: 9200
# pass: null
2018-07-14 10:22:02 -07:00
2019-02-06 02:36:44 -08:00
# Whether disable HSTS
#disableHsts: true
# Clustering
2018-10-10 23:50:27 -07:00
#clusterLimit: 1