[docs] Add postgresql-contrib to installation requirements

This should help reduce the bandwith usage of Iceshrimp when using
Nginx.

The `gzip_types` setting is copied from Akkoma's nginx config:
889b57df82/installation/nginx/akkoma.nginx (L66)

.config/devenv.yml

@@ -2,18 +2,18 @@ url: http://localhost:3000
 port: 3000
 
 db:
-  host: 127.0.0.1
-  port: 5432
+    host: 127.0.0.1
+    port: 5432
 
-  db: iceshrimp
+    db: iceshrimp
 
-  user: iceshrimp
-  pass: iceshrimp
+    user: iceshrimp
+    pass: iceshrimp
 
 redis:
-  host: localhost
-  port: 6379
-  family: 4
+    host: localhost
+    port: 6379
+    family: 4
 #sonic:
 #  host: localhost
 #  port: 1491
@@ -21,18 +21,9 @@ redis:
 #  collection: notes
 #  bucket: default
 
-#elasticsearch:
-#  host: localhost
-#  port: 9200
-#  ssl: false
-#  user:
-#  pass:
-
-id: 'aid'
-
 reservedUsernames:
-  - root
-  - admin
-  - administrator
-  - me
-  - system
+    - root
+    - admin
+    - administrator
+    - me
+    - system

.config/example-docker.yml

@@ -72,42 +72,6 @@ redis:
   #db: 1
   #user: default
 
-#   ┌────────────────────────────┐
-#───┘ Cache server configuration └──────────────────────────────
-
-# A Redis-compatible server (DragonflyDB, Keydb, Redis) for caching
-# If left blank, it will use the Redis server from above
-# Possible values for host: dragonflydb, keydb, redis_cache
-
-#cacheServer:
-  #host: 
-  #port: 6379
-  ##family: 0  # 0=Both, 4=IPv4, 6=IPv6
-  ##pass: example-pass
-  ##prefix: example-prefix
-  ##db: 1
-
-# Please configure either MeiliSearch *or* Sonic.
-# If both MeiliSearch and Sonic configurations are present, MeiliSearch will take precedence.
-
-#   ┌───────────────────────────┐
-#───┘ MeiliSearch configuration └───────────────────────────────
-#meilisearch:
-#  host: meilisearch
-#  port: 7700
-#  ssl: false
-#  apiKey:
-
-#   ┌─────────────────────┐
-#───┘ Sonic configuration └─────────────────────────────────────
-
-#sonic:
-#  host: sonic
-#  port: 1491
-#  auth: SecretPassword
-#  collection: notes
-#  bucket: default
-
 
 #   ┌───────────────┐
 #───┘ ID generation └───────────────────────────────────────────
@@ -220,6 +184,30 @@ reservedUsernames: [
 # 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!

.config/example.yml

@@ -72,41 +72,6 @@ redis:
   #db: 1
   #user: default
 
-#   ┌────────────────────────────┐
-#───┘ Cache server configuration └──────────────────────────────
-
-# A Redis-compatible server (DragonflyDB, Keydb, Redis) for caching
-# If left blank, it will use the Redis server from above
-
-#cacheServer:
-  #host: localhost
-  #port: 6379
-  #family: 0  # 0=Both, 4=IPv4, 6=IPv6
-  #pass: example-pass
-  #prefix: example-prefix
-  #db: 1
-
-# Please configure either MeiliSearch *or* Sonic.
-# If both MeiliSearch and Sonic configurations are present, MeiliSearch will take precedence.
-
-#   ┌───────────────────────────┐
-#───┘ MeiliSearch configuration └───────────────────────────────
-#meilisearch:
-#  host: meilisearch
-#  port: 7700
-#  ssl: false
-#  apiKey:
-
-#   ┌─────────────────────┐
-#───┘ Sonic configuration └─────────────────────────────────────
-
-#sonic:
-#  host: localhost
-#  port: 1491
-#  auth: SecretPassword
-#  collection: notes
-#  bucket: default
-
 
 #   ┌───────────────┐
 #───┘ ID generation └───────────────────────────────────────────
@@ -219,6 +184,30 @@ reservedUsernames: [
 # 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!

.editorconfig

@@ -2,7 +2,7 @@ root = true
 
 [*]
 indent_style = tab
-indent_size = 2
+indent_size = 4
 charset = utf-8
 insert_final_newline = true
 

.env.yarn

@@ -0,0 +1 @@
+JOBS=max

.forgejo/workflows/test-build.yaml

@@ -5,7 +5,7 @@ jobs:
     runs-on: docker
     container:
       image: iceshrimp.dev/iceshrimp/ci-env:latest
-      options: --volume /opt/iceshrimp-cache/yarn:/iceshrimp-caches/yarn --volume /opt/iceshrimp-cache/cargo:/root/.cargo --volume /opt/iceshrimp-cache/built:/iceshrimp-caches/built --volume /opt/iceshrimp-cache/target:/iceshrimp-caches/target
+      options: --volume /opt/iceshrimp-cache/yarn:/iceshrimp-caches/yarn
     services:
       database:
         image: postgres:15
@@ -20,7 +20,7 @@ jobs:
         run: |
           cd /iceshrimp
           cp -Tr /iceshrimp-caches/yarn .yarn
-          yarn
+          yarn --immutable
           rm -rf /iceshrimp-caches/yarn/* && cp -Tr .yarn /iceshrimp-caches/yarn
       - name: Build the shrimp
         run: |

.gitattributes

@@ -1,26 +1,53 @@
-*.svg -diff -text
-*.psd -diff -text
-*.ai -diff -text
-*.mqo -diff -text
-*.glb -diff -text
-*.blend -diff -text
-*.afdesign -diff -text
-*.zip filter=lfs diff=lfs merge=lfs -text
-*.xcf filter=lfs diff=lfs merge=lfs -text
-*.ai filter=lfs diff=lfs merge=lfs -text
-group1-shard?of6 filter=lfs diff=lfs merge=lfs -text
-*.mp3 filter=lfs diff=lfs merge=lfs -text
+*.7z filter=lfs diff=lfs merge=lfs -text
 *.afdesign filter=lfs diff=lfs merge=lfs -text
+*.ai filter=lfs diff=lfs merge=lfs -text
 *.blend filter=lfs diff=lfs merge=lfs -text
-*.glb filter=lfs diff=lfs merge=lfs -text
-*.psd filter=lfs diff=lfs merge=lfs -text
-*.gz filter=lfs diff=lfs merge=lfs -text
-*.woff2 filter=lfs diff=lfs merge=lfs -text
+*.BMP filter=lfs diff=lfs merge=lfs -text
+*.bmp filter=lfs diff=lfs merge=lfs -text
+*.bz2 filter=lfs diff=lfs merge=lfs -text
+*.doc filter=lfs diff=lfs merge=lfs -text
+*.docx filter=lfs diff=lfs merge=lfs -text
 *.enc filter=lfs diff=lfs merge=lfs -text
-*.lockb filter=lfs diff=lfs merge=lfs -text
-*.webp filter=lfs diff=lfs merge=lfs -text
-*.png filter=lfs diff=lfs merge=lfs -text
-*.jpg filter=lfs diff=lfs merge=lfs -text
-*.ico filter=lfs diff=lfs merge=lfs -text
-*.svg filter=lfs diff=lfs merge=lfs -text
+*.flac filter=lfs diff=lfs merge=lfs -text
 *.gif filter=lfs diff=lfs merge=lfs -text
+*.glb filter=lfs diff=lfs merge=lfs -text
+*.gpg filter=lfs diff=lfs merge=lfs -text
+*.gz filter=lfs diff=lfs merge=lfs -text
+*.ico filter=lfs diff=lfs merge=lfs -text
+*.jpeg filter=lfs diff=lfs merge=lfs -text
+*.JPEG filter=lfs diff=lfs merge=lfs -text
+*.jpg filter=lfs diff=lfs merge=lfs -text
+*.JPG filter=lfs diff=lfs merge=lfs -text
+*.lockb filter=lfs diff=lfs merge=lfs -text
+*.mkv filter=lfs diff=lfs merge=lfs -text
+*.mov filter=lfs diff=lfs merge=lfs -text
+*.MOV filter=lfs diff=lfs merge=lfs -text
+*.mp3 filter=lfs diff=lfs merge=lfs -text
+*.mp4 filter=lfs diff=lfs merge=lfs -text
+*.MP4 filter=lfs diff=lfs merge=lfs -text
+*.MPG filter=lfs diff=lfs merge=lfs -text
+*.mpg filter=lfs diff=lfs merge=lfs -text
+*.mqo filter=lfs diff=lfs merge=lfs -text
+*.odp filter=lfs diff=lfs merge=lfs -text
+*.ods filter=lfs diff=lfs merge=lfs -text
+*.odt filter=lfs diff=lfs merge=lfs -text
+*.ogg filter=lfs diff=lfs merge=lfs -text
+*.pdf filter=lfs diff=lfs merge=lfs -text
+*.png filter=lfs diff=lfs merge=lfs -text
+*.PNG filter=lfs diff=lfs merge=lfs -text
+*.pptx filter=lfs diff=lfs merge=lfs -text
+*.psd filter=lfs diff=lfs merge=lfs -text
+*.rar filter=lfs diff=lfs merge=lfs -text
+*.svg filter=lfs diff=lfs merge=lfs -text
+*.tar filter=lfs diff=lfs merge=lfs -text
+*.tgz filter=lfs diff=lfs merge=lfs -text
+*.wav filter=lfs diff=lfs merge=lfs -text
+*.webm filter=lfs diff=lfs merge=lfs -text
+*.webp filter=lfs diff=lfs merge=lfs -text
+*.woff2 filter=lfs diff=lfs merge=lfs -text
+*.xcf filter=lfs diff=lfs merge=lfs -text
+*.xls filter=lfs diff=lfs merge=lfs -text
+*.xz filter=lfs diff=lfs merge=lfs -text
+*.zip filter=lfs diff=lfs merge=lfs -text
+*.zstd filter=lfs diff=lfs merge=lfs -text
+group1-shard?of6 filter=lfs diff=lfs merge=lfs -text

.gitignore

@@ -76,7 +76,12 @@ pnpm*
 !.yarn/sdks
 !.yarn/versions
 !.yarn/unplugged/@discordapp-twemoji-npm-14.1.2-3097b95b97
+!.yarn/corepack.tgz
 
 # Nix Development shell items
 .devenv
-.direnv
+.direnv
+
+# helm chart dependencies
+chart/charts
+chart/Chart.lock

.vscode/extensions.json

@@ -2,10 +2,10 @@
   "recommendations": [
     "editorconfig.editorconfig",
     "eg2.vscode-npm-script",
-    "rome.rome",
-    "Vue.volar",
-    "Vue.vscode-typescript-vue-plugin",
+    "vue.volar",
+    "vue.vscode-typescript-vue-plugin",
     "arcanis.vscode-zipfs",
-		"Orta.vscode-twoslash-queries"
+    "orta.vscode-twoslash-queries",
+    "biomejs.biome"
   ]
 }

.woodpecker/commit.yml

@@ -1,22 +0,0 @@
-pipeline:
-  testCommit:
-    image: node:alpine
-    commands:
-      - apk add --no-cache cargo python3 make g++
-      - cp .config/ci.yml .config/default.yml
-      - corepack enable
-      - corepack prepare pnpm@latest --activate
-      - yarn
-      - yarn build
-      - yarn migrate
-
-services:
-  database:
-    image: postgres:15
-    environment:
-      - POSTGRES_PASSWORD=test
-  redis:
-    image: redis
-
-branches:
-  include: [ main, beta, develop, feature/* ]

.woodpecker/dockerHubRelease.yml

@@ -1,15 +0,0 @@
-pipeline:
-  publish-docker-latest:
-    image: plugins/kaniko
-    settings:
-      repo: iceshrimp/iceshrimp
-      tags: latest
-      dockerfile: Dockerfile
-      username:
-        # Secret 'docker_username' needs to be set in the CI settings
-        from_secret: docker_username
-      password:
-        # Secret 'docker_password' needs to be set in the CI settings
-        from_secret: docker_password
-
-branches: main

.woodpecker/dockerHubReleaseCandidate.yml

@@ -1,14 +0,0 @@
-pipeline:
-  publish-docker-latest:
-    image: plugins/kaniko
-    settings:
-      repo: iceshrimp/iceshrimp
-      tags: rc
-      dockerfile: Dockerfile
-      username:
-        # Secret 'docker_username' needs to be set in the CI settings
-        from_secret: docker_username
-      password:
-        # Secret 'docker_password' needs to be set in the CI settings
-        from_secret: docker_password
-branches: beta

.woodpecker/dockerHubTag.yml

@@ -1,18 +0,0 @@
-pipeline:
-  publish-docker-tag:
-    image: plugins/kaniko
-    settings:
-      repo: iceshrimp/iceshrimp
-      # Uses the tag from git for the container tag
-      tags: ${CI_COMMIT_TAG}
-      dockerfile: Dockerfile
-      username:
-        # Secret 'docker_username' needs to be set in the CI settings
-        from_secret: docker_username
-      password:
-        # Secret 'docker_password' needs to be set in the CI settings
-        from_secret: docker_password
-    when:
-      # Push new version when version tag is created
-      event: tag
-      tag: v*

.woodpecker/testDocker.yml

@@ -1,11 +0,0 @@
-pipeline:
-  docker-build:
-    image: plugins/kaniko
-    settings:
-      repo: iceshrimp/iceshrimp
-      tags: test
-      dockerfile: Dockerfile
-      no_push: true
-
-branches:
-  include: [ main, develop, beta ]