2019-04-07 07:50:36 -05:00
|
|
|
#━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
|
|
# Misskey configuration
|
|
|
|
#━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
|
|
|
|
|
|
# ┌─────┐
|
|
|
|
#───┘ URL └─────────────────────────────────────────────────────
|
|
|
|
|
2018-10-01 21:59:12 -05:00
|
|
|
# Final accessible URL seen by a user.
|
|
|
|
url: https://example.tld/
|
|
|
|
|
2019-04-07 07:50:36 -05:00
|
|
|
# ┌───────────────────────┐
|
|
|
|
#───┘ Port and TLS settings └───────────────────────────────────
|
2018-10-01 21:59:12 -05:00
|
|
|
|
|
|
|
#
|
|
|
|
# Misskey supports two deployment options for public.
|
|
|
|
#
|
|
|
|
|
|
|
|
# Option 1: With Reverse Proxy
|
|
|
|
#
|
|
|
|
# +----- https://example.tld/ ------------+
|
|
|
|
# +------+ |+-------------+ +----------------+|
|
|
|
|
# | User | ---> || Proxy (443) | ---> | Misskey (3000) ||
|
|
|
|
# +------+ |+-------------+ +----------------+|
|
|
|
|
# +---------------------------------------+
|
2018-07-14 12:09:55 -05:00
|
|
|
#
|
2018-11-04 05:08:31 -06:00
|
|
|
# You need to setup reverse proxy. (eg. nginx)
|
2018-10-01 21:59:12 -05:00
|
|
|
# You do not define 'https' section.
|
|
|
|
|
|
|
|
# Option 2: Standalone
|
2018-07-14 12:09:55 -05:00
|
|
|
#
|
2018-10-01 21:59:12 -05: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.
|
2019-04-07 07:50:36 -05:00
|
|
|
#port: 3000 # A port that your Misskey server should listen.
|
2018-10-01 21:59:12 -05:00
|
|
|
|
|
|
|
# To use option 2, uncomment below lines.
|
2019-04-07 07:50:36 -05:00
|
|
|
#port: 443
|
2018-07-14 12:09:55 -05:00
|
|
|
|
2019-04-07 07:50:36 -05:00
|
|
|
#https:
|
|
|
|
# # path for certification
|
|
|
|
# key: /etc/letsencrypt/live/example.tld/privkey.pem
|
|
|
|
# cert: /etc/letsencrypt/live/example.tld/fullchain.pem
|
2018-07-14 09:20:30 -05:00
|
|
|
|
2019-04-07 07:50:36 -05:00
|
|
|
# ┌──────────────────────────┐
|
|
|
|
#───┘ PostgreSQL configuration └────────────────────────────────
|
2017-11-22 14:43:00 -06:00
|
|
|
|
2019-04-07 07:50:36 -05:00
|
|
|
db:
|
2017-11-22 14:43:00 -06:00
|
|
|
host: localhost
|
2019-04-07 07:50:36 -05:00
|
|
|
port: 5432
|
|
|
|
|
|
|
|
# Database name
|
2018-07-14 12:29:50 -05:00
|
|
|
db: misskey
|
2019-04-07 07:50:36 -05:00
|
|
|
|
|
|
|
# Auth
|
2018-07-14 08:42:44 -05:00
|
|
|
user: example-misskey-user
|
|
|
|
pass: example-misskey-pass
|
2017-11-22 14:43:00 -06:00
|
|
|
|
2019-04-07 07:50:36 -05:00
|
|
|
# ┌─────────────────────┐
|
|
|
|
#───┘ Redis configuration └─────────────────────────────────────
|
|
|
|
|
|
|
|
#redis:
|
|
|
|
# host: localhost
|
|
|
|
# port: 6379
|
|
|
|
# pass: example-pass
|
|
|
|
|
|
|
|
# ┌─────────────────────────────┐
|
|
|
|
#───┘ Elasticsearch configuration └─────────────────────────────
|
|
|
|
|
|
|
|
#elasticsearch:
|
|
|
|
# host: localhost
|
|
|
|
# port: 9200
|
|
|
|
# pass: null
|
|
|
|
|
|
|
|
# ┌────────────────────────────────────┐
|
|
|
|
#───┘ File storage (Drive) configuration └──────────────────────
|
|
|
|
|
2018-07-23 11:58:11 -05:00
|
|
|
drive:
|
2019-04-07 07:50:36 -05:00
|
|
|
storage: 'fs'
|
2018-07-23 11:58:11 -05:00
|
|
|
|
|
|
|
# OR
|
|
|
|
|
2018-07-24 18:01:12 -05:00
|
|
|
# storage: 'minio'
|
2018-07-23 11:58:11 -05:00
|
|
|
# bucket:
|
|
|
|
# prefix:
|
|
|
|
# config:
|
|
|
|
# endPoint:
|
|
|
|
# port:
|
2018-08-13 11:57:52 -05:00
|
|
|
# useSSL:
|
2018-07-23 11:58:11 -05:00
|
|
|
# accessKey:
|
|
|
|
# secretKey:
|
|
|
|
|
2018-07-26 03:42:08 -05: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 11:57:52 -05:00
|
|
|
# useSSL: true
|
2018-07-26 03:42:08 -05: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 11:57:52 -05:00
|
|
|
# useSSL: true
|
2018-07-26 03:42:08 -05:00
|
|
|
# accessKey: XXX
|
|
|
|
# secretKey: YYY
|
|
|
|
|
2019-04-07 07:50:36 -05:00
|
|
|
# ┌───────────────┐
|
|
|
|
#───┘ ID generation └───────────────────────────────────────────
|
2018-11-05 15:24:31 -06:00
|
|
|
|
2019-04-07 07:50:36 -05:00
|
|
|
# You can select the ID generation method.
|
|
|
|
# You don't usually need to change this setting, but you can
|
|
|
|
# change it according to your preferences.
|
2018-07-14 09:06:46 -05:00
|
|
|
|
2019-04-07 07:50:36 -05:00
|
|
|
# Available methods:
|
|
|
|
# aid1 ... Use AID for ID generation (with random 1 char)
|
|
|
|
# aid2 ... Use AID for ID generation (with random 2 chars)
|
|
|
|
# aid3 ... Use AID for ID generation (with random 3 chars)
|
|
|
|
# aid4 ... Use AID for ID generation (with random 4 chars)
|
|
|
|
# ulid ... Use ulid for ID generation
|
|
|
|
# objectid ... This is left for backward compatibility.
|
2018-10-11 01:50:27 -05:00
|
|
|
|
2019-04-07 07:50:36 -05:00
|
|
|
# AID(n) is the original ID generation method.
|
|
|
|
# The trailing n represents the number of random characters that
|
|
|
|
# will be suffixed.
|
|
|
|
# The larger n is the safer. If n is small, the possibility of
|
|
|
|
# collision at the same time increases, but there are also
|
|
|
|
# advantages such as shortening of the URL.
|
|
|
|
|
|
|
|
# ULID: Universally Unique Lexicographically Sortable Identifier.
|
|
|
|
# for more details: https://github.com/ulid/spec
|
|
|
|
# * Normally, AID should be sufficient.
|
|
|
|
|
|
|
|
# ObjectID is the method used in previous versions of Misskey.
|
|
|
|
# * Choose this if you are migrating from a previous Misskey.
|
|
|
|
|
|
|
|
id: 'aid2'
|
|
|
|
|
|
|
|
# ┌─────────────────────┐
|
|
|
|
#───┘ Other configuration └─────────────────────────────────────
|
|
|
|
|
|
|
|
# If enabled:
|
|
|
|
# The first account created is automatically marked as Admin.
|
|
|
|
autoAdmin: true
|
2018-07-14 12:22:02 -05:00
|
|
|
|
2019-02-06 04:36:44 -06:00
|
|
|
# Whether disable HSTS
|
|
|
|
#disableHsts: true
|
|
|
|
|
2018-07-27 13:55:41 -05:00
|
|
|
# Clustering
|
2018-10-11 01:50:27 -05:00
|
|
|
#clusterLimit: 1
|