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-07-03 06:31:52 -05:00
|
|
|
# ONCE YOU HAVE STARTED THE INSTANCE, DO NOT CHANGE THE
|
|
|
|
# URL SETTINGS AFTER THAT!
|
|
|
|
|
2019-04-07 07:50:36 -05:00
|
|
|
# ┌───────────────────────┐
|
|
|
|
#───┘ Port and TLS settings └───────────────────────────────────
|
2018-10-01 21:59:12 -05:00
|
|
|
|
|
|
|
#
|
2022-03-08 08:23:18 -06:00
|
|
|
# Misskey requires a reverse proxy to support HTTPS connections.
|
2018-10-01 21:59:12 -05:00
|
|
|
#
|
|
|
|
# +----- https://example.tld/ ------------+
|
|
|
|
# +------+ |+-------------+ +----------------+|
|
|
|
|
# | User | ---> || Proxy (443) | ---> | Misskey (3000) ||
|
|
|
|
# +------+ |+-------------+ +----------------+|
|
|
|
|
# +---------------------------------------+
|
2018-07-14 12:09:55 -05:00
|
|
|
#
|
2022-03-08 08:23:18 -06:00
|
|
|
# You need to set up a reverse proxy. (e.g. nginx)
|
|
|
|
# An encrypted connection with HTTPS is highly recommended
|
|
|
|
# because tokens may be transferred in GET requests.
|
2018-07-14 12:09:55 -05:00
|
|
|
|
2022-03-08 08:23:18 -06:00
|
|
|
# The port that your Misskey server should listen on.
|
|
|
|
port: 3000
|
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-06-11 06:49:08 -05:00
|
|
|
# Whether disable Caching queries
|
|
|
|
#disableCache: true
|
|
|
|
|
2019-05-23 13:26:56 -05:00
|
|
|
# Extra Connection options
|
|
|
|
#extra:
|
|
|
|
# ssl: true
|
|
|
|
|
2019-04-07 07:50:36 -05:00
|
|
|
# ┌─────────────────────┐
|
|
|
|
#───┘ Redis configuration └─────────────────────────────────────
|
|
|
|
|
2019-04-13 05:19:32 -05:00
|
|
|
redis:
|
|
|
|
host: localhost
|
|
|
|
port: 6379
|
2022-06-24 05:22:19 -05:00
|
|
|
#family: 0 # 0=Both, 4=IPv4, 6=IPv6
|
2019-04-13 05:19:32 -05:00
|
|
|
#pass: example-pass
|
2019-11-04 05:48:07 -06:00
|
|
|
#prefix: example-prefix
|
|
|
|
#db: 1
|
2019-04-07 07:50:36 -05:00
|
|
|
|
2023-04-06 21:20:14 -05:00
|
|
|
#redisForPubsub:
|
|
|
|
# host: localhost
|
|
|
|
# port: 6379
|
|
|
|
# #family: 0 # 0=Both, 4=IPv4, 6=IPv6
|
|
|
|
# #pass: example-pass
|
|
|
|
# #prefix: example-prefix
|
|
|
|
# #db: 1
|
|
|
|
|
2023-04-06 21:27:01 -05:00
|
|
|
#redisForJobQueue:
|
|
|
|
# host: localhost
|
|
|
|
# port: 6379
|
|
|
|
# #family: 0 # 0=Both, 4=IPv4, 6=IPv6
|
|
|
|
# #pass: example-pass
|
|
|
|
# #prefix: example-prefix
|
|
|
|
# #db: 1
|
|
|
|
|
2019-04-07 07:50:36 -05:00
|
|
|
# ┌─────────────────────────────┐
|
|
|
|
#───┘ Elasticsearch configuration └─────────────────────────────
|
|
|
|
|
|
|
|
#elasticsearch:
|
|
|
|
# host: localhost
|
|
|
|
# port: 9200
|
2020-03-20 00:00:34 -05:00
|
|
|
# ssl: false
|
|
|
|
# user:
|
|
|
|
# pass:
|
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:
|
2019-04-13 11:40:29 -05:00
|
|
|
# aid ... Short, Millisecond accuracy
|
|
|
|
# meid ... Similar to ObjectID, Millisecond accuracy
|
|
|
|
# ulid ... Millisecond accuracy
|
|
|
|
# objectid ... This is left for backward compatibility
|
2019-04-07 07:50:36 -05:00
|
|
|
|
2019-04-24 22:24:18 -05:00
|
|
|
# ONCE YOU HAVE STARTED THE INSTANCE, DO NOT CHANGE THE
|
|
|
|
# ID SETTINGS AFTER THAT!
|
|
|
|
|
2019-04-13 11:08:26 -05:00
|
|
|
id: 'aid'
|
2019-04-07 07:50:36 -05:00
|
|
|
|
|
|
|
# ┌─────────────────────┐
|
|
|
|
#───┘ Other configuration └─────────────────────────────────────
|
|
|
|
|
2019-02-06 04:36:44 -06:00
|
|
|
# Whether disable HSTS
|
|
|
|
#disableHsts: true
|
|
|
|
|
2019-08-26 15:33:24 -05:00
|
|
|
# Number of worker processes
|
2018-10-11 01:50:27 -05:00
|
|
|
#clusterLimit: 1
|
2019-05-07 03:49:25 -05:00
|
|
|
|
2019-08-26 15:33:24 -05:00
|
|
|
# Job concurrency per worker
|
2019-10-22 05:30:18 -05:00
|
|
|
# deliverJobConcurrency: 128
|
|
|
|
# inboxJobConcurrency: 16
|
2019-08-26 15:33:24 -05:00
|
|
|
|
2020-01-19 23:14:09 -06:00
|
|
|
# Job rate limiter
|
|
|
|
# deliverJobPerSec: 128
|
|
|
|
# inboxJobPerSec: 16
|
|
|
|
|
|
|
|
# Job attempts
|
|
|
|
# deliverJobMaxAttempts: 12
|
|
|
|
# inboxJobMaxAttempts: 8
|
|
|
|
|
2019-05-07 03:49:25 -05:00
|
|
|
# IP address family used for outgoing request (ipv4, ipv6 or dual)
|
|
|
|
#outgoingAddressFamily: ipv4
|
2019-08-29 18:29:46 -05:00
|
|
|
|
2019-09-01 14:42:52 -05:00
|
|
|
# Proxy for HTTP/HTTPS
|
|
|
|
#proxy: http://127.0.0.1:3128
|
|
|
|
|
2023-01-12 06:03:02 -06:00
|
|
|
proxyBypassHosts:
|
|
|
|
- api.deepl.com
|
|
|
|
- api-free.deepl.com
|
|
|
|
- www.recaptcha.net
|
|
|
|
- hcaptcha.com
|
|
|
|
- challenges.cloudflare.com
|
2020-04-12 06:32:34 -05:00
|
|
|
|
2019-09-01 14:42:52 -05:00
|
|
|
# Proxy for SMTP/SMTPS
|
|
|
|
#proxySmtp: http://127.0.0.1:3128 # use HTTP/1.1 CONNECT
|
|
|
|
#proxySmtp: socks4://127.0.0.1:1080 # use SOCKS4
|
|
|
|
#proxySmtp: socks5://127.0.0.1:1080 # use SOCKS5
|
2019-12-19 10:54:28 -06:00
|
|
|
|
|
|
|
# Media Proxy
|
2023-02-03 22:38:51 -06:00
|
|
|
# Reference Implementation: https://github.com/misskey-dev/media-proxy
|
2023-02-11 18:13:47 -06:00
|
|
|
# * Deliver a common cache between instances
|
|
|
|
# * Perform image compression (on a different server resource than the main process)
|
2019-12-31 02:23:47 -06:00
|
|
|
#mediaProxy: https://example.com/proxy
|
2020-10-17 11:46:40 -05:00
|
|
|
|
2022-02-26 22:59:10 -06:00
|
|
|
# Proxy remote files (default: false)
|
2023-02-11 18:13:47 -06:00
|
|
|
# Proxy remote files by this instance or mediaProxy to prevent remote files from running in remote domains.
|
2022-02-26 22:59:10 -06:00
|
|
|
#proxyRemoteFiles: true
|
|
|
|
|
2023-02-11 18:13:47 -06:00
|
|
|
# Movie Thumbnail Generation URL
|
|
|
|
# There is no reference implementation.
|
|
|
|
# For example, Misskey will point to the following URL:
|
|
|
|
# https://example.com/thumbnail.webp?thumbnail=1&url=https%3A%2F%2Fstorage.example.com%2Fpath%2Fto%2Fvideo.mp4
|
|
|
|
#videoThumbnailGenerator: https://example.com
|
|
|
|
|
2022-12-21 00:30:06 -06:00
|
|
|
# Sign to ActivityPub GET request (default: true)
|
|
|
|
signToActivityPubGet: true
|
2021-09-03 07:00:44 -05:00
|
|
|
|
|
|
|
#allowedPrivateNetworks: [
|
|
|
|
# '127.0.0.1/32'
|
|
|
|
#]
|
2021-09-04 06:33:14 -05:00
|
|
|
|
|
|
|
# Upload or download file size limits (bytes)
|
|
|
|
#maxFileSize: 262144000
|