2023-01-15 04:11:38 +01:00
#━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
# Misskey configuration
#━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
2024-02-19 10:48:34 +01:00
# ┌──────────────────────────────┐
#───┘ a boring but important thing └────────────────────────────
#
# First of all, let me tell you a story that may possibly be
# boring to you and possibly important to you.
#
# Misskey is licensed under the AGPLv3 license. This license is
# known to be often misunderstood. Please read the following
# instructions carefully and select the appropriate option so
# that you do not negligently cause a license violation.
#
# --------
# Option 1: If you host Misskey AS-IS (without any changes to
# the source code. forks are not included).
#
# Step 1: Congratulations! You don't need to do anything.
# --------
# Option 2: If you have made changes to the source code (forks
# are included) and publish a Git repository of source
# code. There should be no access restrictions on
# this repository. Strictly speaking, it doesn't have
# to be a Git repository, but you'll probably use Git!
#
# Step 1: Build and run the Misskey server first.
# Step 2: Open <https://your.misskey.example/admin/settings> in
# your browser with the administrator account.
# Step 3: Enter the URL of your Git repository in the
# "Repository URL" field.
# --------
# Option 3: If neither of the above applies to you.
# (In this case, the source code should be published
# on the Misskey interface. IT IS NOT ENOUGH TO
# DISCLOSE THE SOURCE CODE WEHN A USER REQUESTS IT BY
# E-MAIL OR OTHER MEANS. If you are not satisfied
# with this, it is recommended that you read the
# license again carefully. Anyway, enabling this
# option will automatically generate and publish a
# tarball at build time, protecting you from
# inadvertent license violations. (There is no legal
# guarantee, of course.) The tarball will generated
# from the root directory of your codebase. So it is
# also recommended to check <built/tarball> directory
# once after building and before activating the server
# to avoid ACCIDENTAL LEAKING OF SENSITIVE INFORMATION.
# To prevent certain files from being included in the
# tarball, add a glob pattern after line 15 in
# <scripts/tarball.mjs>. DO NOT FORGET TO BUILD AFTER
# ENABLING THIS OPTION!)
#
# Step 1: Uncomment the following line.
#
# publishTarballInsteadOfProvideRepositoryUrl: true
2023-01-15 04:11:38 +01:00
# ┌─────┐
#───┘ URL └─────────────────────────────────────────────────────
# Final accessible URL seen by a user.
2024-07-14 14:33:22 +02:00
# You can set url from an environment variable instead.
2023-01-15 04:11:38 +01:00
url : https://example.tld/
# ONCE YOU HAVE STARTED THE INSTANCE, DO NOT CHANGE THE
# URL SETTINGS AFTER THAT!
# ┌───────────────────────┐
#───┘ Port and TLS settings └───────────────────────────────────
#
# Misskey requires a reverse proxy to support HTTPS connections.
#
# +----- https://example.tld/ ------------+
# +------+ |+-------------+ +----------------+|
# | User | ---> || Proxy (443) | ---> | Misskey (3000) ||
# +------+ |+-------------+ +----------------+|
# +---------------------------------------+
#
# 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.
# The port that your Misskey server should listen on.
port : 3000
# ┌──────────────────────────┐
#───┘ PostgreSQL configuration └────────────────────────────────
db :
host : db
port : 5432
# Database name
2024-07-14 14:33:22 +02:00
# You can set db from an environment variable instead.
2023-01-15 04:11:38 +01:00
db : misskey
# Auth
2024-07-14 14:33:22 +02:00
# You can set user and pass from environment variables instead.
2023-01-15 04:11:38 +01:00
user : example-misskey-user
pass : example-misskey-pass
# Whether disable Caching queries
#disableCache: true
# Extra Connection options
#extra:
# ssl: true
2023-04-08 08:53:36 +02:00
dbReplications : false
# You can configure any number of replicas here
#dbSlaves:
# -
2023-12-13 00:14:34 +01:00
# host:
# port:
# db:
# user:
# pass:
2023-04-08 08:53:36 +02:00
# -
2023-12-13 00:14:34 +01:00
# host:
# port:
# db:
# user:
# pass:
2023-04-08 08:53:36 +02:00
2023-01-15 04:11:38 +01:00
# ┌─────────────────────┐
#───┘ Redis configuration └─────────────────────────────────────
redis :
host : redis
port : 6379
#family: 0 # 0=Both, 4=IPv4, 6=IPv6
#pass: example-pass
#prefix: example-prefix
#db: 1
2023-04-07 04:20:14 +02:00
#redisForPubsub:
# host: redis
# port: 6379
# #family: 0 # 0=Both, 4=IPv4, 6=IPv6
# #pass: example-pass
# #prefix: example-prefix
# #db: 1
2023-04-07 04:27:01 +02:00
#redisForJobQueue:
# host: redis
# port: 6379
# #family: 0 # 0=Both, 4=IPv4, 6=IPv6
# #pass: example-pass
# #prefix: example-prefix
# #db: 1
2023-10-03 13:26:11 +02: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 14:03:53 +02:00
#redisForReactions:
# host: redis
# port: 6379
# #family: 0 # 0=Both, 4=IPv4, 6=IPv6
# #pass: example-pass
# #prefix: example-prefix
# #db: 1
2023-05-05 01:52:14 +02:00
# ┌───────────────────────────┐
#───┘ MeiliSearch configuration └─────────────────────────────
2024-05-28 10:06:33 +02:00
# You can set scope to local (default value) or global
2023-12-07 09:00:34 +01:00
# (include notes from remote).
2023-05-05 01:52:14 +02:00
#meilisearch:
# host: meilisearch
# port: 7700
# apiKey: ''
2023-05-05 21:02:34 +02:00
# ssl: true
2023-05-11 14:09:29 +02:00
# index: ''
2023-11-29 20:23:47 +01:00
# scope: global
2023-01-15 04:11:38 +01: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 11:33:51 +02:00
# aidx ... Millisecond accuracy
2023-01-15 04:11:38 +01: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 11:33:51 +02:00
id : 'aidx'
2023-01-15 04:11:38 +01:00
2024-05-28 10:06:33 +02: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'
2023-01-15 04:11:38 +01:00
# ┌─────────────────────┐
#───┘ Other configuration └─────────────────────────────────────
# Whether disable HSTS
#disableHsts: true
# Number of worker processes
#clusterLimit: 1
# Job concurrency per worker
# deliverJobConcurrency: 128
# inboxJobConcurrency: 16
2024-02-03 20:22:02 +01:00
# relationshipJobConcurrency: 16
# What's relationshipJob?:
2023-11-29 20:23:47 +01:00
# Follow, unfollow, block and unblock(ings) while following-imports, etc. or account migrations.
2023-01-15 04:11:38 +01:00
# Job rate limiter
# deliverJobPerSec: 128
2023-12-13 00:14:34 +01:00
# inboxJobPerSec: 32
2024-02-03 20:22:02 +01:00
# relationshipJobPerSec: 64
2023-01-15 04:11:38 +01:00
# Job attempts
# deliverJobMaxAttempts: 12
# inboxJobMaxAttempts: 8
2023-11-29 20:23:47 +01:00
# Local address used for outgoing requests
#outgoingAddress: 127.0.0.1
2023-01-15 04:11:38 +01:00
# IP address family used for outgoing request (ipv4, ipv6 or dual)
#outgoingAddressFamily: ipv4
2024-10-20 06:49:36 +02:00
# Amount of characters that can be used when writing notes. Longer notes will be rejected. (minimum: 1)
#maxNoteLength: 3000
# Amount of characters that will be saved for remote notes. Longer notes will be truncated to this length. (minimum: 1)
#maxRemoteNoteLength: 100000
2024-10-26 16:04:23 +02:00
# Amount of characters that can be used when writing content warnings. Longer warnings will be rejected. (minimum: 1)
#maxCwLength: 500
# Amount of characters that will be saved for remote content warnings. Longer warnings will be truncated to this length. (minimum: 1)
#maxRemoteCwLength: 5000
2024-10-08 03:03:31 +02:00
# Amount of characters that can be used when writing media descriptions (alt text). Longer descriptions will be rejected. (minimum: 1)
2024-10-20 06:49:36 +02:00
#maxAltTextLength: 20000
2024-10-08 03:03:31 +02:00
# Amount of characters that will be saved for remote media descriptions (alt text). Longer descriptions will be truncated to this length. (minimum: 1)
2024-10-20 06:49:36 +02:00
#maxRemoteAltTextLength: 100000
2023-12-31 18:22:02 +01:00
2023-01-15 04:11:38 +01:00
# Proxy for HTTP/HTTPS
#proxy: http://127.0.0.1:3128
proxyBypassHosts :
- api.deepl.com
- api-free.deepl.com
- www.recaptcha.net
- hcaptcha.com
- challenges.cloudflare.com
# 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
2023-08-05 07:03:01 +02:00
# Proxy remote files (default: true)
2023-11-29 20:23:47 +01:00
# Proxy remote files by this instance or mediaProxy to prevent remote files from running in remote domains.
2023-08-05 07:03:01 +02:00
proxyRemoteFiles : true
2023-01-15 04:11:38 +01:00
2023-11-29 20:23:47 +01: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
2024-07-25 16:37:23 +02:00
# Sign outgoing ActivityPub GET request (default: true)
2023-01-15 04:11:38 +01:00
signToActivityPubGet : true
2024-07-25 16:37:23 +02:00
# Sign outgoing ActivityPub Activities (default: true)
2024-07-27 04:45:07 +02: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 16:37:23 +02:00
attachLdSignatureForRelays : true
2023-12-31 18:22:02 +01:00
# check that inbound ActivityPub GET requests are signed ("authorized fetch")
checkActivityPubGetSignature : false
2023-01-15 04:11:38 +01:00
2023-12-07 09:00:34 +01:00
# For security reasons, uploading attachments from the intranet is prohibited,
2024-05-28 10:06:33 +02:00
# but exceptions can be made from the following settings. Default value is "undefined".
2023-12-07 09:00:34 +01:00
# Read changelog to learn more (Improvements of 12.90.0 (2021/09/04)).
2023-01-15 04:11:38 +01:00
#allowedPrivateNetworks: [
# '127.0.0.1/32'
#]
2023-12-22 13:10:21 +01:00
#customMOTD: ['Hello World', 'The sharks rule all', 'Shonks']
2023-01-15 04:11:38 +01:00
# Upload or download file size limits (bytes)
#maxFileSize: 262144000