2019-04-07 06:50:36 -06:00
|
|
|
#━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
2022-11-15 20:51:59 -07:00
|
|
|
# Calckey configuration
|
2019-04-07 06:50:36 -06:00
|
|
|
#━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
|
|
|
|
|
|
# ┌─────┐
|
|
|
|
#───┘ URL └─────────────────────────────────────────────────────
|
|
|
|
|
2018-10-01 20:59:12 -06:00
|
|
|
# Final accessible URL seen by a user.
|
|
|
|
url: https://example.tld/
|
|
|
|
|
2019-07-03 05:31:52 -06:00
|
|
|
# ONCE YOU HAVE STARTED THE INSTANCE, DO NOT CHANGE THE
|
|
|
|
# URL SETTINGS AFTER THAT!
|
|
|
|
|
2019-04-07 06:50:36 -06:00
|
|
|
# ┌───────────────────────┐
|
|
|
|
#───┘ Port and TLS settings └───────────────────────────────────
|
2018-10-01 20:59:12 -06:00
|
|
|
|
|
|
|
#
|
2022-03-08 07:23:18 -07:00
|
|
|
# Misskey requires a reverse proxy to support HTTPS connections.
|
2018-10-01 20:59:12 -06:00
|
|
|
#
|
|
|
|
# +----- https://example.tld/ ------------+
|
|
|
|
# +------+ |+-------------+ +----------------+|
|
|
|
|
# | User | ---> || Proxy (443) | ---> | Misskey (3000) ||
|
|
|
|
# +------+ |+-------------+ +----------------+|
|
|
|
|
# +---------------------------------------+
|
2018-07-14 11:09:55 -06:00
|
|
|
#
|
2022-03-08 07:23:18 -07: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 11:09:55 -06:00
|
|
|
|
2022-03-08 07:23:18 -07:00
|
|
|
# The port that your Misskey server should listen on.
|
|
|
|
port: 3000
|
2018-07-14 08:20:30 -06:00
|
|
|
|
2019-04-07 06:50:36 -06:00
|
|
|
# ┌──────────────────────────┐
|
|
|
|
#───┘ PostgreSQL configuration └────────────────────────────────
|
2017-11-22 13:43:00 -07:00
|
|
|
|
2019-04-07 06:50:36 -06:00
|
|
|
db:
|
2017-11-22 13:43:00 -07:00
|
|
|
host: localhost
|
2019-04-07 06:50:36 -06:00
|
|
|
port: 5432
|
|
|
|
|
|
|
|
# Database name
|
2022-11-15 20:51:59 -07:00
|
|
|
db: calckey
|
2019-04-07 06:50:36 -06:00
|
|
|
|
|
|
|
# Auth
|
2022-11-15 20:51:59 -07:00
|
|
|
user: example-calckey-user
|
|
|
|
pass: example-calckey-pass
|
2017-11-22 13:43:00 -07:00
|
|
|
|
2019-06-11 05:49:08 -06:00
|
|
|
# Whether disable Caching queries
|
|
|
|
#disableCache: true
|
|
|
|
|
2019-05-23 12:26:56 -06:00
|
|
|
# Extra Connection options
|
|
|
|
#extra:
|
|
|
|
# ssl: true
|
|
|
|
|
2019-04-07 06:50:36 -06:00
|
|
|
# ┌─────────────────────┐
|
|
|
|
#───┘ Redis configuration └─────────────────────────────────────
|
|
|
|
|
2019-04-13 04:19:32 -06:00
|
|
|
redis:
|
|
|
|
host: localhost
|
|
|
|
port: 6379
|
2022-06-24 04:22:19 -06:00
|
|
|
#family: 0 # 0=Both, 4=IPv4, 6=IPv6
|
2019-04-13 04:19:32 -06:00
|
|
|
#pass: example-pass
|
2019-11-04 04:48:07 -07:00
|
|
|
#prefix: example-prefix
|
|
|
|
#db: 1
|
2019-04-07 06:50:36 -06:00
|
|
|
|
2023-03-19 02:26:47 -06:00
|
|
|
# ┌─────────────────────┐
|
|
|
|
#───┘ Sonic configuration └─────────────────────────────────────
|
|
|
|
|
|
|
|
#sonic:
|
|
|
|
# host: localhost
|
|
|
|
# port: 1491
|
|
|
|
# auth: SecretPassword
|
|
|
|
# collection: notes
|
|
|
|
# bucket: default
|
|
|
|
|
2023-03-23 15:45:33 -06:00
|
|
|
# ┌─────────────────────────────┐
|
|
|
|
#───┘ Elasticsearch configuration └─────────────────────────────
|
|
|
|
|
|
|
|
#elasticsearch:
|
|
|
|
# host: localhost
|
|
|
|
# port: 9200
|
|
|
|
# ssl: false
|
2023-04-26 14:06:18 -06:00
|
|
|
# user:
|
|
|
|
# pass:
|
2023-03-23 15:45:33 -06:00
|
|
|
|
2019-04-07 06:50:36 -06:00
|
|
|
# ┌───────────────┐
|
|
|
|
#───┘ ID generation └───────────────────────────────────────────
|
2018-11-05 14:24:31 -07:00
|
|
|
|
2019-04-07 06:50:36 -06: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 08:06:46 -06:00
|
|
|
|
2019-04-07 06:50:36 -06:00
|
|
|
# Available methods:
|
2019-04-13 10:40:29 -06:00
|
|
|
# aid ... Short, Millisecond accuracy
|
|
|
|
# meid ... Similar to ObjectID, Millisecond accuracy
|
|
|
|
# ulid ... Millisecond accuracy
|
|
|
|
# objectid ... This is left for backward compatibility
|
2019-04-07 06:50:36 -06:00
|
|
|
|
2019-04-24 21:24:18 -06:00
|
|
|
# ONCE YOU HAVE STARTED THE INSTANCE, DO NOT CHANGE THE
|
|
|
|
# ID SETTINGS AFTER THAT!
|
|
|
|
|
2019-04-13 10:08:26 -06:00
|
|
|
id: 'aid'
|
2019-04-07 06:50:36 -06:00
|
|
|
|
|
|
|
# ┌─────────────────────┐
|
|
|
|
#───┘ Other configuration └─────────────────────────────────────
|
|
|
|
|
2022-12-12 16:07:38 -07:00
|
|
|
# Max note length, should be < 8000.
|
|
|
|
#maxNoteLength: 3000
|
|
|
|
|
2023-03-04 07:16:20 -07:00
|
|
|
# Maximum lenght of an image caption or file comment (default 1500, max 8192)
|
|
|
|
#maxCaptionLength: 1500
|
|
|
|
|
2023-04-26 14:06:18 -06:00
|
|
|
# Reserved usernames that only the administrator can register with
|
2023-05-08 11:30:21 -06:00
|
|
|
reservedUsernames: [
|
|
|
|
'root',
|
|
|
|
'admin',
|
|
|
|
'administrator',
|
|
|
|
'me',
|
|
|
|
'system'
|
|
|
|
]
|
2023-04-26 14:06:18 -06:00
|
|
|
|
2019-02-06 03:36:44 -07:00
|
|
|
# Whether disable HSTS
|
|
|
|
#disableHsts: true
|
|
|
|
|
2019-08-26 14:33:24 -06:00
|
|
|
# Number of worker processes
|
2018-10-11 00:50:27 -06:00
|
|
|
#clusterLimit: 1
|
2019-05-07 02:49:25 -06:00
|
|
|
|
2023-05-16 16:08:14 -06:00
|
|
|
# Worker only mode
|
|
|
|
#onlyQueueProcessor: 1
|
|
|
|
|
2019-08-26 14:33:24 -06:00
|
|
|
# Job concurrency per worker
|
2019-10-22 04:30:18 -06:00
|
|
|
# deliverJobConcurrency: 128
|
|
|
|
# inboxJobConcurrency: 16
|
2019-08-26 14:33:24 -06:00
|
|
|
|
2020-01-19 22:14:09 -07:00
|
|
|
# Job rate limiter
|
|
|
|
# deliverJobPerSec: 128
|
|
|
|
# inboxJobPerSec: 16
|
|
|
|
|
|
|
|
# Job attempts
|
|
|
|
# deliverJobMaxAttempts: 12
|
|
|
|
# inboxJobMaxAttempts: 8
|
|
|
|
|
2019-05-07 02:49:25 -06:00
|
|
|
# IP address family used for outgoing request (ipv4, ipv6 or dual)
|
|
|
|
#outgoingAddressFamily: ipv4
|
2019-08-29 17:29:46 -06:00
|
|
|
|
|
|
|
# Syslog option
|
|
|
|
#syslog:
|
|
|
|
# host: localhost
|
|
|
|
# port: 514
|
2019-09-01 13:42:52 -06:00
|
|
|
|
|
|
|
# Proxy for HTTP/HTTPS
|
|
|
|
#proxy: http://127.0.0.1:3128
|
|
|
|
|
2020-04-12 05:32:34 -06:00
|
|
|
#proxyBypassHosts: [
|
2023-04-26 22:07:40 -06:00
|
|
|
# 'web.kaiteki.app',
|
2020-04-12 05:32:34 -06:00
|
|
|
# 'example.com',
|
|
|
|
# '192.0.2.8'
|
|
|
|
#]
|
|
|
|
|
2019-09-01 13:42:52 -06: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 09:54:28 -07:00
|
|
|
|
|
|
|
# Media Proxy
|
2019-12-31 01:23:47 -07:00
|
|
|
#mediaProxy: https://example.com/proxy
|
2020-10-17 10:46:40 -06:00
|
|
|
|
2022-02-26 21:59:10 -07:00
|
|
|
# Proxy remote files (default: false)
|
|
|
|
#proxyRemoteFiles: true
|
|
|
|
|
2021-09-03 06:00:44 -06:00
|
|
|
#allowedPrivateNetworks: [
|
|
|
|
# '127.0.0.1/32'
|
|
|
|
#]
|
2021-09-04 05:33:14 -06:00
|
|
|
|
2023-01-21 13:55:38 -07:00
|
|
|
# TWA
|
|
|
|
#twa:
|
|
|
|
# nameSpace: android_app
|
|
|
|
# packageName: tld.domain.twa
|
|
|
|
# sha256CertFingerprints: ['AB:CD:EF']
|
|
|
|
|
2021-09-04 05:33:14 -06:00
|
|
|
# Upload or download file size limits (bytes)
|
|
|
|
#maxFileSize: 262144000
|
2022-10-30 22:38:20 -06:00
|
|
|
|
2022-11-01 19:41:59 -06:00
|
|
|
# Managed hosting settings
|
|
|
|
# !!!!!!!!!!
|
2022-11-15 20:51:59 -07:00
|
|
|
# >>>>>> NORMAL SELF-HOSTERS, STAY AWAY! <<<<<<
|
|
|
|
# >>>>>> YOU DON'T NEED THIS! <<<<<<
|
2022-11-01 19:41:59 -06:00
|
|
|
# !!!!!!!!!!
|
|
|
|
# Each category is optional, but if each item in each category is mandatory!
|
|
|
|
# If you mess this up, that's on you, you've been warned...
|
|
|
|
|
2022-10-30 22:38:20 -06:00
|
|
|
#maxUserSignups: 100
|
2022-11-01 19:41:59 -06:00
|
|
|
#isManagedHosting: true
|
|
|
|
#deepl:
|
|
|
|
# managed: true
|
|
|
|
# authKey: ''
|
|
|
|
# isPro: false
|
|
|
|
#
|
|
|
|
#email:
|
|
|
|
# managed: true
|
|
|
|
# address: 'example@email.com'
|
|
|
|
# host: 'email.com'
|
|
|
|
# port: 587
|
|
|
|
# user: 'example@email.com'
|
|
|
|
# pass: ''
|
|
|
|
# useImplicitSslTls: false
|
|
|
|
#
|
|
|
|
#objectStorage:
|
|
|
|
# managed: true
|
2022-11-02 10:14:42 -06:00
|
|
|
# baseUrl: ''
|
2022-11-01 19:41:59 -06:00
|
|
|
# bucket: ''
|
|
|
|
# prefix: ''
|
|
|
|
# endpoint: ''
|
|
|
|
# region: ''
|
|
|
|
# accessKey: ''
|
|
|
|
# secretKey: ''
|
|
|
|
# useSsl: true
|
|
|
|
# connnectOverProxy: false
|
|
|
|
# setPublicReadOnUpload: true
|
|
|
|
# s3ForcePathStyle: true
|
2022-11-15 20:51:59 -07:00
|
|
|
|
|
|
|
# !!!!!!!!!!
|
|
|
|
# >>>>>> AGAIN, NORMAL SELF-HOSTERS, STAY AWAY! <<<<<<
|
|
|
|
# >>>>>> YOU DON'T NEED THIS, ABOVE SETTINGS ARE FOR MANAGED HOSTING ONLY! <<<<<<
|
|
|
|
# !!!!!!!!!!
|
|
|
|
|
|
|
|
# Seriously. Do NOT fill out the above settings if you're self-hosting.
|
2023-04-26 14:06:18 -06:00
|
|
|
# They're much better off being set from the control panel.
|