2022-05-15 00:39:23 -07:00
#━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
# Misskey configuration
#━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
# ┌─────┐
#───┘ URL └─────────────────────────────────────────────────────
# Final accessible URL seen by a user.
2022-05-15 06:22:06 -07:00
# url: https://example.tld/
2022-05-15 00:39:23 -07:00
# ONCE YOU HAVE STARTED THE INSTANCE, DO NOT CHANGE THE
# URL SETTINGS AFTER THAT!
# ┌───────────────────────┐
#───┘ Port and TLS settings └───────────────────────────────────
#
# Misskey supports two deployment options for public.
#
# Option 1: With Reverse Proxy
#
# +----- https://example.tld/ ------------+
# +------+ |+-------------+ +----------------+|
# | User | ---> || Proxy (443) | ---> | Misskey (3000) ||
# +------+ |+-------------+ +----------------+|
# +---------------------------------------+
#
# You need to setup reverse proxy. (eg. nginx)
# You do not define 'https' section.
# Option 2: Standalone
#
# +- 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.
2022-05-15 06:22:06 -07:00
port : 3000 # A port that your Misskey server should listen.
2022-05-15 00:39:23 -07:00
# To use option 2, uncomment below lines.
#port: 443
#https:
# # path for certification
# key: /etc/letsencrypt/live/example.tld/privkey.pem
# cert: /etc/letsencrypt/live/example.tld/fullchain.pem
# ┌──────────────────────────┐
#───┘ PostgreSQL configuration └────────────────────────────────
db :
host : localhost
port : 5432
# Database name
db : misskey
# Auth
user : example-misskey-user
pass : example-misskey-pass
# Whether disable Caching queries
#disableCache: true
# Extra Connection options
#extra:
# ssl: true
2023-04-07 23:53:36 -07:00
dbReplications : false
# You can configure any number of replicas here
#dbSlaves:
# -
2023-12-12 15:14:34 -08:00
# host:
# port:
# db:
# user:
# pass:
2023-04-07 23:53:36 -07:00
# -
2023-12-12 15:14:34 -08:00
# host:
# port:
# db:
# user:
# pass:
2023-04-07 23:53:36 -07:00
2022-05-15 00:39:23 -07:00
# ┌─────────────────────┐
#───┘ Redis configuration └─────────────────────────────────────
redis :
host : localhost
port : 6379
2023-04-06 19:20:14 -07:00
#family: 0 # 0=Both, 4=IPv4, 6=IPv6
2022-05-15 00:39:23 -07:00
#pass: example-pass
#prefix: example-prefix
#db: 1
2023-04-06 19:20:14 -07: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 19:27:01 -07:00
#redisForJobQueue:
# host: localhost
# port: 6379
# #family: 0 # 0=Both, 4=IPv4, 6=IPv6
# #pass: example-pass
# #prefix: example-prefix
# #db: 1
2023-10-03 04:26:11 -07:00
#redisForTimelines:
# host: redis
# port: 6379
# #family: 0 # 0=Both, 4=IPv4, 6=IPv6
# #pass: example-pass
# #prefix: example-prefix
# #db: 1
2024-09-20 05:03:53 -07:00
#redisForReactions:
# host: redis
# port: 6379
# #family: 0 # 0=Both, 4=IPv4, 6=IPv6
# #pass: example-pass
# #prefix: example-prefix
# #db: 1
2023-05-04 16:52:14 -07:00
# ┌───────────────────────────┐
#───┘ MeiliSearch configuration └─────────────────────────────
2022-05-15 00:39:23 -07:00
2023-05-04 16:52:14 -07:00
#meilisearch:
2022-05-15 00:39:23 -07:00
# host: localhost
2023-05-04 16:52:14 -07:00
# port: 7700
# apiKey: ''
2023-05-05 12:02:34 -07:00
# ssl: true
2023-05-11 05:09:29 -07:00
# index: ''
2022-05-15 00:39:23 -07:00
# ┌───────────────┐
#───┘ ID generation └───────────────────────────────────────────
# 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.
# Available methods:
# aid ... Short, Millisecond accuracy
2023-09-06 02:33:51 -07:00
# aidx ... Millisecond accuracy
2022-05-15 00:39:23 -07:00
# meid ... Similar to ObjectID, Millisecond accuracy
# ulid ... Millisecond accuracy
# objectid ... This is left for backward compatibility
# ONCE YOU HAVE STARTED THE INSTANCE, DO NOT CHANGE THE
# ID SETTINGS AFTER THAT!
2023-09-06 02:33:51 -07:00
id : "aidx"
2024-05-28 01:06:33 -07:00
# ┌────────────────┐
#───┘ Error tracking └──────────────────────────────────────────
# Sentry is available for error tracking.
# See the Sentry documentation for more details on options.
#sentryForBackend:
# enableNodeProfiling: true
# options:
# dsn: 'https://examplePublicKey@o0.ingest.sentry.io/0'
#sentryForFrontend:
# options:
# dsn: 'https://examplePublicKey@o0.ingest.sentry.io/0'
2022-05-15 00:39:23 -07:00
# ┌─────────────────────┐
#───┘ Other configuration └─────────────────────────────────────
# Whether disable HSTS
#disableHsts: true
# Number of worker processes
#clusterLimit: 1
# Job concurrency per worker
# deliverJobConcurrency: 128
# inboxJobConcurrency: 16
# Job rate limiter
# deliverJobPerSec: 128
2023-12-12 15:14:34 -08:00
# inboxJobPerSec: 32
2022-05-15 00:39:23 -07:00
# Job attempts
# deliverJobMaxAttempts: 12
# inboxJobMaxAttempts: 8
# IP address family used for outgoing request (ipv4, ipv6 or dual)
#outgoingAddressFamily: ipv4
# Proxy for HTTP/HTTPS
#proxy: http://127.0.0.1:3128
#proxyBypassHosts: [
# 'example.com',
# '192.0.2.8'
#]
# 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
# Media Proxy
#mediaProxy: https://example.com/proxy
2024-07-25 07:37:23 -07:00
# Sign outgoing ActivityPub GET request (default: true)
2022-12-20 22:30:06 -08:00
signToActivityPubGet : true
2024-07-25 07:37:23 -07:00
# Sign outgoing ActivityPub Activities (default: true)
2024-07-26 19:45:07 -07:00
# Linked Data signatures are cryptographic signatures attached to each activity to provide proof of authenticity.
# When using authorized fetch, this is often undesired as any signed activity can be forwarded to a blocked instance by relays and other instances.
# This setting allows admins to disable LD signatures for increased privacy, at the expense of fewer relayed activities and additional inbound fetch (GET) requests.
2024-07-25 07:37:23 -07:00
attachLdSignatureForRelays : true
2023-12-20 04:17:59 -08:00
# check that inbound ActivityPub GET requests are signed ("authorized fetch")
checkActivityPubGetSignature : false
2022-05-15 00:39:23 -07:00
#allowedPrivateNetworks: [
# '127.0.0.1/32'
#]
# Upload or download file size limits (bytes)
#maxFileSize: 262144000