706b4ae602
This pull request adds support for the [sonic](https://github.com/valeriansaliou/sonic) full text indexing server into Calckey. In addition to this, a stateful endpoint has been added that will completely (re-)index all notes into any (elasticsearch and/or sonic) indexing server defined in your config at `/api/admin/search/index-all`. It can (optionally) take input data to define the starting point, such as: ``` {"cursor": "9beg3lx6ad"} ``` Currently if both sonic and elasticsearch are defined in the config, sonic will take precedence for searching, but both indexes will continue to be updated for new note creations. Future enhancements may include the ability to choose which indexer to use (or combine multiple). Co-authored-by: Kaitlyn Allan <kaitlyn.allan@enlabs.cloud> Reviewed-on: https://codeberg.org/calckey/calckey/pulls/9714 Co-authored-by: Kaity A <supakaity@noreply.codeberg.org> Co-committed-by: Kaity A <supakaity@noreply.codeberg.org>
214 lines
6.2 KiB
YAML
214 lines
6.2 KiB
YAML
#━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
# Calckey configuration
|
|
#━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
|
|
# ┌─────┐
|
|
#───┘ URL └─────────────────────────────────────────────────────
|
|
|
|
# Final accessible URL seen by a user.
|
|
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: localhost
|
|
port: 5432
|
|
|
|
# Database name
|
|
db: calckey
|
|
|
|
# Auth
|
|
user: example-calckey-user
|
|
pass: example-calckey-pass
|
|
|
|
# Whether disable Caching queries
|
|
#disableCache: true
|
|
|
|
# Extra Connection options
|
|
#extra:
|
|
# ssl: true
|
|
|
|
# ┌─────────────────────┐
|
|
#───┘ Redis configuration └─────────────────────────────────────
|
|
|
|
redis:
|
|
host: localhost
|
|
port: 6379
|
|
#family: 0 # 0=Both, 4=IPv4, 6=IPv6
|
|
#pass: example-pass
|
|
#prefix: example-prefix
|
|
#db: 1
|
|
|
|
# ┌─────────────────────────────┐
|
|
#───┘ Elasticsearch configuration └─────────────────────────────
|
|
|
|
#elasticsearch:
|
|
# host: localhost
|
|
# port: 9200
|
|
# ssl: false
|
|
# user:
|
|
# pass:
|
|
|
|
# ┌─────────────────────┐
|
|
#───┘ Sonic configuration └─────────────────────────────────────
|
|
|
|
#sonic:
|
|
# host: localhost
|
|
# port: 1491
|
|
# auth: SecretPassword
|
|
# collection: notes
|
|
# bucket: default
|
|
|
|
# ┌───────────────┐
|
|
#───┘ 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
|
|
# 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: 'aid'
|
|
|
|
# ┌─────────────────────┐
|
|
#───┘ Other configuration └─────────────────────────────────────
|
|
|
|
# Max note length, should be < 8000.
|
|
#maxNoteLength: 3000
|
|
|
|
# Maximum lenght of an image caption or file comment (default 1500, max 8192)
|
|
#maxCaptionLength: 1500
|
|
|
|
# Whether disable HSTS
|
|
#disableHsts: true
|
|
|
|
# Number of worker processes
|
|
#clusterLimit: 1
|
|
|
|
# Job concurrency per worker
|
|
# deliverJobConcurrency: 128
|
|
# inboxJobConcurrency: 16
|
|
|
|
# Job rate limiter
|
|
# deliverJobPerSec: 128
|
|
# inboxJobPerSec: 16
|
|
|
|
# Job attempts
|
|
# deliverJobMaxAttempts: 12
|
|
# inboxJobMaxAttempts: 8
|
|
|
|
# IP address family used for outgoing request (ipv4, ipv6 or dual)
|
|
#outgoingAddressFamily: ipv4
|
|
|
|
# Syslog option
|
|
#syslog:
|
|
# host: localhost
|
|
# port: 514
|
|
|
|
# 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
|
|
|
|
# Proxy remote files (default: false)
|
|
#proxyRemoteFiles: true
|
|
|
|
#allowedPrivateNetworks: [
|
|
# '127.0.0.1/32'
|
|
#]
|
|
|
|
# TWA
|
|
#twa:
|
|
# nameSpace: android_app
|
|
# packageName: tld.domain.twa
|
|
# sha256CertFingerprints: ['AB:CD:EF']
|
|
|
|
# Upload or download file size limits (bytes)
|
|
#maxFileSize: 262144000
|
|
|
|
# Managed hosting settings
|
|
# !!!!!!!!!!
|
|
# >>>>>> NORMAL SELF-HOSTERS, STAY AWAY! <<<<<<
|
|
# >>>>>> YOU DON'T NEED THIS! <<<<<<
|
|
# !!!!!!!!!!
|
|
# 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...
|
|
|
|
#maxUserSignups: 100
|
|
#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
|
|
# baseUrl: ''
|
|
# bucket: ''
|
|
# prefix: ''
|
|
# endpoint: ''
|
|
# region: ''
|
|
# accessKey: ''
|
|
# secretKey: ''
|
|
# useSsl: true
|
|
# connnectOverProxy: false
|
|
# setPublicReadOnUpload: true
|
|
# s3ForcePathStyle: true
|
|
|
|
# !!!!!!!!!!
|
|
# >>>>>> 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.
|
|
# They're much better off being set from the control panel.
|