367 lines
13 KiB
YAML
367 lines
13 KiB
YAML
#━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
# Misskey configuration
|
|
#━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
|
|
# ┌────────────────────────┐
|
|
#───┘ Initial Setup Password └─────────────────────────────────────────────────────
|
|
|
|
# Password to initiate setting up admin account.
|
|
# It will not be used after the initial setup is complete.
|
|
#
|
|
# Be sure to change this when you set up Misskey via the Internet.
|
|
#
|
|
# The provider of the service who sets up Misskey on behalf of the customer should
|
|
# set this value to something unique when generating the Misskey config file,
|
|
# and provide it to the customer.
|
|
setupPassword: example_password_please_change_this_or_you_will_get_hacked
|
|
|
|
# ┌─────┐
|
|
#───┘ URL └─────────────────────────────────────────────────────
|
|
|
|
# Final accessible URL seen by a user.
|
|
url: 'http://misskey.local'
|
|
|
|
# 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: 61812
|
|
|
|
# ┌──────────────────────────┐
|
|
#───┘ PostgreSQL configuration └────────────────────────────────
|
|
|
|
db:
|
|
host: db
|
|
port: 5432
|
|
|
|
# Database name
|
|
db: misskey
|
|
|
|
# Auth
|
|
user: postgres
|
|
pass: postgres
|
|
|
|
## Log a warning to the server console if any query takes longer than this to complete.
|
|
## Measured in milliseconds; set to 0 to disable. (default: 300)
|
|
#slowQueryThreshold: 300
|
|
|
|
# If false, then query results will be cached in redis.
|
|
# If true (default), then queries will not be cached.
|
|
# This will reduce database load at the cost of increased Redis traffic and risk of bugs and unpredictable behavior.
|
|
#disableCache: false
|
|
|
|
# Extra Connection options
|
|
#extra:
|
|
# ssl: true
|
|
# # Set a higher value if you have timeout issues during migration
|
|
# statement_timeout: 10000
|
|
|
|
|
|
dbReplications: false
|
|
|
|
# You can configure any number of replicas here
|
|
#dbSlaves:
|
|
# -
|
|
# host:
|
|
# port:
|
|
# db:
|
|
# user:
|
|
# pass:
|
|
# -
|
|
# host:
|
|
# port:
|
|
# db:
|
|
# user:
|
|
# pass:
|
|
|
|
# ┌─────────────────────┐
|
|
#───┘ Redis configuration └─────────────────────────────────────
|
|
|
|
redis:
|
|
host: redis
|
|
port: 6379
|
|
#family: 0 # 0=Both, 4=IPv4, 6=IPv6
|
|
#pass: example-pass
|
|
#prefix: example-prefix
|
|
#db: 1
|
|
|
|
#redisForPubsub:
|
|
# host: redis
|
|
# port: 6379
|
|
# #family: 0 # 0=Both, 4=IPv4, 6=IPv6
|
|
# #pass: example-pass
|
|
# #prefix: example-prefix
|
|
# #db: 1
|
|
|
|
#redisForJobQueue:
|
|
# host: redis
|
|
# port: 6379
|
|
# #family: 0 # 0=Both, 4=IPv4, 6=IPv6
|
|
# #pass: example-pass
|
|
# #prefix: example-prefix
|
|
# #db: 1
|
|
|
|
#redisForTimelines:
|
|
# host: redis
|
|
# port: 6379
|
|
# #family: 0 # 0=Both, 4=IPv4, 6=IPv6
|
|
# #pass: example-pass
|
|
# #prefix: example-prefix
|
|
# #db: 1
|
|
|
|
#redisForReactions:
|
|
# host: redis
|
|
# port: 6379
|
|
# #family: 0 # 0=Both, 4=IPv4, 6=IPv6
|
|
# #pass: example-pass
|
|
# #prefix: example-prefix
|
|
# #db: 1
|
|
|
|
#redisForRateLimit:
|
|
# host: localhost
|
|
# port: 6379
|
|
# #family: 0 # 0=Both, 4=IPv4, 6=IPv6
|
|
# #pass: example-pass
|
|
# #prefix: example-prefix
|
|
# #db: 1
|
|
# # You can specify more ioredis options...
|
|
# #username: example-username
|
|
|
|
# ┌───────────────────────────────┐
|
|
#───┘ Fulltext search configuration └─────────────────────────────
|
|
|
|
# These are the setting items for the full-text search provider.
|
|
fulltextSearch:
|
|
# You can select the ID generation method.
|
|
# - sqlLike (default)
|
|
# Use SQL-like search.
|
|
# This is a standard feature of PostgreSQL, so no special extensions are required.
|
|
# - sqlPgroonga
|
|
# Use pgroonga.
|
|
# You need to install pgroonga and configure it as a PostgreSQL extension.
|
|
# In addition to the above, you need to create a pgroonga index on the text column of the note table.
|
|
# see: https://pgroonga.github.io/tutorial/
|
|
# - meilisearch
|
|
# Use Meilisearch.
|
|
# You need to install Meilisearch and configure.
|
|
provider: sqlLike
|
|
|
|
# For Meilisearch settings.
|
|
# If you select "meilisearch" for "fulltextSearch.provider", it must be set.
|
|
# You can set scope to local or global (default value)
|
|
# (include notes from remote).
|
|
|
|
#meilisearch:
|
|
# host: meilisearch
|
|
# port: 7700
|
|
# apiKey: ''
|
|
# ssl: true
|
|
# index: ''
|
|
# scope: global
|
|
|
|
# ┌───────────────┐
|
|
#───┘ 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
|
|
# aidx ... Millisecond accuracy
|
|
# 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!
|
|
|
|
id: 'aidx'
|
|
|
|
# ┌────────────────┐
|
|
#───┘ 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:
|
|
# vueIntegration:
|
|
# tracingOptions:
|
|
# trackComponents: true
|
|
# browserTracingIntegration:
|
|
# replayIntegration:
|
|
# options:
|
|
# dsn: 'https://examplePublicKey@o0.ingest.sentry.io/0'
|
|
|
|
# ┌─────────────────────┐
|
|
#───┘ Other configuration └─────────────────────────────────────
|
|
|
|
# Whether disable HSTS
|
|
#disableHsts: true
|
|
|
|
# Number of worker processes
|
|
#clusterLimit: 1
|
|
|
|
# +-------------------------+
|
|
# | Job concurrency options |
|
|
# +-------------------------+
|
|
#
|
|
### Available options:
|
|
# [type]JobConcurrency - limits the number jobs that can run at the same time.
|
|
# Sharkey will allow this many jobs of this type *per worker process*.
|
|
# [type]JobPerSec - limits the total number of jobs that may complete within a single second.
|
|
# If this limit is exceeded, then Sharkey will pause this type of job until the next second.
|
|
# [type]JobMaxAttempts - limits the number of times that a job is allowed to fail and re-try before it's permanently stopped.
|
|
# If this limit is exceeded, then the job is considered "failed" and recorded for debugging.
|
|
#
|
|
### Job types:
|
|
# inbox - processes ActivityPub messages (AKA "Activities") received from remote instances.
|
|
# All inbound activities are queued and processed in chronological order by this job.
|
|
# deliver - processes ActivityPub messages (AKA "Activities") being set to remote instances.
|
|
# All outbound activities are queued and processed in chronological order by this job.
|
|
# relationship - processes user-to-user tasks including follow/unfollow, block/unblock, account migrations, and all follow import jobs.
|
|
# background - processes background synchronization tasks that need to happen soon (but not immediately), such as remote user updates and instance metadata updates.
|
|
|
|
# Job concurrency per worker
|
|
#deliverJobConcurrency: 128
|
|
#inboxJobConcurrency: 16
|
|
#relationshipJobConcurrency: 16
|
|
#backgroundJobConcurrency: 32
|
|
|
|
# Job rate limiter
|
|
#deliverJobPerSec: 128
|
|
#inboxJobPerSec: 32
|
|
#relationshipJobPerSec: 64
|
|
#backgroundJobPerSec: 256
|
|
|
|
# Job attempts
|
|
#deliverJobMaxAttempts: 12
|
|
#inboxJobMaxAttempts: 8
|
|
#backgroundJobMaxAttempts: 8
|
|
|
|
# IP address family used for outgoing request (ipv4, ipv6 or dual)
|
|
#outgoingAddressFamily: ipv4
|
|
|
|
# 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
|
|
# 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
|
|
# Amount of characters that can be used when writing media descriptions (alt text). Longer descriptions will be rejected. (minimum: 1)
|
|
#maxAltTextLength: 20000
|
|
# Amount of characters that will be saved for remote media descriptions (alt text). Longer descriptions will be truncated to this length. (minimum: 1)
|
|
#maxRemoteAltTextLength: 100000
|
|
# Amount of dialog-style announcements that can be active at a time. (minimum: 1)
|
|
#maxDialogAnnouncements: 5
|
|
|
|
# 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
|
|
|
|
# Path to the directory that uploaded media will be saved to
|
|
# Defaults to a folder called "files" in the Sharkey directory
|
|
#mediaDirectory: /var/lib/sharkey
|
|
|
|
# Media Proxy
|
|
#mediaProxy: https://example.com/proxy
|
|
|
|
# Proxy remote files (default: true)
|
|
proxyRemoteFiles: true
|
|
|
|
# Sign to ActivityPub GET request (default: true)
|
|
signToActivityPubGet: true
|
|
|
|
# For security reasons, uploading attachments from the intranet is prohibited,
|
|
# but exceptions can be made from the following settings. Default value is "undefined".
|
|
# Read changelog to learn more (Improvements of 12.90.0 (2021/09/04)).
|
|
# Some example configurations:
|
|
allowedPrivateNetworks:
|
|
# Allow connections to 127.0.0.1 on any port
|
|
- '127.0.0.1/32'
|
|
# # Allow connections to 127.0.0.* on any port
|
|
# - '127.0.0.1/24'
|
|
# # Allow connections to 127.0.0.1 on any port
|
|
# - '127.0.0.1'
|
|
# # Allow connections to 127.0.0.1 on any port
|
|
# - network: '127.0.0.1'
|
|
# # Allow connections to 127.0.0.1 on port 80
|
|
# - network: '127.0.0.1'
|
|
# ports: [80]
|
|
# # Allow connections to 127.0.0.1 on port 80 or 443
|
|
# - network: '127.0.0.1'
|
|
# ports:
|
|
# - 80
|
|
# - 443
|
|
|
|
# Disable automatic redirect for ActivityPub object lookup. (default: false)
|
|
# This is a strong defense against potential impersonation attacks if the viewer instance has inadequate validation.
|
|
# However it will make it impossible for other instances to lookup third-party user and notes through your URL.
|
|
#disallowExternalApRedirect: true
|
|
|
|
# Upload or download file size limits (bytes)
|
|
#maxFileSize: 262144000
|
|
|
|
# CHMod-style permission bits to apply to uploaded files.
|
|
# Permission bits are specified as a base-8 string representing User/Group/Other permissions.
|
|
# This setting is only useful for custom deployments, such as using a reverse proxy to serve media.
|
|
#filePermissionBits: '644'
|
|
|
|
# Log settings
|
|
# logging:
|
|
# sql:
|
|
# # Outputs query parameters during SQL execution to the log.
|
|
# # default: false
|
|
# enableQueryParamLogging: false
|
|
# # Disable query truncation. If set to true, the full text of the query will be output to the log.
|
|
# # default: false
|
|
# disableQueryTruncation: false
|
|
|
|
# Settings for the activity logger, which records inbound activities to the database.
|
|
# Disabled by default due to the large volume of data it saves.
|
|
#activityLogging:
|
|
# Log activities to the database (default: false)
|
|
#enabled: false
|
|
|
|
# Save the activity before processing, then update later with the results.
|
|
# This has the advantage of capturing activities that cause a hard-crash, but doubles the number of queries used.
|
|
# Default: false
|
|
#preSave: false
|
|
|
|
# How long to save each log entry before deleting it.
|
|
# Default: 2592000000 (1 week)
|
|
#maxAge: 2592000000
|