Initial commit

.config/LICENSE

@@ -0,0 +1,14 @@
+Copyright 2023 The Iceshrimp contributors
+Copyright 2023 The Firefish contributors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

.config/devenv.yml

@@ -0,0 +1,29 @@
+url: http://localhost:3000
+port: 3000
+
+db:
+    host: 127.0.0.1
+    port: 5432
+
+    db: iceshrimp
+
+    user: iceshrimp
+    pass: iceshrimp
+
+redis:
+    host: localhost
+    port: 6379
+    family: 4
+#sonic:
+#  host: localhost
+#  port: 1491
+#  auth: SecretPassword
+#  collection: notes
+#  bucket: default
+
+reservedUsernames:
+    - root
+    - admin
+    - administrator
+    - me
+    - system

.config/docker_example.env

@@ -0,0 +1,4 @@
+# db settings
+POSTGRES_PASSWORD=example-iceshrimp-pass
+POSTGRES_USER=example-iceshrimp-user
+POSTGRES_DB=iceshrimp

.config/example-docker.yml

@@ -0,0 +1,263 @@
+#━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+# Iceshrimp configuration
+#━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+# After starting your server, please don't change the URL! Doing so will break federation.
+
+#   ┌─────┐
+#───┘ URL └─────────────────────────────────────────────────────
+
+# Final accessible URL seen by a user.
+url: https://example.org/
+
+# (Optional - ADVANCED) Domain used for account handles.
+# Only uncomment this if you want to for example have the URL be ice.example.org
+# and the handles to be example.org
+# accountDomain: example.org
+
+#   ┌───────────────────────┐
+#───┘ Port and TLS settings └───────────────────────────────────
+
+#
+# Iceshrimp requires a reverse proxy to support HTTPS connections.
+#
+#                 +----- https://example.com/ ------------+
+#   +------+      |+-------------+      +----------------+|
+#   | User | ---> || Proxy (443) | ---> | Iceshrimp (3000) ||
+#   +------+      |+-------------+      +----------------+|
+#                 +---------------------------------------+
+#
+#   You need to set up a reverse proxy. (e.g. nginx, caddy)
+#   An encrypted connection with HTTPS is highly recommended
+#   because tokens may be transferred in GET requests.
+
+# The port that your Iceshrimp server should listen on.
+port: 3000
+
+#   ┌──────────────────────────┐
+#───┘ PostgreSQL configuration └────────────────────────────────
+
+db:
+  host: db
+  port: 5432
+  #ssl: false
+  # Database name
+  db: iceshrimp
+
+  # Auth
+  user: example-iceshrimp-user
+  pass: example-iceshrimp-pass
+
+  # Whether disable Caching queries
+  #disableCache: true
+
+  # Extra Connection options
+  #extra:
+  #  ssl:
+  #   host: localhost
+  #   rejectUnauthorized: false
+
+#   ┌─────────────────────┐
+#───┘ Redis configuration └─────────────────────────────────────
+
+redis:
+  host: redis
+  port: 6379
+  #tls:
+  #  host: localhost
+  #  rejectUnauthorized: false
+  #family: 0  # 0=Both, 4=IPv4, 6=IPv6
+  #pass: example-pass
+  #prefix: example-prefix
+  #db: 1
+  #user: default
+
+
+#   ┌───────────────┐
+#───┘ ID generation └───────────────────────────────────────────
+
+# No need to uncomment in most cases, but you may want to change
+# these settings if you plan to run a large and/or distributed server.
+
+# cuid:
+#   # Min 16, Max 24
+#   length: 16
+#
+#   # Set this to a unique string across workers (e.g., machine's hostname)
+#   # if your workers are running in multiple hosts.
+#   fingerprint: my-fingerprint
+
+
+#   ┌─────────────────────┐
+#───┘ Other configuration └─────────────────────────────────────
+
+# Maximum length of a post (default 3000, max 100000)
+#maxNoteLength: 3000
+
+# Maximum length of an image caption (default 1500, max 8192)
+#maxCaptionLength: 1500
+
+# Reserved usernames that only the administrator can register with
+reservedUsernames: [
+  'root',
+  'admin',
+  'administrator',
+  'me',
+  'system'
+]
+
+# Whether disable HSTS
+#disableHsts: true
+
+# Number of worker processes
+#clusterLimit: 1
+
+# Worker only mode
+#onlyQueueProcessor: 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: [
+#  'web.kaiteki.app',
+#  '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
+
+# Media cleanup settings (defaults: false, 0, false, false)
+#mediaCleanup:
+#  cron: true
+#  maxAgeDays: 30
+#  cleanAvatars: false
+#  cleanHeaders: false
+
+# Status code images
+#images:
+#  info: '/twemoji/1f440.svg'
+#  notFound: '/twemoji/2049.svg'
+#  error: '/twemoji/1f480.svg'
+
+# Search engine (MFM)
+#searchEngine: 'https://duckduckgo.com/?q='
+
+#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
+
+#   ┌────────────────────────────────┐
+#───┘ Mastodon client API HTML Cache └──────────────────────────
+# Caution: rendered post html content is stored in redis (in-memory cache)
+#   for the duration of ttl, so don't set it too high if you have little system memory.
+#
+# The prewarm option causes every incoming user/note create/update event to
+#   be rendered so the cache is always "warm". This trades background cpu load for
+#   better request response time and better scaling, as posts won't have to be rendered
+#   on request.
+#
+# The dbFallback option stores html data that expires into postgres,
+#   which is more expensive than fetching it from redis,
+#   but cheaper than re-rendering the HTML.
+
+#htmlCache:
+#  ttl: 1h
+#  prewarm: false
+#  dbFallback: false
+
+# Duration hard muted notes are stored in redis for.
+# Increasing this trades higher memory consumption for lower cpu usage on repeated requests within the specified ttl.
+#wordMuteCache:
+#  ttl: 24h
+
+#━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+# Congrats, you've reached the end of the config file needed for most deployments!
+# Enjoy your Iceshrimp server!
+#━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+
+
+
+#━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+# 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.

.config/example.yml

@@ -0,0 +1,283 @@
+#━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+# Iceshrimp configuration
+#━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+# After starting your server, please don't change the URL! Doing so will break federation.
+
+#   ┌─────┐
+#───┘ URL └─────────────────────────────────────────────────────
+
+# Final accessible URL seen by a user.
+url: http://100.87.21.24:3000/
+
+# (Optional - ADVANCED) Domain used for account handles.
+# Only uncomment this if you want to for example have the URL be ice.example.org
+# and the handles to be example.org
+# accountDomain: example.org
+
+#   ┌───────────────────────┐
+#───┘ Port and TLS settings └───────────────────────────────────
+
+#
+# Iceshrimp requires a reverse proxy to support HTTPS connections.
+#
+#                 +------- https://example.com/ ------------+
+#   +------+      |+-------------+      +------------------+|
+#   | User | ---> || Proxy (443) | ---> | Iceshrimp (3000) ||
+#   +------+      |+-------------+      +------------------+|
+#                 +-----------------------------------------+
+#
+#   You need to set up a reverse proxy. (e.g. nginx, caddy)
+#   An encrypted connection with HTTPS is highly recommended
+#   because tokens may be transferred in GET requests.
+
+# The port that your Iceshrimp server should listen on.
+port: 3000
+
+# The local address that your Iceshrimp server should bind to.
+listen: 0.0.0.0
+
+# Local HTTPS certificate files.
+# tls:
+#   keyPath: .config/tls/localhost.key
+#   certPath: .config/tls/localhost.crt
+
+#   ┌──────────────────────────┐
+#───┘ PostgreSQL configuration └────────────────────────────────
+
+db:
+  host: localhost
+  port: 5432
+  #ssl: false
+  # Database name
+  db: iceshrimp
+
+  # Auth
+  user: postgres
+  pass: a
+
+  # Whether disable Caching queries
+  #disableCache: true
+
+  # Extra Connection options
+  #extra:
+  #  ssl:
+  #   host: localhost
+  #   rejectUnauthorized: false
+
+  # You can enable different different logging levels by setting the value of logging to any of the values listed below
+  #  * 'error' - logs all failed queries and errors
+  #  * 'slow' - logs slow queries
+  #  * 'query' - logs all queries
+  #  * 'schema' - logs the schema build process
+  #  * 'info' - logs internal orm informative messages
+  #  * 'log' - logs internal orm log messages
+  # You can set multiple log level by specifying them as an array i.e ['log', 'info']
+  # You can set disable all log levels by specifying an empty array: []
+  # You can set enable all log levels by specifying the special value: 'all'
+  logging: ['error', 'slow']
+
+#   ┌─────────────────────┐
+#───┘ Redis configuration └─────────────────────────────────────
+
+redis:
+  host: localhost
+  port: 6379
+  #tls:
+  #  host: localhost
+  #  rejectUnauthorized: false
+  #family: 0  # 0=Both, 4=IPv4, 6=IPv6
+  #pass: example-pass
+  #prefix: example-prefix
+  #db: 1
+  #user: default
+
+
+#   ┌───────────────┐
+#───┘ ID generation └───────────────────────────────────────────
+
+# No need to uncomment in most cases, but you may want to change
+# these settings if you plan to run a large and/or distributed server.
+
+# cuid:
+#   # Min 16, Max 24
+#   length: 16
+#
+#   # Set this to a unique string across workers (e.g., machine's hostname)
+#   # if your workers are running in multiple hosts.
+#   fingerprint: my-fingerprint
+
+
+#   ┌─────────────────────┐
+#───┘ Other configuration └─────────────────────────────────────
+
+# Maximum length of a post (default 3000, max 100000)
+#maxNoteLength: 3000
+
+# Maximum length of an image caption (default 1500, max 8192)
+#maxCaptionLength: 1500
+
+# Reserved usernames that only the administrator can register with
+reservedUsernames: [
+  'root',
+  'admin',
+  'administrator',
+  'me',
+  'system'
+]
+
+# Whether disable HSTS
+disableHsts: true
+
+# Number of worker processes
+#clusterLimit: 1
+
+# Worker only mode
+#onlyQueueProcessor: 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: [
+#  'web.kaiteki.app',
+#  '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
+
+# Media cleanup settings (defaults: false, 0, false, false)
+#mediaCleanup:
+#  cron: true
+#  maxAgeDays: 30
+#  cleanAvatars: false
+#  cleanHeaders: false
+
+# Status code images
+#images:
+#  info: '/twemoji/1f440.svg'
+#  notFound: '/twemoji/2049.svg'
+#  error: '/twemoji/1f480.svg'
+
+# Search engine (MFM)
+#searchEngine: 'https://duckduckgo.com/?q='
+
+#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
+
+#   ┌────────────────────────────────┐
+#───┘ Mastodon client API HTML Cache └──────────────────────────
+# Caution: rendered post html content is stored in redis (in-memory cache)
+#   for the duration of ttl, so don't set it too high if you have little system memory.
+#
+# The prewarm option causes every incoming user/note create/update event to
+#   be rendered so the cache is always "warm". This trades background cpu load for
+#   better request response time and better scaling, as posts won't have to be rendered
+#   on request.
+#
+# The dbFallback option stores html data that expires into postgres,
+#   which is more expensive than fetching it from redis,
+#   but cheaper than re-rendering the HTML.
+
+#htmlCache:
+#  ttl: 1h
+#  prewarm: false
+#  dbFallback: false
+
+# Duration hard muted notes are stored in redis for.
+# Increasing this trades higher memory consumption for lower cpu usage on repeated requests within the specified ttl.
+#wordMuteCache:
+#  ttl: 24h
+
+#━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+# Congrats, you've reached the end of the config file needed for most deployments!
+# Enjoy your Iceshrimp server!
+#━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+
+
+
+#━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+# 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.

.config/helm_values_example.yml

@@ -0,0 +1,82 @@
+replicaCount: 1
+
+resources:
+  requests:
+    cpu: 0.5
+    memory: 512Mi
+  limits:
+    cpu: 1
+    memory: 1Gi
+
+iceshrimp:
+  domain: example.tld
+  smtp:
+    from_address: noreply@example.tld
+    port: 587
+    server: smtp.gmail.com
+    useImplicitSslTls: false
+    login: me@example.tld
+    password: CHANGEME
+  objectStorage:
+    baseUrl: https://example-bucket.nyc3.cdn.digitaloceanspaces.com
+    access_key: CHANGEME
+    access_secret: CHANGEME
+    bucket: example-bucket
+    endpoint: nyc3.digitaloceanspaces.com:443
+    region: nyc3
+  allowedPrivateNetworks: []
+
+ingress:
+  enabled: true
+  annotations:
+    cert-manager.io/cluster-issuer: letsencrypt
+  hosts:
+    - host: example.tld
+      paths:
+        - path: /
+          pathType: ImplementationSpecific
+  tls:
+    - secretName: example-tld-certificate
+      hosts:
+        - example.tld
+
+elasticsearch:
+  enabled: false
+
+postgresql:
+  auth:
+    password: CHANGEME
+    postgresPassword: CHANGEME
+  primary:
+    persistence:
+      enabled: true
+      storageClass: vultr-block-storage
+      size: 25Gi
+    resources:
+      requests:
+        cpu: 0.25
+        memory: 256Mi
+      limits:
+        cpu: 0.5
+        memory: 512Mi
+  metrics:
+    enabled: true
+
+redis:
+  auth:
+    password: CHANGEME
+  master:
+    resources:
+      requests:
+        cpu: 0.25
+        memory: 256Mi
+      limits:
+        cpu: 0.5
+        memory: 256Mi
+    persistence:
+      storageclass: vultr-block-storage
+      size: 10Gi
+  replica:
+    replicaCount: 0
+  metrics:
+    enabled: true