2023-02-12 09:07:56 +09:00
|
|
|
#━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
2023-05-28 18:35:56 +09:00
|
|
|
# CherryPick configuration
|
2023-02-12 09:07:56 +09:00
|
|
|
#━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
|
|
|
|
|
|
# ┌─────┐
|
|
|
|
#───┘ URL └─────────────────────────────────────────────────────
|
|
|
|
|
|
|
|
# Final accessible URL seen by a user.
|
|
|
|
url: http://127.0.0.1:3000/
|
|
|
|
|
|
|
|
# ONCE YOU HAVE STARTED THE INSTANCE, DO NOT CHANGE THE
|
|
|
|
# URL SETTINGS AFTER THAT!
|
|
|
|
|
|
|
|
# ┌───────────────────────┐
|
|
|
|
#───┘ Port and TLS settings └───────────────────────────────────
|
|
|
|
|
|
|
|
#
|
2023-05-28 18:35:56 +09:00
|
|
|
# CherryPick requires a reverse proxy to support HTTPS connections.
|
2023-02-12 09:07:56 +09:00
|
|
|
#
|
2023-05-28 18:35:56 +09:00
|
|
|
# +-------- https://example.tld/ ------------+
|
|
|
|
# +------+ |+-------------+ +-------------------+|
|
|
|
|
# | User | ---> || Proxy (443) | ---> | CherryPick (3000) ||
|
|
|
|
# +------+ |+-------------+ +-------------------+|
|
|
|
|
# +------------------------------------------+
|
2023-02-12 09:07:56 +09: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.
|
|
|
|
|
2023-05-28 18:35:56 +09:00
|
|
|
# The port that your CherryPick server should listen on.
|
2023-02-12 09:07:56 +09:00
|
|
|
port: 3000
|
|
|
|
|
|
|
|
# ┌──────────────────────────┐
|
|
|
|
#───┘ PostgreSQL configuration └────────────────────────────────
|
|
|
|
|
|
|
|
db:
|
|
|
|
host: db
|
|
|
|
port: 5432
|
|
|
|
|
|
|
|
# Database name
|
2023-05-28 18:35:56 +09:00
|
|
|
db: cherrypick
|
2023-02-12 09:07:56 +09:00
|
|
|
|
|
|
|
# Auth
|
|
|
|
user: postgres
|
|
|
|
pass: postgres
|
|
|
|
|
|
|
|
# Whether disable Caching queries
|
|
|
|
#disableCache: true
|
|
|
|
|
|
|
|
# Extra Connection options
|
|
|
|
#extra:
|
|
|
|
# ssl: true
|
|
|
|
|
2023-04-08 15:53:36 +09:00
|
|
|
dbReplications: false
|
|
|
|
|
|
|
|
# You can configure any number of replicas here
|
|
|
|
#dbSlaves:
|
|
|
|
# -
|
2023-09-22 11:42:10 +09:00
|
|
|
# host: localhost
|
|
|
|
# port: 5433
|
|
|
|
# db: cherrypick
|
|
|
|
# user: example-cherrypick-user
|
|
|
|
# pass: example-cherrypick-pass
|
2023-04-08 15:53:36 +09:00
|
|
|
# -
|
2023-09-22 11:42:10 +09:00
|
|
|
# host: localhost
|
|
|
|
# port: 5434
|
|
|
|
# db: cherrypick
|
|
|
|
# user: example-cherrypick-user
|
|
|
|
# pass: example-cherrypick-pass
|
2023-04-08 15:53:36 +09:00
|
|
|
|
2023-02-12 09:07:56 +09: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 11:20:14 +09: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 11:27:01 +09: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 20:26:11 +09:00
|
|
|
#redisForTimelines:
|
|
|
|
# host: redis
|
|
|
|
# port: 6379
|
|
|
|
# #family: 0 # 0=Both, 4=IPv4, 6=IPv6
|
|
|
|
# #pass: example-pass
|
|
|
|
# #prefix: example-prefix
|
|
|
|
# #db: 1
|
|
|
|
|
2023-05-05 08:52:14 +09:00
|
|
|
# ┌───────────────────────────┐
|
|
|
|
#───┘ MeiliSearch configuration └─────────────────────────────
|
|
|
|
|
|
|
|
#meilisearch:
|
|
|
|
# host: meilisearch
|
|
|
|
# port: 7700
|
|
|
|
# apiKey: ''
|
2023-05-06 04:02:34 +09:00
|
|
|
# ssl: true
|
2023-05-11 21:09:29 +09:00
|
|
|
# index: ''
|
2023-02-12 09:07:56 +09: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 18:33:51 +09:00
|
|
|
# aidx ... Millisecond accuracy
|
2023-02-12 09:07:56 +09: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 18:33:51 +09:00
|
|
|
id: 'aidx'
|
2023-02-12 09:07:56 +09:00
|
|
|
|
2024-05-28 17:06:33 +09: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-02-12 09:07:56 +09: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-13 08:14:34 +09:00
|
|
|
# inboxJobPerSec: 32
|
2023-02-12 09:07:56 +09:00
|
|
|
|
|
|
|
# Job attempts
|
|
|
|
# deliverJobMaxAttempts: 12
|
|
|
|
# inboxJobMaxAttempts: 8
|
|
|
|
|
|
|
|
# IP address family used for outgoing request (ipv4, ipv6 or dual)
|
|
|
|
#outgoingAddressFamily: ipv4
|
|
|
|
|
2023-06-18 07:48:27 +09:00
|
|
|
# Cloud Logging
|
|
|
|
#cloudLogging:
|
|
|
|
# projectId: example-project-id
|
|
|
|
# saKeyPath: /path/to/service-account-key.json
|
2023-06-18 19:16:19 +09:00
|
|
|
# logName: cherrypick
|
2023-06-18 07:48:27 +09:00
|
|
|
|
2023-09-22 11:34:50 +09:00
|
|
|
# Override the file URL rendering in ActivityPub (Object Storage file only)
|
2023-09-22 11:42:10 +09:00
|
|
|
#apFileBaseUrl: https://example.tld/
|
2023-09-22 11:34:50 +09:00
|
|
|
|
2023-02-12 09:07:56 +09: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 14:03:01 +09:00
|
|
|
# Proxy remote files (default: true)
|
|
|
|
proxyRemoteFiles: true
|
2023-02-12 09:07:56 +09:00
|
|
|
|
|
|
|
# Sign to ActivityPub GET request (default: true)
|
|
|
|
signToActivityPubGet: true
|
|
|
|
|
|
|
|
allowedPrivateNetworks: [
|
|
|
|
'127.0.0.1/32'
|
|
|
|
]
|
|
|
|
|
|
|
|
# Upload or download file size limits (bytes)
|
|
|
|
#maxFileSize: 262144000
|