do the same for soapbox

Reviewed-on: AkkomaGang/akkoma#124

.dockerignore

@@ -6,6 +6,12 @@ COPYING
 *file
 elixir_buildpack.config
 test/
+instance/
+_build
+deps
+test
+benchmarks
+docs/site
 
 # Required to get version
 !.git

.gitignore

@@ -1,4 +1,5 @@
 # App artifacts
+docs/site
 *.sw*
 secret
 /_build
@@ -61,3 +62,6 @@ pleroma.iml
 # Editor temp files
 /*~
 /*#
+
+# Generated documentation
+docs/site

.gitlab-ci.yml

@@ -1,464 +0,0 @@
-image: git.pleroma.social:5050/pleroma/pleroma/ci-base
-
-variables: &global_variables
-  POSTGRES_DB: pleroma_test
-  POSTGRES_USER: postgres
-  POSTGRES_PASSWORD: postgres
-  DB_HOST: postgres
-  MIX_ENV: test
-
-cache: &global_cache_policy
-  key:
-    files:
-      - mix.lock
-  paths:
-    - deps
-    - _build
-
-stages:
-  - build
-  - test
-  - benchmark
-  - deploy
-  - release
-  - docker
-
-before_script:
-  - echo $MIX_ENV
-  - rm -rf _build/*/lib/pleroma
-  - mix deps.get
-
-after_script:
-  - rm -rf _build/*/lib/pleroma
-
-build:
-  stage: build
-  only:
-    changes:
-      - "**/*.ex"
-      - "**/*.exs"
-      - "mix.lock"
-  script:
-  - mix compile --force
-
-spec-build:
-  stage: test
-  only:
-    changes:
-      - "lib/pleroma/web/api_spec/**/*.ex"
-      - "lib/pleroma/web/api_spec.ex"
-  artifacts:
-    paths:
-    - spec.json
-  script:
-  - mix pleroma.openapi_spec spec.json
-
-benchmark:
-  stage: benchmark
-  when: manual
-  variables:
-    MIX_ENV: benchmark
-  services:
-  - name: postgres:9.6
-    alias: postgres
-    command: ["postgres", "-c", "fsync=off", "-c", "synchronous_commit=off", "-c", "full_page_writes=off"]
-  script:
-    - mix ecto.create
-    - mix ecto.migrate
-    - mix pleroma.load_testing
-
-unit-testing:
-  stage: test
-  only:
-    changes:
-      - "**/*.ex"
-      - "**/*.exs"
-      - "mix.lock"
-  cache: &testing_cache_policy
-    <<: *global_cache_policy
-    policy: pull
-
-  services:
-  - name: postgres:13
-    alias: postgres
-    command: ["postgres", "-c", "fsync=off", "-c", "synchronous_commit=off", "-c", "full_page_writes=off"]
-  script:
-    - mix ecto.create
-    - mix ecto.migrate
-    - mix coveralls --preload-modules
-
-unit-testing-erratic:
-  stage: test
-  retry: 2
-  only:
-    changes:
-      - "**/*.ex"
-      - "**/*.exs"
-      - "mix.lock"
-  cache: &testing_cache_policy
-    <<: *global_cache_policy
-    policy: pull
-
-  services:
-  - name: postgres:13
-    alias: postgres
-    command: ["postgres", "-c", "fsync=off", "-c", "synchronous_commit=off", "-c", "full_page_writes=off"]
-  script:
-    - mix ecto.create
-    - mix ecto.migrate
-    - mix test --only=erratic
-
-# Removed to fix CI issue. In this early state it wasn't adding much value anyway.
-# TODO Fix and reinstate federated testing
-# federated-testing:
-#   stage: test
-#   cache: *testing_cache_policy
-#   services:
-#   - name: minibikini/postgres-with-rum:12
-#     alias: postgres
-#     command: ["postgres", "-c", "fsync=off", "-c", "synchronous_commit=off", "-c", "full_page_writes=off"]
-#   script:
-#     - mix deps.get
-#     - mix ecto.create
-#     - mix ecto.migrate
-#     - epmd -daemon
-#     - mix test --trace --only federated
-
-unit-testing-rum:
-  stage: test
-  only:
-    changes:
-      - "**/*.ex"
-      - "**/*.exs"
-      - "mix.lock"
-  cache: *testing_cache_policy
-  services:
-  - name: minibikini/postgres-with-rum:12
-    alias: postgres
-    command: ["postgres", "-c", "fsync=off", "-c", "synchronous_commit=off", "-c", "full_page_writes=off"]
-  variables:
-    <<: *global_variables
-    RUM_ENABLED: "true"
-  script:
-    - mix ecto.create
-    - mix ecto.migrate
-    - "mix ecto.migrate --migrations-path priv/repo/optional_migrations/rum_indexing/"
-    - mix test --preload-modules
-
-lint:
-  image: elixir:1.12
-  stage: test
-  only:
-    changes:
-      - "**/*.ex"
-      - "**/*.exs"
-      - "mix.lock"
-  cache: *testing_cache_policy
-  before_script:
-    - mix local.hex --force
-    - mix local.rebar --force
-    - mix deps.get
-  script:
-    - mix format --check-formatted
-
-analysis:
-  stage: test
-  only:
-    changes:
-      - "**/*.ex"
-      - "**/*.exs"
-      - "mix.lock"
-  cache: *testing_cache_policy
-  script:
-    - mix credo --strict --only=warnings,todo,fixme,consistency,readability
-
-cycles:
-  stage: test
-  image: elixir:1.11
-  only:
-    changes:
-      - "**/*.ex"
-      - "**/*.exs"
-      - "mix.lock"
-  cache: {}
-  before_script:
-    - mix local.hex --force
-    - mix local.rebar --force
-    - mix deps.get
-    - apt-get update
-    - apt-get install cmake libmagic-dev -y
-  script:
-    - mix compile
-    - mix xref graph --format cycles --label compile | awk '{print $0} END{exit ($0 != "No cycles found")}'
-
-docs-deploy:
-  stage: deploy
-  cache: *testing_cache_policy
-  image: alpine:latest
-  only:
-  - stable@pleroma/pleroma
-  - develop@pleroma/pleroma
-  before_script:
-  - apk add curl
-  script:
-  - curl -X POST -F"token=$DOCS_PIPELINE_TRIGGER" -F'ref=master' -F"variables[BRANCH]=$CI_COMMIT_REF_NAME" https://git.pleroma.social/api/v4/projects/673/trigger/pipeline
-review_app:
-  image: alpine:3.9
-  stage: deploy
-  before_script:
-    - apk update && apk add openssh-client git
-  when: manual
-  environment:
-    name: review/$CI_COMMIT_REF_NAME
-    url: https://$CI_ENVIRONMENT_SLUG.pleroma.online/
-    on_stop: stop_review_app
-  only:
-    - branches
-  except:
-    - master
-    - develop
-  script:
-    - echo "$CI_ENVIRONMENT_SLUG"
-    - mkdir -p ~/.ssh
-    - eval $(ssh-agent -s)
-    - echo "$SSH_PRIVATE_KEY" | tr -d '\r' | ssh-add -
-    - ssh-keyscan -H "pleroma.online" >> ~/.ssh/known_hosts
-    - (ssh -t dokku@pleroma.online -- apps:create "$CI_ENVIRONMENT_SLUG") || true
-    - (ssh -t dokku@pleroma.online -- git:set "$CI_ENVIRONMENT_SLUG" keep-git-dir true) || true
-    - ssh -t dokku@pleroma.online -- config:set "$CI_ENVIRONMENT_SLUG" APP_NAME="$CI_ENVIRONMENT_SLUG" APP_HOST="$CI_ENVIRONMENT_SLUG.pleroma.online" MIX_ENV=dokku
-    - (ssh -t dokku@pleroma.online -- postgres:create $(echo $CI_ENVIRONMENT_SLUG | sed -e 's/-/_/g')_db) || true
-    - (ssh -t dokku@pleroma.online -- postgres:link $(echo $CI_ENVIRONMENT_SLUG | sed -e 's/-/_/g')_db "$CI_ENVIRONMENT_SLUG") || true
-    - (ssh -t dokku@pleroma.online -- certs:add "$CI_ENVIRONMENT_SLUG" /home/dokku/server.crt /home/dokku/server.key) || true
-    - git push -f dokku@pleroma.online:$CI_ENVIRONMENT_SLUG $CI_COMMIT_SHA:refs/heads/master
-
-spec-deploy:
-  stage: deploy
-  artifacts:
-    paths:
-    - spec.json
-  only:
-    - develop@pleroma/pleroma
-  image: alpine:latest
-  before_script:
-    - apk add curl
-  script:
-    - curl -X POST -F"token=$API_DOCS_PIPELINE_TRIGGER" -F'ref=master' -F"variables[BRANCH]=$CI_COMMIT_REF_NAME" -F"variables[JOB_REF]=$CI_JOB_ID" https://git.pleroma.social/api/v4/projects/1130/trigger/pipeline
-
-
-stop_review_app:
-  image: alpine:3.9
-  stage: deploy
-  before_script:
-    - apk update && apk add openssh-client git
-  when: manual
-  environment:
-    name: review/$CI_COMMIT_REF_NAME
-    action: stop
-  script:
-    - echo "$CI_ENVIRONMENT_SLUG"
-    - mkdir -p ~/.ssh
-    - eval $(ssh-agent -s)
-    - echo "$SSH_PRIVATE_KEY" | tr -d '\r' | ssh-add -
-    - ssh-keyscan -H "pleroma.online" >> ~/.ssh/known_hosts
-    - ssh -t dokku@pleroma.online -- --force apps:destroy "$CI_ENVIRONMENT_SLUG"
-    - ssh -t dokku@pleroma.online -- --force postgres:destroy $(echo $CI_ENVIRONMENT_SLUG | sed -e 's/-/_/g')_db
-
-amd64:
-  stage: release
-  image: elixir:1.10.4
-  only: &release-only
-  - stable@pleroma/pleroma
-  - develop@pleroma/pleroma
-  - /^maint/.*$/@pleroma/pleroma
-  - /^release/.*$/@pleroma/pleroma
-  artifacts: &release-artifacts
-    name: "pleroma-$CI_COMMIT_REF_NAME-$CI_COMMIT_SHORT_SHA-$CI_JOB_NAME"
-    paths:
-      - release/*
-    # Ideally it would be never for master branch and with the next commit for develop,
-    # but Gitlab does not support neither `only` for artifacts
-    # nor setting it to never from .gitlab-ci.yml
-    # nor expiring with the next commit
-    expire_in: 42 yrs
-
-  cache: &release-cache
-    key: $CI_COMMIT_REF_NAME-$CI_JOB_NAME
-    paths:
-          - deps
-  variables: &release-variables
-    MIX_ENV: prod
-  before_script: &before-release
-  - apt-get update && apt-get install -y cmake libmagic-dev
-  - echo "import Mix.Config" > config/prod.secret.exs
-  - mix local.hex --force
-  - mix local.rebar --force
-  script: &release
-    - mix deps.get --only prod
-    - mkdir release
-    - export PLEROMA_BUILD_BRANCH=$CI_COMMIT_REF_NAME
-    - mix release --path release
-
-
-amd64-musl:
-  stage: release
-  artifacts: *release-artifacts
-  only: *release-only
-  image: elixir:1.10.4-alpine
-  cache: *release-cache
-  variables: *release-variables
-  before_script: &before-release-musl
-  - apk add git gcc g++ musl-dev make cmake file-dev
-  - echo "import Mix.Config" > config/prod.secret.exs
-  - mix local.hex --force
-  - mix local.rebar --force
-  script: *release
-
-arm:
-  stage: release
-  artifacts: *release-artifacts
-  only: *release-only
-  tags:
-    - arm32-specified
-  image: arm32v7/elixir:1.10.4
-  cache: *release-cache
-  variables: *release-variables
-  before_script: *before-release
-  script: *release
-
-arm-musl:
-  stage: release
-  artifacts: *release-artifacts
-  only: *release-only
-  tags:
-    - arm32-specified
-  image: arm32v7/elixir:1.10.4-alpine
-  cache: *release-cache
-  variables: *release-variables
-  before_script: *before-release-musl
-  script: *release
-
-arm64:
-  stage: release
-  artifacts: *release-artifacts
-  only: *release-only
-  tags:
-    - arm
-  image: arm64v8/elixir:1.10.4
-  cache: *release-cache
-  variables: *release-variables
-  before_script: *before-release
-  script: *release
-
-arm64-musl:
-  stage: release
-  artifacts: *release-artifacts
-  only: *release-only
-  tags:
-    - arm
-  image: arm64v8/elixir:1.10.4-alpine
-  cache: *release-cache
-  variables: *release-variables
-  before_script: *before-release-musl
-  script: *release
-
-docker:
-  stage: docker
-  image: docker:latest
-  cache: {}
-  dependencies: []
-  variables: &docker-variables
-    DOCKER_DRIVER: overlay2
-    DOCKER_HOST: unix:///var/run/docker.sock
-    IMAGE_TAG: $CI_REGISTRY_IMAGE:$CI_COMMIT_SHORT_SHA
-    IMAGE_TAG_SLUG: $CI_REGISTRY_IMAGE:$CI_COMMIT_REF_SLUG
-    IMAGE_TAG_LATEST: $CI_REGISTRY_IMAGE:latest
-    IMAGE_TAG_LATEST_STABLE: $CI_REGISTRY_IMAGE:latest-stable
-    DOCKER_BUILDX_URL: https://github.com/docker/buildx/releases/download/v0.6.3/buildx-v0.6.3.linux-amd64
-    DOCKER_BUILDX_HASH: 980e6b9655f971991fbbb5fd6cd19f1672386195
-  before_script: &before-docker
-    - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
-    - docker pull $IMAGE_TAG_SLUG || true
-    - export CI_JOB_TIMESTAMP=$(date --utc -Iseconds)
-    - export CI_VCS_REF=$CI_COMMIT_SHORT_SHA
-  allow_failure: true
-  script:
-    - mkdir -p /root/.docker/cli-plugins
-    - wget "${DOCKER_BUILDX_URL}" -O ~/.docker/cli-plugins/docker-buildx
-    - echo "${DOCKER_BUILDX_HASH}  /root/.docker/cli-plugins/docker-buildx" | sha1sum -c
-    - chmod +x ~/.docker/cli-plugins/docker-buildx
-    - docker run --rm --privileged multiarch/qemu-user-static --reset -p yes
-    - docker buildx create --name mbuilder --driver docker-container --use
-    - docker buildx inspect --bootstrap
-    - docker buildx build --platform linux/amd64,linux/arm/v7,linux/arm64/v8 --push --cache-from $IMAGE_TAG_SLUG --build-arg VCS_REF=$CI_VCS_REF --build-arg BUILD_DATE=$CI_JOB_TIMESTAMP -t $IMAGE_TAG -t $IMAGE_TAG_SLUG -t $IMAGE_TAG_LATEST .
-  tags:
-    - dind
-  only:
-    - develop@pleroma/pleroma
-
-docker-stable:
-  stage: docker
-  image: docker:latest
-  cache: {}
-  dependencies: []
-  variables: *docker-variables
-  before_script: *before-docker
-  allow_failure: true
-  script:
-    - mkdir -p /root/.docker/cli-plugins
-    - wget "${DOCKER_BUILDX_URL}" -O ~/.docker/cli-plugins/docker-buildx
-    - echo "${DOCKER_BUILDX_HASH}  /root/.docker/cli-plugins/docker-buildx" | sha1sum -c
-    - chmod +x ~/.docker/cli-plugins/docker-buildx
-    - docker run --rm --privileged multiarch/qemu-user-static --reset -p yes
-    - docker buildx create --name mbuilder --driver docker-container --use
-    - docker buildx inspect --bootstrap
-    - docker buildx build --platform linux/amd64,linux/arm/v7,linux/arm64/v8 --push --cache-from $IMAGE_TAG_SLUG --build-arg VCS_REF=$CI_VCS_REF --build-arg BUILD_DATE=$CI_JOB_TIMESTAMP -t $IMAGE_TAG -t $IMAGE_TAG_SLUG -t $IMAGE_TAG_LATEST_STABLE .
-  tags:
-    - dind
-  only:
-    - stable@pleroma/pleroma
-
-docker-release:
-  stage: docker
-  image: docker:latest
-  cache: {}
-  dependencies: []
-  variables: *docker-variables
-  before_script: *before-docker
-  allow_failure: true
-  script:
-  script:
-    - mkdir -p /root/.docker/cli-plugins
-    - wget "${DOCKER_BUILDX_URL}" -O ~/.docker/cli-plugins/docker-buildx
-    - echo "${DOCKER_BUILDX_HASH}  /root/.docker/cli-plugins/docker-buildx" | sha1sum -c
-    - chmod +x ~/.docker/cli-plugins/docker-buildx
-    - docker run --rm --privileged multiarch/qemu-user-static --reset -p yes
-    - docker buildx create --name mbuilder --driver docker-container --use
-    - docker buildx inspect --bootstrap
-    - docker buildx build --platform linux/amd64,linux/arm/v7,linux/arm64/v8 --push --cache-from $IMAGE_TAG_SLUG --build-arg VCS_REF=$CI_VCS_REF --build-arg BUILD_DATE=$CI_JOB_TIMESTAMP -t $IMAGE_TAG -t $IMAGE_TAG_SLUG .
-  tags:
-    - dind
-  only:
-    - /^release/.*$/@pleroma/pleroma
-
-docker-adhoc:
-  stage: docker
-  image: docker:latest
-  cache: {}
-  dependencies: []
-  variables: *docker-variables
-  before_script: *before-docker
-  allow_failure: true
-  script:
-  script:
-    - mkdir -p /root/.docker/cli-plugins
-    - wget "${DOCKER_BUILDX_URL}" -O ~/.docker/cli-plugins/docker-buildx
-    - echo "${DOCKER_BUILDX_HASH}  /root/.docker/cli-plugins/docker-buildx" | sha1sum -c
-    - chmod +x ~/.docker/cli-plugins/docker-buildx
-    - docker run --rm --privileged multiarch/qemu-user-static --reset -p yes
-    - docker buildx create --name mbuilder --driver docker-container --use
-    - docker buildx inspect --bootstrap
-    - docker buildx build --platform linux/amd64,linux/arm/v7,linux/arm64/v8 --push --cache-from $IMAGE_TAG_SLUG --build-arg VCS_REF=$CI_VCS_REF --build-arg BUILD_DATE=$CI_JOB_TIMESTAMP -t $IMAGE_TAG -t $IMAGE_TAG_SLUG .
-  tags:
-    - dind
-  only:
-    - /^build-docker/.*$/@pleroma/pleroma

.woodpecker.yml

@@ -0,0 +1,188 @@
+variables:
+  - &scw-secrets
+    - SCW_ACCESS_KEY
+    - SCW_SECRET_KEY
+    - SCW_DEFAULT_ORGANIZATION_ID
+  - &setup-hex "mix local.hex --force && mix local.rebar --force"
+  - &on-release
+    when:
+      event:
+        - push
+        - tag
+      branch:
+        - develop
+        - stable
+        - refs/tags/v*
+        - refs/tags/stable-*
+  - &on-point-release
+    when:
+      event:
+        - push
+      branch:
+        - develop
+        - stable
+  - &on-pr-open
+    when:
+      event:
+        - pull_request
+
+  - &tag-build "export BUILD_TAG=$${CI_COMMIT_TAG:-\"$CI_COMMIT_BRANCH\"} && export PLEROMA_BUILD_BRANCH=$BUILD_TAG"
+
+  - &clean "(rm -rf release || true) && (rm -rf _build || true) && (rm -rf /root/.mix)"
+  - &mix-clean "mix deps.clean --all && mix clean"
+
+services:
+  postgres:
+    image: postgres:13
+    when:
+      event:
+        - pull_request
+    environment:
+      POSTGRES_DB: pleroma_test
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
+
+pipeline:
+  lint:
+    <<: *on-pr-open
+    image: akkoma/ci-base:latest
+    commands:
+    - mix local.hex --force
+    - mix local.rebar --force
+    - mix format --check-formatted
+
+  build:
+    image: akkoma/ci-base:latest
+    <<: *on-pr-open
+    environment:
+      MIX_ENV: test
+      POSTGRES_DB: pleroma_test
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
+      DB_HOST: postgres
+    commands:
+      - mix local.hex --force
+      - mix local.rebar --force
+      - mix deps.get
+      - mix compile
+
+  test:
+    image: akkoma/ci-base:latest
+    <<: *on-pr-open
+    environment:
+      MIX_ENV: test
+      POSTGRES_DB: pleroma_test
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
+      DB_HOST: postgres
+    commands:
+    - mix local.hex --force
+    - mix local.rebar --force
+    - mix deps.get
+    - mix compile
+    - mix ecto.drop -f -q
+    - mix ecto.create
+    - mix ecto.migrate
+    - mix test --preload-modules --exclude erratic --exclude federated --max-cases 4
+
+  # Canonical amd64
+  ubuntu22:
+    image: hexpm/elixir:1.13.4-erlang-25.0.2-ubuntu-jammy-20220428
+    <<: *on-release
+    environment:
+      MIX_ENV: prod
+      DEBIAN_FRONTEND: noninteractive
+    commands:
+      - rm config/emoji.txt
+      - apt-get update && apt-get install -y cmake libmagic-dev rclone zip imagemagick libmagic-dev git build-essential g++ wget
+      - *clean
+      - echo "import Config" > config/prod.secret.exs
+      - *setup-hex
+      - *tag-build
+      - mix deps.get --only prod
+      - mix release --path release
+      - zip akkoma-ubuntu-jammy.zip -r release
+
+  release-ubuntu22:
+    image: akkoma/releaser
+    <<: *on-release
+    secrets: *scw-secrets
+    commands:
+      - export SOURCE=akkoma-ubuntu-jammy.zip
+      - export DEST=scaleway:akkoma-updates/$${CI_COMMIT_TAG:-"$CI_COMMIT_BRANCH"}/akkoma-ubuntu-jammy.zip
+      - /bin/sh /entrypoint.sh
+
+  debian-bullseye:
+    image: elixir:1.13.4
+    <<: *on-release
+    environment:
+      MIX_ENV: prod
+      DEBIAN_FRONTEND: noninteractive
+    commands:
+      - apt-get update && apt-get install -y cmake libmagic-dev rclone zip imagemagick libmagic-dev git build-essential gcc make g++ wget
+      - *clean
+      - echo "import Config" > config/prod.secret.exs
+      - *setup-hex
+      - *tag-build
+      - *mix-clean
+      - mix deps.get --only prod
+      - mix release --path release
+      - zip akkoma-amd64.zip -r release
+
+  release-debian:
+    image: akkoma/releaser
+    <<: *on-release
+    secrets: *scw-secrets
+    commands:
+      - export SOURCE=akkoma-amd64.zip
+      - export DEST=scaleway:akkoma-updates/$${CI_COMMIT_TAG:-"$CI_COMMIT_BRANCH"}/akkoma-amd64.zip
+      - /bin/sh /entrypoint.sh
+      - export DEST=scaleway:akkoma-updates/$${CI_COMMIT_TAG:-"$CI_COMMIT_BRANCH"}/akkoma-debian-stable.zip
+      - /bin/sh /entrypoint.sh
+
+  # Canonical amd64-musl
+  musl:
+    image: elixir:1.13.4-alpine
+    <<: *on-release
+    environment:
+      MIX_ENV: prod
+    commands:
+      - apk add git gcc g++ musl-dev make cmake file-dev rclone wget zip imagemagick
+      - *clean
+      - *setup-hex
+      - *mix-clean
+      - *tag-build
+      - mix deps.get --only prod
+      - mix release --path release
+      - zip akkoma-amd64-musl.zip -r release
+
+  release-musl:
+    image: akkoma/releaser
+    <<: *on-release
+    secrets: *scw-secrets
+    commands:
+      - export SOURCE=akkoma-amd64-musl.zip
+      - export DEST=scaleway:akkoma-updates/$${CI_COMMIT_TAG:-"$CI_COMMIT_BRANCH"}/akkoma-amd64-musl.zip
+      - /bin/sh /entrypoint.sh
+
+  docs:
+    <<: *on-point-release
+    secrets:
+    - SCW_ACCESS_KEY
+    - SCW_SECRET_KEY
+    - SCW_DEFAULT_ORGANIZATION_ID
+    environment:
+      CI: "true"
+    image: python:3.10-slim
+    commands:
+      - apt-get update && apt-get install -y rclone wget git zip
+      - wget https://github.com/scaleway/scaleway-cli/releases/download/v2.5.1/scaleway-cli_2.5.1_linux_amd64
+      - mv scaleway-cli_2.5.1_linux_amd64 scaleway-cli
+      - chmod +x scaleway-cli
+      - ./scaleway-cli object config install type=rclone
+      - cd docs
+      - pip install -r requirements.txt
+      - mkdocs build
+      - zip -r docs.zip site/*
+      - cd site
+      - rclone copy . scaleway:akkoma-docs/$CI_COMMIT_BRANCH/

.woodpecker/.lint.yml

@@ -1,10 +0,0 @@
-pipeline:
-  lint:
-    image: pleromaforkci/ci-base:1.13
-    commands:
-    - mix local.hex --force
-    - mix local.rebar --force
-    - mix format --check-formatted
-    when:
-      event:
-      - push

.woodpecker/.release.yml

@@ -1,78 +0,0 @@
-matrix:
-  docker_prefix:
-  - ""
-  - arm64v8/
-  - arm32v7/
-  tag:
-  - amd64
-  - arm64
-  - arm
-
-  include:
-  - tag: amd64
-    docker_prefix: ""
-
-pipeline:
-  glibc:
-    when:
-      event:
-        - push
-      branch:
-        - develop
-    secrets:
-    - SCW_ACCESS_KEY
-    - SCW_SECRET_KEY
-    - SCW_DEFAULT_ORGANIZATION_ID
-    image: ${docker_prefix}elixir:1.13
-    environment:
-      MIX_ENV: prod
-    commands:
-      - apt-get update && apt-get install -y cmake libmagic-dev rclone zip imagemagick libmagic-dev
-      - wget https://github.com/scaleway/scaleway-cli/releases/download/v2.5.1/scaleway-cli_2.5.1_linux_amd64
-      - mv scaleway-cli_2.5.1_linux_amd64 scaleway-cli
-      - chmod +x scaleway-cli
-      - ./scaleway-cli object config install type=rclone
-      - echo "import Mix.Config" > config/prod.secret.exs
-      - mix local.hex --force
-      - mix local.rebar --force
-      - mix deps.clean --all
-      - mix deps.get --only prod
-      - mkdir release
-      - export PLEROMA_BUILD_BRANCH=develop
-      - mix release --path release
-      - zip akkoma-${tag}.zip -r release
-      - rclone copyto akkoma-${tag}.zip scaleway:akkoma-updates/develop/akkoma-${tag}.zip
-
-  musl:
-    when:
-      event:
-        - push
-      branch:
-        - develop
-    secrets:
-    - SCW_ACCESS_KEY
-    - SCW_SECRET_KEY
-    - SCW_DEFAULT_ORGANIZATION_ID
-    group: release
-    image: ${docker_prefix}elixir:1.13-alpine
-    environment:
-      MIX_ENV: prod
-    commands:
-      - apk add git gcc g++ musl-dev make cmake file-dev rclone wget zip imagemagick
-      - rm -rf release || true
-      - rm -rf _build || true
-      - rm -rf /root/.mix
-      - rm scaleway-cli || true
-      - wget https://github.com/scaleway/scaleway-cli/releases/download/v2.5.1/scaleway-cli_2.5.1_linux_amd64
-      - mv scaleway-cli_2.5.1_linux_amd64 scaleway-cli
-      - chmod +x scaleway-cli
-      - ./scaleway-cli object config install type=rclone
-
-      - mix local.hex --force
-      - mix local.rebar --force
-      - mix deps.clean --all 
-      - mix deps.get --only prod
-      - mix release --path release
-      - export PLEROMA_BUILD_BRANCH=develop
-      - zip akkoma-${tag}.zip -r release
-      - rclone copyto akkoma-${tag}.zip scaleway:akkoma-updates/develop/akkoma-${tag}-musl.zip

.woodpecker/.test.yml

@@ -1,50 +0,0 @@
-depends_on:
-- lint
-
-matrix:
-  ELIXIR_VERSION:
-  - 1.13
-
-pipeline:
-  build:
-    image: pleromaforkci/ci-base:${ELIXIR_VERSION}
-    when:
-      event:
-      - push
-      - pull_request
-    environment:
-      MIX_ENV: test
-    commands:
-    - mix local.hex --force
-    - mix local.rebar --force
-    - mix deps.get
-    - mix compile
-
-  test:
-    group: test
-    image: pleromaforkci/ci-base:${ELIXIR_VERSION}
-    when:
-      event:
-      - push
-      - pull_request
-    environment:
-      MIX_ENV: test
-      POSTGRES_DB: pleroma_test
-      POSTGRES_USER: postgres
-      POSTGRES_PASSWORD: postgres
-      DB_HOST: postgres
-    commands:
-    - mix local.hex --force
-    - mix local.rebar --force
-    - mix ecto.drop -f -q
-    - mix ecto.create
-    - mix ecto.migrate
-    - mix test --preload-modules --exclude erratic --exclude federated --max-cases 4
-     
-services:
-  postgres:
-    image: postgres:13
-    environment:
-      POSTGRES_DB: pleroma_test
-      POSTGRES_USER: postgres
-      POSTGRES_PASSWORD: postgres

CHANGELOG.md

@@ -6,10 +6,40 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ## [Unreleased]
 
+### Added
+- extended runtime module support, see config cheatsheet
+- quote posting; quotes are limited to public posts
+
+### Changed
+- quarantining is now considered absolutely; public activities are no longer
+  an exception.
+- flavours:
+  - amd64 is built for debian stable. Compatible with ubuntu 20.
+  - ubuntu-jammy is built for... well, ubuntu 22 (LTS)
+  - amd64-musl is built for alpine 3.16
+
+### Fixed
+- Updated mastoFE path, for the newer version
+
+### Removed
+- Scrobbling support
+  - `/api/v1/pleroma/scrobble`
+  - `/api/v1/pleroma/accounts/{id}/scrobbles`
+- Deprecated endpoints
+  - `/api/v1/pleroma/chats`
+  - `/api/v1/notifications/dismiss`
+  - `/api/v1/search`
+  - `/api/v1/statuses/{id}/card` 
+- Chats, they were half-baked. Just use PMs.
+- Prometheus, it causes massive slowdown
+
+## 2022.07
+
 ### Added
 - Added move account API
 - Added ability to set instance accent-color via theme-color
 - A fallback page for when a user does not have a frontend installed
+- Support for OTP musl11
 
 ### Removed
 - SSH frontend, to be potentially re-enabled via a bridge rather than wired into the main system
@@ -21,6 +51,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ### Upgrade Notes
 - The bundled frontend has been removed, you will need to run the `pleroma.frontend install` mix task to install your frontend of choice. Configuration by default is set to `pleroma-fe`.
+- Admin-FE users will have to ensure that :admin is set _BEFORE_ restart, or
+you might end up in a situation where you don't have an ability to get it.
 
 ## 2.5.2
 

Dockerfile

@@ -1,52 +1,50 @@
-FROM elixir:1.9-alpine as build
+FROM elixir:1.13.4-alpine as build
 
 COPY . .
 
 ENV MIX_ENV=prod
 
 RUN apk add git gcc g++ musl-dev make cmake file-dev &&\
-	echo "import Mix.Config" > config/prod.secret.exs &&\
+	echo "import Config" > config/prod.secret.exs &&\
 	mix local.hex --force &&\
 	mix local.rebar --force &&\
 	mix deps.get --only prod &&\
 	mkdir release &&\
 	mix release --path release
 
-FROM alpine:3.14
+FROM alpine:3.16
 
 ARG BUILD_DATE
 ARG VCS_REF
 
-LABEL maintainer="ops@pleroma.social" \
-    org.opencontainers.image.title="pleroma" \
-    org.opencontainers.image.description="Pleroma for Docker" \
-    org.opencontainers.image.authors="ops@pleroma.social" \
-    org.opencontainers.image.vendor="pleroma.social" \
-    org.opencontainers.image.documentation="https://git.pleroma.social/pleroma/pleroma" \
+LABEL org.opencontainers.image.title="akkoma" \
+    org.opencontainers.image.description="Akkoma for Docker" \
+    org.opencontainers.image.vendor="akkoma.dev" \
+    org.opencontainers.image.documentation="https://docs.akkoma.dev/stable/" \
     org.opencontainers.image.licenses="AGPL-3.0" \
-    org.opencontainers.image.url="https://pleroma.social" \
+    org.opencontainers.image.url="https://akkoma.dev" \
     org.opencontainers.image.revision=$VCS_REF \
     org.opencontainers.image.created=$BUILD_DATE
 
-ARG HOME=/opt/pleroma
-ARG DATA=/var/lib/pleroma
+ARG HOME=/opt/akkoma
+ARG DATA=/var/lib/akkoma
 
 RUN apk update &&\
 	apk add exiftool ffmpeg imagemagick libmagic ncurses postgresql-client &&\
-	adduser --system --shell /bin/false --home ${HOME} pleroma &&\
+	adduser --system --shell /bin/false --home ${HOME} akkoma &&\
 	mkdir -p ${DATA}/uploads &&\
 	mkdir -p ${DATA}/static &&\
-	chown -R pleroma ${DATA} &&\
-	mkdir -p /etc/pleroma &&\
-	chown -R pleroma /etc/pleroma
+	chown -R akkoma ${DATA} &&\
+	mkdir -p /etc/akkoma &&\
+	chown -R akkoma /etc/akkoma
 
-USER pleroma
+USER akkoma
 
-COPY --from=build --chown=pleroma:0 /release ${HOME}
+COPY --from=build --chown=akkoma:0 /release ${HOME}
 
-COPY ./config/docker.exs /etc/pleroma/config.exs
+COPY ./config/docker.exs /etc/akkoma/config.exs
 COPY ./docker-entrypoint.sh ${HOME}
 
 EXPOSE 4000
 
-ENTRYPOINT ["/opt/pleroma/docker-entrypoint.sh"]
+ENTRYPOINT ["/opt/akkoma/docker-entrypoint.sh"]

Makefile

@@ -0,0 +1,7 @@
+all:	install
+	pipenv run mkdocs build
+
+install:
+	pipenv install
+clean:
+	rm -rf docs

README.md

@@ -4,37 +4,37 @@
 
 ## About 
 
-This is a fork of Pleroma, which is a microblogging server software that can federate (= exchange messages with) other servers that support ActivityPub. What that means is that you can host a server for yourself or your friends and stay in control of your online identity, but still exchange messages with people on larger servers. Pleroma will federate with all servers that implement ActivityPub, like Friendica, GNU Social, Hubzilla, Mastodon, Misskey, Peertube, and Pixelfed.
+This is a fork of Pleroma, which is a microblogging server software that can federate (= exchange messages with) other servers that support ActivityPub. What that means is that you can host a server for yourself or your friends and stay in control of your online identity, but still exchange messages with people on larger servers. Akkoma will federate with all servers that implement ActivityPub, like Friendica, GNU Social, Hubzilla, Mastodon, Misskey, Peertube, and Pixelfed.
 
 Akkoma is written in Elixir and uses PostgresSQL for data storage.
 
-For clients it supports the [Mastodon client API](https://docs.joinmastodon.org/api/guidelines/) with Pleroma extensions (see the API section on <https://docs.akkoma.dev/main/>).
+For clients it supports the [Mastodon client API](https://docs.joinmastodon.org/api/guidelines/) with Pleroma extensions (see the API section on <https://docs.akkoma.dev/stable/>).
 
-- [Client Applications for Pleroma](https://docs.akkoma.dev/main/backend/clients/)
+- [Client Applications for Akkoma](https://docs.akkoma.dev/stable/clients/)
 
 ## Installation
 
 ### OTP releases (Recommended)
-If you are running Linux (glibc or musl) on x86, the recommended way to install Pleroma is by using OTP releases. OTP releases are as close as you can get to binary releases with Erlang/Elixir. The release is self-contained, and provides everything needed to boot it. The installation instructions are available [here](https://docs.akkoma.dev/main/backend/installation/otp_en/).
+If you are running Linux (glibc or musl) on x86, the recommended way to install Akkoma is by using OTP releases. OTP releases are as close as you can get to binary releases with Erlang/Elixir. The release is self-contained, and provides everything needed to boot it. The installation instructions are available [here](https://docs.akkoma.dev/stable/installation/otp_en/).
 
 ### From Source
-If your platform is not supported, or you just want to be able to edit the source code easily, you may install Pleroma from source.
+If your platform is not supported, or you just want to be able to edit the source code easily, you may install Akkoma from source.
 
-- [Alpine Linux](https://docs.akkoma.dev/main/backend/installation/alpine_linux_en/)
-- [Arch Linux](https://docs.akkoma.dev/main/backend/installation/arch_linux_en/)
-- [Debian-based](https://docs.akkoma.dev/main/backend/installation/debian_based_en/)
-- [Debian-based (jp)](https://docs.akkoma.dev/main/backend/installation/debian_based_jp/)
-- [FreeBSD](https://docs.akkoma.dev/main/backend/installation/freebsd_en/)
-- [Gentoo Linux](https://docs.akkoma.dev/main/backend/installation/gentoo_en/)
-- [NetBSD](https://docs.akkoma.dev/main/backend/installation/netbsd_en/)
-- [OpenBSD](https://docs.akkoma.dev/main/backend/installation/openbsd_en/)
-- [OpenBSD (fi)](https://docs.akkoma.dev/main/backend/installation/openbsd_fi/)
+- [Alpine Linux](https://docs.akkoma.dev/stable/installation/alpine_linux_en/)
+- [Arch Linux](https://docs.akkoma.dev/stable/installation/arch_linux_en/)
+- [Debian-based](https://docs.akkoma.dev/stable/installation/debian_based_en/)
+- [Debian-based (jp)](https://docs.akkoma.dev/stable/installation/debian_based_jp/)
+- [FreeBSD](https://docs.akkoma.dev/stable/installation/freebsd_en/)
+- [Gentoo Linux](https://docs.akkoma.dev/stable/installation/gentoo_en/)
+- [NetBSD](https://docs.akkoma.dev/stable/installation/netbsd_en/)
+- [OpenBSD](https://docs.akkoma.dev/stable/installation/openbsd_en/)
+- [OpenBSD (fi)](https://docs.akkoma.dev/stable/installation/openbsd_fi/)
 
 ### Docker
 While we don’t provide docker files, other people have written very good ones. Take a look at <https://github.com/angristan/docker-pleroma> or <https://glitch.sh/sn0w/pleroma-docker>.
 
 ### Compilation Troubleshooting
-If you ever encounter compilation issues during the updating of Pleroma, you can try these commands and see if they fix things:
+If you ever encounter compilation issues during the updating of Akkoma, you can try these commands and see if they fix things:
 
 - `mix deps.clean --all`
 - `mix local.rebar`
@@ -42,4 +42,4 @@ If you ever encounter compilation issues during the updating of Pleroma, you can
 - `rm -r _build`
 
 ## Documentation
-- https://docs.akkoma.dev/main
+- https://docs.akkoma.dev/stable

config/config.exs

@@ -259,7 +259,8 @@
   show_reactions: true,
   password_reset_token_validity: 60 * 60 * 24,
   profile_directory: true,
-  privileged_staff: false
+  privileged_staff: false,
+  local_bubble: []
 
 config :pleroma, :welcome,
   direct_message: [
@@ -267,11 +268,6 @@
     sender_nickname: nil,
     message: nil
   ],
-  chat_message: [
-    enabled: false,
-    sender_nickname: nil,
-    message: nil
-  ],
   email: [
     enabled: false,
     sender: nil,
@@ -411,6 +407,8 @@
   accept: [],
   reject: []
 
+config :pleroma, :mrf_inline_quote, prefix: "RE"
+
 # threshold of 7 days
 config :pleroma, :mrf_object_age,
   threshold: 604_800,
@@ -638,13 +636,6 @@
 
 config :pleroma, Pleroma.Emails.NewUsersDigestEmail, enabled: false
 
-config :prometheus, Pleroma.Web.Endpoint.MetricsExporter,
-  enabled: false,
-  auth: false,
-  ip_whitelist: [],
-  path: "/api/pleroma/app_metrics",
-  format: :text
-
 config :pleroma, Pleroma.ScheduledActivity,
   daily_user_limit: 25,
   total_user_limit: 300,
@@ -718,28 +709,38 @@
 # available: %{...}
 
 config :pleroma, :frontends,
-  primary: %{"name" => "pleroma-fe", "ref" => "develop"},
+  primary: %{"name" => "pleroma-fe", "ref" => "stable"},
+  admin: %{"name" => "admin-fe", "ref" => "stable"},
+  mastodon: %{"name" => "mastodon-fe", "ref" => "akkoma"},
+  swagger: %{
+    "name" => "swagger-ui",
+    "ref" => "stable",
+    "enabled" => false
+  },
   available: %{
     "pleroma-fe" => %{
       "name" => "pleroma-fe",
       "git" => "https://akkoma.dev/AkkomaGang/pleroma-fe",
-      "build_url" => "https://akkoma-updates.s3-website.fr-par.scw.cloud/frontend/akkoma-fe.zip",
-      "ref" => "develop",
+      "build_url" =>
+        "https://akkoma-updates.s3-website.fr-par.scw.cloud/frontend/${ref}/akkoma-fe.zip",
+      "ref" => "stable",
       "build_dir" => "dist"
     },
     # Mastodon-Fe cannot be set as a primary - this is only here so we can update this seperately
     "mastodon-fe" => %{
       "name" => "mastodon-fe",
       "git" => "https://akkoma.dev/AkkomaGang/masto-fe",
-      "build_url" => "https://akkoma-updates.s3-website.fr-par.scw.cloud/frontend/masto-fe.zip",
+      "build_url" =>
+        "https://akkoma-updates.s3-website.fr-par.scw.cloud/frontend/${ref}/masto-fe.zip",
       "build_dir" => "distribution",
-      "ref" => "develop"
+      "ref" => "akkoma"
     },
     "admin-fe" => %{
       "name" => "admin-fe",
       "git" => "https://akkoma.dev/AkkomaGang/admin-fe",
-      "build_url" => "https://akkoma-updates.s3-website.fr-par.scw.cloud/frontend/admin-fe.zip",
-      "ref" => "develop"
+      "build_url" =>
+        "https://akkoma-updates.s3-website.fr-par.scw.cloud/frontend/${ref}/admin-fe.zip",
+      "ref" => "stable"
     },
     "soapbox-fe" => %{
       "name" => "soapbox-fe",
@@ -748,6 +749,14 @@
         "https://gitlab.com/soapbox-pub/soapbox-fe/-/jobs/artifacts/${ref}/download?job=build-production",
       "ref" => "v1.0.0",
       "build_dir" => "static"
+    },
+    # For developers - enables a swagger frontend to view the openapi spec
+    "swagger-ui" => %{
+      "name" => "swagger-ui",
+      "git" => "https://github.com/swagger-api/swagger-ui",
+      "build_url" => "https://akkoma-updates.s3-website.fr-par.scw.cloud/frontend/swagger-ui.zip",
+      "build_dir" => "dist",
+      "ref" => "stable"
     }
   }
 

config/description.exs

@@ -691,7 +691,7 @@
         key_placeholder: "instance",
         value_placeholder: "reason",
         description:
-          "List of ActivityPub instances where private (DMs, followers-only) activities will not be sent and the reason for doing so",
+          "List of ActivityPub instances where activities will not be sent, and the reason for doing so",
         suggestions: [
           {"quarantined.com", "Reason"},
           {"*.quarantined.com", "Reason"}
@@ -946,7 +946,13 @@
         key: :privileged_staff,
         type: :boolean,
         description:
-          "Let moderators access sensitive data (e.g. updating user credentials, get password reset token, delete users, index and read private statuses and chats)"
+          "Let moderators access sensitive data (e.g. updating user credentials, get password reset token, delete users, index and read private statuses)"
+      },
+      %{
+        key: :local_bubble,
+        type: {:list, :string},
+        description:
+          "List of instances that make up your local bubble (closely-related instances). Used to populate the 'bubble' timeline (domain only)."
       }
     ]
   },
@@ -984,35 +990,6 @@
           }
         ]
       },
-      %{
-        key: :chat_message,
-        type: :keyword,
-        descpiption: "Chat message settings",
-        children: [
-          %{
-            key: :enabled,
-            type: :boolean,
-            description: "Enables sending a chat message to newly registered users"
-          },
-          %{
-            key: :message,
-            type: :string,
-            description:
-              "A message that will be sent to newly registered users as a chat message",
-            suggestions: [
-              "Hello, welcome on board!"
-            ]
-          },
-          %{
-            key: :sender_nickname,
-            type: :string,
-            description: "The nickname of the local user that sends a welcome chat message",
-            suggestions: [
-              "lain"
-            ]
-          }
-        ]
-      },
       %{
         key: :email,
         type: :keyword,
@@ -1678,6 +1655,11 @@
         type: :boolean,
         description: "Sign object fetches with HTTP signatures"
       },
+      %{
+        key: :authorized_fetch_mode,
+        type: :boolean,
+        description: "Require HTTP signatures on AP fetches"
+      },
       %{
         key: :note_replies_output_limit,
         type: :integer,
@@ -2605,27 +2587,6 @@
       }
     ]
   },
-  %{
-    group: :pleroma,
-    key: :shout,
-    type: :group,
-    description: "Pleroma shout settings",
-    children: [
-      %{
-        key: :enabled,
-        type: :boolean,
-        description: "Enables the backend Shoutbox chat feature."
-      },
-      %{
-        key: :limit,
-        type: :integer,
-        description: "Shout message character limit.",
-        suggestions: [
-          5_000
-        ]
-      }
-    ]
-  },
   %{
     group: :pleroma,
     key: :http,
@@ -3089,6 +3050,27 @@
         description: "Admin frontend",
         children: installed_frontend_options
       },
+      %{
+        key: :mastodon,
+        type: :map,
+        description: "Mastodon frontend",
+        children: installed_frontend_options
+      },
+      %{
+        key: :swagger,
+        type: :map,
+        description: "Swagger API reference frontend",
+        children:
+          installed_frontend_options ++
+            [
+              %{
+                key: "enabled",
+                label: "Enabled",
+                type: :boolean,
+                description: "Whether to have this enabled at all"
+              }
+            ]
+      },
       %{
         key: :available,
         type: :map,
@@ -3151,43 +3133,6 @@
       }
     ]
   },
-  %{
-    group: :prometheus,
-    key: Pleroma.Web.Endpoint.MetricsExporter,
-    type: :group,
-    description: "Prometheus app metrics endpoint configuration",
-    children: [
-      %{
-        key: :enabled,
-        type: :boolean,
-        description: "[Pleroma extension] Enables app metrics endpoint."
-      },
-      %{
-        key: :ip_whitelist,
-        label: "IP Whitelist",
-        type: [{:list, :string}, {:list, :charlist}, {:list, :tuple}],
-        description: "Restrict access of app metrics endpoint to the specified IP addresses."
-      },
-      %{
-        key: :auth,
-        type: [:boolean, :tuple],
-        description: "Enables HTTP Basic Auth for app metrics endpoint.",
-        suggestion: [false, {:basic, "myusername", "mypassword"}]
-      },
-      %{
-        key: :path,
-        type: :string,
-        description: "App metrics endpoint URI path.",
-        suggestions: ["/api/pleroma/app_metrics"]
-      },
-      %{
-        key: :format,
-        type: :atom,
-        description: "App metrics endpoint output format.",
-        suggestions: [:text, :protobuf]
-      }
-    ]
-  },
   %{
     group: :pleroma,
     key: ConcurrentLimiter,

docs/Makefile

@@ -0,0 +1,9 @@
+all:	install
+	pipenv run mkdocs build
+
+install:
+	pipenv install
+clean:
+	rm -rf site
+serve:
+	pipenv run python3 -m http.server -d site  

docs/Pipfile

@@ -0,0 +1,10 @@
+[[source]]
+name = "pypi"
+url = "https://pypi.org/simple"
+verify_ssl = true
+
+[dev-packages]
+
+[packages]
+mkdocs-material = "*"
+markdown-include = "*"

docs/Pipfile.lock

@@ -0,0 +1,277 @@
+{
+    "_meta": {
+        "hash": {
+            "sha256": "926d34630c729228bb015cb958c04f8269c57f5ca1ffc2ceab1dfd1798884772"
+        },
+        "pipfile-spec": 6,
+        "requires": {},
+        "sources": [
+            {
+                "name": "pypi",
+                "url": "https://pypi.org/simple",
+                "verify_ssl": true
+            }
+        ]
+    },
+    "default": {
+        "click": {
+            "hashes": [
+                "sha256:7682dc8afb30297001674575ea00d1814d808d6a36af415a82bd481d37ba7b8e",
+                "sha256:bb4d8133cb15a609f44e8213d9b391b0809795062913b383c62be0ee95b1db48"
+            ],
+            "markers": "python_version >= '3.7'",
+            "version": "==8.1.3"
+        },
+        "ghp-import": {
+            "hashes": [
+                "sha256:8337dd7b50877f163d4c0289bc1f1c7f127550241988d568c1db512c4324a619",
+                "sha256:9c535c4c61193c2df8871222567d7fd7e5014d835f97dc7b7439069e2413d343"
+            ],
+            "version": "==2.1.0"
+        },
+        "importlib-metadata": {
+            "hashes": [
+                "sha256:637245b8bab2b6502fcbc752cc4b7a6f6243bb02b31c5c26156ad103d3d45670",
+                "sha256:7401a975809ea1fdc658c3aa4f78cc2195a0e019c5cbc4c06122884e9ae80c23"
+            ],
+            "markers": "python_version >= '3.7'",
+            "version": "==4.12.0"
+        },
+        "jinja2": {
+            "hashes": [
+                "sha256:31351a702a408a9e7595a8fc6150fc3f43bb6bf7e319770cbc0db9df9437e852",
+                "sha256:6088930bfe239f0e6710546ab9c19c9ef35e29792895fed6e6e31a023a182a61"
+            ],
+            "markers": "python_version >= '3.7'",
+            "version": "==3.1.2"
+        },
+        "markdown": {
+            "hashes": [
+                "sha256:cbb516f16218e643d8e0a95b309f77eb118cb138d39a4f27851e6a63581db874",
+                "sha256:f5da449a6e1c989a4cea2631aa8ee67caa5a2ef855d551c88f9e309f4634c621"
+            ],
+            "markers": "python_version >= '3.6'",
+            "version": "==3.3.7"
+        },
+        "markdown-include": {
+            "hashes": [
+                "sha256:6f5d680e36f7780c7f0f61dca53ca581bd50d1b56137ddcd6353efafa0c3e4a2"
+            ],
+            "index": "pypi",
+            "version": "==0.6.0"
+        },
+        "markupsafe": {
+            "hashes": [
+                "sha256:0212a68688482dc52b2d45013df70d169f542b7394fc744c02a57374a4207003",
+                "sha256:089cf3dbf0cd6c100f02945abeb18484bd1ee57a079aefd52cffd17fba910b88",
+                "sha256:10c1bfff05d95783da83491be968e8fe789263689c02724e0c691933c52994f5",
+                "sha256:33b74d289bd2f5e527beadcaa3f401e0df0a89927c1559c8566c066fa4248ab7",
+                "sha256:3799351e2336dc91ea70b034983ee71cf2f9533cdff7c14c90ea126bfd95d65a",
+                "sha256:3ce11ee3f23f79dbd06fb3d63e2f6af7b12db1d46932fe7bd8afa259a5996603",
+                "sha256:421be9fbf0ffe9ffd7a378aafebbf6f4602d564d34be190fc19a193232fd12b1",
+                "sha256:43093fb83d8343aac0b1baa75516da6092f58f41200907ef92448ecab8825135",
+                "sha256:46d00d6cfecdde84d40e572d63735ef81423ad31184100411e6e3388d405e247",
+                "sha256:4a33dea2b688b3190ee12bd7cfa29d39c9ed176bda40bfa11099a3ce5d3a7ac6",
+                "sha256:4b9fe39a2ccc108a4accc2676e77da025ce383c108593d65cc909add5c3bd601",
+                "sha256:56442863ed2b06d19c37f94d999035e15ee982988920e12a5b4ba29b62ad1f77",
+                "sha256:671cd1187ed5e62818414afe79ed29da836dde67166a9fac6d435873c44fdd02",
+                "sha256:694deca8d702d5db21ec83983ce0bb4b26a578e71fbdbd4fdcd387daa90e4d5e",
+                "sha256:6a074d34ee7a5ce3effbc526b7083ec9731bb3cbf921bbe1d3005d4d2bdb3a63",
+                "sha256:6d0072fea50feec76a4c418096652f2c3238eaa014b2f94aeb1d56a66b41403f",
+                "sha256:6fbf47b5d3728c6aea2abb0589b5d30459e369baa772e0f37a0320185e87c980",
+                "sha256:7f91197cc9e48f989d12e4e6fbc46495c446636dfc81b9ccf50bb0ec74b91d4b",
+                "sha256:86b1f75c4e7c2ac2ccdaec2b9022845dbb81880ca318bb7a0a01fbf7813e3812",
+                "sha256:8dc1c72a69aa7e082593c4a203dcf94ddb74bb5c8a731e4e1eb68d031e8498ff",
+                "sha256:8e3dcf21f367459434c18e71b2a9532d96547aef8a871872a5bd69a715c15f96",
+                "sha256:8e576a51ad59e4bfaac456023a78f6b5e6e7651dcd383bcc3e18d06f9b55d6d1",
+                "sha256:96e37a3dc86e80bf81758c152fe66dbf60ed5eca3d26305edf01892257049925",
+                "sha256:97a68e6ada378df82bc9f16b800ab77cbf4b2fada0081794318520138c088e4a",
+                "sha256:99a2a507ed3ac881b975a2976d59f38c19386d128e7a9a18b7df6fff1fd4c1d6",
+                "sha256:a49907dd8420c5685cfa064a1335b6754b74541bbb3706c259c02ed65b644b3e",
+                "sha256:b09bf97215625a311f669476f44b8b318b075847b49316d3e28c08e41a7a573f",
+                "sha256:b7bd98b796e2b6553da7225aeb61f447f80a1ca64f41d83612e6139ca5213aa4",
+                "sha256:b87db4360013327109564f0e591bd2a3b318547bcef31b468a92ee504d07ae4f",
+                "sha256:bcb3ed405ed3222f9904899563d6fc492ff75cce56cba05e32eff40e6acbeaa3",
+                "sha256:d4306c36ca495956b6d568d276ac11fdd9c30a36f1b6eb928070dc5360b22e1c",
+                "sha256:d5ee4f386140395a2c818d149221149c54849dfcfcb9f1debfe07a8b8bd63f9a",
+                "sha256:dda30ba7e87fbbb7eab1ec9f58678558fd9a6b8b853530e176eabd064da81417",
+                "sha256:e04e26803c9c3851c931eac40c695602c6295b8d432cbe78609649ad9bd2da8a",
+                "sha256:e1c0b87e09fa55a220f058d1d49d3fb8df88fbfab58558f1198e08c1e1de842a",
+                "sha256:e72591e9ecd94d7feb70c1cbd7be7b3ebea3f548870aa91e2732960fa4d57a37",
+                "sha256:e8c843bbcda3a2f1e3c2ab25913c80a3c5376cd00c6e8c4a86a89a28c8dc5452",
+                "sha256:efc1913fd2ca4f334418481c7e595c00aad186563bbc1ec76067848c7ca0a933",
+                "sha256:f121a1420d4e173a5d96e47e9a0c0dcff965afdf1626d28de1460815f7c4ee7a",
+                "sha256:fc7b548b17d238737688817ab67deebb30e8073c95749d55538ed473130ec0c7"
+            ],
+            "markers": "python_version >= '3.7'",
+            "version": "==2.1.1"
+        },
+        "mergedeep": {
+            "hashes": [
+                "sha256:0096d52e9dad9939c3d975a774666af186eda617e6ca84df4c94dec30004f2a8",
+                "sha256:70775750742b25c0d8f36c55aed03d24c3384d17c951b3175d898bd778ef0307"
+            ],
+            "markers": "python_version >= '3.6'",
+            "version": "==1.3.4"
+        },
+        "mkdocs": {
+            "hashes": [
+                "sha256:26bd2b03d739ac57a3e6eed0b7bcc86168703b719c27b99ad6ca91dc439aacde",
+                "sha256:b504405b04da38795fec9b2e5e28f6aa3a73bb0960cb6d5d27ead28952bd35ea"
+            ],
+            "markers": "python_version >= '3.6'",
+            "version": "==1.3.0"
+        },
+        "mkdocs-material": {
+            "hashes": [
+                "sha256:263f2721f3abe533b61f7c8bed435a0462620912742c919821ac2d698b4bfe67",
+                "sha256:dc82b667d2a83f0de581b46a6d0949732ab77e7638b87ea35b770b33bc02e75a"
+            ],
+            "index": "pypi",
+            "version": "==8.3.9"
+        },
+        "mkdocs-material-extensions": {
+            "hashes": [
+                "sha256:a82b70e533ce060b2a5d9eb2bc2e1be201cf61f901f93704b4acf6e3d5983a44",
+                "sha256:bfd24dfdef7b41c312ede42648f9eb83476ea168ec163b613f9abd12bbfddba2"
+            ],
+            "markers": "python_version >= '3.6'",
+            "version": "==1.0.3"
+        },
+        "packaging": {
+            "hashes": [
+                "sha256:dd47c42927d89ab911e606518907cc2d3a1f38bbd026385970643f9c5b8ecfeb",
+                "sha256:ef103e05f519cdc783ae24ea4e2e0f508a9c99b2d4969652eed6a2e1ea5bd522"
+            ],
+            "markers": "python_version >= '3.6'",
+            "version": "==21.3"
+        },
+        "pygments": {
+            "hashes": [
+                "sha256:5eb116118f9612ff1ee89ac96437bb6b49e8f04d8a13b514ba26f620208e26eb",
+                "sha256:dc9c10fb40944260f6ed4c688ece0cd2048414940f1cea51b8b226318411c519"
+            ],
+            "markers": "python_version >= '3.6'",
+            "version": "==2.12.0"
+        },
+        "pymdown-extensions": {
+            "hashes": [
+                "sha256:3ef2d998c0d5fa7eb09291926d90d69391283561cf6306f85cd588a5eb5befa0",
+                "sha256:ec141c0f4983755349f0c8710416348d1a13753976c028186ed14f190c8061c4"
+            ],
+            "markers": "python_version >= '3.7'",
+            "version": "==9.5"
+        },
+        "pyparsing": {
+            "hashes": [
+                "sha256:2b020ecf7d21b687f219b71ecad3631f644a47f01403fa1d1036b0c6416d70fb",
+                "sha256:5026bae9a10eeaefb61dab2f09052b9f4307d44aee4eda64b309723d8d206bbc"
+            ],
+            "markers": "python_full_version >= '3.6.8'",
+            "version": "==3.0.9"
+        },
+        "python-dateutil": {
+            "hashes": [
+                "sha256:0123cacc1627ae19ddf3c27a5de5bd67ee4586fbdd6440d9748f8abb483d3e86",
+                "sha256:961d03dc3453ebbc59dbdea9e4e11c5651520a876d0f4db161e8674aae935da9"
+            ],
+            "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'",
+            "version": "==2.8.2"
+        },
+        "pyyaml": {
+            "hashes": [
+                "sha256:0283c35a6a9fbf047493e3a0ce8d79ef5030852c51e9d911a27badfde0605293",
+                "sha256:055d937d65826939cb044fc8c9b08889e8c743fdc6a32b33e2390f66013e449b",
+                "sha256:07751360502caac1c067a8132d150cf3d61339af5691fe9e87803040dbc5db57",
+                "sha256:0b4624f379dab24d3725ffde76559cff63d9ec94e1736b556dacdfebe5ab6d4b",
+                "sha256:0ce82d761c532fe4ec3f87fc45688bdd3a4c1dc5e0b4a19814b9009a29baefd4",
+                "sha256:1e4747bc279b4f613a09eb64bba2ba602d8a6664c6ce6396a4d0cd413a50ce07",
+                "sha256:213c60cd50106436cc818accf5baa1aba61c0189ff610f64f4a3e8c6726218ba",
+                "sha256:231710d57adfd809ef5d34183b8ed1eeae3f76459c18fb4a0b373ad56bedcdd9",
+                "sha256:277a0ef2981ca40581a47093e9e2d13b3f1fbbeffae064c1d21bfceba2030287",
+                "sha256:2cd5df3de48857ed0544b34e2d40e9fac445930039f3cfe4bcc592a1f836d513",
+                "sha256:40527857252b61eacd1d9af500c3337ba8deb8fc298940291486c465c8b46ec0",
+                "sha256:473f9edb243cb1935ab5a084eb238d842fb8f404ed2193a915d1784b5a6b5fc0",
+                "sha256:48c346915c114f5fdb3ead70312bd042a953a8ce5c7106d5bfb1a5254e47da92",
+                "sha256:50602afada6d6cbfad699b0c7bb50d5ccffa7e46a3d738092afddc1f9758427f",
+                "sha256:68fb519c14306fec9720a2a5b45bc9f0c8d1b9c72adf45c37baedfcd949c35a2",
+                "sha256:77f396e6ef4c73fdc33a9157446466f1cff553d979bd00ecb64385760c6babdc",
+                "sha256:819b3830a1543db06c4d4b865e70ded25be52a2e0631ccd2f6a47a2822f2fd7c",
+                "sha256:897b80890765f037df3403d22bab41627ca8811ae55e9a722fd0392850ec4d86",
+                "sha256:98c4d36e99714e55cfbaaee6dd5badbc9a1ec339ebfc3b1f52e293aee6bb71a4",
+                "sha256:9df7ed3b3d2e0ecfe09e14741b857df43adb5a3ddadc919a2d94fbdf78fea53c",
+                "sha256:9fa600030013c4de8165339db93d182b9431076eb98eb40ee068700c9c813e34",
+                "sha256:a80a78046a72361de73f8f395f1f1e49f956c6be882eed58505a15f3e430962b",
+                "sha256:b3d267842bf12586ba6c734f89d1f5b871df0273157918b0ccefa29deb05c21c",
+                "sha256:b5b9eccad747aabaaffbc6064800670f0c297e52c12754eb1d976c57e4f74dcb",
+                "sha256:c5687b8d43cf58545ade1fe3e055f70eac7a5a1a0bf42824308d868289a95737",
+                "sha256:cba8c411ef271aa037d7357a2bc8f9ee8b58b9965831d9e51baf703280dc73d3",
+                "sha256:d15a181d1ecd0d4270dc32edb46f7cb7733c7c508857278d3d378d14d606db2d",
+                "sha256:d4db7c7aef085872ef65a8fd7d6d09a14ae91f691dec3e87ee5ee0539d516f53",
+                "sha256:d4eccecf9adf6fbcc6861a38015c2a64f38b9d94838ac1810a9023a0609e1b78",
+                "sha256:d67d839ede4ed1b28a4e8909735fc992a923cdb84e618544973d7dfc71540803",
+                "sha256:daf496c58a8c52083df09b80c860005194014c3698698d1a57cbcfa182142a3a",
+                "sha256:e61ceaab6f49fb8bdfaa0f92c4b57bcfbea54c09277b1b4f7ac376bfb7a7c174",
+                "sha256:f84fbc98b019fef2ee9a1cb3ce93e3187a6df0b2538a651bfb890254ba9f90b5"
+            ],
+            "markers": "python_version >= '3.6'",
+            "version": "==6.0"
+        },
+        "pyyaml-env-tag": {
+            "hashes": [
+                "sha256:70092675bda14fdec33b31ba77e7543de9ddc88f2e5b99160396572d11525bdb",
+                "sha256:af31106dec8a4d68c60207c1886031cbf839b68aa7abccdb19868200532c2069"
+            ],
+            "markers": "python_version >= '3.6'",
+            "version": "==0.1"
+        },
+        "six": {
+            "hashes": [
+                "sha256:1e61c37477a1626458e36f7b1d82aa5c9b094fa4802892072e49de9c60c4c926",
+                "sha256:8abb2f1d86890a2dfb989f9a77cfcfd3e47c2a354b01111771326f8aa26e0254"
+            ],
+            "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'",
+            "version": "==1.16.0"
+        },
+        "watchdog": {
+            "hashes": [
+                "sha256:083171652584e1b8829581f965b9b7723ca5f9a2cd7e20271edf264cfd7c1412",
+                "sha256:117ffc6ec261639a0209a3252546b12800670d4bf5f84fbd355957a0595fe654",
+                "sha256:186f6c55abc5e03872ae14c2f294a153ec7292f807af99f57611acc8caa75306",
+                "sha256:195fc70c6e41237362ba720e9aaf394f8178bfc7fa68207f112d108edef1af33",
+                "sha256:226b3c6c468ce72051a4c15a4cc2ef317c32590d82ba0b330403cafd98a62cfd",
+                "sha256:247dcf1df956daa24828bfea5a138d0e7a7c98b1a47cf1fa5b0c3c16241fcbb7",
+                "sha256:255bb5758f7e89b1a13c05a5bceccec2219f8995a3a4c4d6968fe1de6a3b2892",
+                "sha256:43ce20ebb36a51f21fa376f76d1d4692452b2527ccd601950d69ed36b9e21609",
+                "sha256:4f4e1c4aa54fb86316a62a87b3378c025e228178d55481d30d857c6c438897d6",
+                "sha256:5952135968519e2447a01875a6f5fc8c03190b24d14ee52b0f4b1682259520b1",
+                "sha256:64a27aed691408a6abd83394b38503e8176f69031ca25d64131d8d640a307591",
+                "sha256:6b17d302850c8d412784d9246cfe8d7e3af6bcd45f958abb2d08a6f8bedf695d",
+                "sha256:70af927aa1613ded6a68089a9262a009fbdf819f46d09c1a908d4b36e1ba2b2d",
+                "sha256:7a833211f49143c3d336729b0020ffd1274078e94b0ae42e22f596999f50279c",
+                "sha256:8250546a98388cbc00c3ee3cc5cf96799b5a595270dfcfa855491a64b86ef8c3",
+                "sha256:97f9752208f5154e9e7b76acc8c4f5a58801b338de2af14e7e181ee3b28a5d39",
+                "sha256:9f05a5f7c12452f6a27203f76779ae3f46fa30f1dd833037ea8cbc2887c60213",
+                "sha256:a735a990a1095f75ca4f36ea2ef2752c99e6ee997c46b0de507ba40a09bf7330",
+                "sha256:ad576a565260d8f99d97f2e64b0f97a48228317095908568a9d5c786c829d428",
+                "sha256:b530ae007a5f5d50b7fbba96634c7ee21abec70dc3e7f0233339c81943848dc1",
+                "sha256:bfc4d351e6348d6ec51df007432e6fe80adb53fd41183716017026af03427846",
+                "sha256:d3dda00aca282b26194bdd0adec21e4c21e916956d972369359ba63ade616153",
+                "sha256:d9820fe47c20c13e3c9dd544d3706a2a26c02b2b43c993b62fcd8011bcc0adb3",
+                "sha256:ed80a1628cee19f5cfc6bb74e173f1b4189eb532e705e2a13e3250312a62e0c9",
+                "sha256:ee3e38a6cc050a8830089f79cbec8a3878ec2fe5160cdb2dc8ccb6def8552658"
+            ],
+            "markers": "python_version >= '3.6'",
+            "version": "==2.1.9"
+        },
+        "zipp": {
+            "hashes": [
+                "sha256:56bf8aadb83c24db6c4b577e13de374ccfb67da2078beba1d037c17980bf43ad",
+                "sha256:c4f6e5bbf48e74f7a38e7cc5b0480ff42b0ae5178957d564d18932525d5cf099"
+            ],
+            "markers": "python_version >= '3.7'",
+            "version": "==3.8.0"
+        }
+    },
+    "develop": {}
+}

docs/README.md

@@ -0,0 +1,34 @@
+## Building the docs
+
+You don't need to build and test the docs as long as you make sure the syntax is correct. But in case you do want to build the docs, feel free to do so.
+
+You'll need to install mkdocs for which you can check the [mkdocs installation guide](https://www.mkdocs.org/#installation). Generally it's best to install it using `pip`. You'll also need to install the correct dependencies.
+
+### Example using a Debian based distro
+
+#### 1. Install pipenv and dependencies
+
+```shell
+pip install pipenv
+pipenv sync
+```
+
+#### 2. (Optional) Activate the virtual environment
+
+Since dependencies are installed in a virtual environment, you can't use them directly. To use them you should either prefix the command with `pipenv run`, or activate the virtual environment for current shell by executing `pipenv shell` once.
+
+#### 3. Build the docs using the script
+
+```shell
+[pipenv run] make all
+```
+
+#### 4. Serve the files
+
+A folder `site` containing the static html pages will have been created. You can serve them from a server by pointing your server software (nginx, apache...) to this location. During development, you can run locally with
+
+```shell
+[pipenv run] mkdocs serve
+```
+
+This handles setting up an http server and rebuilding when files change. You can then access the docs on <http://127.0.0.1:8000>

docs/development/API/chats.md

@@ -1,255 +0,0 @@
-# Chats
-
-Chats are a way to represent an IM-style conversation between two actors. They are not the same as direct messages and they are not `Status`es, even though they have a lot in common.
-
-## Why Chats?
-
-There are no 'visibility levels' in ActivityPub, their definition is purely a Mastodon convention. Direct Messaging between users on the fediverse has mostly been modeled by using ActivityPub addressing following Mastodon conventions on normal `Note` objects. In this case, a 'direct message' would be a message that has no followers addressed and also does not address the special public actor, but just the recipients in the `to` field. It would still be a `Note` and is presented with other `Note`s as a `Status` in the API.
-
-This is an awkward setup for a few reasons:
-
-- As DMs generally still follow the usual `Status` conventions, it is easy to accidentally pull somebody into a DM thread by mentioning them. (e.g. "I hate @badguy so much")
-- It is possible to go from a publicly addressed `Status` to a DM reply, back to public, then to a 'followers only' reply, and so on. This can be become very confusing, as it is unclear which user can see which part of the conversation.
-- The standard `Status` format of implicit addressing also leads to rather ugly results if you try to display the messages as a chat, because all the recipients are always mentioned by name in the message.
-- As direct messages are posted with the same api call (and usually same frontend component) as public messages, accidentally making a public message private or vice versa can happen easily. Client bugs can also lead to this, accidentally making private messages public.
-
-As a measure to improve this situation, the `Conversation` concept and related Akkoma extensions were introduced. While it made it possible to work around a few of the issues, many of the problems remained and it didn't see much adoption because it was too complicated to use correctly.
-
-## Chats explained
-For this reasons, Chats are a new and different entity, both in the API as well as in ActivityPub. A quick overview:
-
-- Chats are meant to represent an instant message conversation between two actors. For now these are only 1-on-1 conversations, but the other actor can be a group in the future.
-- Chat messages have the ActivityPub type `ChatMessage`. They are not `Note`s. Servers that don't understand them will just drop them.
-- The only addressing allowed in `ChatMessage`s is one single ActivityPub actor in the `to` field.
-- There's always only one Chat between two actors. If you start chatting with someone and later start a 'new' Chat, the old Chat will be continued.
-- `ChatMessage`s are posted with a different api, making it very hard to accidentally send a message to the wrong person.
-- `ChatMessage`s don't show up in the existing timelines.
-- Chats can never go from private to public. They are always private between the two actors.
-
-## Caveats
-
-- Chats are NOT E2E encrypted (yet). Security is still the same as email.
-
-## API
-
-In general, the way to send a `ChatMessage` is to first create a `Chat`, then post a message to that `Chat`. `Group`s will later be supported by making them a sub-type of `Account`.
-
-This is the overview of using the API. The API is also documented via OpenAPI, so you can view it and play with it by pointing SwaggerUI or a similar OpenAPI tool to `https://yourinstance.tld/api/openapi`.
-
-### Creating or getting a chat.
-
-To create or get an existing Chat for a certain recipient (identified by Account ID)
-you can call:
-
-`POST /api/v1/pleroma/chats/by-account-id/:account_id`
-
-The account id is the normal FlakeId of the user
-```
-POST /api/v1/pleroma/chats/by-account-id/someflakeid
-```
-
-If you already have the id of a chat, you can also use
-
-```
-GET /api/v1/pleroma/chats/:id
-```
-
-There will only ever be ONE Chat for you and a given recipient, so this call
-will return the same Chat if you already have one with that user.
-
-Returned data:
-
-```json
-{
-  "account": {
-    "id": "someflakeid",
-    "username": "somenick",
-    ...
-  },
-  "id" : "1",
-  "unread" : 2,
-  "last_message" : {...}, // The last message in that chat
-  "updated_at": "2020-04-21T15:11:46.000Z"
-}
-```
-
-### Marking a chat as read
-
-To mark a number of messages in a chat up to a certain message as read, you can use
-
-`POST /api/v1/pleroma/chats/:id/read`
-
-
-Parameters:
-- last_read_id: Given this id, all chat messages until this one will be marked as read. Required.
-
-
-Returned data:
-
-```json
-{
-  "account": {
-    "id": "someflakeid",
-    "username": "somenick",
-    ...
-  },
-  "id" : "1",
-  "unread" : 0,
-  "updated_at": "2020-04-21T15:11:46.000Z"
-}
-```
-
-### Marking a single chat message as read
-
-To set the `unread` property of a message to `false`
-
-`POST /api/v1/pleroma/chats/:id/messages/:message_id/read`
-
-Returned data:
-
-The modified chat message
-
-### Getting a list of Chats
-
-`GET /api/v1/pleroma/chats`
-
-This will return a list of chats that you have been involved in, sorted by their
-last update (so new chats will be at the top).
-
-Parameters:
-
-- with_muted: Include chats from muted users (boolean).
-
-Returned data:
-
-```json
-[
-   {
-      "account": {
-        "id": "someflakeid",
-        "username": "somenick",
-        ...
-      },
-      "id" : "1",
-      "unread" : 2,
-      "last_message" : {...}, // The last message in that chat
-      "updated_at": "2020-04-21T15:11:46.000Z"
-   }
-]
-```
-
-The recipient of messages that are sent to this chat is given by their AP ID.
-No pagination is implemented for now.
-
-### Getting the messages for a Chat
-
-For a given Chat id, you can get the associated messages with
-
-`GET /api/v1/pleroma/chats/:id/messages`
-
-This will return all messages, sorted by most recent to least recent. The usual
-pagination options are implemented.
-
-Returned data:
-
-```json
-[
-  {
-    "account_id": "someflakeid",
-    "chat_id": "1",
-    "content": "Check this out :firefox:",
-    "created_at": "2020-04-21T15:11:46.000Z",
-    "emojis": [
-      {
-        "shortcode": "firefox",
-        "static_url": "https://dontbulling.me/emoji/Firefox.gif",
-        "url": "https://dontbulling.me/emoji/Firefox.gif",
-        "visible_in_picker": false
-      }
-    ],
-    "id": "13",
-    "unread": true
-  },
-  {
-    "account_id": "someflakeid",
-    "chat_id": "1",
-    "content": "Whats' up?",
-    "created_at": "2020-04-21T15:06:45.000Z",
-    "emojis": [],
-    "id": "12",
-    "unread": false,
-    "idempotency_key": "75442486-0874-440c-9db1-a7006c25a31f"
-  }
-]
-```
-
-- idempotency_key: The copy of the `idempotency-key` HTTP request header that can be used for optimistic message sending. Included only during the first few minutes after the message creation.
-
-### Posting a chat message
-
-Posting a chat message for given Chat id works like this:
-
-`POST /api/v1/pleroma/chats/:id/messages`
-
-Parameters:
-- content: The text content of the message. Optional if media is attached.
-- media_id: The id of an upload that will be attached to the message.
-
-Currently, no formatting beyond basic escaping and emoji is implemented.
-
-Returned data:
-
-```json
-{
-  "account_id": "someflakeid",
-  "chat_id": "1",
-  "content": "Check this out :firefox:",
-  "created_at": "2020-04-21T15:11:46.000Z",
-  "emojis": [
-    {
-      "shortcode": "firefox",
-      "static_url": "https://dontbulling.me/emoji/Firefox.gif",
-      "url": "https://dontbulling.me/emoji/Firefox.gif",
-      "visible_in_picker": false
-    }
-  ],
-  "id": "13",
-  "unread": false
-}
-```
-
-### Deleting a chat message
-
-Deleting a chat message for given Chat id works like this:
-
-`DELETE /api/v1/pleroma/chats/:chat_id/messages/:message_id`
-
-Returned data is the deleted message.
-
-### Notifications
-
-There's a new `pleroma:chat_mention` notification, which has this form. It is not given out in the notifications endpoint by default, you need to explicitly request it with `include_types[]=pleroma:chat_mention`:
-
-```json
-{
-  "id": "someid",
-  "type": "pleroma:chat_mention",
-  "account": { ... } // User account of the sender,
-  "chat_message": {
-    "chat_id": "1",
-    "id": "10",
-    "content": "Hello",
-    "account_id": "someflakeid",
-    "unread": false
-  },
-  "created_at": "somedate"
-}
-```
-
-### Streaming
-
-There is an additional `user:pleroma_chat` stream. Incoming chat messages will make the current chat be sent to this `user` stream. The `event` of an incoming chat message is `pleroma:chat_update`. The payload is the updated chat with the incoming chat message in the `last_message` field.
-
-### Web Push
-
-If you want to receive push messages for this type, you'll need to add the `pleroma:chat_mention` type to your alerts in the push subscription.

docs/development/ap_extensions.md

@@ -1,65 +0,0 @@
-# AP Extensions
-## Actor endpoints
-
-The following endpoints are additionally present into our actors.
-
-- `oauthRegistrationEndpoint` (`http://litepub.social/ns#oauthRegistrationEndpoint`)
-- `uploadMedia` (`https://www.w3.org/ns/activitystreams#uploadMedia`)
-
-### oauthRegistrationEndpoint
-
-Points to MastodonAPI `/api/v1/apps` for now.
-
-See <https://docs.joinmastodon.org/methods/apps/>
-
-### uploadMedia
-
-Inspired by <https://www.w3.org/wiki/SocialCG/ActivityPub/MediaUpload>, it is part of the ActivityStreams namespace because it used to be part of the ActivityPub specification and got removed from it.
-
-Content-Type: multipart/form-data
-
-Parameters:
-- (required) `file`: The file being uploaded
-- (optionnal) `description`: A plain-text description of the media, for accessibility purposes.
-
-Response: HTTP 201 Created with the object into the body, no `Location` header provided as it doesn't have an `id`
-
-The object given in the reponse should then be inserted into an Object's `attachment` field.
-
-## ChatMessages
-
-`ChatMessage`s are the messages sent in 1-on-1 chats. They are similar to
-`Note`s, but the addresing is done by having a single AP actor in the `to`
-field. Addressing multiple actors is not allowed. These messages are always
-private, there is no public version of them. They are created with a `Create`
-activity.
-
-They are part of the `litepub` namespace as `http://litepub.social/ns#ChatMessage`.
-
-Example:
-
-```json
-{
-  "actor": "http://2hu.gensokyo/users/raymoo",
-  "id": "http://2hu.gensokyo/objects/1",
-  "object": {
-    "attributedTo": "http://2hu.gensokyo/users/raymoo",
-    "content": "You expected a cute girl? Too bad.",
-    "id": "http://2hu.gensokyo/objects/2",
-    "published": "2020-02-12T14:08:20Z",
-    "to": [
-      "http://2hu.gensokyo/users/marisa"
-    ],
-    "type": "ChatMessage"
-  },
-  "published": "2018-02-12T14:08:20Z",
-  "to": [
-    "http://2hu.gensokyo/users/marisa"
-  ],
-  "type": "Create"
-}
-```
-
-This setup does not prevent multi-user chats, but these will have to go through
-a `Group`, which will be the recipient of the messages and then `Announce` them
-to the users in the `Group`.

docs/docs/administration/CLI_tasks/config.md

@@ -1,6 +1,6 @@
 # Transfering the config to/from the database
 
-{! backend/administration/CLI_tasks/general_cli_task_info.include !}
+{! administration/CLI_tasks/general_cli_task_info.include !}
 
 ## Transfer config from file to DB.
 

docs/docs/administration/CLI_tasks/database.md

@@ -1,6 +1,6 @@
 # Database maintenance tasks
 
-{! backend/administration/CLI_tasks/general_cli_task_info.include !}
+{! administration/CLI_tasks/general_cli_task_info.include !}
 
 !!! danger
     These mix tasks can take a long time to complete. Many of them were written to address specific database issues that happened because of bugs in migrations or other specific scenarios. Do not run these tasks "just in case" if everything is fine your instance.

docs/docs/administration/CLI_tasks/digest.md

@@ -1,6 +1,6 @@
 # Managing digest emails
 
-{! backend/administration/CLI_tasks/general_cli_task_info.include !}
+{! administration/CLI_tasks/general_cli_task_info.include !}
 
 ## Send digest email since given date (user registration date by default) ignoring user activity status.
 

docs/docs/administration/CLI_tasks/email.md

@@ -1,6 +1,6 @@
 # EMail administration tasks
 
-{! backend/administration/CLI_tasks/general_cli_task_info.include !}
+{! administration/CLI_tasks/general_cli_task_info.include !}
 
 ## Send test email (instance email by default)
 

docs/docs/administration/CLI_tasks/emoji.md

@@ -1,6 +1,6 @@
 # Managing emoji packs
 
-{! backend/administration/CLI_tasks/general_cli_task_info.include !}
+{! administration/CLI_tasks/general_cli_task_info.include !}
 
 ## Lists emoji packs and metadata specified in the manifest
 

docs/docs/administration/CLI_tasks/instance.md

@@ -1,6 +1,6 @@
 # Managing instance configuration
 
-{! backend/administration/CLI_tasks/general_cli_task_info.include !}
+{! administration/CLI_tasks/general_cli_task_info.include !}
 
 ## Generate a new configuration file
 === "OTP"

docs/docs/administration/CLI_tasks/oauth_app.md

@@ -1,6 +1,6 @@
 # Creating trusted OAuth App
 
-{! backend/administration/CLI_tasks/general_cli_task_info.include !}
+{! administration/CLI_tasks/general_cli_task_info.include !}
 
 ## Create trusted OAuth App.
 

docs/docs/administration/CLI_tasks/relay.md

@@ -1,6 +1,6 @@
 # Managing relays
 
-{! backend/administration/CLI_tasks/general_cli_task_info.include !}
+{! administration/CLI_tasks/general_cli_task_info.include !}
 
 ## Follow a relay
 

docs/docs/administration/CLI_tasks/robots_txt.md

@@ -1,6 +1,6 @@
 # Managing robots.txt
 
-{! backend/administration/CLI_tasks/general_cli_task_info.include !}
+{! administration/CLI_tasks/general_cli_task_info.include !}
 
 ## Generate a new robots.txt file and add it to the static directory
 

docs/docs/administration/CLI_tasks/uploads.md

@@ -1,6 +1,6 @@
 # Managing uploads
 
-{! backend/administration/CLI_tasks/general_cli_task_info.include !}
+{! administration/CLI_tasks/general_cli_task_info.include !}
 
 ## Migrate uploads from local to remote storage
 === "OTP"

docs/docs/administration/CLI_tasks/user.md

@@ -1,6 +1,6 @@
 # Managing users
 
-{! backend/administration/CLI_tasks/general_cli_task_info.include !}
+{! administration/CLI_tasks/general_cli_task_info.include !}
 
 ## Create a user
 
@@ -300,3 +300,28 @@
     ```sh
     mix pleroma.user unconfirm_all
     ```
+
+## Fix following state
+
+Sometimes the system can get into a situation where
+it think you're already following someone and won't send a request
+to the remote instance, or won't let you unfollow someone. This
+bug was fixed, but in case you encounter these weird states:
+
+=== "OTP"
+
+    ```sh
+     ./bin/pleroma_ctl user fix_follow_state localuser remoteuser@example.com
+    ```
+
+=== "From Source"
+
+    ```sh
+    mix pleroma.user fix_follow_state localuser remoteuser@example.com
+    ```
+
+The first argument is the local user's nickname - if you are `myuser@myinstance`, this should be `myuser`.
+
+The second is the remote user, consisting of both nickname AND domain.
+
+If you are a weird follow state situation and cannot resolve it with the above, you may need to co-operate with the remote admin to clear the state their side too - they should provide the arguments *backwards*, i.e `fix_follow_state remote local`.

docs/docs/administration/updating.md

@@ -8,7 +8,7 @@ Besides that, doing the following is generally enough:
 
 ```sh
 # Download the new release
-su akkoma -s $SHELL -lc "./bin/pleroma_ctl update"
+su akkoma -s $SHELL -lc "./bin/pleroma_ctl update" 
 
 # Migrate the database, you are advised to stop the instance before doing that
 su akkoma -s $SHELL -lc "./bin/pleroma_ctl migrate"

docs/docs/configuration/cheatsheet.md

@@ -8,11 +8,6 @@ For from source installations Akkoma configuration works by first importing the
 
 To add configuration to your config file, you can copy it from the base config. The latest version of it can be viewed [here](https://akkoma.dev/AkkomaGang/akkoma/src/branch/develop/config/config.exs). You can also use this file if you don't know how an option is supposed to be formatted.
 
-## :shout
-
-* `enabled` - Enables the backend Shoutbox chat feature. Defaults to `true`.
-* `limit` - Shout character limit. Defaults to `5_000`
-
 ## :instance
 * `name`: The instance’s name.
 * `email`: Email used to reach an Administrator/Moderator of the instance.
@@ -39,7 +34,7 @@ To add configuration to your config file, you can copy it from the base config.
 * `federation_reachability_timeout_days`: Timeout (in days) of each external federation target being unreachable prior to pausing federating to it.
 * `allow_relay`: Permits remote instances to subscribe to all public posts of your instance. This may increase the visibility of your instance.
 * `public`: Makes the client API in authenticated mode-only except for user-profiles. Useful for disabling the Local Timeline and The Whole Known Network. Note that there is a dependent setting restricting or allowing unauthenticated access to specific resources, see `restrict_unauthenticated` for more details.
-* `quarantined_instances`: ActivityPub instances where private (DMs, followers-only) activities will not be send.
+* `quarantined_instances`: ActivityPub instances where activities will not be sent. They can still reach there via other means, we just won't send them.
 * `allowed_post_formats`: MIME-type list of formats allowed to be posted (transformed into HTML).
 * `extended_nickname_format`: Set to `true` to use extended local nicknames format (allows underscores/dashes). This will break federation with
     older software for theses nicknames.
@@ -77,10 +72,6 @@ To add configuration to your config file, you can copy it from the base config.
   * `enabled`: Enables the send a direct message to a newly registered user. Defaults to `false`.
   * `sender_nickname`: The nickname of the local user that sends the welcome message.
   * `message`: A message that will be send to a newly registered users as a direct message.
-* `chat_message`: - welcome message sent as a chat message.
-  * `enabled`: Enables the send a chat message to a newly registered user. Defaults to `false`.
-  * `sender_nickname`: The nickname of the local user that sends the welcome message.
-  * `message`: A message that will be send to a newly registered users as a chat message.
 * `email`: - welcome message sent as a email.
   * `enabled`: Enables the send a welcome email to a newly registered user. Defaults to `false`.
   * `sender`: The email address or tuple with `{nickname, email}` that will use as sender to the welcome email.
@@ -249,9 +240,11 @@ Notes:
 * `total_user_limit`: the number of scheduled activities a user is allowed to create in total (Default: `300`)
 * `enabled`: whether scheduled activities are sent to the job queue to be executed
 
+## Frontend Management
+
 ### :frontend_configurations
 
-This can be used to configure a keyword list that keeps the configuration data for any kind of frontend. By default, settings for `pleroma_fe` and `masto_fe` are configured. You can find the documentation for `pleroma_fe` configuration into [Pleroma-FE configuration and customization for instance administrators](/frontend/CONFIGURATION/#options).
+This can be used to configure a keyword list that keeps the configuration data for any kind of frontend. By default, settings for `pleroma_fe` and `masto_fe` are configured. You can find the documentation for `pleroma_fe` configuration into [Pleroma-FE configuration and customization for instance administrators](https://docs-fe.akkoma.dev/stable/CONFIGURATION/#options).
 
 Frontends can access these settings at `/api/v1/pleroma/frontend_configurations`
 
@@ -270,6 +263,33 @@ config :pleroma, :frontend_configurations,
 
 These settings **need to be complete**, they will override the defaults.
 
+### :frontends
+
+These settings tell akkoma which frontend files to serve the user.
+
+See: [Frontend Management](../frontend_management)
+
+```elixir
+config :pleroma, :frontends,
+  primary: %{
+    "name" => "pleroma-fe",
+    "ref" => "develop"
+  },
+  admin: %{
+    "name" => "admin-fe",
+    "ref" => "develop"
+  },
+  swagger: %{
+    "name" => "swagger-ui",
+    "ref" => "stable",
+    "enabled" => true
+  } 
+```
+
+* `:primary` - The frontend that will be served at `/`
+* `:admin` - The frontend that will be served at `/pleroma/admin`
+* `:swagger` - Config for developers to act as an API reference to be served at `/akkoma/swaggerui/` (trailing slash _needed_). Disabled by default.
+
 ### :static_fe
 
 Render profiles and posts using server-generated HTML that is viewable without using JavaScript.
@@ -1014,7 +1034,22 @@ config :pleroma, Pleroma.Formatter,
 
 ## Custom Runtime Modules (`:modules`)
 
-* `runtime_dir`: A path to custom Elixir modules (such as MRF policies).
+* `runtime_dir`: A path to custom Elixir modules, such as MRF policies or
+ custom authenticators. These modules will be loaded on boot, and can be
+ contained in subdirectories. It is advised to use version-controlled
+ subdirectories to make management of them a bit easier. Note that only
+ files with the extension `.ex` will be loaded.
+
+```elixir
+config :pleroma, :modules, runtime_dir: "instance/modules"
+```
+
+### Adding a module
+
+```bash
+cd instance/modules/
+git clone <MY MODULE>
+```
 
 ## :configurable_from_database
 
@@ -1088,40 +1123,6 @@ Control favicons for instances.
     4. C:\TMP on Windows or /tmp on Unix-like operating systems
     5. as a last resort, the current working directory
 
-## Frontend management
-
-Frontends in Akkoma are swappable - you can specify which one to use here.
-
-You can set a frontends for the key `primary` and `admin` and the options of `name` and `ref`. This will then make Akkoma serve the frontend from a folder constructed by concatenating the instance static path, `frontends` and the name and ref.
-
-The key `primary` refers to the frontend that will be served by default for general requests. The key `admin` refers to the frontend that will be served at the `/pleroma/admin` path.
-
-If you don't set anything here, you will not have _any_ frontend at all.
-
-Example:
-
-```
-config :pleroma, :frontends,
-  primary: %{
-    "name" => "pleroma",
-    "ref" => "stable"
-  },
-  admin: %{
-    "name" => "admin",
-    "ref" => "develop"
-  }
-```
-
-This would serve the frontend from the the folder at `$instance_static/frontends/pleroma/stable`. You have to copy the frontend into this folder yourself. You can choose the name and ref any way you like, but they will be used by mix tasks to automate installation in the future, the name referring to the project and the ref referring to a commit.
-
-Refer to [the frontend CLI task](../../administration/CLI_tasks/frontend) for how to install the frontend's files
-
-If you wish masto-fe to also be enabled, you will also need to run the install task for `mastodon-fe`. Not doing this will lead to the frontend not working.
-
-If you choose not to install a frontend for whatever reason, it is recommended that you enable [`:static_fe`](#static_fe) to allow remote users to click "view remote source". Don't bother with this if you've got no unauthenticated access though.
-
-You can also replace the default "no frontend" page by placing an `index.html` file under your `instance/static/` directory.
-
 ### Theme settings
 
 Settings to change theme as exposed to the outside world, for software

docs/docs/configuration/frontend_management.md

@@ -0,0 +1,53 @@
+# Frontend Management
+
+Frontends in Akkoma are swappable, you can pick which you'd like.
+
+For a basic setup, you can set a frontends for the key `primary` and `admin` and the options of `name` and `ref`. This will then make Akkoma serve the frontend from a folder constructed by concatenating the instance static path, `frontends` and the name and ref.
+
+The key `primary` refers to the frontend that will be served by default for general requests. The key `admin` refers to the frontend that will be served at the `/pleroma/admin` path.
+
+If you don't set anything here, you will not have _any_ frontend at all.
+
+Example:
+
+```elixir
+config :pleroma, :frontends,
+  primary: %{
+    "name" => "pleroma-fe",
+    "ref" => "stable"
+  },
+  admin: %{
+    "name" => "admin-fe",
+    "ref" => "stable"
+  }
+```
+
+This would serve the frontend from the the folder at `$instance_static/frontends/pleroma/stable`. You have to copy the frontend into this folder yourself. You can choose the name and ref any way you like, but they will be used by mix tasks to automate installation in the future, the name referring to the project and the ref referring to a commit.
+
+Refer to [the frontend CLI task](../../administration/CLI_tasks/frontend) for how to install the frontend's files
+
+If you wish masto-fe to also be enabled, you will also need to run the install task for `mastodon-fe`. Not doing this will lead to the frontend not working.
+
+If you choose not to install a frontend for whatever reason, it is recommended that you enable [`:static_fe`](#static_fe) to allow remote users to click "view remote source". Don't bother with this if you've got no unauthenticated access though.
+
+You can also replace the default "no frontend" page by placing an `index.html` file under your `instance/static/` directory.
+
+## Swagger (openAPI) documentation viewer
+
+If you're a developer and you'd like a human-readable rendering of the
+API documentation, you can enable [Swagger UI](https://github.com/swagger-api/swagger-ui).
+
+In your config:
+
+```elixir
+config :pleroma, :frontends,
+  swagger: %{
+    "name" => "swagger-ui",
+    "ref" => "stable",
+    "enabled" => true
+  }
+```
+
+Then run the [pleroma.frontend cli task](../../administration/CLI_tasks/frontend) with the name of `swagger-ui` to install the distribution files.
+
+You will now be able to view documentation at `/akkoma/swaggerui`

docs/docs/configuration/howto_theming_your_instance.md

@@ -60,7 +60,7 @@ Example of `my-awesome-theme.json` where we add the name "My Awesome Theme"
 
 ### Set as default theme
 
-Now we can set the new theme as default in the [Pleroma FE configuration](../../../frontend/CONFIGURATION).
+Now we can set the new theme as default in the [Pleroma FE configuration](https://docs-fe.akkoma.dev/stable/CONFIGURATION).
 
 Example of adding the new theme in the back-end config files
 ```elixir

docs/docs/configuration/search.md

@@ -1,6 +1,6 @@
 # Configuring search
 
-{! backend/administration/CLI_tasks/general_cli_task_info.include !}
+{! administration/CLI_tasks/general_cli_task_info.include !}
 
 ## Built-in search
 

docs/docs/css/extra.css

@@ -0,0 +1,28 @@
+p, a, li, pre {
+  font-family: "Tiresias PCFont", -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, "Noto Sans", sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji" !important;
+}
+
+code,
+.codehilite pre {
+  font-weight: bold;
+}
+
+:root > * {
+  --md-primary-fg-color:        #593196;
+  --md-accent-fg-color:         #455a63;
+}
+
+@font-face {
+  font-family: 'Tiresias PCFont';
+  font-style: normal;
+  font-weight: 400;
+  src: local('Tiresias PCFont'), local('Tiresias PCFont'),
+       url('./fonts/Tiresias_PCfont.ttf') format('truetype')
+}
+@font-face {
+  font-family: 'Tiresias Infofont';
+  font-style: normal;   
+  font-weight: 400;
+  src: local('Tiresias Infofont'), local('Tiresias Infofont'),
+       url('./fonts/Tiresias_Infofont.ttf') format('truetype')
+} 

docs/docs/development/API/admin_api.md

@@ -1031,7 +1031,6 @@ Most of the settings will be applied in `runtime`, this means that you don't nee
   - `:hackney_pools`
   - `:connections_pool`
   - `:pools`
-  - `:chat`
 - partially settings inside these keys:
   - `:seconds_valid` in `Pleroma.Captcha`
   - `:proxy_remote` in `Pleroma.Upload`
@@ -1411,127 +1410,6 @@ Loads json generated from `config/descriptions.exs`.
 
 ```
 
-## GET /api/v1/pleroma/admin/users/:nickname/chats
-
-### List a user's chats
-
-- Params: None
-
-- Response:
-
-```json
-[
-   {
-      "sender": {
-        "id": "someflakeid",
-        "username": "somenick",
-        ...
-      },
-      "receiver": {
-        "id": "someflakeid",
-        "username": "somenick",
-        ...
-      },
-      "id" : "1",
-      "unread" : 2,
-      "last_message" : {...}, // The last message in that chat
-      "updated_at": "2020-04-21T15:11:46.000Z"
-   }
-]
-```
-
-## GET /api/v1/pleroma/admin/chats/:chat_id
-
-### View a single chat
-
-- Params: None
-
-- Response:
-
-```json
-{
-  "sender": {
-    "id": "someflakeid",
-    "username": "somenick",
-    ...
-  },
-  "receiver": {
-    "id": "someflakeid",
-    "username": "somenick",
-    ...
-  },
-  "id" : "1",
-  "unread" : 2,
-  "last_message" : {...}, // The last message in that chat
-  "updated_at": "2020-04-21T15:11:46.000Z"
-}
-```
-
-## GET /api/v1/pleroma/admin/chats/:chat_id/messages
-
-### List the messages in a chat
-
-- Params: `max_id`, `min_id`
-
-- Response:
-
-```json
-[
-  {
-    "account_id": "someflakeid",
-    "chat_id": "1",
-    "content": "Check this out :firefox:",
-    "created_at": "2020-04-21T15:11:46.000Z",
-    "emojis": [
-      {
-        "shortcode": "firefox",
-        "static_url": "https://dontbulling.me/emoji/Firefox.gif",
-        "url": "https://dontbulling.me/emoji/Firefox.gif",
-        "visible_in_picker": false
-      }
-    ],
-    "id": "13",
-    "unread": true
-  },
-  {
-    "account_id": "someflakeid",
-    "chat_id": "1",
-    "content": "Whats' up?",
-    "created_at": "2020-04-21T15:06:45.000Z",
-    "emojis": [],
-    "id": "12",
-    "unread": false
-  }
-]
-```
-
-## DELETE /api/v1/pleroma/admin/chats/:chat_id/messages/:message_id
-
-### Delete a single message
-
-- Params: None
-
-- Response:
-
-```json
-{
-  "account_id": "someflakeid",
-  "chat_id": "1",
-  "content": "Check this out :firefox:",
-  "created_at": "2020-04-21T15:11:46.000Z",
-  "emojis": [
-    {
-      "shortcode": "firefox",
-      "static_url": "https://dontbulling.me/emoji/Firefox.gif",
-      "url": "https://dontbulling.me/emoji/Firefox.gif",
-      "visible_in_picker": false
-    }
-  ],
-  "id": "13",
-  "unread": false
-}
-```
-
 ## `GET /api/v1/pleroma/admin/instance_document/:document_name`
 
 ### Get an instance document
@@ -1636,3 +1514,117 @@ Returns the content of the document
   "error": "Could not install frontend"
 }
 ```
+
+## `GET /api/v1/pleroma/admin/announcements`
+
+### List announcements
+
+- Params: `offset`, `limit`
+
+- Response: JSON, list of announcements
+
+```json
+[
+  {
+    "id": "AHDp0GBdRn1EPN5HN2",
+    "content": "some content",
+    "starts_at": null,
+    "ends_at": null,
+    "all_day": false,
+    "published_at": "2022-03-09T02:13:05",
+    "reactions": [],
+    "statuses": [],
+    "tags": [],
+    "emojis": [],
+    "updated_at": "2022-03-09T02:13:05"
+  }
+]
+```
+
+Note that this differs from the Mastodon API variant: Mastodon API only returns *active* announcements, while this returns all.
+
+## `GET /api/v1/pleroma/admin/announcements/:id`
+
+### Display one announcement
+
+- Response: JSON, one announcement
+
+```json
+{
+  "id": "AHDp0GBdRn1EPN5HN2",
+  "content": "some content",
+  "starts_at": null,
+  "ends_at": null,
+  "all_day": false,
+  "published_at": "2022-03-09T02:13:05",
+  "reactions": [],
+  "statuses": [],
+  "tags": [],
+  "emojis": [],
+  "updated_at": "2022-03-09T02:13:05"
+}
+```
+
+## `POST /api/v1/pleroma/admin/announcements`
+
+### Create an announcement
+
+- Params:
+  - `content`: string, required, announcement content
+  - `starts_at`: datetime, optional, default to null, the time when the announcement will become active (displayed to users); if it is null, the announcement will be active immediately
+  - `ends_at`: datetime, optional, default to null, the time when the announcement will become inactive (no longer displayed to users); if it is null, the announcement will be active until an admin deletes it
+  - `all_day`: boolean, optional, default to false, tells the client whether to only display dates for `starts_at` and `ends_at`
+
+- Response: JSON, created announcement
+
+```json
+{
+  "id": "AHDp0GBdRn1EPN5HN2",
+  "content": "some content",
+  "starts_at": null,
+  "ends_at": null,
+  "all_day": false,
+  "published_at": "2022-03-09T02:13:05",
+  "reactions": [],
+  "statuses": [],
+  "tags": [],
+  "emojis": [],
+  "updated_at": "2022-03-09T02:13:05"
+}
+```
+
+## `PATCH /api/v1/pleroma/admin/announcements/:id`
+
+### Change an announcement
+
+- Params: same as `POST /api/v1/pleroma/admin/announcements`, except no param is required.
+
+- Updates the announcement according to params. Missing params are kept as-is.
+
+- Response: JSON, updated announcement
+
+```json
+{
+  "id": "AHDp0GBdRn1EPN5HN2",
+  "content": "some content",
+  "starts_at": null,
+  "ends_at": null,
+  "all_day": false,
+  "published_at": "2022-03-09T02:13:05",
+  "reactions": [],
+  "statuses": [],
+  "tags": [],
+  "emojis": [],
+  "updated_at": "2022-03-09T02:13:05"
+}
+```
+
+## `DELETE /api/v1/pleroma/admin/announcements/:id`
+
+### Delete an announcement
+
+- Response: JSON, empty object
+
+```json
+{}
+```

docs/docs/development/API/differences_in_mastoapi_responses.md

@@ -99,13 +99,11 @@ Has these additional fields under the `pleroma` object:
 - `hide_followers_count`: boolean, true when the user has follower stat hiding enabled
 - `hide_follows_count`: boolean, true when the user has follow stat hiding enabled
 - `settings_store`: A generic map of settings for frontends. Opaque to the backend. Only returned in `/api/v1/accounts/verify_credentials` and `/api/v1/accounts/update_credentials`
-- `chat_token`: The token needed for Akkoma shoutbox. Only returned in `/api/v1/accounts/verify_credentials`
 - `deactivated`: boolean, true when the user is deactivated
 - `allow_following_move`: boolean, true when the user allows automatically follow moved following accounts
 - `unread_conversation_count`: The count of unread conversations. Only returned to the account owner.
 - `unread_notifications_count`: The count of unread notifications. Only returned to the account owner.
 - `notification_settings`: object, can be absent. See `/api/v1/pleroma/notification_settings` for the parameters/keys returned.
-- `accepts_chat_messages`: boolean, but can be null if we don't have that information about a user
 - `favicon`: nullable URL string, Favicon image of the user's instance
 
 ### Source
@@ -159,15 +157,6 @@ The `type` value is `pleroma:emoji_reaction`. Has these fields:
 - `account`: The account of the user who reacted
 - `status`: The status that was reacted on
 
-### ChatMention Notification (not default)
-
-This notification has to be requested explicitly.
-
-The `type` value is `pleroma:chat_mention`
-
-- `account`: The account who sent the message
-- `chat_message`: The chat message
-
 ### Report Notification (not default)
 
 This notification has to be requested explicitly.
@@ -182,7 +171,7 @@ The `type` value is `pleroma:report`
 Accepts additional parameters:
 
 - `exclude_visibilities`: will exclude the notifications for activities with the given visibilities. The parameter accepts an array of visibility types (`public`, `unlisted`, `private`, `direct`). Usage example: `GET /api/v1/notifications?exclude_visibilities[]=direct&exclude_visibilities[]=private`.
-- `include_types`: will include the notifications for activities with the given types. The parameter accepts an array of types (`mention`, `follow`, `reblog`, `favourite`, `move`, `pleroma:emoji_reaction`, `pleroma:chat_mention`, `pleroma:report`). Usage example: `GET /api/v1/notifications?include_types[]=mention&include_types[]=reblog`.
+- `include_types`: will include the notifications for activities with the given types. The parameter accepts an array of types (`mention`, `follow`, `reblog`, `favourite`, `move`, `pleroma:emoji_reaction`, `pleroma:report`). Usage example: `GET /api/v1/notifications?include_types[]=mention&include_types[]=reblog`.
 
 ## DELETE `/api/v1/notifications/destroy_multiple`
 
@@ -240,7 +229,6 @@ Additional parameters can be added to the JSON body/Form data:
 - `pleroma_background_image` - sets the background image of the user. Can be set to "" (an empty string) to reset.
 - `discoverable` - if true, external services (search bots) etc. are allowed to index / list the account (regardless of this setting, user will still appear in regular search results).
 - `actor_type` - the type of this account.
-- `accepts_chat_messages` - if false, this account will reject all chat messages.
 - `language` - user's preferred language for receiving emails (digest, confirmation, etc.)
 
 All images (avatar, banner and background) can be reset to the default by sending an empty string ("") instead of a file.
@@ -300,7 +288,6 @@ Has these additional parameters (which are the same as in Akkoma-API):
 `GET /api/v1/instance` has additional fields
 
 - `max_toot_chars`: The maximum characters per post
-- `chat_limit`: The maximum characters per chat message
 - `description_limit`: The maximum characters per image description
 - `poll_limits`: The limits of polls
 - `upload_limit`: The maximum upload file size
@@ -321,7 +308,6 @@ Has these additional parameters (which are the same as in Akkoma-API):
 
 Permits these additional alert types:
 
-- pleroma:chat_mention
 - pleroma:emoji_reaction
 
 ## Markers
@@ -332,10 +318,6 @@ Has these additional fields under the `pleroma` object:
 
 ## Streaming
 
-### Chats
-
-There is an additional `user:pleroma_chat` stream. Incoming chat messages will make the current chat be sent to this `user` stream. The `event` of an incoming chat message is `pleroma:chat_update`. The payload is the updated chat with the incoming chat message in the `last_message` field.
-
 ### Remote timelines
 
 For viewing remote server timelines, there are `public:remote` and `public:remote:media` streams. Each of these accept a parameter like `?instance=lain.com`.

docs/docs/development/API/nodeinfo.md

@@ -44,11 +44,8 @@ See also [the Nodeinfo standard](https://nodeinfo.diaspora.software/).
          "shareable_emoji_packs",
          "multifetch",
          "pleroma:api/v1/notifications:include_types_filter",
-         "chat",
-         "shout",
          "relay",
-         "pleroma_emoji_reactions",
-         "pleroma_chat_messages"
+         "pleroma_emoji_reactions"
       ],
       "federation":{
          "enabled":true,
@@ -204,11 +201,8 @@ See also [the Nodeinfo standard](https://nodeinfo.diaspora.software/).
          "shareable_emoji_packs",
          "multifetch",
          "pleroma:api/v1/notifications:include_types_filter",
-         "chat",
-         "shout",
          "relay",
-         "pleroma_emoji_reactions",
-         "pleroma_chat_messages"
+         "pleroma_emoji_reactions"
       ],
       "federation":{
          "enabled":true,

docs/docs/development/API/pleroma_api.md

@@ -576,38 +576,6 @@ The status posting endpoint takes an additional parameter, `in_reply_to_conversa
 * Response: the archive of the pack with a 200 status code, 403 if the pack is not set as shared,
   404 if the pack does not exist
 
-## `GET /api/v1/pleroma/accounts/:id/scrobbles`
-### Requests a list of current and recent Listen activities for an account
-* Method `GET`
-* Authentication: not required
-* Params: None
-* Response: An array of media metadata entities.
-* Example response:
-```json
-[
-   {
-       "account": {...},
-       "id": "1234",
-       "title": "Some Title",
-       "artist": "Some Artist",
-       "album": "Some Album",
-       "length": 180000,
-       "created_at": "2019-09-28T12:40:45.000Z"
-   }
-]
-```
-
-## `POST /api/v1/pleroma/scrobble`
-### Creates a new Listen activity for an account
-* Method `POST`
-* Authentication: required
-* Params:
-  * `title`: the title of the media playing
-  * `album`: the album of the media playing [optional]
-  * `artist`: the artist of the media playing [optional]
-  * `length`: the length of the media playing [optional]
-* Response: the newly created media metadata entity representing the Listen activity
-
 # Emoji Reactions
 
 Emoji reactions work a lot like favourites do. They make it possible to react to a post with a single emoji character. To detect the presence of this feature, you can check `pleroma_emoji_reactions` entry in the features list of nodeinfo.

docs/docs/development/ap_extensions.md

@@ -0,0 +1,28 @@
+# AP Extensions
+## Actor endpoints
+
+The following endpoints are additionally present into our actors.
+
+- `oauthRegistrationEndpoint` (`http://litepub.social/ns#oauthRegistrationEndpoint`)
+- `uploadMedia` (`https://www.w3.org/ns/activitystreams#uploadMedia`)
+
+### oauthRegistrationEndpoint
+
+Points to MastodonAPI `/api/v1/apps` for now.
+
+See <https://docs.joinmastodon.org/methods/apps/>
+
+### uploadMedia
+
+Inspired by <https://www.w3.org/wiki/SocialCG/ActivityPub/MediaUpload>, it is part of the ActivityStreams namespace because it used to be part of the ActivityPub specification and got removed from it.
+
+Content-Type: multipart/form-data
+
+Parameters:
+- (required) `file`: The file being uploaded
+- (optionnal) `description`: A plain-text description of the media, for accessibility purposes.
+
+Response: HTTP 201 Created with the object into the body, no `Location` header provided as it doesn't have an `id`
+
+The object given in the reponse should then be inserted into an Object's `attachment` field.
+

docs/docs/development/setting_up_akkoma_dev.md

@@ -36,6 +36,33 @@ config :logger, :console,
   level: :info
 ```
 
+## Testing with HTTPS
+
+If you end up developing alongside other software like misskey,
+you will not be able to federate without an SSL certificate. You should
+be able to use the snakeoil certificate that comes standard with most
+distributions or generate one from scratch, then force elixir to accept it.
+
+HTTP clients are none too keen to accept self-signed certs, but we can do
+this:
+
+```elixir
+config :pleroma, :http,
+  adapter: [
+    pools: %{
+      default: [
+        conn_opts: [
+          transport_opts: [
+            verify: :verify_none
+          ]
+        ]
+      ]
+    }
+  ]
+```
+
+Now your SSL requests will work. Hooray.
+
 ## Testing
 
 1. Create a `test.secret.exs` file with the content as shown below

docs/docs/index.md

@@ -18,7 +18,7 @@ Installation instructions can be found in the installation section of these docs
 Great! Now you can explore the fediverse! Open the login page for your Akkoma instance (e.g. <https://pleroma.soykaf.com>) and login with your username and password. (If you don't have an account yet, click on Register)
 
 ### Pleroma-FE
-The default front-end used by Akkoma is Pleroma-FE. You can find more information on what it is and how to use it in the [Introduction to Pleroma-FE](../frontend).
+The default front-end used by Akkoma is Pleroma-FE. You can find more information on what it is and how to use it in the [Introduction to Pleroma-FE](https://docs-fe.akkoma.dev/stable/).
 
 ### Mastodon interface
 If the Pleroma-FE interface isn't your thing, or you're just trying something new but you want to keep using the familiar Mastodon interface, we got that too!

docs/docs/installation/alpine_linux_en.md

@@ -1,6 +1,6 @@
 # Installing on Alpine Linux
 
-{! backend/installation/otp_vs_from_source_source.include !}
+{! installation/otp_vs_from_source_source.include !}
 
 ## Installation
 
@@ -10,7 +10,7 @@ As of Alpine Linux v3.16, `doas` is the preferred way of running privileged comm
 If you are running an earlier version, replace `doas` with `sudo` (and use `sudo -Hu akkoma` instead of `doas -u akkoma`).
 If you want to run this guide with root, ignore the `doas` at the beginning of the lines, unless it calls a user like `doas -u akkoma`; in this case, use `su -l <username> -s $SHELL -c 'command'` instead.
 
-{! backend/installation/generic_dependencies.include !}
+{! installation/generic_dependencies.include !}
 
 ### Prepare the system
 
@@ -223,6 +223,6 @@ doas -u akkoma env MIX_ENV=prod mix pleroma.user new <username> <your@emailaddre
 
 #### Further reading
 
-{! backend/installation/further_reading.include !}
+{! installation/further_reading.include !}
 
-{! backend/support.include !}
+{! support.include !}

docs/docs/installation/arch_linux_en.md

@@ -1,6 +1,6 @@
 # Installing on Arch Linux
 
-{! backend/installation/otp_vs_from_source_source.include !}
+{! installation/otp_vs_from_source_source.include !}
 
 ## Installation
 
@@ -214,6 +214,6 @@ sudo -Hu akkoma MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress>
 
 #### Further reading
 
-{! backend/installation/further_reading.include !}
+{! installation/further_reading.include !}
 
-{! backend/support.include !}
+{! support.include !}

docs/docs/installation/debian_based_en.md

@@ -1,12 +1,12 @@
 # Installing on Debian Based Distributions
 
-{! backend/installation/otp_vs_from_source_source.include !}
+{! installation/otp_vs_from_source_source.include !}
 
 ## Installation
 
 This guide will assume you are on Debian 11 (“bullseye”) or later. This guide should also work with Ubuntu 18.04 (“Bionic Beaver”) and later. It also assumes that you have administrative rights, either as root or a user with [sudo permissions](https://www.digitalocean.com/community/tutorials/how-to-add-delete-and-grant-sudo-privileges-to-users-on-a-debian-vps). If you want to run this guide with root, ignore the `sudo` at the beginning of the lines, unless it calls a user like `sudo -Hu akkoma`; in this case, use `su <username> -s $SHELL -c 'command'` instead.
 
-{! backend/installation/generic_dependencies.include !}
+{! installation/generic_dependencies.include !}
 
 ### Prepare the system
 
@@ -177,6 +177,6 @@ sudo -Hu akkoma MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress>
 
 #### Further reading
 
-{! backend/installation/further_reading.include !}
+{! installation/further_reading.include !}
 
-{! backend/support.include !}
+{! support.include !}

docs/docs/installation/fedora_based_en.md

@@ -0,0 +1,197 @@
+# Installing on Fedora
+
+## OTP releases and RedHat-distributions
+
+While the OTP releases of Akkoma work on most Linux distributions, they do not work correctly with RedHat-distributions. Therefore from-source installations are the recommended way to go when trying to install Akkoma on Fedora, Centos Stream or RedHat.
+
+However, it is possible to compile your own OTP release of Akkoma for RedHat. Keep in mind that this has a few drawbacks, and has no particular advantage over a from-source installation, since you'll need to install Erlang and Elixir anyway.
+
+This guide will cover a from-source installation. For instructions on how to build your own OTP release, please check out [the OTP for RedHat guide](./otp_redhat_en.md).
+
+## Installation
+
+This guide will assume you are on Fedora 36. This guide should also work with current releases of Centos Stream and RedHat, although it has not been tested yet. It also assumes that you have administrative rights, either as root or a user with [sudo permissions](https://docs.fedoraproject.org/en-US/quick-docs/adding_user_to_sudoers_file/). If you want to run this guide with root, ignore the `sudo` at the beginning of the lines, unless it calls a user like `sudo -Hu akkoma`; in this case, use `su <username> -s $SHELL -c 'command'` instead.
+
+{! installation/generic_dependencies.include !}
+
+### Prepare the system
+
+* First update the system, if not already done:
+
+```shell
+sudo dnf upgrade --refresh
+```
+
+* Install some of the above mentioned programs:
+
+```shell
+sudo dnf install git gcc g++ make cmake file-devel postgresql postgresql-contrib
+```
+
+### Install Elixir and Erlang
+
+* Install Elixir and Erlang:
+
+```shell
+sudo dnf install elixir erlang-os_mon erlang-eldap erlang-xmerl erlang-erl_interface erlang-syntax_tools
+```
+
+
+### Optional packages: [`docs/installation/optional/media_graphics_packages.md`](../installation/optional/media_graphics_packages.md)
+
+* Install ffmpeg (requires setting up the RPM-fusion repositories):
+
+```shell
+sudo dnf -y install https://download1.rpmfusion.org/free/fedora/rpmfusion-free-release-$(rpm -E %fedora).noarch.rpm
+sudo dnf -y install https://download1.rpmfusion.org/nonfree/fedora/rpmfusion-nonfree-release-$(rpm -E %fedora).noarch.rpm
+sudo dnf install ffmpeg
+```
+
+* Install ImageMagick and ExifTool for image manipulation:
+
+```shell
+sudo dnf install Imagemagick perl-Image-ExifTool
+```
+
+
+
+### Install AkkomaBE
+
+* Add a new system user for the Akkoma service:
+
+```shell
+sudo useradd -r -s /bin/false -m -d /var/lib/akkoma -U akkoma
+```
+
+**Note**: To execute a single command as the Akkoma system user, use `sudo -Hu akkoma command`. You can also switch to a shell by using `sudo -Hu akkoma $SHELL`. If you don’t have and want `sudo` on your system, you can use `su` as root user (UID 0) for a single command by using `su -l akkoma -s $SHELL -c 'command'` and `su -l akkoma -s $SHELL` for starting a shell.
+
+* Git clone the AkkomaBE repository and make the Akkoma user the owner of the directory:
+
+```shell
+sudo mkdir -p /opt/akkoma
+sudo chown -R akkoma:akkoma /opt/akkoma
+sudo -Hu akkoma git clone https://akkoma.dev/AkkomaGang/akkoma.git /opt/akkoma
+```
+
+* Change to the new directory:
+
+```shell
+cd /opt/akkoma
+```
+
+* Install the dependencies for Akkoma and answer with `yes` if it asks you to install `Hex`:
+
+```shell
+sudo -Hu akkoma mix deps.get
+```
+
+* Generate the configuration: `sudo -Hu akkoma MIX_ENV=prod mix pleroma.instance gen`
+  * Answer with `yes` if it asks you to install `rebar3`.
+  * This may take some time, because parts of akkoma get compiled first.
+  * After that it will ask you a few questions about your instance and generates a configuration file in `config/generated_config.exs`.
+
+* Check the configuration and if all looks right, rename it, so Akkoma will load it (`prod.secret.exs` for productive instance, `dev.secret.exs` for development instances):
+
+```shell
+sudo -Hu akkoma mv config/{generated_config.exs,prod.secret.exs}
+```
+
+
+* The previous command creates also the file `config/setup_db.psql`, with which you can create the database:
+
+```shell
+sudo -Hu postgres psql -f config/setup_db.psql
+```
+
+* Now run the database migration:
+
+```shell
+sudo -Hu akkoma MIX_ENV=prod mix ecto.migrate
+```
+
+* Now you can start Akkoma already
+
+```shell
+sudo -Hu akkoma MIX_ENV=prod mix phx.server
+```
+
+### Finalize installation
+
+If you want to open your newly installed instance to the world, you should run nginx or some other webserver/proxy in front of Akkoma and you should consider to create a systemd service file for Akkoma.
+
+#### Nginx
+
+* Install nginx, if not already done:
+
+```shell
+sudo dnf install nginx
+```
+
+* Setup your SSL cert, using your method of choice or certbot. If using certbot, first install it:
+
+```shell
+sudo dnf install certbot
+```
+
+and then set it up:
+
+```shell
+sudo mkdir -p /var/lib/letsencrypt/
+sudo certbot certonly --email <your@emailaddress> -d <yourdomain> --standalone
+```
+
+If that doesn’t work, make sure, that nginx is not already running. If it still doesn’t work, try setting up nginx first (change ssl “on” to “off” and try again).
+
+---
+
+* Copy the example nginx configuration and activate it:
+
+```shell
+sudo cp /opt/akkoma/installation/nginx/akkoma.nginx /etc/nginx/conf.d/akkoma.conf
+```
+
+* Before starting nginx edit the configuration and change it to your needs (e.g. change servername, change cert paths)
+* Enable and start nginx:
+
+```shell
+sudo systemctl enable --now nginx.service
+```
+
+If you need to renew the certificate in the future, uncomment the relevant location block in the nginx config and run:
+
+```shell
+sudo certbot certonly --email <your@emailaddress> -d <yourdomain> --webroot -w /var/lib/letsencrypt/
+```
+
+#### Other webserver/proxies
+
+You can find example configurations for them in `/opt/akkoma/installation/`.
+
+#### Systemd service
+
+* Copy example service file
+
+```shell
+sudo cp /opt/akkoma/installation/akkoma.service /etc/systemd/system/akkoma.service
+```
+
+* Edit the service file and make sure that all paths fit your installation
+* Enable and start `akkoma.service`:
+
+```shell
+sudo systemctl enable --now akkoma.service
+```
+
+#### Create your first user
+
+If your instance is up and running, you can create your first user with administrative rights with the following task:
+
+```shell
+sudo -Hu akkoma MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress> --admin
+```
+
+#### Further reading
+
+{! installation/further_reading.include !}
+
+{! support.include !}

docs/docs/installation/freebsd_en.md

@@ -2,7 +2,7 @@
 
 This document was written for FreeBSD 12.1, but should be work on future releases.
 
-{! backend/installation/generic_dependencies.include !}
+{! installation/generic_dependencies.include !}
 
 ## Installing software used in this guide
 
@@ -213,4 +213,4 @@ Restart nginx with `# service nginx restart` and you should be up and running.
 Make sure your time is in sync, or other instances will receive your posts with
 incorrect timestamps. You should have ntpd running.
 
-{! backend/support.include !}
+{! support.include !}

docs/docs/installation/gentoo_en.md

@@ -1,12 +1,12 @@
 # Installing on Gentoo GNU/Linux
 
-{! backend/installation/otp_vs_from_source_source.include !}
+{! installation/otp_vs_from_source_source.include !}
 
 ## Installation
 
 This guide will assume that you have administrative rights, either as root or a user with [sudo permissions](https://wiki.gentoo.org/wiki/Sudo). Lines that begin with `#` indicate that they should be run as the superuser. Lines using `$` should be run as the indicated user, e.g. `akkoma$` should be run as the `akkoma` user.
 
-{! backend/installation/generic_dependencies.include !}
+{! installation/generic_dependencies.include !}
 
 ### Your make.conf, package.use, and USE flags
 
@@ -295,6 +295,6 @@ If you opted to allow sudo for the `akkoma` user but would like to remove the ab
 
 #### Further reading
 
-{! backend/installation/further_reading.include !}
+{! installation/further_reading.include !}
 
-{! backend/support.include !}
+{! support.include !}

docs/docs/installation/migrating_from_source_otp_en.md

@@ -1,6 +1,6 @@
 # Switching a from-source install to OTP releases
 
-{! backend/installation/otp_vs_from_source.include !}
+{! installation/otp_vs_from_source.include !}
 
 In this guide we cover how you can migrate from a from source installation to one using OTP releases.
 
@@ -142,4 +142,4 @@ Refer to [Running mix tasks](otp_en.md#running-mix-tasks) section from OTP relea
 ## Updating
 Refer to [Updating](otp_en.md#updating) section from OTP release installation guide.
 
-{! backend/support.include !}
+{! support.include !}

docs/docs/installation/migrating_to_akkoma.md

@@ -30,16 +30,18 @@ upstream git URL then just rebuild - that'll be:
 git remote set-url origin https://akkoma.dev/AkkomaGang/akkoma.git/
 git fetch origin
 git pull -r
+# or, if you're on an instance-specific branch, you may want
+# to run "git merge stable" instead (or develop if you want)
 ```
 
 Then compile, migrate and restart as usual.
 
 ## From OTP
 
-This will just be setting the update URL -
+This will just be setting the update URL - find your flavour from the [mapping on the install guide](../otp_en/#detecting-flavour) first.
 
 ```bash
-export FLAVOUR=$(arch="$(uname -m)";if [ "$arch" = "x86_64" ];then arch="amd64";elif [ "$arch" = "armv7l" ];then arch="arm";elif [ "$arch" = "aarch64" ];then arch="arm64";else echo "Unsupported arch: $arch">&2;fi;if getconf GNU_LIBC_VERSION>/dev/null;then libc_postfix="";elif [ "$(ldd 2>&1|head -c 9)" = "musl libc" ];then libc_postfix="-musl";elif [ "$(find /lib/libc.musl*|wc -l)" ];then libc_postfix="-musl";else echo "Unsupported libc">&2;fi;echo "$arch$libc_postfix")
+export FLAVOUR=[the flavour you found above]
 
 ./bin/pleroma_ctl update --zip-url https://akkoma-updates.s3-website.fr-par.scw.cloud/develop/akkoma-$FLAVOUR.zip
 ./bin/pleroma_ctl migrate

docs/docs/installation/netbsd_en.md

@@ -1,6 +1,6 @@
 # Installing on NetBSD
 
-{! backend/installation/generic_dependencies.include !}
+{! installation/generic_dependencies.include !}
 
 ## Installing software used in this guide
 
@@ -204,6 +204,6 @@ incorrect timestamps. You should have ntpd running.
 
 #### Further reading
 
-{! backend/installation/further_reading.include !}
+{! installation/further_reading.include !}
 
-{! backend/support.include !}
+{! support.include !}

docs/docs/installation/openbsd_en.md

@@ -4,7 +4,7 @@ This guide describes the installation and configuration of akkoma (and the requi
 
 For any additional information regarding commands and configuration files mentioned here, check the man pages [online](https://man.openbsd.org/) or directly on your server with the man command.
 
-{! backend/installation/generic_dependencies.include !}
+{! installation/generic_dependencies.include !}
 
 ### Preparing the system
 #### Required software
@@ -252,6 +252,6 @@ LC_ALL=en_US.UTF-8 MIX_ENV=prod mix pleroma.user new <username> <your@emailaddre
 
 #### Further reading
 
-{! backend/installation/further_reading.include !}
+{! installation/further_reading.include !}
 
-{! backend/support.include !}
+{! support.include !}

docs/docs/installation/otp_en.md

@@ -1,11 +1,12 @@
 # Installing on Linux using OTP releases
 
-{! backend/installation/otp_vs_from_source.include !}
+{! installation/otp_vs_from_source.include !}
 
 This guide covers a installation using an OTP release. To install Akkoma from source, please check out the corresponding guide for your distro.
 
 ## Pre-requisites
 * A machine running Linux with GNU (e.g. Debian, Ubuntu) or musl (e.g. Alpine) libc and `x86_64`, `aarch64` or `armv7l` CPU, you have root access to. If you are not sure if it's compatible see [Detecting flavour section](#detecting-flavour) below
+* For installing OTP releases on RedHat-based distros like Fedora and Centos Stream, please follow [this guide](./otp_redhat_en.md) instead.
 * A (sub)domain pointed to the machine
 
 You will be running commands as root. If you aren't root already, please elevate your priviledges by executing `sudo su`/`su`.
@@ -14,12 +15,19 @@ While in theory OTP releases are possbile to install on any compatible machine,
 
 ### Detecting flavour
 
-Paste the following into the shell:
-```sh
-arch="$(uname -m)";if [ "$arch" = "x86_64" ];then arch="amd64";elif [ "$arch" = "armv7l" ];then arch="arm";elif [ "$arch" = "aarch64" ];then arch="arm64";else echo "Unsupported arch: $arch">&2;fi;if getconf GNU_LIBC_VERSION>/dev/null;then libc_postfix="";elif [ "$(ldd 2>&1|head -c 9)" = "musl libc" ];then libc_postfix="-musl";elif [ "$(find /lib/libc.musl*|wc -l)" ];then libc_postfix="-musl";else echo "Unsupported libc">&2;fi;echo "$arch$libc_postfix"
-```
+This is a little more complex than it used to be (thanks ubuntu)
 
-If your platform is supported the output will contain the flavour string, you will need it later. If not, this just means that we don't build releases for your platform, you can still try installing from source.
+Use the following mapping to figure out your flavour:
+
+| distribution  | flavour      |
+| ------------- | ------------ |
+| debian stable | amd64        |
+| ubuntu focal  | amd64        |
+| ubuntu jammy  | ubuntu-jammy |
+| alpine        | amd64-musl   |
+
+Other similar distributions will _probably_ work, but if it is not listed above, there is no official
+support.
 
 ### Installing the required packages
 
@@ -235,7 +243,7 @@ At this point if you open your (sub)domain in a browser you should see a 502 err
 
 If everything worked, you should see Akkoma-FE when visiting your domain. If that didn't happen, try reviewing the installation steps, starting Akkoma in the foreground and seeing if there are any errrors.
 
-{! backend/support.include !}
+{! support.include !}
 
 ## Post installation
 
@@ -300,6 +308,6 @@ This will create an account withe the username of 'joeuser' with the email addre
 
 ## Further reading
 
-{! backend/installation/further_reading.include !}
+{! installation/further_reading.include !}
 
-{! backend/support.include !}
+{! support.include !}

docs/docs/installation/otp_redhat_en.md

@@ -0,0 +1,285 @@
+# Installing on RedHat using OTP releases
+
+## OTP releases and Fedora/RedHat
+
+The current OTP builds available for Linux are unfortunately incompatible with RedHat Linux distributions, like Fedora and Centos Stream. This is due to RedHat maintaining patched versions of certain Erlang libraries, making them incompatible with other Linux distributions.
+
+However, you may compile your own OTP release from scratch. This is particularly useful if you wish to quickly distribute your OTP build onto multiple systems, without having to worry about compiling code on every system. However, if your goal is to simply set up a single instance for yourself, installing from-source might be a simpler option. To install from-source, please follow [this guide](./fedora_based_en.md).
+
+
+## Pre-requisites
+
+In order to compile a RedHat-compatible OTP release, you will need to run a RedHat Linux distribution. This guide will assume you run Fedora 36, though it should also work on older Fedora releases and other RedHat distributions. It also assumes that you have administrative rights and sufficient knowledge on how to perform common CLI tasks in Linux. If you want to run this guide with root, ignore the `sudo` at the beginning of the lines.
+
+Important: keep in mind that you must build your OTP release for the specific RedHat distribution you wish to use it on. A build on Fedora will only be compatible with a specific Fedora release version.
+
+
+## Building an OTP release for Fedora 36
+
+### Installing required packages
+
+* First, update your system, if not already done:
+
+```shell
+sudo dnf upgrade --refresh
+```
+
+* Then install the required packages to build your OTP release:
+
+```shell
+sudo dnf install git gcc g++ erlang elixir erlang-os_mon erlang-eldap erlang-xmerl erlang-erl_interface erlang-syntax_tools make cmake file-devel
+```
+
+
+### Preparing the project files
+
+* Git clone the AkkomaBE repository. This can be done anywhere:
+
+```shell
+cd ~
+git clone https://akkoma.dev/AkkomaGang/akkoma.git
+```
+
+* Change to the new directory:
+
+```shell
+cd ./akkoma
+```
+
+
+### Building the OTP release
+
+* Run the following commands:
+
+```shell
+export MIX_ENV=prod
+echo "import Config" > config/prod.secret.exs
+mix local.hex --force
+mix local.rebar --force
+mix deps.get --only prod
+mkdir release
+mix release --path release
+```
+
+Note that compiling the OTP release will take some time. Once it completes, you will find the OTP files in the directory `release`.
+
+If all went well, you will have built your very own Fedora-compatible OTP release! You can now pack up the files in the `release` directory and deploy them to your other Fedora servers.
+
+
+## Installing the OTP release
+
+Installing the OTP release from this point onward will be very similar to the regular OTP release. This guide assumes you will want to install your OTP package on other systems, so additional pre-requisites will be listed below.
+
+Please note that running your own OTP release has some minor caveats that you should be aware of. They will be listed below as well.
+
+
+### Installing required packages
+
+Other than things bundled in the OTP release Akkoma depends on:
+
+* curl (to download the release build)
+* ncurses (ERTS won't run without it)
+* PostgreSQL (also utilizes extensions in postgresql-contrib)
+* nginx (could be swapped with another reverse proxy but this guide covers only it)
+* certbot (for Let's Encrypt certificates, could be swapped with another ACME client, but this guide covers only it)
+* libmagic/file
+
+First, update your system, if not already done:
+
+```shell
+sudo dnf upgrade --refresh
+```
+
+Then install the required packages:
+
+```shell
+sudo dnf install curl ncurses postgresql postgresql-contrib nginx certbot file-devel
+```
+
+
+### Optional packages: [`docs/installation/optional/media_graphics_packages.md`](../installation/optional/media_graphics_packages.md)
+
+* Install ffmpeg (requires setting up the RPM-fusion repositories):
+
+```shell
+sudo dnf -y install https://download1.rpmfusion.org/free/fedora/rpmfusion-free-release-$(rpm -E %fedora).noarch.rpm
+sudo dnf -y install https://download1.rpmfusion.org/nonfree/fedora/rpmfusion-nonfree-release-$(rpm -E %fedora).noarch.rpm
+sudo dnf install ffmpeg
+```
+
+* Install ImageMagick and ExifTool for image manipulation:
+
+```shell
+sudo dnf install Imagemagick perl-Image-ExifTool
+```
+
+
+### Configuring PostgreSQL
+#### (Optional) Performance configuration
+It is encouraged to check [Optimizing your PostgreSQL performance](../configuration/postgresql.md) document, for tips on PostgreSQL tuning.
+
+Restart PostgreSQL to apply configuration changes:
+
+```shell
+sudo systemctl restart postgresql
+```
+
+### Installing Akkoma
+```sh
+# Create a Akkoma user
+adduser --system --shell  /bin/false --home /opt/akkoma akkoma
+
+# Move your custom OTP release to the home directory
+sudo -Hu akkoma mv /your/custom/otp/release /opt/akkoma
+
+# Create uploads directory and set proper permissions (skip if planning to use a remote uploader)
+# Note: It does not have to be `/var/lib/akkoma/uploads`, the config generator will ask about the upload directory later
+
+sudo mkdir -p /var/lib/akkoma/uploads
+sudo chown -R akkoma /var/lib/akkoma
+
+# Create custom public files directory (custom emojis, frontend bundle overrides, robots.txt, etc.)
+# Note: It does not have to be `/var/lib/akkoma/static`, the config generator will ask about the custom public files directory later
+sudo mkdir -p /var/lib/akkoma/static
+sudo chown -R akkoma /var/lib/akkoma
+
+# Create a config directory
+sudo mkdir -p /etc/akkoma
+sudo chown -R akkoma /etc/akkoma
+
+# Run the config generator
+sudo -Hu akkoma ./bin/pleroma_ctl instance gen --output /etc/akkoma/config.exs --output-psql /tmp/setup_db.psql
+
+# Create the postgres database
+sudo -Hu postgres psql -f /tmp/setup_db.psql
+
+# Create the database schema
+sudo -Hu akkoma ./bin/pleroma_ctl migrate
+
+# Start the instance to verify that everything is working as expected
+sudo -Hu akkoma ./bin/pleroma daemon
+
+# Wait for about 20 seconds and query the instance endpoint, if it shows your uri, name and email correctly, you are configured correctly
+sleep 20 && curl http://localhost:4000/api/v1/instance
+
+# Stop the instance
+sudo -Hu akkoma ./bin/pleroma stop
+```
+
+
+### Setting up nginx and getting Let's Encrypt SSL certificaties
+
+#### Get a Let's Encrypt certificate
+
+```shell
+certbot certonly --standalone --preferred-challenges http -d yourinstance.tld
+```
+
+#### Copy Akkoma nginx configuration to the nginx folder
+
+```shell
+cp /opt/akkoma/installation/nginx/akkoma.nginx /etc/nginx/conf.d/akkoma.conf
+```
+
+#### Edit the nginx config
+```shell
+# Replace example.tld with your (sub)domain (replace $EDITOR with your editor of choice)
+sudo $EDITOR /etc/nginx/conf.d/akkoma.conf
+
+# Verify that the config is valid
+sudo nginx -t
+```
+#### Start nginx
+
+```shell
+sudo systemctl start nginx
+```
+
+At this point if you open your (sub)domain in a browser you should see a 502 error, that's because Akkoma is not started yet.
+
+
+### Setting up a system service
+
+```shell
+# Copy the service into a proper directory
+cp /opt/akkoma/installation/akkoma.service /etc/systemd/system/akkoma.service
+
+# Edit the service file and make any neccesary changes
+sudo $EDITOR /etc/systemd/system/akkoma.service
+
+# If you use SELinux, set the correct file context on the pleroma binary
+sudo semanage fcontext -a -t init_t /opt/akkoma/bin/pleroma
+sudo restorecon -v /opt/akkoma/bin/pleroma
+
+# Start akkoma and enable it on boot
+sudo systemctl start akkoma
+sudo systemctl enable akkoma
+```
+
+If everything worked, you should see a response from Akkoma-BE when visiting your domain. You may need to install frontends like Akkoma-FE and Admin-FE; refer to [this guide](../administration/CLI_tasks/frontend.md) on how to install them.
+
+If that didn't happen, try reviewing the installation steps, starting Akkoma in the foreground and seeing if there are any errrors.
+
+{! support.include !}
+
+## Post installation
+
+### Setting up auto-renew of the Let's Encrypt certificate
+
+```shell
+# Create the directory for webroot challenges
+sudo mkdir -p /var/lib/letsencrypt
+
+# Uncomment the webroot method
+sudo $EDITOR /etc/nginx/conf.d/akkoma.conf
+
+# Verify that the config is valid
+sudo nginx -t
+
+# Restart nginx
+sudo systemctl restart nginx
+
+# Ensure the webroot menthod and post hook is working
+sudo certbot renew --cert-name yourinstance.tld --webroot -w /var/lib/letsencrypt/ --dry-run --post-hook 'systemctl reload nginx'
+
+# Add it to the daily cron
+echo '#!/bin/sh
+certbot renew --cert-name yourinstance.tld --webroot -w /var/lib/letsencrypt/ --post-hook "systemctl reload nginx"
+' > /etc/cron.daily/renew-akkoma-cert
+sudo chmod +x /etc/cron.daily/renew-akkoma-cert
+
+# If everything worked the output should contain /etc/cron.daily/renew-akkoma-cert
+sudo run-parts --test /etc/cron.daily
+```
+
+
+## Create your first user and set as admin
+```shell
+cd /opt/akkoma
+sudo -Hu akkoma ./bin/pleroma_ctl user new joeuser joeuser@sld.tld --admin
+```
+This will create an account withe the username of 'joeuser' with the email address of joeuser@sld.tld, and set that user's account as an admin. This will result in a link that you can paste into the browser, which logs you in and enables you to set the password.
+
+## Further reading
+
+### Caveats of building your own OTP release
+
+There are some things to take note of when your are running your own OTP builds.
+
+#### Updating your OTP builds
+
+Using your custom OTP build, you will not be able to update the installation using the `pleroma_ctl update` command. Running this command would overwrite your install with an OTP release from the main Akkoma repository, which will break your install.
+
+Instead, you will have to rebuild your OTP release every time there are updates, then manually move it to where your Akkoma installation is running, overwriting the old OTP release files. Make sure to stop the Akkoma-BE server before overwriting any files!
+
+After that, run the `pleroma_ctl migrate` command as usual to perform database migrations.
+
+
+#### Cross-compatibility between RedHat distributions
+
+As it currently stands, your OTP build will only be compatible for the specific RedHat distribution you've built it on. Fedora builds only work on Fedora, Centos builds only on Centos, RedHat builds only on RedHat. Secondly, for Fedora, they will also be bound to the specific Fedora release. This is because different releases of Fedora may have significant changes made in some of the required packages and libraries.
+
+
+{! installation/further_reading.include !}
+
+{! support.include !}

docs/docs/installation/otp_vs_from_source_source.include

@@ -1,3 +1,3 @@
-{! backend/installation/otp_vs_from_source.include !}
+{! installation/otp_vs_from_source.include !}
 
 This guide covers a from-source installation. To install using OTP releases, please check out [the OTP guide](./otp_en.md).

docs/installation/debian_based_jp.md

@@ -1,188 +0,0 @@
-# Akkomaの入れ方
-## 日本語訳について
-
-この記事は [Installing on Debian based distributions](Installing on Debian based distributions) の日本語訳です。何かがおかしいと思ったら、原文を見てください。
-
-## インストール
-
-このガイドはDebian Stretchを利用することを想定しています。Ubuntu 16.04や18.04でもおそらく動作します。また、ユーザはrootもしくはsudoにより管理者権限を持っていることを前提とします。もし、以下の操作をrootユーザで行う場合は、 `sudo` を無視してください。ただし、`sudo -Hu akkoma` のようにユーザを指定している場合には `su <username> -s $SHELL -c 'command'` を代わりに使ってください。
-
-### 必要なソフトウェア
-
-- PostgreSQL 9.6以上 (Ubuntu16.04では9.5しか提供されていないので，[](https://www.postgresql.org/download/linux/ubuntu/)こちらから新しいバージョンを入手してください)
-- `postgresql-contrib` 9.6以上 (同上)
-- Elixir 1.8 以上 ([Debianのリポジトリからインストールしないこと！！！ ここからインストールすること！](https://elixir-lang.org/install.html#unix-and-unix-like)。または [asdf](https://github.com/asdf-vm/asdf) をakkomaユーザーでインストールしてください)
-- `erlang-dev`
-- `erlang-nox`
-- `git`
-- `build-essential`
-- `cmake`
-- `libmagic-dev`
-
-#### このガイドで利用している追加パッケージ
-
-- `nginx` (おすすめです。他のリバースプロキシを使う場合は、参考となる設定をこのリポジトリから探してください)
-- `certbot` (または何らかのLet's Encrypt向けACMEクライアント)
-- `ImageMagick`
-- `ffmpeg`
-- `exiftool`
-
-### システムを準備する
-
-* まずシステムをアップデートしてください。
-```
-sudo apt update
-sudo apt full-upgrade
-```
-
-* 上記に挙げたパッケージをインストールしておきます。
-```
-sudo apt install git build-essential postgresql postgresql-contrib cmake ffmpeg imagemagick libmagic-dev
-```
-
-### ElixirとErlangをインストールします
-
-* Erlangのリポジトリをダウンロードおよびインストールします。
-```
-wget -P /tmp/ https://packages.erlang-solutions.com/erlang-solutions_2.0_all.deb
-sudo dpkg -i /tmp/erlang-solutions_2.0_all.deb
-```
-
-* ElixirとErlangをインストールします、
-```
-sudo apt update
-sudo apt install elixir erlang-dev erlang-nox
-```
-
-### オプションパッケージ: [`docs/installation/optional/media_graphics_packages.md`](../installation/optional/media_graphics_packages.md)
-
-```shell
-sudo apt install imagemagick ffmpeg libimage-exiftool-perl
-```
-
-### Akkoma BE (バックエンド) をインストールします
-
-*  Akkoma用に新しいユーザーを作ります。
-
-```
-sudo useradd -r -s /bin/false -m -d /var/lib/akkoma -U akkoma
-```
-
-**注意**: Akkomaユーザとして単発のコマンドを実行したい場合はは、`sudo -Hu akkoma command` を使ってください。シェルを使いたい場合は `sudo -Hu akkoma $SHELL`です。もし `sudo` を使わない場合は、rootユーザで `su -l akkoma -s $SHELL -c 'command'` とすることでコマンドを、`su -l akkoma -s $SHELL` とすることでシェルを開始できます。
-
-*  Gitリポジトリをクローンします。
-```
-sudo mkdir -p /opt/akkoma
-sudo chown -R akkoma:akkoma /opt/akkoma
-sudo -Hu akkoma git clone https://akkoma.dev/AkkomaGang/akkoma.git /opt/akkoma
-```
-
-*  新しいディレクトリに移動します。
-```
-cd /opt/akkoma
-```
-
-* Akkomaが依存するパッケージをインストールします。Hexをインストールしてもよいか聞かれたら、yesを入力してください。
-```
-sudo -Hu akkoma mix deps.get
-```
-
-* コンフィギュレーションを生成します。
-```
-sudo -Hu akkoma MIX_ENV=prod mix pleroma.instance gen
-```
-    * rebar3をインストールしてもよいか聞かれたら、yesを入力してください。
-    * このときにakkomaの一部がコンパイルされるため、この処理には時間がかかります。
-    * あなたのインスタンスについて、いくつかの質問されます。この質問により `config/generated_config.exs` という設定ファイルが生成されます。
-
-
-* コンフィギュレーションを確認して、もし問題なければ、ファイル名を変更してください。
-```
-sudo -Hu akkoma mv config/{generated_config.exs,prod.secret.exs}
-```
-
-* 先程のコマンドで、すでに `config/setup_db.psql` というファイルが作られています。このファイルをもとに、データベースを作成します。
-```
-sudo -Hu akkoma MIX_ENV=prod mix pleroma.instance gen
-```
-
-* そして、データベースのマイグレーションを実行します。
-```
-sudo -Hu akkoma MIX_ENV=prod mix ecto.migrate
-```
-
-* これでAkkomaを起動できるようになりました。
-```
-sudo -Hu akkoma MIX_ENV=prod mix phx.server
-```
-
-### インストールの最終段階
-
-あなたの新しいインスタンスを世界に向けて公開するには、nginx等のWebサーバやプロキシサーバをAkkomaの前段に使用する必要があります。また、Akkoma のためにシステムサービスファイルを作成する必要があります。
-
-#### Nginx
-
-* まだインストールしていないなら、nginxをインストールします。
-```
-sudo apt install nginx
-```
-
-* SSLをセットアップします。他の方法でもよいですが、ここではcertbotを説明します。
-certbotを使うならば、まずそれをインストールします。
-```
-sudo apt install certbot
-```
-そしてセットアップします。
-```
-sudo mkdir -p /var/lib/letsencrypt/
-sudo certbot certonly --email <your@emailaddress> -d <yourdomain> --standalone
-```
-もしうまくいかないときは、nginxが正しく動いていない可能性があります。先にnginxを設定してください。ssl "on" を "off" に変えてから再試行してください。
-
----
-
-* nginxの設定ファイルサンプルをnginxフォルダーにコピーします。
-```
-sudo cp /opt/akkoma/installation/nginx/akkoma.nginx /etc/nginx/sites-available/akkoma.nginx
-sudo ln -s /etc/nginx/sites-available/akkoma.nginx /etc/nginx/sites-enabled/akkoma.nginx
-```
-
-* nginxを起動する前に、設定ファイルを編集してください。例えば、サーバー名、証明書のパスなどを変更する必要があります。
-* nginxを再起動します。
-```
-sudo systemctl enable --now nginx.service
-```
-
-もし証明書を更新する必要が出てきた場合には、nginxの関連するlocationブロックのコメントアウトを外し、以下のコマンドを動かします。
-
-```
-sudo certbot certonly --email <your@emailaddress> -d <yourdomain> --webroot -w /var/lib/letsencrypt/
-```
-
-#### 他のWebサーバやプロキシ
-これに関してはサンプルが `/opt/akkoma/installation/` にあるので、探してみてください。
-
-#### Systemd サービス
-
-* サービスファイルのサンプルをコピーします。
-```
-sudo cp /opt/akkoma/installation/akkoma.service /etc/systemd/system/akkoma.service
-```
-
-* サービスファイルを変更します。すべてのパスが正しいことを確認してください
-* サービスを有効化し `akkoma.service` を開始してください
-```
-sudo systemctl enable --now akkoma.service
-```
-
-#### 初期ユーザの作成
-
-新たにインスタンスを作成したら、以下のコマンドにより管理者権限を持った初期ユーザを作成できます。
-
-```
-sudo -Hu akkoma MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress> --admin
-```
-
-#### その他の設定とカスタマイズ
-
-{! backend/installation/further_reading.include !}

docs/installation/openbsd_fi.md

@@ -1,121 +0,0 @@
-# Akkoman asennus OpenBSD:llä
-
-Tarvitset:
-* Oman domainin
-* OpenBSD 6.3 -serverin
-* Auttavan ymmärryksen unix-järjestelmistä
-
-Komennot, joiden edessä on '#', tulee ajaa käyttäjänä `root`. Tämä on
-suositeltavaa tehdä komennon `doas` avulla, katso `doas (1)` ja `doas.conf (5)`.
-Tästä eteenpäin oletuksena on, että domain "esimerkki.com" osoittaa
-serverin IP-osoitteeseen.
-
-Jos asennuksen kanssa on ongelmia, IRC-kanava #pleroma Libera.chat tai
-Matrix-kanava #pleroma:libera.chat ovat hyviä paikkoja löytää apua
-(englanniksi), `/msg eal kukkuu` jos haluat välttämättä puhua härmää.
-
-Asenna tarvittava ohjelmisto:
-
-`# pkg_add git elixir gmake postgresql-server-10.3 postgresql-contrib-10.3 cmake ffmpeg ImageMagick`
-
-#### Optional software
-
-[`docs/installation/optional/media_graphics_packages.md`](../installation/optional/media_graphics_packages.md):
-  * ImageMagick
-  * ffmpeg
-  * exiftool
-
-Asenna tarvittava ohjelmisto:
-
-`# pkg_add ImageMagick ffmpeg p5-Image-ExifTool`
-
-Luo postgresql-tietokanta:
-
-`# su - _postgresql`
-
-`$ mkdir /var/postgresql/data`
-
-`$ initdb -D /var/postgresql/data -E UTF8`
-
-`$ createdb`
-
-Käynnistä tietokanta ja aseta se käynnistymään automaattisesti.
-
-`# rcctl start postgresql`
-
-`# rcctl enable postgresql`
-
-Luo käyttäjä akkomaa varten (kysyy muutaman kysymyksen):
-
-`# adduser akkoma`
-
-Vaihda akkoma-käyttäjään ja mene kotihakemistoosi:
-
-`# su - akkoma`
-
-Lataa akkoman lähdekoodi:
-
-`$ git clone https://akkoma.dev/AkkomaGang/akkoma.git`
-
-`$ cd akkoma`
-
-Asenna tarvittavat elixir-kirjastot:
-
-`$ mix deps.get`
-
-`$ mix deps.compile`
-
-Luo tarvittava konfiguraatio:
-
-`$ mix generate_config`
-
-`$ cp config/generated_config.exs config/prod.secret.exs`
-
-Aja luodut tietokantakomennot:
-
-`# su _postgres -c 'psql -f config/setup_db.psql'`
-
-`$ MIX_ENV=prod mix ecto.migrate`
-
-Käynnistä akkoma-prosessi:
-
-`$ MIX_ENV=prod mix compile`
-
-`$ MIX_ENV=prod mix phx.server`
-
-Tässä vaiheessa on hyvä tarkistaa että asetukset ovat oikein. Avaa selaimella,
-curlilla tai vastaavalla työkalulla `esimerkki.com:4000/api/v1/instance` ja katso
-että kohta "uri" on "https://esimerkki.com".
-
-Huom! Muista varmistaa että muuttuja MIX_ENV on "prod" mix-komentoja ajaessasi.
-Mix lukee oikean konfiguraatiotiedoston sen mukaisesti.
-
-Ohessa enimmäkseen toimivaksi todettu rc.d-skripti akkoman käynnistämiseen.
-Kirjoita se tiedostoon /etc/rc.d/akkoma. Tämän jälkeen aja
-`# chmod +x /etc/rc.d/akkoma`, ja voit käynnistää akkoman komennolla
-`# /etc/rc.d/akkoma start`.
-
-```
-#!/bin/ksh
-#/etc/rc.d/akkoma
-
-daemon="cd /home/akkoma/akkoma;MIX_ENV=prod /usr/local/bin/elixir"
-daemon_flags="--detached /usr/local/bin/mix phx.server"
-daemon_user="akkoma"
-rc_reload="NO"
-rc_bg="YES"
-
-pexp="beam"
-
-. /etc/rc.d/rc.subr
-
-rc_cmd $1
-```
-
-Tämän jälkeen tarvitset enää HTTP-serverin välittämään kutsut akkoma-prosessille.
-Tiedostosta `install/akkoma.nginx` löytyy esimerkkikonfiguraatio, ja TLS-sertifikaatit
-saat ilmaiseksi esimerkiksi [letsencryptiltä](https://certbot.eff.org/lets-encrypt/opbsd-nginx.html).
-Nginx asentuu yksinkertaisesti komennolla `# pkg_add nginx`.
-
-Kun olet valmis, avaa https://esimerkki.com selaimessasi. Luo käyttäjä ja seuraa kiinnostavia
-tyyppejä muilla palvelimilla!

docs/mkdocs.yml

@@ -0,0 +1,37 @@
+site_name: Akkoma Documentation
+theme:
+  favicon: 'images/akko_badday.png'
+  name: 'material'
+  custom_dir: 'theme'
+  # Disable google fonts
+  font: false
+  logo: 'images/akko_badday.png'
+  features:
+    - tabs
+  palette:
+    primary: 'deep purple'
+    accent: 'blue grey'
+
+extra_css:
+  - css/extra.css
+repo_name: 'AkkomaGang/akkoma'
+repo_url: 'https://akkoma.dev/AkkomaGang/akkoma'
+
+extra:
+  repo_icon: gitea
+
+markdown_extensions:
+  # Note/warning blocks https://squidfunk.github.io/mkdocs-material/extensions/admonition/
+  - admonition
+  - codehilite:
+      guess_lang: false
+  # Make it possible to link to every header https://squidfunk.github.io/mkdocs-material/extensions/permalinks/
+  - toc:
+      permalink: true
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - pymdownx.superfences
+  - pymdownx.tabbed
+  - pymdownx.details
+  - markdown_include.include:
+      base_path: docs

docs/requirements.txt

@@ -0,0 +1,22 @@
+click==8.1.3
+ghp-import==2.1.0
+importlib-metadata==4.12.0
+Jinja2==3.1.2
+Markdown==3.3.7
+markdown-include==0.6.0
+MarkupSafe==2.1.1
+mergedeep==1.3.4
+mkdocs==1.3.0
+mkdocs-bootswatch==1.1
+mkdocs-material==8.1.8
+mkdocs-material-extensions==1.0.3
+packaging==21.3
+Pygments==2.11.2
+pymdown-extensions==9.1
+pyparsing==3.0.9
+python-dateutil==2.8.2
+PyYAML==6.0
+pyyaml_env_tag==0.1
+six==1.16.0
+watchdog==2.1.9
+zipp==3.8.0

docs/theme/partials/source.html

@@ -0,0 +1,64 @@
+<!--
+  Copyright (c) 2016-2019 Martin Donath <martin.donath@squidfunk.com>
+
+  Permission is hereby granted, free of charge, to any person obtaining a copy
+  of this software and associated documentation files (the "Software"), to
+  deal in the Software without restriction, including without limitation the
+  rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+  sell copies of the Software, and to permit persons to whom the Software is
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in
+  all copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+  IN THE SOFTWARE.
+-->
+
+{% import "partials/language.html" as lang with context %}
+
+<!--
+  Check whether the repository is hosted on one of the supported code hosting
+  platforms (GitHub, GitLab or Bitbucket) to show icon.
+-->
+{% set platform = config.extra.repo_icon or config.repo_url %}
+{% if "github" in platform %}
+  {% set repo_type = "github" %}
+{% elif "gitlab" in platform %}
+  {% set repo_type = "gitlab" %}
+{% elif "bitbucket" in platform %}
+  {% set repo_type = "bitbucket" %}
+{% else %}
+  {% set repo_type = "" %}
+{% endif %}
+
+{% if page and page.url.startswith('backend') %}
+  {% set repo_url = "https://git.pleroma.social/pleroma/pleroma" %}
+  {% set repo_name = "pleroma/pleroma" %}
+{% elif page and page.url.startswith('frontend') %}
+  {% set repo_url = "https://git.pleroma.social/pleroma/pleroma-fe" %}
+  {% set repo_name = "pleroma/pleroma-fe" %}
+{% else %}
+  {% set repo_url = config.repo_url %}
+  {% set repo_name = config.repo_name %}
+{% endif %}
+
+<!-- Repository containing source -->
+<a href="{{ repo_url }}" title="{{ lang.t('source.link.title') }}"
+    class="md-source" data-md-source="{{ repo_type }}">
+  {% if repo_type %}
+    <div class="md-source__icon">
+      <svg viewBox="0 0 24 24" width="24" height="24">
+        <use xlink:href="#__{{ repo_type }}" width="24" height="24"></use>
+      </svg>
+    </div>
+  {% endif %}
+  <div class="md-source__repository">
+    {{ repo_name }}
+  </div>
+</a>

installation/apache/akkoma-apache.conf

@@ -8,7 +8,7 @@
 #    'a2ensite akkoma-apache.conf', then restart Apache.
 #
 # Optional: enable disk-based caching for the media proxy
-# For details, see https://docs.akkoma.dev/main/backend/configuration/howto_mediaproxy/
+# For details, see https://docs.akkoma.dev/stable/configuration/howto_mediaproxy/
 #
 # 1. Create a directory as shown below for the CacheRoot and make sure
 #    the Apache user can write to it.

lib/mix/tasks/pleroma/app.ex

@@ -3,7 +3,7 @@
 # SPDX-License-Identifier: AGPL-3.0-only
 
 defmodule Mix.Tasks.Pleroma.App do
-  @moduledoc File.read!("docs/administration/CLI_tasks/oauth_app.md")
+  @moduledoc File.read!("docs/docs/administration/CLI_tasks/oauth_app.md")
   use Mix.Task
 
   import Mix.Pleroma

lib/mix/tasks/pleroma/config.ex

@@ -12,7 +12,7 @@ defmodule Mix.Tasks.Pleroma.Config do
   alias Pleroma.Repo
 
   @shortdoc "Manages the location of the config"
-  @moduledoc File.read!("docs/administration/CLI_tasks/config.md")
+  @moduledoc File.read!("docs/docs/administration/CLI_tasks/config.md")
 
   def run(["migrate_to_db"]) do
     check_configdb(fn ->

lib/mix/tasks/pleroma/database.ex

@@ -18,7 +18,7 @@ defmodule Mix.Tasks.Pleroma.Database do
   use Mix.Task
 
   @shortdoc "A collection of database related tasks"
-  @moduledoc File.read!("docs/administration/CLI_tasks/database.md")
+  @moduledoc File.read!("docs/docs/administration/CLI_tasks/database.md")
 
   def run(["remove_embedded_objects" | args]) do
     {options, [], []} =

lib/mix/tasks/pleroma/digest.ex

@@ -7,7 +7,7 @@ defmodule Mix.Tasks.Pleroma.Digest do
   import Mix.Pleroma
 
   @shortdoc "Manages digest emails"
-  @moduledoc File.read!("docs/administration/CLI_tasks/digest.md")
+  @moduledoc File.read!("docs/docs/administration/CLI_tasks/digest.md")
 
   def run(["test", nickname | opts]) do
     Mix.Pleroma.start_pleroma()

lib/mix/tasks/pleroma/email.ex

@@ -7,7 +7,7 @@ defmodule Mix.Tasks.Pleroma.Email do
   import Mix.Pleroma
 
   @shortdoc "Email administrative tasks"
-  @moduledoc File.read!("docs/administration/CLI_tasks/email.md")
+  @moduledoc File.read!("docs/docs/administration/CLI_tasks/email.md")
 
   def run(["test" | args]) do
     start_pleroma()

lib/mix/tasks/pleroma/emoji.ex

@@ -7,7 +7,7 @@ defmodule Mix.Tasks.Pleroma.Emoji do
   import Mix.Pleroma
 
   @shortdoc "Manages emoji packs"
-  @moduledoc File.read!("docs/administration/CLI_tasks/emoji.md")
+  @moduledoc File.read!("docs/docs/administration/CLI_tasks/emoji.md")
 
   def run(["ls-packs" | args]) do
     start_pleroma()