Merge branch 'develop' into issue/1469

.credo.exs

@@ -25,7 +25,7 @@
       #
       # If you create your own checks, you must specify the source files for
       # them here, so they can be loaded by Credo before running the analysis.
-      requires: ["./test/credo/check/consistency/file_location.ex"],
+      requires: [],
       #
       # Credo automatically checks for updates, like e.g. Hex does.
       # You can disable this behaviour below:
@@ -71,6 +71,7 @@
         # set this value to 0 (zero).
         {Credo.Check.Design.TagTODO, exit_status: 0},
         {Credo.Check.Design.TagFIXME, exit_status: 0},
+
         {Credo.Check.Readability.FunctionNames},
         {Credo.Check.Readability.LargeNumbers},
         {Credo.Check.Readability.MaxLineLength, priority: :low, max_length: 100},
@@ -83,7 +84,6 @@
         # lanodan: I think PreferImplicitTry should be consistency, and the behaviour seems
         # inconsistent, see: https://github.com/rrrene/credo/issues/224
         {Credo.Check.Readability.PreferImplicitTry, false},
-        {Credo.Check.Readability.PipeIntoAnonymousFunctions, exit_status: 0},
         {Credo.Check.Readability.RedundantBlankLines},
         {Credo.Check.Readability.StringSigils},
         {Credo.Check.Readability.TrailingBlankLine},
@@ -91,7 +91,7 @@
         {Credo.Check.Readability.VariableNames},
         {Credo.Check.Readability.Semicolons},
         {Credo.Check.Readability.SpaceAfterCommas},
-        {Credo.Check.Readability.WithSingleClause, exit_status: 0},
+
         {Credo.Check.Refactor.DoubleBooleanNegation},
         {Credo.Check.Refactor.CondStatements},
         {Credo.Check.Refactor.CyclomaticComplexity},
@@ -102,6 +102,7 @@
         {Credo.Check.Refactor.Nesting},
         {Credo.Check.Refactor.PipeChainStart},
         {Credo.Check.Refactor.UnlessWithElse},
+
         {Credo.Check.Warning.BoolOperationOnSameValues},
         {Credo.Check.Warning.IExPry},
         {Credo.Check.Warning.IoInspect},
@@ -130,7 +131,6 @@
 
         # Custom checks can be created using `mix credo.gen.check`.
         #
-        {Credo.Check.Consistency.FileLocation}
       ]
     }
   ]

.formatter.exs

@@ -1,3 +1,3 @@
 [
-  inputs: ["mix.exs", "{config,lib,test}/**/*.{ex,exs}", "priv/repo/migrations/*.exs", "priv/repo/optional_migrations/**/*.exs", "priv/scrubbers/*.ex"]
+  inputs: ["mix.exs", "{config,lib,test}/**/*.{ex,exs}", "priv/repo/migrations/*.exs", "priv/scrubbers/*.ex"]
 ]

.gitattributes

@@ -1,10 +1,2 @@
 *.ex diff=elixir
 *.exs diff=elixir
-
-priv/static/instance/static.css diff=css
-
-# Most of js/css files included in the repo are minified bundles,
-#   and we don't want to search/diff those as text files.
-*.js binary
-*.js.map binary
-*.css binary

.gitignore

@@ -3,10 +3,8 @@
 /db
 /deps
 /*.ez
-/test/instance
 /test/uploads
 /.elixir_ls
-/test/fixtures/DSCN0010_tmp.jpg
 /test/fixtures/test_tmp.txt
 /test/fixtures/image_tmp.jpg
 /test/tmp/
@@ -28,12 +26,9 @@ erl_crash.dump
 # variables.
 /config/*.secret.exs
 /config/generated_config.exs
-/config/runtime.exs
-/config/*.env
-
 
 # Database setup file, some may forget to delete it
-/config/setup_db*.psql
+/config/setup_db.psql
 
 .DS_Store
 .env
@@ -48,14 +43,9 @@ docs/generated_config.md
 # Code test coverage
 /cover
 /Elixir.*.coverdata
-/coverage.xml
 
 .idea
 pleroma.iml
 
 # asdf
 .tool-versions
-
-# Editor temp files
-/*~
-/*#

.gitlab-ci.yml

@@ -1,17 +1,14 @@
-image: git.pleroma.social:5050/pleroma/pleroma/ci-base
+image: elixir:1.8.1
 
 variables: &global_variables
   POSTGRES_DB: pleroma_test
   POSTGRES_USER: postgres
   POSTGRES_PASSWORD: postgres
   DB_HOST: postgres
-  DB_PORT: 5432
   MIX_ENV: test
 
 cache: &global_cache_policy
-  key:
-    files:
-      - mix.lock
+  key: ${CI_COMMIT_REF_SLUG}
   paths:
     - deps
     - _build
@@ -25,113 +22,62 @@ stages:
   - docker
 
 before_script:
-  - echo $MIX_ENV
-  - rm -rf _build/*/lib/pleroma
-  - mix deps.get
-
-after_script:
-  - rm -rf _build/*/lib/pleroma
+  - mix local.hex --force
+  - mix local.rebar --force
 
 build:
   stage: build
-  only:
-    changes: &build_changes_policy
-      - ".gitlab-ci.yml"
-      - "**/*.ex"
-      - "**/*.exs"
-      - "mix.lock"
   script:
+  - mix deps.get
   - mix compile --force
 
-spec-build:
-  stage: test
-  only:
-    changes:
-      - ".gitlab-ci.yml"
-      - "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-alpine
+  - name: postgres:9.6
     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
     - mix pleroma.load_testing
 
 unit-testing:
   stage: test
-  only:
-    changes: *build_changes_policy
   cache: &testing_cache_policy
     <<: *global_cache_policy
     policy: pull
 
   services:
-  - name: postgres:13-alpine
+  - name: postgres:9.6
     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
-    - mix test --cover --preload-modules
-  coverage: '/^Line total: ([^ ]*%)$/'
-  artifacts:
-    reports:
-      coverage_report:
-        coverage_format: cobertura
-        path: coverage.xml
+    - mix coveralls --preload-modules
 
-unit-testing-erratic:
+federated-testing:
   stage: test
-  retry: 2
-  allow_failure: true
-  only:
-    changes: *build_changes_policy
-  cache: &testing_cache_policy
-    <<: *global_cache_policy
-    policy: pull
-
+  cache: *testing_cache_policy
   services:
-  - name: postgres:13-alpine
+  - 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
-    - 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
+    - epmd -daemon
+    - mix test --trace --only federated
 
 unit-testing-rum:
   stage: test
-  only:
-    changes: *build_changes_policy
   cache: *testing_cache_policy
   services:
   - name: minibikini/postgres-with-rum:12
@@ -141,45 +87,25 @@ unit-testing-rum:
     <<: *global_variables
     RUM_ENABLED: "true"
   script:
+    - mix deps.get
     - mix ecto.create
     - mix ecto.migrate
     - "mix ecto.migrate --migrations-path priv/repo/optional_migrations/rum_indexing/"
     - mix test --preload-modules
 
 lint:
-  image: &current_elixir elixir:1.12-alpine
   stage: test
-  only:
-    changes: *build_changes_policy
   cache: *testing_cache_policy
-  before_script: &current_bfr_script
-    - apk update
-    - apk add build-base cmake file-dev git openssl
-    - mix local.hex --force
-    - mix local.rebar --force
-    - mix deps.get
   script:
     - mix format --check-formatted
 
 analysis:
   stage: test
-  only:
-    changes: *build_changes_policy
   cache: *testing_cache_policy
   script:
+    - mix deps.get
     - mix credo --strict --only=warnings,todo,fixme,consistency,readability
 
-cycles:
-  image: *current_elixir
-  stage: test
-  only:
-    changes: *build_changes_policy
-  cache: {}
-  before_script: *current_bfr_script
-  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
@@ -220,20 +146,6 @@ review_app:
     - (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
@@ -254,14 +166,13 @@ stop_review_app:
 
 amd64:
   stage: release
-  image: elixir:1.11.4
+  # TODO: Replace with upstream image when 1.9.0 comes out
+  image: rinpatch/elixir:1.9.0-rc.0
   only: &release-only
   - stable@pleroma/pleroma
   - develop@pleroma/pleroma
   - /^maint/.*$/@pleroma/pleroma
   - /^release/.*$/@pleroma/pleroma
-  tags:
-    - amd64
   artifacts: &release-artifacts
     name: "pleroma-$CI_COMMIT_REF_NAME-$CI_COMMIT_SHORT_SHA-$CI_JOB_NAME"
     paths:
@@ -279,8 +190,7 @@ amd64:
   variables: &release-variables
     MIX_ENV: prod
   before_script: &before-release
-  - apt-get update && apt-get install -y cmake libmagic-dev
-  - echo "import Config" > config/prod.secret.exs
+  - echo "import Mix.Config" > config/prod.secret.exs
   - mix local.hex --force
   - mix local.rebar --force
   script: &release
@@ -294,14 +204,13 @@ amd64-musl:
   stage: release
   artifacts: *release-artifacts
   only: *release-only
-  image: elixir:1.11.4-alpine
-  tags:
-    - amd64
+  # TODO: Replace with upstream image when 1.9.0 comes out
+  image: rinpatch/elixir:1.9.0-rc.0-alpine
   cache: *release-cache
   variables: *release-variables
   before_script: &before-release-musl
-  - apk add git build-base cmake file-dev openssl
-  - echo "import Config" > config/prod.secret.exs
+  - apk add git gcc g++ musl-dev make
+  - echo "import Mix.Config" > config/prod.secret.exs
   - mix local.hex --force
   - mix local.rebar --force
   script: *release
@@ -311,8 +220,9 @@ arm:
   artifacts: *release-artifacts
   only: *release-only
   tags:
-    - arm32-specified
-  image: arm32v7/elixir:1.11.4
+    - arm32
+  # TODO: Replace with upstream image when 1.9.0 comes out
+  image: rinpatch/elixir:1.9.0-rc.0-arm
   cache: *release-cache
   variables: *release-variables
   before_script: *before-release
@@ -323,8 +233,9 @@ arm-musl:
   artifacts: *release-artifacts
   only: *release-only
   tags:
-    - arm32-specified
-  image: arm32v7/elixir:1.11.4-alpine
+    - arm32
+  # TODO: Replace with upstream image when 1.9.0 comes out
+  image: rinpatch/elixir:1.9.0-rc.0-arm-alpine
   cache: *release-cache
   variables: *release-variables
   before_script: *before-release-musl
@@ -336,7 +247,8 @@ arm64:
   only: *release-only
   tags:
     - arm
-  image: arm64v8/elixir:1.11.4
+  # TODO: Replace with upstream image when 1.9.0 comes out
+  image: rinpatch/elixir:1.9.0-rc.0-arm64
   cache: *release-cache
   variables: *release-variables
   before_script: *before-release
@@ -348,7 +260,8 @@ arm64-musl:
   only: *release-only
   tags:
     - arm
-  image: arm64v8/elixir:1.11.4-alpine
+  # TODO: Replace with upstream image when 1.9.0 comes out
+  image: rinpatch/elixir:1.9.0-rc.0-arm64-alpine
   cache: *release-cache
   variables: *release-variables
   before_script: *before-release-musl
@@ -366,8 +279,6 @@ docker:
     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
@@ -375,14 +286,10 @@ docker:
     - 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 .
+    - docker build --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 .
+    - docker push $IMAGE_TAG
+    - docker push $IMAGE_TAG_SLUG
+    - docker push $IMAGE_TAG_LATEST
   tags:
     - dind
   only:
@@ -397,14 +304,10 @@ docker-stable:
   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 .
+    - docker build --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 .
+    - docker push $IMAGE_TAG
+    - docker push $IMAGE_TAG_SLUG
+    - docker push $IMAGE_TAG_LATEST_STABLE
   tags:
     - dind
   only:
@@ -419,39 +322,10 @@ docker-release:
   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 .
+    - docker build --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 .
+    - docker push $IMAGE_TAG
+    - docker push $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

.gitlab/issue_templates/Bug.md

@@ -1,18 +0,0 @@
-<!--
-### Precheck
-
-* For support use https://git.pleroma.social/pleroma/pleroma-support or [community channels](https://git.pleroma.social/pleroma/pleroma#community-channels).
-* Please do a quick search to ensure no similar bug has been reported before. If the bug has not been addressed after 2 weeks, it's fine to bump it.
-* Try to ensure that the bug is actually related to the Pleroma backend. For example, if a bug happens in Pleroma-FE but not in Mastodon-FE or mobile clients, it's likely that the bug should be filed in [Pleroma-FE](https://git.pleroma.social/pleroma/pleroma-fe/issues/new) repository.
--->
-
-### Environment
-
-* Installation type (OTP or From Source):
-* Pleroma version (could be found in the "Version" tab of settings in Pleroma-FE): 
-* Elixir version (`elixir -v` for from source installations, N/A for OTP):
-* Operating system:
-* PostgreSQL version (`psql -V`):
-
-
-### Bug description

.gitlab/merge_request_templates/Release.md

@@ -1,8 +0,0 @@
-### Release checklist
-* [ ] Bump version in `mix.exs`
-* [ ] Compile a changelog
-* [ ] Create an MR with an announcement to pleroma.social
-#### post-merge
-* [ ] Tag the release on the merge commit
-* [ ] Make the tag into a Gitlab Release™
-* [ ] Merge `stable` into `develop` (in case the fixes are already in develop, use `git merge -s ours --no-commit` and manually merge the changelogs)

.mailmap

@@ -1,3 +1,2 @@
 Ariadne Conill <ariadne@dereferenced.org> <nenolod@dereferenced.org>
 Ariadne Conill <ariadne@dereferenced.org> <nenolod@gmail.com>
-rinpatch <rin@patch.cx> <rinpatch@sdf.org>

CC-BY-4.0

@@ -1,395 +0,0 @@
-Attribution 4.0 International
-
-=======================================================================
-
-Creative Commons Corporation ("Creative Commons") is not a law firm and
-does not provide legal services or legal advice. Distribution of
-Creative Commons public licenses does not create a lawyer-client or
-other relationship. Creative Commons makes its licenses and related
-information available on an "as-is" basis. Creative Commons gives no
-warranties regarding its licenses, any material licensed under their
-terms and conditions, or any related information. Creative Commons
-disclaims all liability for damages resulting from their use to the
-fullest extent possible.
-
-Using Creative Commons Public Licenses
-
-Creative Commons public licenses provide a standard set of terms and
-conditions that creators and other rights holders may use to share
-original works of authorship and other material subject to copyright
-and certain other rights specified in the public license below. The
-following considerations are for informational purposes only, are not
-exhaustive, and do not form part of our licenses.
-
-     Considerations for licensors: Our public licenses are
-     intended for use by those authorized to give the public
-     permission to use material in ways otherwise restricted by
-     copyright and certain other rights. Our licenses are
-     irrevocable. Licensors should read and understand the terms
-     and conditions of the license they choose before applying it.
-     Licensors should also secure all rights necessary before
-     applying our licenses so that the public can reuse the
-     material as expected. Licensors should clearly mark any
-     material not subject to the license. This includes other CC-
-     licensed material, or material used under an exception or
-     limitation to copyright. More considerations for licensors:
-    wiki.creativecommons.org/Considerations_for_licensors
-
-     Considerations for the public: By using one of our public
-     licenses, a licensor grants the public permission to use the
-     licensed material under specified terms and conditions. If
-     the licensor's permission is not necessary for any reason--for
-     example, because of any applicable exception or limitation to
-     copyright--then that use is not regulated by the license. Our
-     licenses grant only permissions under copyright and certain
-     other rights that a licensor has authority to grant. Use of
-     the licensed material may still be restricted for other
-     reasons, including because others have copyright or other
-     rights in the material. A licensor may make special requests,
-     such as asking that all changes be marked or described.
-     Although not required by our licenses, you are encouraged to
-     respect those requests where reasonable. More considerations
-     for the public:
-    wiki.creativecommons.org/Considerations_for_licensees
-
-=======================================================================
-
-Creative Commons Attribution 4.0 International Public License
-
-By exercising the Licensed Rights (defined below), You accept and agree
-to be bound by the terms and conditions of this Creative Commons
-Attribution 4.0 International Public License ("Public License"). To the
-extent this Public License may be interpreted as a contract, You are
-granted the Licensed Rights in consideration of Your acceptance of
-these terms and conditions, and the Licensor grants You such rights in
-consideration of benefits the Licensor receives from making the
-Licensed Material available under these terms and conditions.
-
-
-Section 1 -- Definitions.
-
-  a. Adapted Material means material subject to Copyright and Similar
-     Rights that is derived from or based upon the Licensed Material
-     and in which the Licensed Material is translated, altered,
-     arranged, transformed, or otherwise modified in a manner requiring
-     permission under the Copyright and Similar Rights held by the
-     Licensor. For purposes of this Public License, where the Licensed
-     Material is a musical work, performance, or sound recording,
-     Adapted Material is always produced where the Licensed Material is
-     synched in timed relation with a moving image.
-
-  b. Adapter's License means the license You apply to Your Copyright
-     and Similar Rights in Your contributions to Adapted Material in
-     accordance with the terms and conditions of this Public License.
-
-  c. Copyright and Similar Rights means copyright and/or similar rights
-     closely related to copyright including, without limitation,
-     performance, broadcast, sound recording, and Sui Generis Database
-     Rights, without regard to how the rights are labeled or
-     categorized. For purposes of this Public License, the rights
-     specified in Section 2(b)(1)-(2) are not Copyright and Similar
-     Rights.
-
-  d. Effective Technological Measures means those measures that, in the
-     absence of proper authority, may not be circumvented under laws
-     fulfilling obligations under Article 11 of the WIPO Copyright
-     Treaty adopted on December 20, 1996, and/or similar international
-     agreements.
-
-  e. Exceptions and Limitations means fair use, fair dealing, and/or
-     any other exception or limitation to Copyright and Similar Rights
-     that applies to Your use of the Licensed Material.
-
-  f. Licensed Material means the artistic or literary work, database,
-     or other material to which the Licensor applied this Public
-     License.
-
-  g. Licensed Rights means the rights granted to You subject to the
-     terms and conditions of this Public License, which are limited to
-     all Copyright and Similar Rights that apply to Your use of the
-     Licensed Material and that the Licensor has authority to license.
-
-  h. Licensor means the individual(s) or entity(ies) granting rights
-     under this Public License.
-
-  i. Share means to provide material to the public by any means or
-     process that requires permission under the Licensed Rights, such
-     as reproduction, public display, public performance, distribution,
-     dissemination, communication, or importation, and to make material
-     available to the public including in ways that members of the
-     public may access the material from a place and at a time
-     individually chosen by them.
-
-  j. Sui Generis Database Rights means rights other than copyright
-     resulting from Directive 96/9/EC of the European Parliament and of
-     the Council of 11 March 1996 on the legal protection of databases,
-     as amended and/or succeeded, as well as other essentially
-     equivalent rights anywhere in the world.
-
-  k. You means the individual or entity exercising the Licensed Rights
-     under this Public License. Your has a corresponding meaning.
-
-
-Section 2 -- Scope.
-
-  a. License grant.
-
-       1. Subject to the terms and conditions of this Public License,
-          the Licensor hereby grants You a worldwide, royalty-free,
-          non-sublicensable, non-exclusive, irrevocable license to
-          exercise the Licensed Rights in the Licensed Material to:
-
-            a. reproduce and Share the Licensed Material, in whole or
-               in part; and
-
-            b. produce, reproduce, and Share Adapted Material.
-
-       2. Exceptions and Limitations. For the avoidance of doubt, where
-          Exceptions and Limitations apply to Your use, this Public
-          License does not apply, and You do not need to comply with
-          its terms and conditions.
-
-       3. Term. The term of this Public License is specified in Section
-          6(a).
-
-       4. Media and formats; technical modifications allowed. The
-          Licensor authorizes You to exercise the Licensed Rights in
-          all media and formats whether now known or hereafter created,
-          and to make technical modifications necessary to do so. The
-          Licensor waives and/or agrees not to assert any right or
-          authority to forbid You from making technical modifications
-          necessary to exercise the Licensed Rights, including
-          technical modifications necessary to circumvent Effective
-          Technological Measures. For purposes of this Public License,
-          simply making modifications authorized by this Section 2(a)
-          (4) never produces Adapted Material.
-
-       5. Downstream recipients.
-
-            a. Offer from the Licensor -- Licensed Material. Every
-               recipient of the Licensed Material automatically
-               receives an offer from the Licensor to exercise the
-               Licensed Rights under the terms and conditions of this
-               Public License.
-
-            b. No downstream restrictions. You may not offer or impose
-               any additional or different terms or conditions on, or
-               apply any Effective Technological Measures to, the
-               Licensed Material if doing so restricts exercise of the
-               Licensed Rights by any recipient of the Licensed
-               Material.
-
-       6. No endorsement. Nothing in this Public License constitutes or
-          may be construed as permission to assert or imply that You
-          are, or that Your use of the Licensed Material is, connected
-          with, or sponsored, endorsed, or granted official status by,
-          the Licensor or others designated to receive attribution as
-          provided in Section 3(a)(1)(A)(i).
-
-  b. Other rights.
-
-       1. Moral rights, such as the right of integrity, are not
-          licensed under this Public License, nor are publicity,
-          privacy, and/or other similar personality rights; however, to
-          the extent possible, the Licensor waives and/or agrees not to
-          assert any such rights held by the Licensor to the limited
-          extent necessary to allow You to exercise the Licensed
-          Rights, but not otherwise.
-
-       2. Patent and trademark rights are not licensed under this
-          Public License.
-
-       3. To the extent possible, the Licensor waives any right to
-          collect royalties from You for the exercise of the Licensed
-          Rights, whether directly or through a collecting society
-          under any voluntary or waivable statutory or compulsory
-          licensing scheme. In all other cases the Licensor expressly
-          reserves any right to collect such royalties.
-
-
-Section 3 -- License Conditions.
-
-Your exercise of the Licensed Rights is expressly made subject to the
-following conditions.
-
-  a. Attribution.
-
-       1. If You Share the Licensed Material (including in modified
-          form), You must:
-
-            a. retain the following if it is supplied by the Licensor
-               with the Licensed Material:
-
-                 i. identification of the creator(s) of the Licensed
-                    Material and any others designated to receive
-                    attribution, in any reasonable manner requested by
-                    the Licensor (including by pseudonym if
-                    designated);
-
-                ii. a copyright notice;
-
-               iii. a notice that refers to this Public License;
-
-                iv. a notice that refers to the disclaimer of
-                    warranties;
-
-                 v. a URI or hyperlink to the Licensed Material to the
-                    extent reasonably practicable;
-
-            b. indicate if You modified the Licensed Material and
-               retain an indication of any previous modifications; and
-
-            c. indicate the Licensed Material is licensed under this
-               Public License, and include the text of, or the URI or
-               hyperlink to, this Public License.
-
-       2. You may satisfy the conditions in Section 3(a)(1) in any
-          reasonable manner based on the medium, means, and context in
-          which You Share the Licensed Material. For example, it may be
-          reasonable to satisfy the conditions by providing a URI or
-          hyperlink to a resource that includes the required
-          information.
-
-       3. If requested by the Licensor, You must remove any of the
-          information required by Section 3(a)(1)(A) to the extent
-          reasonably practicable.
-
-       4. If You Share Adapted Material You produce, the Adapter's
-          License You apply must not prevent recipients of the Adapted
-          Material from complying with this Public License.
-
-
-Section 4 -- Sui Generis Database Rights.
-
-Where the Licensed Rights include Sui Generis Database Rights that
-apply to Your use of the Licensed Material:
-
-  a. for the avoidance of doubt, Section 2(a)(1) grants You the right
-     to extract, reuse, reproduce, and Share all or a substantial
-     portion of the contents of the database;
-
-  b. if You include all or a substantial portion of the database
-     contents in a database in which You have Sui Generis Database
-     Rights, then the database in which You have Sui Generis Database
-     Rights (but not its individual contents) is Adapted Material; and
-
-  c. You must comply with the conditions in Section 3(a) if You Share
-     all or a substantial portion of the contents of the database.
-
-For the avoidance of doubt, this Section 4 supplements and does not
-replace Your obligations under this Public License where the Licensed
-Rights include other Copyright and Similar Rights.
-
-
-Section 5 -- Disclaimer of Warranties and Limitation of Liability.
-
-  a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
-     EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
-     AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
-     ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
-     IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
-     WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
-     PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
-     ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
-     KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
-     ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.
-
-  b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
-     TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
-     NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
-     INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
-     COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
-     USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
-     ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
-     DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
-     IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.
-
-  c. The disclaimer of warranties and limitation of liability provided
-     above shall be interpreted in a manner that, to the extent
-     possible, most closely approximates an absolute disclaimer and
-     waiver of all liability.
-
-
-Section 6 -- Term and Termination.
-
-  a. This Public License applies for the term of the Copyright and
-     Similar Rights licensed here. However, if You fail to comply with
-     this Public License, then Your rights under this Public License
-     terminate automatically.
-
-  b. Where Your right to use the Licensed Material has terminated under
-     Section 6(a), it reinstates:
-
-       1. automatically as of the date the violation is cured, provided
-          it is cured within 30 days of Your discovery of the
-          violation; or
-
-       2. upon express reinstatement by the Licensor.
-
-     For the avoidance of doubt, this Section 6(b) does not affect any
-     right the Licensor may have to seek remedies for Your violations
-     of this Public License.
-
-  c. For the avoidance of doubt, the Licensor may also offer the
-     Licensed Material under separate terms or conditions or stop
-     distributing the Licensed Material at any time; however, doing so
-     will not terminate this Public License.
-
-  d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
-     License.
-
-
-Section 7 -- Other Terms and Conditions.
-
-  a. The Licensor shall not be bound by any additional or different
-     terms or conditions communicated by You unless expressly agreed.
-
-  b. Any arrangements, understandings, or agreements regarding the
-     Licensed Material not stated herein are separate from and
-     independent of the terms and conditions of this Public License.
-
-
-Section 8 -- Interpretation.
-
-  a. For the avoidance of doubt, this Public License does not, and
-     shall not be interpreted to, reduce, limit, restrict, or impose
-     conditions on any use of the Licensed Material that could lawfully
-     be made without permission under this Public License.
-
-  b. To the extent possible, if any provision of this Public License is
-     deemed unenforceable, it shall be automatically reformed to the
-     minimum extent necessary to make it enforceable. If the provision
-     cannot be reformed, it shall be severed from this Public License
-     without affecting the enforceability of the remaining terms and
-     conditions.
-
-  c. No term or condition of this Public License will be waived and no
-     failure to comply consented to unless expressly agreed to by the
-     Licensor.
-
-  d. Nothing in this Public License constitutes or may be interpreted
-     as a limitation upon, or waiver of, any privileges and immunities
-     that apply to the Licensor or You, including from the legal
-     processes of any jurisdiction or authority.
-
-
-=======================================================================
-
-Creative Commons is not a party to its public
-licenses. Notwithstanding, Creative Commons may elect to apply one of
-its public licenses to material it publishes and in those instances
-will be considered the “Licensor.” The text of the Creative Commons
-public licenses is dedicated to the public domain under the CC0 Public
-Domain Dedication. Except for the limited purpose of indicating that
-material is shared under a Creative Commons public license or as
-otherwise permitted by the Creative Commons policies published at
-creativecommons.org/policies, Creative Commons does not authorize the
-use of the trademark "Creative Commons" or any other trademark or logo
-of Creative Commons without its prior written consent including,
-without limitation, in connection with any unauthorized modifications
-to any of its public licenses or any other arrangements,
-understandings, or agreements concerning use of licensed material. For
-the avoidance of doubt, this paragraph does not form part of the
-public licenses.
-
-Creative Commons may be contacted at creativecommons.org.

CHANGELOG.md

@@ -1,702 +1,11 @@
 # Changelog
-
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
-## Unreleased
-
-### Changed
-
-### Added
-
-### Fixed
-
-### Removed
-
-## 2.5.0 - 2022-12-23
-
-### Removed
-
-- MastoFE
-- Quack, the logging backend that pushes to Slack channels
-
-### Changed
-- **Breaking:** Elixir >=1.11 is now required (was >= 1.9)
-- Allow users to remove their emails if instance does not need email to register
-- Uploadfilter `Pleroma.Upload.Filter.Exiftool` has been renamed to `Pleroma.Upload.Filter.Exiftool.StripLocation`
-- **Breaking**: `/api/v1/pleroma/backups` endpoints now requires `read:backups` scope instead of `read:accounts`
-- Updated the recommended pleroma.vcl configuration for Varnish to target Varnish 7.0+
-- Set timeout values for Oban queues. The default is infinity and some operations may not time out on their own.
-- Delete activities are federated at lowest priority
-- CSP now includes wasm-unsafe-eval
-
-### Added
-- `activeMonth` and `activeHalfyear` fields in NodeInfo usage.users object
-- Experimental support for Finch. Put `config :tesla, :adapter, {Tesla.Adapter.Finch, name: MyFinch}` in your secrets file to use it. Reverse Proxy will still use Hackney.
-- `ForceMentionsInPostContent` MRF policy
-- PleromaAPI: Add remote follow API endpoint at `POST /api/v1/pleroma/remote_interaction`
-- MastoAPI: Add `GET /api/v1/accounts/lookup`
-- MastoAPI: Profile Directory support
-- MastoAPI: Support v2 Suggestions (handpicked accounts only)
-- Ability to log slow Ecto queries by configuring `:pleroma, :telemetry, :slow_queries_logging`
-- Added Phoenix LiveDashboard at `/phoenix/live_dashboard`
-- Added `/manifest.json` for progressive web apps.
-- MastoAPI: Support for `birthday` and `show_birthday` field in `/api/v1/accounts/update_credentials`.
-- Configuration: Add `birthday_required` and `birthday_min_age` settings to provide a way to require users to enter their birth date.
-- PleromaAPI: Add `GET /api/v1/pleroma/birthdays` API endpoint
-- Make backend-rendered pages translatable. This includes emails. Pages returned as a HTTP response are translated using the language specified in the `userLanguage` cookie, or the `Accept-Language` header. Emails are translated using the `language` field when registering. This language can be changed by `PATCH /api/v1/accounts/update_credentials` with the `language` field.
-- Add fine grained options to provide privileges to moderators and admins (e.g. delete messages, manage reports...)
-- Uploadfilter `Pleroma.Upload.Filter.Exiftool.ReadDescription` returns description values to the FE so they can pre fill the image description field
-- Added move account API
-- Enable remote users to interact with posts
-- Possibility to discover users like `user@example.org`, while Pleroma is working on `pleroma.example.org`. Additional configuration required.
-
-### Fixed
-- Subscription(Bell) Notifications: Don't create from Pipeline Ingested replies
-- Handle Reject for already-accepted Follows properly
-- Display OpenGraph data on alternative notice routes.
-- Fix replies count for remote replies
-- Fixed hashtags disappearing from the end of lines when Markdown is enabled
-- ChatAPI: Add link headers
-- Limited number of search results to 40 to prevent DoS attacks
-- ActivityPub: fixed federation of attachment dimensions
-- Fixed benchmarks
-- Elixir 1.13 support
-- Fixed crash when pinned_objects is nil
-- Fixed slow timelines when there are a lot of deactivated users
-- Fixed account deletion API
-- Fixed lowercase HTTP HEAD method in the Media Proxy Preview code
-- Removed useless notification call on Delete activities
-- Improved performance for filtering out deactivated and invisible users
-- RSS and Atom feeds for users work again
-- TwitterCard meta tags conformance
-
-## 2.4.5 - 2022-11-27
-
-## Fixed
-- Image `class` attributes not being scrubbed, allowing to exploit frontend special classes [!3792](https://git.pleroma.social/pleroma/pleroma/-/merge_requests/3792)
-- Delete report notifs when demoting from superuser [!3642](https://git.pleroma.social/pleroma/pleroma/-/merge_requests/3642)
-- Validate `mediaType` only by it's format rather than using a list [!3597](https://git.pleroma.social/pleroma/pleroma/-/merge_requests/3597)
-- Pagination: Make mutes and blocks lists behave the same as other lists [!3693](https://git.pleroma.social/pleroma/pleroma/-/merge_requests/3693)
-- Compatibility with Elixir 1.14 [!3740](https://git.pleroma.social/pleroma/pleroma/-/merge_requests/3740)
-- Frontend installer: FediFE build URL [!3736](https://git.pleroma.social/pleroma/pleroma/-/merge_requests/3736)
-- Streaming: Don't stream ChatMessage into the home timeline [!3738](https://git.pleroma.social/pleroma/pleroma/-/merge_requests/3738)
-- Streaming: Stream local-only posts in the local timeline [!3738](https://git.pleroma.social/pleroma/pleroma/-/merge_requests/3738)
-- Signatures: Fix `keyId` lookup for GoToSocial [!3725](https://git.pleroma.social/pleroma/pleroma/-/merge_requests/3725)
-- Validator: Fix `replies` handling for GoToSocial [!3725](https://git.pleroma.social/pleroma/pleroma/-/merge_requests/3725)
-
-## 2.4.4 - 2022-08-19
-
+## [Unreleased]
 ### Security
-- Streaming API sessions will now properly disconnect if the corresponding token is revoked
-
-## 2.4.3 - 2022-05-06
-
-### Security
-- Private `/objects/` and `/activities/` leaking if cached by authenticated user
-- SweetXML library DTD bomb
-
-## 2.4.2 - 2022-01-10
-
-### Fixed
-- Federation issues caused by HTTP pool checkout timeouts
-- Compatibility with Elixir 1.13
-
-### Upgrade notes
-
-1. Restart Pleroma
-
-## 2.4.1 - 2021-08-29
-
-### Changed
-- Make `mix pleroma.database set_text_search_config` run concurrently and indefinitely
-
-### Added
-- AdminAPI: Missing configuration description for StealEmojiPolicy
-
-### Fixed
-- MastodonAPI: Stream out Create activities
-- MRF ObjectAgePolicy: Fix pattern matching on "published"
-- TwitterAPI: Make `change_password` and `change_email` require params on body instead of query
-- Subscription(Bell) Notifications: Don't create from Pipeline Ingested replies
-- AdminAPI: Fix rendering reports containing a `nil` object
-- Mastodon API: Activity Search fallbacks on status fetching after a DB Timeout/Error
-- Mastodon API: Fix crash in Streamer related to reblogging
-- AdminAPI: List available frontends when `static/frontends` folder is missing
-- Make activity search properly use language-aware GIN indexes
-- AdminAPI: Fix suggestions for MRF Policies
-
-## 2.4.0 - 2021-08-08
-
-### Changed
-
-- **Breaking:** Configuration: `:chat, enabled` moved to `:shout, enabled` and `:instance, chat_limit` moved to `:shout, limit`
-- **Breaking** Entries for simple_policy, transparency_exclusions and quarantined_instances now list both the instance and a reason.
-- Support for Erlang/OTP 24
-- The `application` metadata returned with statuses is no longer hardcoded. Apps that want to display these details will now have valid data for new posts after this change.
-- HTTPSecurityPlug now sends a response header to opt out of Google's FLoC (Federated Learning of Cohorts) targeted advertising.
-- Email address is now returned if requesting user is the owner of the user account so it can be exposed in client and FE user settings UIs.
-- Improved Twittercard and OpenGraph meta tag generation including thumbnails and image dimension metadata when available.
-- AdminAPI: sort users so the newest are at the top.
-- ActivityPub Client-to-Server(C2S): Limitation on the type of Activity/Object are lifted as they are now passed through ObjectValidators
-- MRF (`AntiFollowbotPolicy`): Bot accounts are now also considered followbots. Users can still allow bots to follow them by first following the bot.
-
-### Added
-
-- MRF (`FollowBotPolicy`): New MRF Policy which makes a designated local Bot account attempt to follow all users in public Notes received by your instance. Users who require approving follower requests or have #nobot in their profile are excluded.
-- Return OAuth token `id` (primary key) in POST `/oauth/token`.
-- AdminAPI: return `created_at` date with users.
-- AdminAPI: add DELETE `/api/v1/pleroma/admin/instances/:instance` to delete all content from a remote instance.
-- `AnalyzeMetadata` upload filter for extracting image/video attachment dimensions and generating blurhashes for images. Blurhashes for videos are not generated at this time.
-- Attachment dimensions and blurhashes are federated when available.
-- Mastodon API: support `poll` notification.
-- Pinned posts federation
-
-### Fixed
-- Don't crash so hard when email settings are invalid.
-- Checking activated Upload Filters for required commands.
-- Remote users can no longer reappear after being deleted.
-- Deactivated users may now be deleted.
-- Deleting an activity with a lot of likes/boosts no longer causes a database timeout.
-- Mix task `pleroma.database prune_objects`
-- Fixed rendering of JSON errors on ActivityPub endpoints.
-- Linkify: Parsing crash with URLs ending in unbalanced closed paren, no path separator, and no query parameters
-- Try to save exported ConfigDB settings (migrate_from_db) in the system temp directory if default location is not writable.
-- Uploading custom instance thumbnail via AdminAPI/AdminFE generated invalid URL to the image
-- Applying ConcurrentLimiter settings via AdminAPI
-- User login failures if their `notification_settings` were in a NULL state.
-- Mix task `pleroma.user delete_activities` query transaction timeout is now :infinity
-- MRF (`SimplePolicy`): Embedded objects are now checked. If any embedded object would be rejected, its parent is rejected. This fixes Announces leaking posts from blocked domains.
-- Fixed some Markdown issues, including trailing slash in links.
-
-### Removed
-- **Breaking**: Remove deprecated `/api/qvitter/statuses/notifications/read` (replaced by `/api/v1/pleroma/notifications/read`)
-
-## [2.3.0] - 2021-03-01
-
-### Security
-
-- Fixed client user agent leaking through MediaProxy
-
-### Removed
-
-- `:auth, :enforce_oauth_admin_scope_usage` configuration option.
-
-### Changed
-
-- **Breaking**: Changed `mix pleroma.user toggle_confirmed` to `mix pleroma.user confirm`
-- **Breaking**: Changed `mix pleroma.user toggle_activated` to `mix pleroma.user activate/deactivate`
-- **Breaking:** NSFW hashtag is no longer added on sensitive posts
-- Polls now always return a `voters_count`, even if they are single-choice.
-- Admin Emails: The ap id is used as the user link in emails now.
-- Improved registration workflow for email confirmation and account approval modes.
-- Search: When using Postgres 11+, Pleroma will use the `websearch_to_tsvector` function to parse search queries.
-- Emoji: Support the full Unicode 13.1 set of Emoji for reactions, plus regional indicators.
-- Deprecated `Pleroma.Uploaders.S3, :public_endpoint`. Now `Pleroma.Upload, :base_url` is the standard configuration key for all uploaders.
-- Improved Apache webserver support: updated sample configuration, MediaProxy cache invalidation verified with the included sample script
-- Improve OAuth 2.0 provider support. A missing `fqn` field was added to the response, but does not expose the user's email address.
-- Provide redirect of external posts from `/notice/:id` to their original URL
-- Admins no longer receive notifications for reports if they are the actor making the report.
-- Improved Mailer configuration setting descriptions for AdminFE.
-- Updated default avatar to look nicer.
-
-<details>
-  <summary>API Changes</summary>
-
-- **Breaking:** AdminAPI changed User field `confirmation_pending` to `is_confirmed`
-- **Breaking:** AdminAPI changed User field `approval_pending` to `is_approved`
-- **Breaking**: AdminAPI changed User field `deactivated` to `is_active`
-- **Breaking:** AdminAPI `GET /api/pleroma/admin/users/:nickname_or_id/statuses` changed response format and added the number of total users posts.
-- **Breaking:** AdminAPI `GET /api/pleroma/admin/instances/:instance/statuses` changed response format and added the number of total users posts.
-- Admin API: Reports now ordered by newest
-- Pleroma API: `GET /api/v1/pleroma/chats` is deprecated in favor of `GET /api/v2/pleroma/chats`.
-- Pleroma API: Reroute `/api/pleroma/*` to `/api/v1/pleroma/*`
-
-</details>
-- Improved hashtag timeline performance (requires a background migration).
-
-### Added
-
-- Reports now generate notifications for admins and mods.
-- Support for local-only statuses.
-- Support pagination of blocks and mutes.
-- Account backup.
-- Configuration: Add `:instance, autofollowing_nicknames` setting to provide a way to make accounts automatically follow new users that register on the local Pleroma instance.
-- `[:activitypub, :blockers_visible]` config to control visibility of blockers.
-- Ability to view remote timelines, with ex. `/api/v1/timelines/public?instance=lain.com` and streams `public:remote` and `public:remote:media`.
-- The site title is now injected as a `title` tag like preloads or metadata.
-- Password reset tokens now are not accepted after a certain age.
-- Mix tasks to help with displaying and removing ConfigDB entries. See `mix pleroma.config`.
-- OAuth form improvements: users are remembered by their cookie, the CSS is overridable by the admin, and the style has been improved.
-- OAuth improvements and fixes: more secure session-based authentication (by token that could be revoked anytime), ability to revoke belonging OAuth token from any client etc.
-- Ability to set ActivityPub aliases for follower migration.
-- Configurable background job limits for RichMedia (link previews) and MediaProxyWarmingPolicy
-- Ability to define custom HTTP headers per each frontend
-- MRF (`NoEmptyPolicy`): New MRF Policy which will deny empty statuses or statuses of only mentions from being created by local users
-- New users will receive a simple email confirming their registration if no other emails will be dispatched. (e.g., Welcome, Confirmation, or Approval Required)
-
-<details>
-  <summary>API Changes</summary>
-- Admin API: (`GET /api/pleroma/admin/users`) filter users by `unconfirmed` status and `actor_type`.
-- Admin API: OpenAPI spec for the user-related operations
-- Pleroma API: `GET /api/v2/pleroma/chats` added. It is exactly like `GET /api/v1/pleroma/chats` except supports pagination.
-- Pleroma API: Add `idempotency_key` to the chat message entity that can be used for optimistic message sending.
-- Pleroma API: (`GET /api/v1/pleroma/federation_status`) Add a way to get a list of unreachable instances.
-- Mastodon API: User and conversation mutes can now auto-expire if `expires_in` parameter was given while adding the mute.
-- Admin API: An endpoint to manage frontends.
-- Streaming API: Add follow relationships updates.
-- WebPush: Introduce `pleroma:chat_mention` and `pleroma:emoji_reaction` notification types.
-- Mastodon API: Add monthly active users to `/api/v1/instance` (`pleroma.stats.mau`).
-- Mastodon API: Home, public, hashtag & list timelines accept `only_media`, `remote` & `local` parameters for filtration.
-- Mastodon API: `/api/v1/accounts/:id` & `/api/v1/mutes` endpoints accept `with_relationships` parameter and return filled `pleroma.relationship` field.
-- Mastodon API: Endpoint to remove a conversation (`DELETE /api/v1/conversations/:id`).
-- Mastodon API: `expires_in` in the scheduled post `params` field on `/api/v1/statuses` and `/api/v1/scheduled_statuses/:id` endpoints.
-</details>
-
-### Fixed
-
-- Users with `is_discoverable` field set to false (default value) will appear in in-service search results but be hidden from external services (search bots etc.).
-- Streaming API: Posts and notifications are not dropped, when CLI task is executing.
-- Creating incorrect IPv4 address-style HTTP links when encountering certain numbers.
-- Reblog API Endpoint: Do not set visibility parameter to public by default and let CommonAPI to infer it from status, so a user can reblog their private status without explicitly setting reblog visibility to private.
-- Tag URLs in statuses are now absolute
-- Removed duplicate jobs to purge expired activities
-- File extensions of some attachments were incorrectly changed. This feature has been disabled for now.
-- Mix task pleroma.instance creates missing parent directories if the configuration or SQL output paths are changed.
-
-<details>
-  <summary>API Changes</summary>
-  - Mastodon API: Current user is now included in conversation if it's the only participant.
-  - Mastodon API: Fixed last_status.account being not filled with account data.
-  - Mastodon API: Fix not being able to add or remove multiple users at once in lists.
-  - Mastodon API: Fixed own_votes being not returned with poll data.
-  - Mastodon API: Fixed creation of scheduled posts with polls.
-  - Mastodon API: Support for expires_in/expires_at in the Filters.
-</details>
-
-## [2.2.2] - 2021-01-18
-
-### Fixed
-
-- StealEmojiPolicy creates dir for emojis, if it doesn't exist.
-- Updated `elixir_make` to a non-retired version
-
-### Upgrade notes
-
-1. Restart Pleroma
-
-## [2.2.1] - 2020-12-22
-
-### Changed
-- Updated Pleroma FE
-
-### Fixed
-
-- Config generation: rename `Pleroma.Upload.Filter.ExifTool` to `Pleroma.Upload.Filter.Exiftool`.
-- S3 Uploads with Elixir 1.11.
-- Mix task pleroma.user delete_activities for source installations.
-- Search: RUM index search speed has been fixed.
-- Rich Media Previews sometimes showed the wrong preview due to a bug following redirects.
-- Fixes for the autolinker.
-- Forwarded reports duplication from Pleroma instances.
-- Emoji Reaction activity filtering from blocked and muted accounts.
-
-- <details>
-    <summary>API</summary>
-  - Statuses were not displayed for Mastodon forwarded reports.
-  </details>
-
-### Upgrade notes
-
-1. Restart Pleroma
-
-## [2.2.0] - 2020-11-12
-
-### Security
-
-- Fixed the possibility of using file uploads to spoof posts.
-
-### Changed
-
-- **Breaking** Requires `libmagic` (or `file`) to guess file types.
-- **Breaking:** App metrics endpoint (`/api/pleroma/app_metrics`) is disabled by default, check `docs/API/prometheus.md` on enabling and configuring.
-- **Breaking:** Pleroma Admin API: emoji packs and files routes changed.
-- **Breaking:** Sensitive/NSFW statuses no longer disable link previews.
-- Search: Users are now findable by their urls.
-- Renamed `:await_up_timeout` in `:connections_pool` namespace to `:connect_timeout`, old name is deprecated.
-- Renamed `:timeout` in `pools` namespace to `:recv_timeout`, old name is deprecated.
-- The `discoverable` field in the `User` struct will now add a NOINDEX metatag to profile pages when false.
-- Users with the `is_discoverable` field set to false will not show up in searches ([bug](https://git.pleroma.social/pleroma/pleroma/-/issues/2301)).
-- Minimum lifetime for ephmeral activities changed to 10 minutes and made configurable (`:min_lifetime` option).
-- Introduced optional dependencies on `ffmpeg`, `ImageMagick`, `exiftool` software packages. Please refer to `docs/installation/optional/media_graphics_packages.md`.
-- <details>
-  <summary>API Changes</summary>
-- API: Empty parameter values for integer parameters are now ignored in non-strict validaton mode.
-</details>
-
-### Removed
-
-- **Breaking:** `Pleroma.Workers.Cron.StatsWorker` setting from Oban `:crontab` (moved to a simpler implementation).
-- **Breaking:** `Pleroma.Workers.Cron.ClearOauthTokenWorker` setting from Oban `:crontab` (moved to scheduled jobs).
-- **Breaking:** `Pleroma.Workers.Cron.PurgeExpiredActivitiesWorker` setting from Oban `:crontab` (moved to scheduled jobs).
-- Removed `:managed_config` option. In practice, it was accidentally removed with 2.0.0 release when frontends were
-switched to a new configuration mechanism, however it was not officially removed until now.
-
-### Added
-
-- Media preview proxy (requires `ffmpeg` and `ImageMagick` to be installed and media proxy to be enabled; see `:media_preview_proxy` config for more details).
-- Mix tasks for controlling user account confirmation status in bulk (`mix pleroma.user confirm_all` and `mix pleroma.user unconfirm_all`)
-- Mix task for sending confirmation emails to all unconfirmed users (`mix pleroma.email resend_confirmation_emails`)
-- Mix task option for force-unfollowing relays
-- App metrics: ability to restrict access to specified IP whitelist.
-
-<details>
-  <summary>API Changes</summary>
-
-- Admin API: Importing emoji from a zip file
-- Pleroma API: Importing the mutes users from CSV files.
-- Pleroma API: Pagination for remote/local packs and emoji.
-
-</details>
-
-### Fixed
-
-- Add documented-but-missing chat pagination.
-- Allow sending out emails again.
-- Allow sending chat messages to yourself
-- OStatus / static FE endpoints: fixed inaccessibility for anonymous users on non-federating instances, switched to handling per `:restrict_unauthenticated` setting.
-- Fix remote users with a whitespace name.
-
-### Upgrade notes
-
-1. Install libmagic and development headers (`libmagic-dev` on Ubuntu/Debian, `file-dev` on Alpine Linux)
-2. Run database migrations (inside Pleroma directory):
-  - OTP: `./bin/pleroma_ctl migrate`
-  - From Source: `mix ecto.migrate`
-3. Restart Pleroma
-
-## [2.1.2] - 2020-09-17
-
-### Security
-
-- Fix most MRF rules either crashing or not being applied to objects passed into the Common Pipeline (ChatMessage, Question, Answer, Audio, Event).
-
-### Fixed
-
-- Welcome Chat messages preventing user registration with MRF Simple Policy applied to the local instance.
-- Mastodon API: the public timeline returning an error when the `reply_visibility` parameter is set to `self` for an unauthenticated user.
-- Mastodon Streaming API: Handler crashes on authentication failures, resulting in error logs.
-- Mastodon Streaming API: Error logs on client pings.
-- Rich media: Log spam on failures. Now the error is only logged once per attempt.
-
-### Changed
-
-- Rich Media: A HEAD request is now done to the url, to ensure it has the appropriate content type and size before proceeding with a GET.
-
-### Upgrade notes
-
-1. Restart Pleroma
-
-## [2.1.1] - 2020-09-08
-
-### Security
-- Fix possible DoS in Mastodon API user search due to an error in match clauses, leading to an infinite recursion and subsequent OOM with certain inputs.
-- Fix metadata leak for accounts and statuses on private instances.
-- Fix possible DoS in Admin API search using an atom leak vulnerability. Authentication with admin rights was required to exploit.
-
-### Changed
-
-- **Breaking:** The metadata providers RelMe and Feed are no longer configurable. RelMe should always be activated and Feed only provides a <link> header tag for the actual RSS/Atom feed when the instance is public.
-- Improved error message when cmake is not available at build stage.
-
-### Added
-- Rich media failure tracking (along with `:failure_backoff` option).
-
-<details>
-  <summary>Admin API Changes</summary>
-
-- Add `PATCH /api/pleroma/admin/instance_document/:document_name` to modify the Terms of Service and Instance Panel HTML pages via Admin API
-</details>
-
-### Fixed
-- Default HTTP adapter not respecting pool setting, leading to possible OOM.
-- Fixed uploading webp images when the Exiftool Upload Filter is enabled by skipping them
-- Mastodon API: Search parameter `following` now correctly returns the followings rather than the followers
-- Mastodon API: Timelines hanging for (`number of posts with links * rich media timeout`) in the worst case.
-  Reduced to just rich media timeout.
-- Mastodon API: Cards being wrong for preview statuses due to cache key collision.
-- Password resets no longer processed for deactivated accounts.
-- Favicon scraper raising exceptions on URLs longer than 255 characters.
-
-## [2.1.0] - 2020-08-28
-
-### Changed
-
-- **Breaking:** The default descriptions on uploads are now empty. The old behavior (filename as default) can be configured, see the cheat sheet.
-- **Breaking:** Added the ObjectAgePolicy to the default set of MRFs. This will delist and strip the follower collection of any message received that is older than 7 days. This will stop users from seeing very old messages in the timelines. The messages can still be viewed on the user's page and in conversations. They also still trigger notifications.
-- **Breaking:** Elixir >=1.9 is now required (was >= 1.8)
-- **Breaking:** Configuration: `:auto_linker, :opts` moved to `:pleroma, Pleroma.Formatter`. Old config namespace is deprecated.
-- **Breaking:** Configuration: `:instance, welcome_user_nickname` moved to `:welcome, :direct_message, :sender_nickname`, `:instance, :welcome_message` moved to `:welcome, :direct_message, :message`. Old config namespace is deprecated.
-- **Breaking:** LDAP: Fallback to local database authentication has been removed for security reasons and lack of a mechanism to ensure the passwords are synchronized when LDAP passwords are updated.
-- **Breaking** Changed defaults for `:restrict_unauthenticated` so that when `:instance, :public` is set to `false` then all `:restrict_unauthenticated` items be effectively set to `true`. If you'd like to allow unauthenticated access to specific API endpoints on a private instance, please explicitly set `:restrict_unauthenticated` to non-default value in `config/prod.secret.exs`.
-- In Conversations, return only direct messages as `last_status`
-- Using the `only_media` filter on timelines will now exclude reblog media
-- MFR policy to set global expiration for all local Create activities
-- OGP rich media parser merged with TwitterCard
-- Configuration: `:instance, rewrite_policy` moved to `:mrf, policies`, `:instance, :mrf_transparency` moved to `:mrf, :transparency`, `:instance, :mrf_transparency_exclusions` moved to `:mrf, :transparency_exclusions`. Old config namespace is deprecated.
-- Configuration: `:media_proxy, whitelist` format changed to host with scheme (e.g. `http://example.com` instead of `example.com`). Domain format is deprecated.
-
-<details>
-  <summary>API Changes</summary>
-
-- **Breaking:** Pleroma API: The routes to update avatar, banner and background have been removed.
-- **Breaking:** Image description length is limited now.
-- **Breaking:** Emoji API: changed methods and renamed routes.
-- **Breaking:** Notification Settings API for suppressing notifications has been simplified down to `block_from_strangers`.
-- **Breaking:** Notification Settings API option for hiding push notification contents has been renamed to `hide_notification_contents`.
-- MastodonAPI: Allow removal of avatar, banner and background.
-- Streaming: Repeats of a user's posts will no longer be pushed to the user's stream.
-- Mastodon API: Added `pleroma.metadata.fields_limits` to /api/v1/instance
-- Mastodon API: On deletion, returns the original post text.
-- Mastodon API: Add `pleroma.unread_count` to the Marker entity.
-- Mastodon API: Added `pleroma.metadata.post_formats` to /api/v1/instance
-- Mastodon API (legacy): Allow query parameters for `/api/v1/domain_blocks`, e.g. `/api/v1/domain_blocks?domain=badposters.zone`
-- Mastodon API: Make notifications about statuses from muted users and threads read automatically
-- Pleroma API: `/api/pleroma/captcha` responses now include `seconds_valid` with an integer value.
-
-</details>
-
-<details>
-  <summary>Admin API Changes</summary>
-
-- **Breaking** Changed relay `/api/pleroma/admin/relay` endpoints response format.
-- Status visibility stats: now can return stats per instance.
-- Mix task to refresh counter cache (`mix pleroma.refresh_counter_cache`)
-
-</details>
-
-### Removed
-
-- **Breaking:** removed `with_move` parameter from notifications timeline.
-
-### Added
-
-- Frontends: Add mix task to install frontends.
-- Frontends: Add configurable frontends for primary and admin fe.
-- Configuration: Added a blacklist for email servers.
-- Chats: Added `accepts_chat_messages` field to user, exposed in APIs and federation.
-- Chats: Added support for federated chats. For details, see the docs.
-- ActivityPub: Added support for existing AP ids for instances migrated from Mastodon.
-- Instance: Add `background_image` to configuration and `/api/v1/instance`
-- Instance: Extend `/api/v1/instance` with Pleroma-specific information.
-- NodeInfo: `pleroma:api/v1/notifications:include_types_filter` to the `features` list.
-- NodeInfo: `pleroma_emoji_reactions` to the `features` list.
-- Configuration: `:restrict_unauthenticated` setting, restrict access for unauthenticated users to timelines (public and federate), user profiles and statuses.
-- Configuration: Add `:database_config_whitelist` setting to whitelist settings which can be configured from AdminFE.
-- Configuration: `filename_display_max_length` option to set filename truncate limit, if filename display enabled (0 = no limit).
-- New HTTP adapter [gun](https://github.com/ninenines/gun). Gun adapter requires minimum OTP version of 22.2 otherwise Pleroma won’t start. For hackney OTP update is not required.
-- Mix task to create trusted OAuth App.
-- Mix task to reset MFA for user accounts
-- Notifications: Added `follow_request` notification type.
-- Added `:reject_deletes` group to SimplePolicy
-- MRF (`EmojiStealPolicy`): New MRF Policy which allows to automatically download emojis from remote instances
-- Support pagination in emoji packs API (for packs and for files in pack)
-- Support for viewing instances favicons next to posts and accounts
-- Added Pleroma.Upload.Filter.Exiftool as an alternate EXIF stripping mechanism targeting GPS/location metadata.
-- "By approval" registrations mode.
-- Configuration: Added `:welcome` settings for the welcome message to newly registered users. You can send a welcome message as a direct message, chat or email.
-- Ability to hide favourites and emoji reactions in the API with `[:instance, :show_reactions]` config.
-
-<details>
-  <summary>API Changes</summary>
-
-- Mastodon API: Add pleroma.parent_visible field to statuses.
-- Mastodon API: Extended `/api/v1/instance`.
-- Mastodon API: Support for `include_types` in `/api/v1/notifications`.
-- Mastodon API: Added `/api/v1/notifications/:id/dismiss` endpoint.
-- Mastodon API: Add support for filtering replies in public and home timelines.
-- Mastodon API: Support for `bot` field in `/api/v1/accounts/update_credentials`.
-- Mastodon API: Support irreversible property for filters.
-- Mastodon API: Add pleroma.favicon field to accounts.
-- Admin API: endpoints for create/update/delete OAuth Apps.
-- Admin API: endpoint for status view.
-- OTP: Add command to reload emoji packs
-</details>
-
-### Fixed
-- Fix list pagination and other list issues.
-- Support pagination in conversations API
-- **Breaking**: SimplePolicy `:reject` and `:accept` allow deletions again
-- Fix follower/blocks import when nicknames starts with @
-- Filtering of push notifications on activities from blocked domains
-- Resolving Peertube accounts with Webfinger
-- `blob:` urls not being allowed by connect-src CSP
-- Mastodon API: fix `GET /api/v1/notifications` not returning the full result set
-- Rich Media Previews for Twitter links
-- Admin API: fix `GET /api/pleroma/admin/users/:nickname/credentials` returning 404 when getting the credentials of a remote user while `:instance, :limit_to_local_content` is set to `:unauthenticated`
-- Fix CSP policy generation to include remote Captcha services
-- Fix edge case where MediaProxy truncates media, usually caused when Caddy is serving content for the other Federated instance.
-- Emoji Packs could not be listed when instance was set to `public: false`
-- Fix whole_word always returning false on filter get requests
-- Migrations not working on OTP releases if the database was connected over ssl
-- Fix relay following
-
-## [2.0.7] - 2020-06-13
-
-### Security
-- Fix potential DoSes exploiting atom leaks in rich media parser and the `UserAllowListPolicy` MRF policy
-
-### Fixed
-- CSP: not allowing images/media from every host when mediaproxy is disabled
-- CSP: not adding mediaproxy base url to image/media hosts
-- StaticFE missing the CSS file
-
-### Upgrade notes
-
-1. Restart Pleroma
-
-## [2.0.6] - 2020-06-09
-
-### Security
-- CSP: harden `image-src` and `media-src` when MediaProxy is used
-
-### Fixed
-- AP C2S: Fix pagination in inbox/outbox
-- Various compilation errors on OTP 23
-- Mastodon API streaming: Repeats from muted threads not being filtered
-
-### Changed
-- Various database performance improvements
-
-### Upgrade notes
-1. Run database migrations (inside Pleroma directory):
-  - OTP: `./bin/pleroma_ctl migrate`
-  - From Source: `mix ecto.migrate`
-2. Restart Pleroma
-
-## [2.0.5] - 2020-05-13
-
-### Security
-- Fix possible private status leaks in Mastodon Streaming API
-
-### Fixed
-- Crashes when trying to block a user if block federation is disabled
-- Not being able to start the instance without `erlang-eldap` installed
-- Users with bios over the limit getting rejected
-- Follower counters not being updated on incoming follow accepts
-
-### Upgrade notes
-
-1. Restart Pleroma
-
-## [2.0.4] - 2020-05-10
-
-### Security
-- AP C2S: Fix a potential DoS by creating nonsensical objects that break timelines
-
-### Fixed
-- Peertube user lookups not working
-- `InsertSkeletonsForDeletedUsers` migration failing on some instances
-- Healthcheck reporting the number of memory currently used, rather than allocated in total
-- LDAP not being usable in OTP releases
-- Default apache configuration having tls chain issues
-
-### Upgrade notes
-
-#### Apache only
-
-1. Remove the following line from your config:
-```
-    SSLCertificateFile      /etc/letsencrypt/live/${servername}/cert.pem
-```
-
-#### Everyone
-
-1. Restart Pleroma
-
-## [2.0.3] - 2020-05-02
-
-### Security
-- Disallow re-registration of previously deleted users, which allowed viewing direct messages addressed to them
-- Mastodon API: Fix `POST /api/v1/follow_requests/:id/authorize` allowing to force a follow from a local user even if they didn't request to follow
-- CSP: Sandbox uploads
-
-### Fixed
-- Notifications from blocked domains
-- Potential federation issues with Mastodon versions before 3.0.0
-- HTTP Basic Authentication permissions issue
-- Follow/Block imports not being able to find the user if the nickname started with an `@`
-- Instance stats counting internal users
-- Inability to run a From Source release without git
-- ObjectAgePolicy didn't filter out old messages
-- `blob:` urls not being allowed by CSP
-
-### Added
-- NodeInfo: ObjectAgePolicy settings to the `federation` list.
-- Follow request notifications
-<details>
-  <summary>API Changes</summary>
-- Admin API: `GET /api/pleroma/admin/need_reboot`.
-</details>
-
-### Upgrade notes
-
-1. Restart Pleroma
-2. Run database migrations (inside Pleroma directory):
-  - OTP: `./bin/pleroma_ctl migrate`
-  - From Source: `mix ecto.migrate`
-3. Reset status visibility counters (inside Pleroma directory):
-  - OTP: `./bin/pleroma_ctl refresh_counter_cache`
-  - From Source: `mix pleroma.refresh_counter_cache`
-
-
-## [2.0.2] - 2020-04-08
-### Added
-- Support for Funkwhale's `Audio` activity
-- Admin API: `PATCH /api/pleroma/admin/users/:nickname/update_credentials`
-
-### Fixed
-- Blocked/muted users still generating push notifications
-- Input textbox for bio ignoring newlines
-- OTP: Inability to use PostgreSQL databases with SSL
-- `user delete_activities` breaking when trying to delete already deleted posts
-- Incorrect URL for Funkwhale channels
-
-### Upgrade notes
-1. Restart Pleroma
-
-## [2.0.1] - 2020-03-15
-### Security
-- Static-FE: Fix remote posts not being sanitized
-
-### Fixed
-- Rate limiter crashes when there is no explicitly specified ip in the config
-- 500 errors when no `Accept` header is present if Static-FE is enabled
-- Instance panel not being updated immediately due to wrong `Cache-Control` headers
-- Statuses posted with BBCode/Markdown having unncessary newlines in Pleroma-FE
-- OTP: Fix some settings not being migrated to in-database config properly
-- No `Cache-Control` headers on attachment/media proxy requests
-- Character limit enforcement being off by 1
-- Mastodon Streaming API: hashtag timelines not working
-
-### Changed
-- BBCode and Markdown formatters will no longer return any `\n` and only use `<br/>` for newlines
-- Mastodon API: Allow registration without email if email verification is not enabled
-
-### Upgrade notes
-#### Nginx only
-1. Remove `proxy_ignore_headers Cache-Control;` and `proxy_hide_header  Cache-Control;` from your config.
-
-#### Everyone
-1. Run database migrations (inside Pleroma directory):
-  - OTP: `./bin/pleroma_ctl migrate`
-  - From Source: `mix ecto.migrate`
-2. Restart Pleroma
-
-## [2.0.0] - 2019-03-08
-### Security
-- Mastodon API: Fix being able to request enormous amount of statuses in timelines leading to DoS. Now limited to 40 per request.
+- Mastodon API: Fix being able to request enourmous amount of statuses in timelines leading to DoS. Now limited to 40 per request.
 
 ### Removed
 - **Breaking**: Removed 1.0+ deprecated configurations `Pleroma.Upload, :strip_exif` and `:instance, :dedupe_media`
@@ -705,7 +14,6 @@ switched to a new configuration mechanism, however it was not officially removed
 - **Breaking**: Using third party engines for user recommendation
 <details>
   <summary>API Changes</summary>
-
 - **Breaking**: AdminAPI: migrate_from_db endpoint
 </details>
 
@@ -730,7 +38,6 @@ switched to a new configuration mechanism, however it was not officially removed
 - Rate limiter is now disabled for localhost/socket (unless remoteip plug is enabled)
 - Logger: default log level changed from `warn` to `info`.
 - Config mix task `migrate_to_db` truncates `config` table before migrating the config file.
-- Allow account registration without an email
 - Default to `prepare: :unnamed` in the database configuration.
 - Instance stats are now loaded on startup instead of being empty until next hourly job.
 <details>
@@ -741,7 +48,7 @@ switched to a new configuration mechanism, however it was not officially removed
 - **Breaking:** Admin API: Return link alongside with token on password reset
 - **Breaking:** Admin API: `PUT /api/pleroma/admin/reports/:id` is now `PATCH /api/pleroma/admin/reports`, see admin_api.md for details
 - **Breaking:** `/api/pleroma/admin/users/invite_token` now uses `POST`, changed accepted params and returns full invite in json instead of only token string.
-- **Breaking** replying to reports is now "report notes", endpoint changed from `POST /api/pleroma/admin/reports/:id/respond` to `POST /api/pleroma/admin/reports/:id/notes`
+- **Breaking** replying to reports is now "report notes", enpoint changed from `POST /api/pleroma/admin/reports/:id/respond` to `POST /api/pleroma/admin/reports/:id/notes`
 - Mastodon API: stopped sanitizing display names, field names and subject fields since they are supposed to be treated as plaintext
 - Admin API: Return `total` when querying for reports
 - Mastodon API: Return `pleroma.direct_conversation_id` when creating a direct message (`POST /api/v1/statuses`)
@@ -755,7 +62,6 @@ switched to a new configuration mechanism, however it was not officially removed
 - Mastodon API: User timelines will now respect blocks, unless you are getting the user timeline of somebody you blocked (which would be empty otherwise).
 - Mastodon API: Favoriting / Repeating a post multiple times will now return the identical response every time. Before, executing that action twice would return an error ("already favorited") on the second try.
 - Mastodon API: Limit timeline requests to 3 per timeline per 500ms per user/ip by default.
-- Admin API: `PATCH /api/pleroma/admin/users/:nickname/credentials` and `GET /api/pleroma/admin/users/:nickname/credentials`
 </details>
 
 ### Added
@@ -777,6 +83,7 @@ switched to a new configuration mechanism, however it was not officially removed
 - Add an option `authorized_fetch_mode` to require HTTP signatures for AP fetches.
 - ActivityPub: support for `replies` collection (output for outgoing federation & fetching on incoming federation).
 - Mix task to refresh counter cache (`mix pleroma.refresh_counter_cache`)
+- Configuration: `web_endpoint` option for `Pleroma.Web.Endpoint`, defaulting missing.
 <details>
   <summary>API Changes</summary>
 
@@ -844,43 +151,6 @@ switched to a new configuration mechanism, however it was not officially removed
 - Mastodon API: Marking a conversation as read (`POST /api/v1/conversations/:id/read`) now no longer brings it to the top in the user's direct conversation list
 </details>
 
-## [1.1.9] - 2020-02-10
-### Fixed
-- OTP: Inability to set the upload limit (again)
-- Not being able to pin polls
-- Streaming API: incorrect handling of reblog mutes
-- Rejecting the user when field length limit is exceeded
-- OpenGraph provider: html entities in descriptions
-
-## [1.1.8] - 2020-01-10
-### Fixed
-- Captcha generation issues
-- Returned Kocaptcha endpoint to configuration
-- Captcha validity is now 5 minutes
-
-## [1.1.7] - 2019-12-13
-### Fixed
-- OTP: Inability to set the upload limit
-- OTP: Inability to override node name/distribution type to run 2 Pleroma instances on the same machine
-
-### Added
-- Integrated captcha provider
-
-### Changed
-- Captcha enabled by default
-- Default Captcha provider changed from `Pleroma.Captcha.Kocaptcha` to `Pleroma.Captcha.Native`
-- Better `Cache-Control` header for static content
-
-### Bundled Pleroma-FE Changes
-#### Added
-- Icons in the navigation panel
-
-#### Fixed
-- Improved support unauthenticated view of private instances
-
-#### Removed
-- Whitespace hack on empty post content
-
 ## [1.1.6] - 2019-11-19
 ### Fixed
 - Not being able to log into to third party apps when the browser is logged into mastofe

COPYING

@@ -1,17 +1,10 @@
-Unless otherwise stated this repository is copyright © 2017-2022
+Unless otherwise stated this repository is copyright © 2017-2019
 Pleroma Authors <https://pleroma.social/>, and is distributed under
 The GNU Affero General Public License Version 3, you should have received a
 copy of the license file as AGPL-3.
 
 ---
 
-Files inside docs directory are copyright © 2022 Pleroma Authors
-<https://pleroma.social/>, and are distributed under the Creative Commons
-Attribution 4.0 International license, you should have received
-a copy of the license file as CC-BY-4.0.
-
----
-
 The following files are copyright © 2019 shitposter.club, and are distributed
 under the Creative Commons Attribution-ShareAlike 4.0 International license,
 you should have received a copy of the license file as CC-BY-SA-4.0.
@@ -30,7 +23,7 @@ priv/static/images/pleroma-fox-tan-shy.png
 
 ---
 
-The following files are copyright © 2017-2022 Pleroma Authors
+The following files are copyright © 2017-2019 Pleroma Authors
 <https://pleroma.social/>, and are distributed under the Creative Commons
 Attribution-ShareAlike 4.0 International license, you should have received
 a copy of the license file as CC-BY-SA-4.0.

Dockerfile

@@ -1,18 +1,18 @@
-FROM elixir:1.11.4-alpine as build
+FROM elixir:1.9-alpine as build
 
 COPY . .
 
 ENV MIX_ENV=prod
 
-RUN apk add git gcc g++ musl-dev make cmake file-dev &&\
-	echo "import Config" > config/prod.secret.exs &&\
+RUN apk add git gcc g++ musl-dev make &&\
+	echo "import Mix.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
+FROM alpine:3.9
 
 ARG BUILD_DATE
 ARG VCS_REF
@@ -31,8 +31,9 @@ LABEL maintainer="ops@pleroma.social" \
 ARG HOME=/opt/pleroma
 ARG DATA=/var/lib/pleroma
 
-RUN apk update &&\
-	apk add exiftool ffmpeg imagemagick libmagic ncurses postgresql-client &&\
+RUN echo "http://nl.alpinelinux.org/alpine/latest-stable/community" >> /etc/apk/repositories &&\
+	apk update &&\
+	apk add ncurses postgresql-client &&\
 	adduser --system --shell /bin/false --home ${HOME} pleroma &&\
 	mkdir -p ${DATA}/uploads &&\
 	mkdir -p ${DATA}/static &&\

README.md

@@ -18,40 +18,26 @@ If you are running Linux (glibc or musl) on x86/arm, the recommended way to inst
 ### 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.
 
-- [Alpine Linux](https://docs-develop.pleroma.social/backend/installation/alpine_linux_en/)
-- [Arch Linux](https://docs-develop.pleroma.social/backend/installation/arch_linux_en/)
-- [CentOS 7](https://docs-develop.pleroma.social/backend/installation/centos7_en/)
 - [Debian-based](https://docs-develop.pleroma.social/backend/installation/debian_based_en/)
 - [Debian-based (jp)](https://docs-develop.pleroma.social/backend/installation/debian_based_jp/)
-- [FreeBSD](https://docs-develop.pleroma.social/backend/installation/freebsd_en/)
+- [Alpine Linux](https://docs-develop.pleroma.social/backend/installation/alpine_linux_en/)
+- [Arch Linux](https://docs-develop.pleroma.social/backend/installation/arch_linux_en/)
 - [Gentoo Linux](https://docs-develop.pleroma.social/backend/installation/gentoo_en/)
 - [NetBSD](https://docs-develop.pleroma.social/backend/installation/netbsd_en/)
 - [OpenBSD](https://docs-develop.pleroma.social/backend/installation/openbsd_en/)
 - [OpenBSD (fi)](https://docs-develop.pleroma.social/backend/installation/openbsd_fi/)
+- [CentOS 7](https://docs-develop.pleroma.social/backend/installation/centos7_en/)
 
 ### OS/Distro packages
-Currently Pleroma is packaged for [YunoHost](https://yunohost.org) and [NixOS](https://nixos.org). If you want to package Pleroma for any OS/Distros, we can guide you through the process on our [community channels](#community-channels). If you want to change default options in your Pleroma package, please **discuss it with us first**.
+Currently Pleroma is not packaged by any OS/Distros, but if you want to package it for one, we can guide you through the process on our [community channels](#community-channels). If you want to change default options in your Pleroma package, please **discuss it with us first**.
 
 ### 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>.
 
-### Raspberry Pi
-Community maintained Raspberry Pi image that you can flash and run Pleroma on your Raspberry Pi. Available here <https://github.com/guysoft/PleromaPi>.
-
-### Compilation Troubleshooting
-If you ever encounter compilation issues during the updating of Pleroma, you can try these commands and see if they fix things:
-
-- `mix deps.clean --all`
-- `mix local.rebar`
-- `mix local.hex`
-- `rm -r _build`
-
-If you are not developing Pleroma, it is better to use the OTP release, which comes with everything precompiled.
-
 ## Documentation
 - Latest Released revision: <https://docs.pleroma.social>
 - Latest Git revision: <https://docs-develop.pleroma.social>
 
 ## Community Channels
-* IRC: **#pleroma** and **#pleroma-dev** on libera.chat, webchat is available at <https://irc.pleroma.social>
-* Matrix: [#pleroma:libera.chat](https://matrix.to/#/#pleroma:libera.chat) and [#pleroma-dev:libera.chat](https://matrix.to/#/#pleroma-dev:libera.chat)
+* IRC: **#pleroma** and **#pleroma-dev** on freenode, webchat is available at <https://irc.pleroma.social>
+* Matrix: <https://matrix.to/#/#freenode_#pleroma:matrix.org> and <https://matrix.to/#/#freenode_#pleroma-dev:matrix.org>

SECURITY.md

@@ -1,16 +0,0 @@
-# Pleroma backend security policy
-
-## Supported versions
-
-Currently, Pleroma offers bugfixes and security patches only for the latest minor release.
-
-| Version | Support 
-|---------| --------
-| 2.2     | Bugfixes and security patches
-
-## Reporting a vulnerability
-
-Please use confidential issues (tick the "This issue is confidential and should only be visible to team members with at least Reporter access." box when submitting) at our [bugtracker](https://git.pleroma.social/pleroma/pleroma/-/issues/new) for reporting vulnerabilities.
-## Announcements
-
-New releases are announced at [pleroma.social](https://pleroma.social/announcements/). All security releases are tagged with ["Security"](https://pleroma.social/announcements/tags/security/). You can be notified of them by subscribing to an Atom feed at <https://pleroma.social/announcements/tags/security/feed.xml>. 

benchmarks/load_testing/activities.ex

@@ -1,595 +0,0 @@
-defmodule Pleroma.LoadTesting.Activities do
-  @moduledoc """
-  Module for generating different activities.
-  """
-  import Ecto.Query
-  import Pleroma.LoadTesting.Helper, only: [to_sec: 1]
-
-  alias Ecto.UUID
-  alias Pleroma.Constants
-  alias Pleroma.LoadTesting.Users
-  alias Pleroma.Repo
-  alias Pleroma.Web.CommonAPI
-
-  require Constants
-
-  @defaults [
-    iterations: 170,
-    friends_used: 20,
-    non_friends_used: 20
-  ]
-
-  @max_concurrency 10
-
-  @visibility ~w(public private direct unlisted)
-  @types [
-    :simple,
-    :simple_filtered,
-    :emoji,
-    :mentions,
-    :hell_thread,
-    :attachment,
-    :tag,
-    :like,
-    :reblog,
-    :simple_thread
-  ]
-  @groups [:friends_local, :friends_remote, :non_friends_local, :non_friends_local]
-  @remote_groups [:friends_remote, :non_friends_remote]
-  @friends_groups [:friends_local, :friends_remote]
-  @non_friends_groups [:non_friends_local, :non_friends_remote]
-
-  @spec generate(User.t(), keyword()) :: :ok
-  def generate(user, opts \\ []) do
-    {:ok, _} =
-      Agent.start_link(fn -> %{} end,
-        name: :benchmark_state
-      )
-
-    opts = Keyword.merge(@defaults, opts)
-
-    users = Users.prepare_users(user, opts)
-
-    {:ok, _} = Agent.start_link(fn -> users[:non_friends_remote] end, name: :non_friends_remote)
-
-    task_data =
-      for visibility <- @visibility,
-          type <- @types,
-          group <- [:user | @groups],
-          do: {visibility, type, group}
-
-    IO.puts("Starting generating #{opts[:iterations]} iterations of activities...")
-
-    public_long_thread = fn ->
-      generate_long_thread("public", users, opts)
-    end
-
-    private_long_thread = fn ->
-      generate_long_thread("private", users, opts)
-    end
-
-    iterations = opts[:iterations]
-
-    {time, _} =
-      :timer.tc(fn ->
-        Enum.each(
-          1..iterations,
-          fn
-            i when i == iterations - 2 ->
-              spawn(public_long_thread)
-              spawn(private_long_thread)
-              generate_activities(users, Enum.shuffle(task_data), opts)
-
-            _ ->
-              generate_activities(users, Enum.shuffle(task_data), opts)
-          end
-        )
-      end)
-
-    IO.puts("Generating iterations of activities took #{to_sec(time)} sec.\n")
-    :ok
-  end
-
-  def generate_power_intervals(opts \\ []) do
-    count = Keyword.get(opts, :count, 20)
-    power = Keyword.get(opts, :power, 2)
-    IO.puts("Generating #{count} intervals for a power #{power} series...")
-    counts = Enum.map(1..count, fn n -> :math.pow(n, power) end)
-    sum = Enum.sum(counts)
-
-    densities =
-      Enum.map(counts, fn c ->
-        c / sum
-      end)
-
-    densities
-    |> Enum.reduce(0, fn density, acc ->
-      if acc == 0 do
-        [{0, density}]
-      else
-        [{_, lower} | _] = acc
-        [{lower, lower + density} | acc]
-      end
-    end)
-    |> Enum.reverse()
-  end
-
-  def generate_tagged_activities(opts \\ []) do
-    tag_count = Keyword.get(opts, :tag_count, 20)
-    users = Keyword.get(opts, :users, Repo.all(Pleroma.User))
-    activity_count = Keyword.get(opts, :count, 200_000)
-
-    intervals = generate_power_intervals(count: tag_count)
-
-    IO.puts(
-      "Generating #{activity_count} activities using #{tag_count} different tags of format `tag_n`, starting at tag_0"
-    )
-
-    Enum.each(1..activity_count, fn _ ->
-      random = :rand.uniform()
-      i = Enum.find_index(intervals, fn {lower, upper} -> lower <= random && upper > random end)
-      CommonAPI.post(Enum.random(users), %{status: "a post with the tag #tag_#{i}"})
-    end)
-  end
-
-  defp generate_long_thread(visibility, users, _opts) do
-    group =
-      if visibility == "public",
-        do: :friends_local,
-        else: :user
-
-    tasks = get_reply_tasks(visibility, group) |> Stream.cycle() |> Enum.take(50)
-
-    {:ok, activity} =
-      CommonAPI.post(users[:user], %{
-        status: "Start of #{visibility} long thread",
-        visibility: visibility
-      })
-
-    Agent.update(:benchmark_state, fn state ->
-      key =
-        if visibility == "public",
-          do: :public_thread,
-          else: :private_thread
-
-      Map.put(state, key, activity)
-    end)
-
-    acc = {activity.id, ["@" <> users[:user].nickname, "reply to long thread"]}
-    insert_replies_for_long_thread(tasks, visibility, users, acc)
-    IO.puts("Generating #{visibility} long thread ended\n")
-  end
-
-  defp insert_replies_for_long_thread(tasks, visibility, users, acc) do
-    Enum.reduce(tasks, acc, fn
-      :user, {id, data} ->
-        user = users[:user]
-        insert_reply(user, List.delete(data, "@" <> user.nickname), id, visibility)
-
-      group, {id, data} ->
-        replier = Enum.random(users[group])
-        insert_reply(replier, List.delete(data, "@" <> replier.nickname), id, visibility)
-    end)
-  end
-
-  defp generate_activities(users, task_data, opts) do
-    Task.async_stream(
-      task_data,
-      fn {visibility, type, group} ->
-        insert_activity(type, visibility, group, users, opts)
-      end,
-      max_concurrency: @max_concurrency,
-      timeout: 30_000
-    )
-    |> Stream.run()
-  end
-
-  defp insert_local_activity(visibility, group, users, status) do
-    {:ok, _} =
-      group
-      |> get_actor(users)
-      |> CommonAPI.post(%{status: status, visibility: visibility})
-  end
-
-  defp insert_remote_activity(visibility, group, users, status) do
-    actor = get_actor(group, users)
-    {act_data, obj_data} = prepare_activity_data(actor, visibility, users[:user])
-    {activity_data, object_data} = other_data(actor, status)
-
-    activity_data
-    |> Map.merge(act_data)
-    |> Map.put("object", Map.merge(object_data, obj_data))
-    |> Pleroma.Web.ActivityPub.ActivityPub.insert(false)
-  end
-
-  defp user_mentions(users) do
-    user_mentions =
-      Enum.reduce(
-        @groups,
-        [],
-        fn group, acc ->
-          acc ++ get_random_mentions(users[group], Enum.random(0..2))
-        end
-      )
-
-    if Enum.random([true, false]),
-      do: ["@" <> users[:user].nickname | user_mentions],
-      else: user_mentions
-  end
-
-  defp hell_thread_mentions(users) do
-    with {:ok, nil} <- Cachex.get(:user_cache, "hell_thread_mentions") do
-      cached =
-        @groups
-        |> Enum.reduce([users[:user]], fn group, acc ->
-          acc ++ Enum.take(users[group], 5)
-        end)
-        |> Enum.map(&"@#{&1.nickname}")
-        |> Enum.join(", ")
-
-      Cachex.put(:user_cache, "hell_thread_mentions", cached)
-      cached
-    else
-      {:ok, cached} -> cached
-    end
-  end
-
-  defp insert_activity(:simple, visibility, group, users, _opts)
-       when group in @remote_groups do
-    insert_remote_activity(visibility, group, users, "Remote status")
-  end
-
-  defp insert_activity(:simple, visibility, group, users, _opts) do
-    insert_local_activity(visibility, group, users, "Simple status")
-  end
-
-  defp insert_activity(:simple_filtered, visibility, group, users, _opts)
-       when group in @remote_groups do
-    insert_remote_activity(visibility, group, users, "Remote status which must be filtered")
-  end
-
-  defp insert_activity(:simple_filtered, visibility, group, users, _opts) do
-    insert_local_activity(visibility, group, users, "Simple status which must be filtered")
-  end
-
-  defp insert_activity(:emoji, visibility, group, users, _opts)
-       when group in @remote_groups do
-    insert_remote_activity(visibility, group, users, "Remote status with emoji :firefox:")
-  end
-
-  defp insert_activity(:emoji, visibility, group, users, _opts) do
-    insert_local_activity(visibility, group, users, "Simple status with emoji :firefox:")
-  end
-
-  defp insert_activity(:mentions, visibility, group, users, _opts)
-       when group in @remote_groups do
-    mentions = user_mentions(users)
-
-    status = Enum.join(mentions, ", ") <> " remote status with mentions"
-
-    insert_remote_activity(visibility, group, users, status)
-  end
-
-  defp insert_activity(:mentions, visibility, group, users, _opts) do
-    mentions = user_mentions(users)
-
-    status = Enum.join(mentions, ", ") <> " simple status with mentions"
-    insert_remote_activity(visibility, group, users, status)
-  end
-
-  defp insert_activity(:hell_thread, visibility, group, users, _)
-       when group in @remote_groups do
-    mentions = hell_thread_mentions(users)
-    insert_remote_activity(visibility, group, users, mentions <> " remote hell thread status")
-  end
-
-  defp insert_activity(:hell_thread, visibility, group, users, _opts) do
-    mentions = hell_thread_mentions(users)
-
-    insert_local_activity(visibility, group, users, mentions <> " hell thread status")
-  end
-
-  defp insert_activity(:attachment, visibility, group, users, _opts) do
-    actor = get_actor(group, users)
-
-    obj_data = %{
-      "actor" => actor.ap_id,
-      "name" => "4467-11.jpg",
-      "type" => "Document",
-      "url" => [
-        %{
-          "href" =>
-            "#{Pleroma.Web.Endpoint.url()}/media/b1b873552422a07bf53af01f3c231c841db4dfc42c35efde681abaf0f2a4eab7.jpg",
-          "mediaType" => "image/jpeg",
-          "type" => "Link"
-        }
-      ]
-    }
-
-    object = Repo.insert!(%Pleroma.Object{data: obj_data})
-
-    {:ok, _activity} =
-      CommonAPI.post(actor, %{
-        status: "Post with attachment",
-        visibility: visibility,
-        media_ids: [object.id]
-      })
-  end
-
-  defp insert_activity(:tag, visibility, group, users, _opts) do
-    insert_local_activity(visibility, group, users, "Status with #tag")
-  end
-
-  defp insert_activity(:like, visibility, group, users, opts) do
-    actor = get_actor(group, users)
-
-    with activity_id when not is_nil(activity_id) <- get_random_create_activity_id(),
-         {:ok, _activity} <- CommonAPI.favorite(actor, activity_id) do
-      :ok
-    else
-      {:error, _} ->
-        insert_activity(:like, visibility, group, users, opts)
-
-      nil ->
-        Process.sleep(15)
-        insert_activity(:like, visibility, group, users, opts)
-    end
-  end
-
-  defp insert_activity(:reblog, visibility, group, users, opts) do
-    actor = get_actor(group, users)
-
-    with activity_id when not is_nil(activity_id) <- get_random_create_activity_id(),
-         {:ok, _activity} <- CommonAPI.repeat(activity_id, actor) do
-      :ok
-    else
-      {:error, _} ->
-        insert_activity(:reblog, visibility, group, users, opts)
-
-      nil ->
-        Process.sleep(15)
-        insert_activity(:reblog, visibility, group, users, opts)
-    end
-  end
-
-  defp insert_activity(:simple_thread, "direct", group, users, _opts) do
-    actor = get_actor(group, users)
-    tasks = get_reply_tasks("direct", group)
-
-    list =
-      case group do
-        :user ->
-          group = Enum.random(@friends_groups)
-          Enum.take(users[group], 3)
-
-        _ ->
-          Enum.take(users[group], 3)
-      end
-
-    data = Enum.map(list, &("@" <> &1.nickname))
-
-    {:ok, activity} =
-      CommonAPI.post(actor, %{
-        status: Enum.join(data, ", ") <> "simple status",
-        visibility: "direct"
-      })
-
-    acc = {activity.id, ["@" <> users[:user].nickname | data] ++ ["reply to status"]}
-    insert_direct_replies(tasks, users[:user], list, acc)
-  end
-
-  defp insert_activity(:simple_thread, visibility, group, users, _opts) do
-    actor = get_actor(group, users)
-    tasks = get_reply_tasks(visibility, group)
-
-    {:ok, activity} =
-      CommonAPI.post(users[:user], %{status: "Simple status", visibility: visibility})
-
-    acc = {activity.id, ["@" <> actor.nickname, "reply to status"]}
-    insert_replies(tasks, visibility, users, acc)
-  end
-
-  defp get_actor(:user, %{user: user}), do: user
-  defp get_actor(group, users), do: Enum.random(users[group])
-
-  defp other_data(actor, content) do
-    %{host: host} = URI.parse(actor.ap_id)
-    datetime = DateTime.utc_now() |> to_string()
-    context_id = "https://#{host}/contexts/#{UUID.generate()}"
-    activity_id = "https://#{host}/activities/#{UUID.generate()}"
-    object_id = "https://#{host}/objects/#{UUID.generate()}"
-
-    activity_data = %{
-      "actor" => actor.ap_id,
-      "context" => context_id,
-      "id" => activity_id,
-      "published" => datetime,
-      "type" => "Create",
-      "directMessage" => false
-    }
-
-    object_data = %{
-      "actor" => actor.ap_id,
-      "attachment" => [],
-      "attributedTo" => actor.ap_id,
-      "bcc" => [],
-      "bto" => [],
-      "content" => content,
-      "context" => context_id,
-      "conversation" => context_id,
-      "emoji" => %{},
-      "id" => object_id,
-      "published" => datetime,
-      "sensitive" => false,
-      "summary" => "",
-      "tag" => [],
-      "to" => ["https://www.w3.org/ns/activitystreams#Public"],
-      "type" => "Note"
-    }
-
-    {activity_data, object_data}
-  end
-
-  defp prepare_activity_data(actor, "public", _mention) do
-    obj_data = %{
-      "cc" => [actor.follower_address],
-      "to" => [Constants.as_public()]
-    }
-
-    act_data = %{
-      "cc" => [actor.follower_address],
-      "to" => [Constants.as_public()]
-    }
-
-    {act_data, obj_data}
-  end
-
-  defp prepare_activity_data(actor, "private", _mention) do
-    obj_data = %{
-      "cc" => [],
-      "to" => [actor.follower_address]
-    }
-
-    act_data = %{
-      "cc" => [],
-      "to" => [actor.follower_address]
-    }
-
-    {act_data, obj_data}
-  end
-
-  defp prepare_activity_data(actor, "unlisted", _mention) do
-    obj_data = %{
-      "cc" => [Constants.as_public()],
-      "to" => [actor.follower_address]
-    }
-
-    act_data = %{
-      "cc" => [Constants.as_public()],
-      "to" => [actor.follower_address]
-    }
-
-    {act_data, obj_data}
-  end
-
-  defp prepare_activity_data(_actor, "direct", mention) do
-    %{host: mentioned_host} = URI.parse(mention.ap_id)
-
-    obj_data = %{
-      "cc" => [],
-      "content" =>
-        "<span class=\"h-card\"><a class=\"u-url mention\" href=\"#{mention.ap_id}\" rel=\"ugc\">@<span>#{
-          mention.nickname
-        }</span></a></span> direct message",
-      "tag" => [
-        %{
-          "href" => mention.ap_id,
-          "name" => "@#{mention.nickname}@#{mentioned_host}",
-          "type" => "Mention"
-        }
-      ],
-      "to" => [mention.ap_id]
-    }
-
-    act_data = %{
-      "cc" => [],
-      "directMessage" => true,
-      "to" => [mention.ap_id]
-    }
-
-    {act_data, obj_data}
-  end
-
-  defp get_reply_tasks("public", :user) do
-    [:friends_local, :friends_remote, :non_friends_local, :non_friends_remote, :user]
-  end
-
-  defp get_reply_tasks("public", group) when group in @friends_groups do
-    [:non_friends_local, :non_friends_remote, :user, :friends_local, :friends_remote]
-  end
-
-  defp get_reply_tasks("public", group) when group in @non_friends_groups do
-    [:user, :friends_local, :friends_remote, :non_friends_local, :non_friends_remote]
-  end
-
-  defp get_reply_tasks(visibility, :user) when visibility in ["unlisted", "private"] do
-    [:friends_local, :friends_remote, :user, :friends_local, :friends_remote]
-  end
-
-  defp get_reply_tasks(visibility, group)
-       when visibility in ["unlisted", "private"] and group in @friends_groups do
-    [:user, :friends_remote, :friends_local, :user]
-  end
-
-  defp get_reply_tasks(visibility, group)
-       when visibility in ["unlisted", "private"] and
-              group in @non_friends_groups,
-       do: []
-
-  defp get_reply_tasks("direct", :user), do: [:friends_local, :user, :friends_remote]
-
-  defp get_reply_tasks("direct", group) when group in @friends_groups,
-    do: [:user, group, :user]
-
-  defp get_reply_tasks("direct", group) when group in @non_friends_groups do
-    [:user, :non_friends_remote, :user, :non_friends_local]
-  end
-
-  defp insert_replies(tasks, visibility, users, acc) do
-    Enum.reduce(tasks, acc, fn
-      :user, {id, data} ->
-        insert_reply(users[:user], data, id, visibility)
-
-      group, {id, data} ->
-        replier = Enum.random(users[group])
-        insert_reply(replier, data, id, visibility)
-    end)
-  end
-
-  defp insert_direct_replies(tasks, user, list, acc) do
-    Enum.reduce(tasks, acc, fn
-      :user, {id, data} ->
-        {reply_id, _} = insert_reply(user, List.delete(data, "@" <> user.nickname), id, "direct")
-        {reply_id, data}
-
-      _, {id, data} ->
-        actor = Enum.random(list)
-
-        {reply_id, _} =
-          insert_reply(actor, List.delete(data, "@" <> actor.nickname), id, "direct")
-
-        {reply_id, data}
-    end)
-  end
-
-  defp insert_reply(actor, data, activity_id, visibility) do
-    {:ok, reply} =
-      CommonAPI.post(actor, %{
-        status: Enum.join(data, ", "),
-        visibility: visibility,
-        in_reply_to_status_id: activity_id
-      })
-
-    {reply.id, ["@" <> actor.nickname | data]}
-  end
-
-  defp get_random_mentions(_users, count) when count == 0, do: []
-
-  defp get_random_mentions(users, count) do
-    users
-    |> Enum.shuffle()
-    |> Enum.take(count)
-    |> Enum.map(&"@#{&1.nickname}")
-  end
-
-  defp get_random_create_activity_id do
-    Repo.one(
-      from(a in Pleroma.Activity,
-        where: fragment("(?)->>'type' = ?", a.data, ^"Create"),
-        order_by: fragment("RANDOM()"),
-        limit: 1,
-        select: a.id
-      )
-    )
-  end
-end

benchmarks/load_testing/fetcher.ex

@@ -1,624 +1,260 @@
 defmodule Pleroma.LoadTesting.Fetcher do
-  alias Pleroma.Activity
-  alias Pleroma.Pagination
-  alias Pleroma.Repo
-  alias Pleroma.User
-  alias Pleroma.Web.ActivityPub.ActivityPub
-  alias Pleroma.Web.MastodonAPI.MastodonAPI
-  alias Pleroma.Web.MastodonAPI.StatusView
+  use Pleroma.LoadTesting.Helper
 
-  @spec run_benchmarks(User.t()) :: any()
-  def run_benchmarks(user) do
-    fetch_user(user)
-    fetch_timelines(user)
-    render_views(user)
-  end
-
-  defp formatters do
-    [
-      Benchee.Formatters.Console
-    ]
-  end
-
-  defp fetch_user(user) do
-    Benchee.run(
-      %{
-        "By id" => fn -> Repo.get_by(User, id: user.id) end,
-        "By ap_id" => fn -> Repo.get_by(User, ap_id: user.ap_id) end,
-        "By email" => fn -> Repo.get_by(User, email: user.email) end,
-        "By nickname" => fn -> Repo.get_by(User, nickname: user.nickname) end
-      },
-      formatters: formatters()
-    )
-  end
-
-  defp create_filter(user) do
-    Pleroma.Filter.create(%{
-      user_id: user.id,
-      phrase: "must be filtered",
-      hide: true,
-      context: ["home"]
+  def fetch_user(user) do
+    Benchee.run(%{
+      "By id" => fn -> Repo.get_by(User, id: user.id) end,
+      "By ap_id" => fn -> Repo.get_by(User, ap_id: user.ap_id) end,
+      "By email" => fn -> Repo.get_by(User, email: user.email) end,
+      "By nickname" => fn -> Repo.get_by(User, nickname: user.nickname) end
     })
   end
 
-  defp delete_filter(filter), do: Repo.delete(filter)
-
-  defp fetch_timelines(user) do
-    fetch_home_timeline(user)
-    fetch_home_timeline_with_filter(user)
-    fetch_direct_timeline(user)
-    fetch_public_timeline(user)
-    fetch_public_timeline_with_filter(user)
-    fetch_public_timeline(user, :with_blocks)
-    fetch_public_timeline(user, :local)
-    fetch_public_timeline(user, :tag)
-    fetch_notifications(user)
-    fetch_favourites(user)
-    fetch_long_thread(user)
-    fetch_timelines_with_reply_filtering(user)
-  end
-
-  defp render_views(user) do
-    render_timelines(user)
-    render_long_thread(user)
-  end
-
-  defp opts_for_home_timeline(user) do
-    %{
-      blocking_user: user,
-      count: "20",
-      muting_user: user,
-      type: ["Create", "Announce"],
-      user: user,
-      with_muted: true
+  def query_timelines(user) do
+    home_timeline_params = %{
+      "count" => 20,
+      "with_muted" => true,
+      "type" => ["Create", "Announce"],
+      "blocking_user" => user,
+      "muting_user" => user,
+      "user" => user
     }
-  end
 
-  defp fetch_home_timeline(user, title_end \\ "") do
-    opts = opts_for_home_timeline(user)
-
-    recipients = [user.ap_id | User.following(user)]
-
-    first_page_last =
-      ActivityPub.fetch_activities(recipients, opts) |> Enum.reverse() |> List.last()
-
-    second_page_last =
-      ActivityPub.fetch_activities(recipients, Map.put(opts, :max_id, first_page_last.id))
-      |> Enum.reverse()
-      |> List.last()
-
-    third_page_last =
-      ActivityPub.fetch_activities(recipients, Map.put(opts, :max_id, second_page_last.id))
-      |> Enum.reverse()
-      |> List.last()
-
-    forth_page_last =
-      ActivityPub.fetch_activities(recipients, Map.put(opts, :max_id, third_page_last.id))
-      |> Enum.reverse()
-      |> List.last()
-
-    title = "home timeline " <> title_end
-
-    Benchee.run(
-      %{
-        title => fn opts -> ActivityPub.fetch_activities(recipients, opts) end
-      },
-      inputs: %{
-        "1 page" => opts,
-        "2 page" => Map.put(opts, :max_id, first_page_last.id),
-        "3 page" => Map.put(opts, :max_id, second_page_last.id),
-        "4 page" => Map.put(opts, :max_id, third_page_last.id),
-        "5 page" => Map.put(opts, :max_id, forth_page_last.id),
-        "1 page only media" => Map.put(opts, :only_media, true),
-        "2 page only media" =>
-          Map.put(opts, :max_id, first_page_last.id) |> Map.put(:only_media, true),
-        "3 page only media" =>
-          Map.put(opts, :max_id, second_page_last.id) |> Map.put(:only_media, true),
-        "4 page only media" =>
-          Map.put(opts, :max_id, third_page_last.id) |> Map.put(:only_media, true),
-        "5 page only media" =>
-          Map.put(opts, :max_id, forth_page_last.id) |> Map.put(:only_media, true)
-      },
-      formatters: formatters()
-    )
-  end
-
-  defp fetch_home_timeline_with_filter(user) do
-    {:ok, filter} = create_filter(user)
-
-    fetch_home_timeline(user, "with filters")
-
-    delete_filter(filter)
-  end
-
-  defp opts_for_direct_timeline(user) do
-    %{
-      visibility: "direct",
-      blocking_user: user,
-      count: "20",
-      type: "Create",
-      user: user,
-      with_muted: true
+    mastodon_public_timeline_params = %{
+      "count" => 20,
+      "local_only" => true,
+      "only_media" => "false",
+      "type" => ["Create", "Announce"],
+      "with_muted" => "true",
+      "blocking_user" => user,
+      "muting_user" => user
     }
-  end
 
-  defp fetch_direct_timeline(user) do
-    recipients = [user.ap_id]
-
-    opts = opts_for_direct_timeline(user)
-
-    first_page_last =
-      recipients
-      |> ActivityPub.fetch_activities_query(opts)
-      |> Pagination.fetch_paginated(opts)
-      |> List.last()
-
-    opts2 = Map.put(opts, :max_id, first_page_last.id)
-
-    second_page_last =
-      recipients
-      |> ActivityPub.fetch_activities_query(opts2)
-      |> Pagination.fetch_paginated(opts2)
-      |> List.last()
-
-    opts3 = Map.put(opts, :max_id, second_page_last.id)
-
-    third_page_last =
-      recipients
-      |> ActivityPub.fetch_activities_query(opts3)
-      |> Pagination.fetch_paginated(opts3)
-      |> List.last()
-
-    opts4 = Map.put(opts, :max_id, third_page_last.id)
-
-    forth_page_last =
-      recipients
-      |> ActivityPub.fetch_activities_query(opts4)
-      |> Pagination.fetch_paginated(opts4)
-      |> List.last()
-
-    Benchee.run(
-      %{
-        "direct timeline" => fn opts ->
-          ActivityPub.fetch_activities_query(recipients, opts) |> Pagination.fetch_paginated(opts)
-        end
-      },
-      inputs: %{
-        "1 page" => opts,
-        "2 page" => opts2,
-        "3 page" => opts3,
-        "4 page" => opts4,
-        "5 page" => Map.put(opts4, :max_id, forth_page_last.id)
-      },
-      formatters: formatters()
-    )
-  end
-
-  defp opts_for_public_timeline(user) do
-    %{
-      type: ["Create", "Announce"],
-      local_only: false,
-      blocking_user: user,
-      muting_user: user
+    mastodon_federated_timeline_params = %{
+      "count" => 20,
+      "only_media" => "false",
+      "type" => ["Create", "Announce"],
+      "with_muted" => "true",
+      "blocking_user" => user,
+      "muting_user" => user
     }
-  end
 
-  defp opts_for_public_timeline(user, :local) do
-    %{
-      type: ["Create", "Announce"],
-      local_only: true,
-      blocking_user: user,
-      muting_user: user
-    }
-  end
-
-  defp opts_for_public_timeline(user, :tag) do
-    %{
-      blocking_user: user,
-      count: "20",
-      local_only: nil,
-      muting_user: user,
-      tag: ["tag"],
-      tag_all: [],
-      tag_reject: [],
-      type: "Create",
-      user: user,
-      with_muted: true
-    }
-  end
-
-  defp fetch_public_timeline(user) do
-    opts = opts_for_public_timeline(user)
-
-    fetch_public_timeline(opts, "public timeline")
-  end
-
-  defp fetch_public_timeline_with_filter(user) do
-    {:ok, filter} = create_filter(user)
-    opts = opts_for_public_timeline(user)
-
-    fetch_public_timeline(opts, "public timeline with filters")
-    delete_filter(filter)
-  end
-
-  defp fetch_public_timeline(user, :local) do
-    opts = opts_for_public_timeline(user, :local)
-
-    fetch_public_timeline(opts, "public timeline only local")
-  end
-
-  defp fetch_public_timeline(user, :tag) do
-    opts = opts_for_public_timeline(user, :tag)
-
-    fetch_public_timeline(opts, "hashtag timeline")
-  end
-
-  defp fetch_public_timeline(user, :only_media) do
-    opts = opts_for_public_timeline(user) |> Map.put(:only_media, true)
-
-    fetch_public_timeline(opts, "public timeline only media")
-  end
-
-  defp fetch_public_timeline(user, :with_blocks) do
-    opts = opts_for_public_timeline(user)
-
-    remote_non_friends = Agent.get(:non_friends_remote, & &1)
+    following = User.following(user)
 
     Benchee.run(%{
-      "public timeline without blocks" => fn ->
-        ActivityPub.fetch_public_activities(opts)
+      "User home timeline" => fn ->
+        Pleroma.Web.ActivityPub.ActivityPub.fetch_activities(
+          following,
+          home_timeline_params
+        )
+      end,
+      "User mastodon public timeline" => fn ->
+        Pleroma.Web.ActivityPub.ActivityPub.fetch_public_activities(
+          mastodon_public_timeline_params
+        )
+      end,
+      "User mastodon federated public timeline" => fn ->
+        Pleroma.Web.ActivityPub.ActivityPub.fetch_public_activities(
+          mastodon_federated_timeline_params
+        )
       end
     })
 
-    Enum.each(remote_non_friends, fn non_friend ->
-      {:ok, _} = User.block(user, non_friend)
-    end)
-
-    user = User.get_by_id(user.id)
-
-    opts = Map.put(opts, :blocking_user, user)
-
-    Benchee.run(%{
-      "public timeline with user block" => fn ->
-        ActivityPub.fetch_public_activities(opts)
-      end
-    })
-
-    domains =
-      Enum.reduce(remote_non_friends, [], fn non_friend, domains ->
-        {:ok, _user} = User.unblock(user, non_friend)
-        %{host: host} = URI.parse(non_friend.ap_id)
-        [host | domains]
-      end)
-
-    domains = Enum.uniq(domains)
-
-    Enum.each(domains, fn domain ->
-      {:ok, _} = User.block_domain(user, domain)
-    end)
-
-    user = User.get_by_id(user.id)
-    opts = Map.put(opts, :blocking_user, user)
-
-    Benchee.run(%{
-      "public timeline with domain block" => fn ->
-        ActivityPub.fetch_public_activities(opts)
-      end
-    })
-  end
-
-  defp fetch_public_timeline(opts, title) when is_binary(title) do
-    first_page_last = ActivityPub.fetch_public_activities(opts) |> List.last()
-
-    second_page_last =
-      ActivityPub.fetch_public_activities(Map.put(opts, :max_id, first_page_last.id))
-      |> List.last()
-
-    third_page_last =
-      ActivityPub.fetch_public_activities(Map.put(opts, :max_id, second_page_last.id))
-      |> List.last()
-
-    forth_page_last =
-      ActivityPub.fetch_public_activities(Map.put(opts, :max_id, third_page_last.id))
-      |> List.last()
-
-    Benchee.run(
-      %{
-        title => fn opts ->
-          ActivityPub.fetch_public_activities(opts)
-        end
-      },
-      inputs: %{
-        "1 page" => opts,
-        "2 page" => Map.put(opts, :max_id, first_page_last.id),
-        "3 page" => Map.put(opts, :max_id, second_page_last.id),
-        "4 page" => Map.put(opts, :max_id, third_page_last.id),
-        "5 page" => Map.put(opts, :max_id, forth_page_last.id)
-      },
-      formatters: formatters()
-    )
-  end
-
-  defp opts_for_notifications do
-    %{count: "20", with_muted: true}
-  end
-
-  defp fetch_notifications(user) do
-    opts = opts_for_notifications()
-
-    first_page_last = MastodonAPI.get_notifications(user, opts) |> List.last()
-
-    second_page_last =
-      MastodonAPI.get_notifications(user, Map.put(opts, :max_id, first_page_last.id))
-      |> List.last()
-
-    third_page_last =
-      MastodonAPI.get_notifications(user, Map.put(opts, :max_id, second_page_last.id))
-      |> List.last()
-
-    forth_page_last =
-      MastodonAPI.get_notifications(user, Map.put(opts, :max_id, third_page_last.id))
-      |> List.last()
-
-    Benchee.run(
-      %{
-        "Notifications" => fn opts ->
-          MastodonAPI.get_notifications(user, opts)
-        end
-      },
-      inputs: %{
-        "1 page" => opts,
-        "2 page" => Map.put(opts, :max_id, first_page_last.id),
-        "3 page" => Map.put(opts, :max_id, second_page_last.id),
-        "4 page" => Map.put(opts, :max_id, third_page_last.id),
-        "5 page" => Map.put(opts, :max_id, forth_page_last.id)
-      },
-      formatters: formatters()
-    )
-  end
-
-  defp fetch_favourites(user) do
-    first_page_last = ActivityPub.fetch_favourites(user) |> List.last()
-
-    second_page_last =
-      ActivityPub.fetch_favourites(user, %{:max_id => first_page_last.id}) |> List.last()
-
-    third_page_last =
-      ActivityPub.fetch_favourites(user, %{:max_id => second_page_last.id}) |> List.last()
-
-    forth_page_last =
-      ActivityPub.fetch_favourites(user, %{:max_id => third_page_last.id}) |> List.last()
-
-    Benchee.run(
-      %{
-        "Favourites" => fn opts ->
-          ActivityPub.fetch_favourites(user, opts)
-        end
-      },
-      inputs: %{
-        "1 page" => %{},
-        "2 page" => %{:max_id => first_page_last.id},
-        "3 page" => %{:max_id => second_page_last.id},
-        "4 page" => %{:max_id => third_page_last.id},
-        "5 page" => %{:max_id => forth_page_last.id}
-      },
-      formatters: formatters()
-    )
-  end
-
-  defp opts_for_long_thread(user) do
-    %{
-      blocking_user: user,
-      user: user
-    }
-  end
-
-  defp fetch_long_thread(user) do
-    %{public_thread: public, private_thread: private} =
-      Agent.get(:benchmark_state, fn state -> state end)
-
-    opts = opts_for_long_thread(user)
-
-    private_input = {private.data["context"], Map.put(opts, :exclude_id, private.id)}
-
-    public_input = {public.data["context"], Map.put(opts, :exclude_id, public.id)}
-
-    Benchee.run(
-      %{
-        "fetch context" => fn {context, opts} ->
-          ActivityPub.fetch_activities_for_context(context, opts)
-        end
-      },
-      inputs: %{
-        "Private long thread" => private_input,
-        "Public long thread" => public_input
-      },
-      formatters: formatters()
-    )
-  end
-
-  defp render_timelines(user) do
-    opts = opts_for_home_timeline(user)
-
-    recipients = [user.ap_id | User.following(user)]
-
-    home_activities = ActivityPub.fetch_activities(recipients, opts) |> Enum.reverse()
-
-    recipients = [user.ap_id]
-
-    opts = opts_for_direct_timeline(user)
-
-    direct_activities =
-      recipients
-      |> ActivityPub.fetch_activities_query(opts)
-      |> Pagination.fetch_paginated(opts)
-
-    opts = opts_for_public_timeline(user)
-
-    public_activities = ActivityPub.fetch_public_activities(opts)
-
-    opts = opts_for_public_timeline(user, :tag)
-
-    tag_activities = ActivityPub.fetch_public_activities(opts)
-
-    opts = opts_for_notifications()
-
-    notifications = MastodonAPI.get_notifications(user, opts)
-
-    favourites = ActivityPub.fetch_favourites(user)
-
-    Benchee.run(
-      %{
-        "Rendering home timeline" => fn ->
-          StatusView.render("index.json", %{
-            activities: home_activities,
-            for: user,
-            as: :activity
-          })
-        end,
-        "Rendering direct timeline" => fn ->
-          StatusView.render("index.json", %{
-            activities: direct_activities,
-            for: user,
-            as: :activity
-          })
-        end,
-        "Rendering public timeline" => fn ->
-          StatusView.render("index.json", %{
-            activities: public_activities,
-            for: user,
-            as: :activity
-          })
-        end,
-        "Rendering tag timeline" => fn ->
-          StatusView.render("index.json", %{
-            activities: tag_activities,
-            for: user,
-            as: :activity
-          })
-        end,
-        "Rendering notifications" => fn ->
-          Pleroma.Web.MastodonAPI.NotificationView.render("index.json", %{
-            notifications: notifications,
-            for: user
-          })
-        end,
-        "Rendering favourites timeline" => fn ->
-          StatusView.render("index.json", %{
-            activities: favourites,
-            for: user,
-            as: :activity
-          })
-        end
-      },
-      formatters: formatters()
-    )
-  end
-
-  defp render_long_thread(user) do
-    %{public_thread: public, private_thread: private} =
-      Agent.get(:benchmark_state, fn state -> state end)
-
-    opts = %{for: user}
-    public_activity = Activity.get_by_id_with_object(public.id)
-    private_activity = Activity.get_by_id_with_object(private.id)
-
-    Benchee.run(
-      %{
-        "render" => fn opts ->
-          StatusView.render("show.json", opts)
-        end
-      },
-      inputs: %{
-        "Public root" => Map.put(opts, :activity, public_activity),
-        "Private root" => Map.put(opts, :activity, private_activity)
-      },
-      formatters: formatters()
-    )
-
-    fetch_opts = opts_for_long_thread(user)
-
-    public_context =
-      ActivityPub.fetch_activities_for_context(
-        public.data["context"],
-        Map.put(fetch_opts, :exclude_id, public.id)
+    home_activities =
+      Pleroma.Web.ActivityPub.ActivityPub.fetch_activities(
+        following,
+        home_timeline_params
       )
 
-    private_context =
-      ActivityPub.fetch_activities_for_context(
-        private.data["context"],
-        Map.put(fetch_opts, :exclude_id, private.id)
+    public_activities =
+      Pleroma.Web.ActivityPub.ActivityPub.fetch_public_activities(mastodon_public_timeline_params)
+
+    public_federated_activities =
+      Pleroma.Web.ActivityPub.ActivityPub.fetch_public_activities(
+        mastodon_federated_timeline_params
       )
 
-    Benchee.run(
-      %{
-        "render" => fn opts ->
-          StatusView.render("context.json", opts)
-        end
-      },
-      inputs: %{
-        "Public context" => %{user: user, activity: public_activity, activities: public_context},
-        "Private context" => %{
-          user: user,
-          activity: private_activity,
-          activities: private_context
+    Benchee.run(%{
+      "Rendering home timeline" => fn ->
+        Pleroma.Web.MastodonAPI.StatusView.render("index.json", %{
+          activities: home_activities,
+          for: user,
+          as: :activity
+        })
+      end,
+      "Rendering public timeline" => fn ->
+        Pleroma.Web.MastodonAPI.StatusView.render("index.json", %{
+          activities: public_activities,
+          for: user,
+          as: :activity
+        })
+      end,
+      "Rendering public federated timeline" => fn ->
+        Pleroma.Web.MastodonAPI.StatusView.render("index.json", %{
+          activities: public_federated_activities,
+          for: user,
+          as: :activity
+        })
+      end,
+      "Rendering favorites timeline" => fn ->
+        conn = Phoenix.ConnTest.build_conn(:get, "http://localhost:4001/api/v1/favourites", nil)
+        Pleroma.Web.MastodonAPI.StatusController.favourites(
+          %Plug.Conn{conn |
+                     assigns: %{user: user},
+                     query_params:  %{"limit" => "0"},
+                     body_params: %{},
+                     cookies: %{},
+                     params: %{},
+                     path_params: %{},
+                     private: %{
+                       Pleroma.Web.Router => {[], %{}},
+                       phoenix_router: Pleroma.Web.Router,
+                       phoenix_action: :favourites,
+                       phoenix_controller: Pleroma.Web.MastodonAPI.StatusController,
+                       phoenix_endpoint: Pleroma.Web.Endpoint,
+                       phoenix_format: "json",
+                       phoenix_layout: {Pleroma.Web.LayoutView, "app.html"},
+                       phoenix_recycled: true,
+
+                       phoenix_view: Pleroma.Web.MastodonAPI.StatusView,
+                       plug_session: %{"user_id" => user.id},
+                       plug_session_fetch: :done,
+                       plug_session_info: :write,
+                       plug_skip_csrf_protection: true
+                     }
+          },
+          %{})
+      end,
+    })
+  end
+
+  def query_notifications(user) do
+    without_muted_params = %{"count" => "20", "with_muted" => "false"}
+    with_muted_params = %{"count" => "20", "with_muted" => "true"}
+
+    Benchee.run(%{
+      "Notifications without muted" => fn ->
+        Pleroma.Web.MastodonAPI.MastodonAPI.get_notifications(user, without_muted_params)
+      end,
+      "Notifications with muted" => fn ->
+        Pleroma.Web.MastodonAPI.MastodonAPI.get_notifications(user, with_muted_params)
+      end
+    })
+
+    without_muted_notifications =
+      Pleroma.Web.MastodonAPI.MastodonAPI.get_notifications(user, without_muted_params)
+
+    with_muted_notifications =
+      Pleroma.Web.MastodonAPI.MastodonAPI.get_notifications(user, with_muted_params)
+
+    Benchee.run(%{
+      "Render notifications without muted" => fn ->
+        Pleroma.Web.MastodonAPI.NotificationView.render("index.json", %{
+          notifications: without_muted_notifications,
+          for: user
+        })
+      end,
+      "Render notifications with muted" => fn ->
+        Pleroma.Web.MastodonAPI.NotificationView.render("index.json", %{
+          notifications: with_muted_notifications,
+          for: user
+        })
+      end
+    })
+  end
+
+  def query_dms(user) do
+    params = %{
+      "count" => "20",
+      "with_muted" => "true",
+      "type" => "Create",
+      "blocking_user" => user,
+      "user" => user,
+      visibility: "direct"
+    }
+
+    Benchee.run(%{
+      "Direct messages with muted" => fn ->
+        Pleroma.Web.ActivityPub.ActivityPub.fetch_activities_query([user.ap_id], params)
+        |> Pleroma.Pagination.fetch_paginated(params)
+      end,
+      "Direct messages without muted" => fn ->
+        Pleroma.Web.ActivityPub.ActivityPub.fetch_activities_query([user.ap_id], params)
+        |> Pleroma.Pagination.fetch_paginated(Map.put(params, "with_muted", false))
+      end
+    })
+
+    dms_with_muted =
+      Pleroma.Web.ActivityPub.ActivityPub.fetch_activities_query([user.ap_id], params)
+      |> Pleroma.Pagination.fetch_paginated(params)
+
+    dms_without_muted =
+      Pleroma.Web.ActivityPub.ActivityPub.fetch_activities_query([user.ap_id], params)
+      |> Pleroma.Pagination.fetch_paginated(Map.put(params, "with_muted", false))
+
+    Benchee.run(%{
+      "Rendering dms with muted" => fn ->
+        Pleroma.Web.MastodonAPI.StatusView.render("index.json", %{
+          activities: dms_with_muted,
+          for: user,
+          as: :activity
+        })
+      end,
+      "Rendering dms without muted" => fn ->
+        Pleroma.Web.MastodonAPI.StatusView.render("index.json", %{
+          activities: dms_without_muted,
+          for: user,
+          as: :activity
+        })
+      end
+    })
+  end
+
+  def query_long_thread(user, activity) do
+    Benchee.run(%{
+      "Fetch main post" => fn ->
+        Pleroma.Activity.get_by_id_with_object(activity.id)
+      end,
+      "Fetch context of main post" => fn ->
+        Pleroma.Web.ActivityPub.ActivityPub.fetch_activities_for_context(
+          activity.data["context"],
+          %{
+            "blocking_user" => user,
+            "user" => user,
+            "exclude_id" => activity.id
+          }
+        )
+      end
+    })
+
+    activity = Pleroma.Activity.get_by_id_with_object(activity.id)
+
+    context =
+      Pleroma.Web.ActivityPub.ActivityPub.fetch_activities_for_context(
+        activity.data["context"],
+        %{
+          "blocking_user" => user,
+          "user" => user,
+          "exclude_id" => activity.id
         }
-      },
-      formatters: formatters()
-    )
-  end
+      )
 
-  defp fetch_timelines_with_reply_filtering(user) do
-    public_params = opts_for_public_timeline(user)
-
-    Benchee.run(
-      %{
-        "Public timeline without reply filtering" => fn ->
-          ActivityPub.fetch_public_activities(public_params)
-        end,
-        "Public timeline with reply filtering - following" => fn ->
-          public_params
-          |> Map.put(:reply_visibility, "following")
-          |> Map.put(:reply_filtering_user, user)
-          |> ActivityPub.fetch_public_activities()
-        end,
-        "Public timeline with reply filtering - self" => fn ->
-          public_params
-          |> Map.put(:reply_visibility, "self")
-          |> Map.put(:reply_filtering_user, user)
-          |> ActivityPub.fetch_public_activities()
-        end
-      },
-      formatters: formatters()
-    )
-
-    private_params = opts_for_home_timeline(user)
-
-    recipients = [user.ap_id | User.following(user)]
-
-    Benchee.run(
-      %{
-        "Home timeline without reply filtering" => fn ->
-          ActivityPub.fetch_activities(recipients, private_params)
-        end,
-        "Home timeline with reply filtering - following" => fn ->
-          private_params =
-            private_params
-            |> Map.put(:reply_filtering_user, user)
-            |> Map.put(:reply_visibility, "following")
-
-          ActivityPub.fetch_activities(recipients, private_params)
-        end,
-        "Home timeline with reply filtering - self" => fn ->
-          private_params =
-            private_params
-            |> Map.put(:reply_filtering_user, user)
-            |> Map.put(:reply_visibility, "self")
-
-          ActivityPub.fetch_activities(recipients, private_params)
-        end
-      },
-      formatters: formatters()
-    )
+    Benchee.run(%{
+      "Render status" => fn ->
+        Pleroma.Web.MastodonAPI.StatusView.render("show.json", %{
+          activity: activity,
+          for: user
+        })
+      end,
+      "Render context" => fn ->
+        Pleroma.Web.MastodonAPI.StatusView.render(
+          "index.json",
+          for: user,
+          activities: context,
+          as: :activity
+        )
+        |> Enum.reverse()
+      end
+    })
   end
 end

benchmarks/load_testing/generator.ex

@@ -0,0 +1,409 @@
+defmodule Pleroma.LoadTesting.Generator do
+  use Pleroma.LoadTesting.Helper
+  alias Pleroma.Web.CommonAPI
+
+  def generate_like_activities(user, posts) do
+    count_likes = Kernel.trunc(length(posts) / 4)
+    IO.puts("Starting generating #{count_likes} like activities...")
+
+    {time, _} =
+      :timer.tc(fn ->
+        Task.async_stream(
+          Enum.take_random(posts, count_likes),
+          fn post -> {:ok, _, _} = CommonAPI.favorite(post.id, user) end,
+          max_concurrency: 10,
+          timeout: 30_000
+        )
+        |> Stream.run()
+      end)
+
+    IO.puts("Inserting like activities take #{to_sec(time)} sec.\n")
+  end
+
+  def generate_users(opts) do
+    IO.puts("Starting generating #{opts[:users_max]} users...")
+    {time, _} = :timer.tc(fn -> do_generate_users(opts) end)
+
+    IO.puts("Inserting users take #{to_sec(time)} sec.\n")
+  end
+
+  defp do_generate_users(opts) do
+    max = Keyword.get(opts, :users_max)
+
+    Task.async_stream(
+      1..max,
+      &generate_user_data(&1),
+      max_concurrency: 10,
+      timeout: 30_000
+    )
+    |> Enum.to_list()
+  end
+
+  defp generate_user_data(i) do
+    remote = Enum.random([true, false])
+
+    user = %User{
+      name: "Test テスト User #{i}",
+      email: "user#{i}@example.com",
+      nickname: "nick#{i}",
+      password_hash:
+        "$pbkdf2-sha512$160000$bU.OSFI7H/yqWb5DPEqyjw$uKp/2rmXw12QqnRRTqTtuk2DTwZfF8VR4MYW2xMeIlqPR/UX1nT1CEKVUx2CowFMZ5JON8aDvURrZpJjSgqXrg",
+      bio: "Tester Number #{i}",
+      local: remote
+    }
+
+    user_urls =
+      if remote do
+        base_url =
+          Enum.random(["https://domain1.com", "https://domain2.com", "https://domain3.com"])
+
+        ap_id = "#{base_url}/users/#{user.nickname}"
+
+        %{
+          ap_id: ap_id,
+          follower_address: ap_id <> "/followers",
+          following_address: ap_id <> "/following"
+        }
+      else
+        %{
+          ap_id: User.ap_id(user),
+          follower_address: User.ap_followers(user),
+          following_address: User.ap_following(user)
+        }
+      end
+
+    user = Map.merge(user, user_urls)
+
+    Repo.insert!(user)
+  end
+
+  def generate_activities(user, users) do
+    do_generate_activities(user, users)
+  end
+
+  defp do_generate_activities(user, users) do
+    IO.puts("Starting generating 20000 common activities...")
+
+    {time, _} =
+      :timer.tc(fn ->
+        Task.async_stream(
+          1..20_000,
+          fn _ ->
+            do_generate_activity([user | users])
+          end,
+          max_concurrency: 10,
+          timeout: 30_000
+        )
+        |> Stream.run()
+      end)
+
+    IO.puts("Inserting common activities take #{to_sec(time)} sec.\n")
+
+    IO.puts("Starting generating 20000 activities with mentions...")
+
+    {time, _} =
+      :timer.tc(fn ->
+        Task.async_stream(
+          1..20_000,
+          fn _ ->
+            do_generate_activity_with_mention(user, users)
+          end,
+          max_concurrency: 10,
+          timeout: 30_000
+        )
+        |> Stream.run()
+      end)
+
+    IO.puts("Inserting activities with menthions take #{to_sec(time)} sec.\n")
+
+    IO.puts("Starting generating 10000 activities with threads...")
+
+    {time, _} =
+      :timer.tc(fn ->
+        Task.async_stream(
+          1..10_000,
+          fn _ ->
+            do_generate_threads([user | users])
+          end,
+          max_concurrency: 10,
+          timeout: 30_000
+        )
+        |> Stream.run()
+      end)
+
+    IO.puts("Inserting activities with threads take #{to_sec(time)} sec.\n")
+  end
+
+  defp do_generate_activity(users) do
+    post = %{
+      "status" => "Some status without mention with random user"
+    }
+
+    CommonAPI.post(Enum.random(users), post)
+  end
+
+  def generate_power_intervals(opts \\ []) do
+    count = Keyword.get(opts, :count, 20)
+    power = Keyword.get(opts, :power, 2)
+    IO.puts("Generating #{count} intervals for a power #{power} series...")
+    counts = Enum.map(1..count, fn n -> :math.pow(n, power) end)
+    sum = Enum.sum(counts)
+
+    densities =
+      Enum.map(counts, fn c ->
+        c / sum
+      end)
+
+    densities
+    |> Enum.reduce(0, fn density, acc ->
+      if acc == 0 do
+        [{0, density}]
+      else
+        [{_, lower} | _] = acc
+        [{lower, lower + density} | acc]
+      end
+    end)
+    |> Enum.reverse()
+  end
+
+  def generate_tagged_activities(opts \\ []) do
+    tag_count = Keyword.get(opts, :tag_count, 20)
+    users = Keyword.get(opts, :users, Repo.all(User))
+    activity_count = Keyword.get(opts, :count, 200_000)
+
+    intervals = generate_power_intervals(count: tag_count)
+
+    IO.puts(
+      "Generating #{activity_count} activities using #{tag_count} different tags of format `tag_n`, starting at tag_0"
+    )
+
+    Enum.each(1..activity_count, fn _ ->
+      random = :rand.uniform()
+      i = Enum.find_index(intervals, fn {lower, upper} -> lower <= random && upper > random end)
+      CommonAPI.post(Enum.random(users), %{"status" => "a post with the tag #tag_#{i}"})
+    end)
+  end
+
+  defp do_generate_activity_with_mention(user, users) do
+    mentions_cnt = Enum.random([2, 3, 4, 5])
+    with_user = Enum.random([true, false])
+    users = Enum.shuffle(users)
+    mentions_users = Enum.take(users, mentions_cnt)
+    mentions_users = if with_user, do: [user | mentions_users], else: mentions_users
+
+    mentions_str =
+      Enum.map(mentions_users, fn user -> "@" <> user.nickname end) |> Enum.join(", ")
+
+    post = %{
+      "status" => mentions_str <> "some status with mentions random users"
+    }
+
+    CommonAPI.post(Enum.random(users), post)
+  end
+
+  defp do_generate_threads(users) do
+    thread_length = Enum.random([2, 3, 4, 5])
+    actor = Enum.random(users)
+
+    post = %{
+      "status" => "Start of the thread"
+    }
+
+    {:ok, activity} = CommonAPI.post(actor, post)
+
+    Enum.each(1..thread_length, fn _ ->
+      user = Enum.random(users)
+
+      post = %{
+        "status" => "@#{actor.nickname} reply to thread",
+        "in_reply_to_status_id" => activity.id
+      }
+
+      CommonAPI.post(user, post)
+    end)
+  end
+
+  def generate_remote_activities(user, users) do
+    do_generate_remote_activities(user, users)
+  end
+
+  defp do_generate_remote_activities(user, users) do
+    IO.puts("Starting generating 10000 remote activities...")
+
+    {time, _} =
+      :timer.tc(fn ->
+        Task.async_stream(
+          1..10_000,
+          fn i ->
+            do_generate_remote_activity(i, user, users)
+          end,
+          max_concurrency: 10,
+          timeout: 30_000
+        )
+        |> Stream.run()
+      end)
+
+    IO.puts("Inserting remote activities take #{to_sec(time)} sec.\n")
+  end
+
+  defp do_generate_remote_activity(i, user, users) do
+    actor = Enum.random(users)
+    %{host: host} = URI.parse(actor.ap_id)
+    date = Date.utc_today()
+    datetime = DateTime.utc_now()
+
+    map = %{
+      "actor" => actor.ap_id,
+      "cc" => [actor.follower_address, user.ap_id],
+      "context" => "tag:mastodon.example.org,#{date}:objectId=#{i}:objectType=Conversation",
+      "id" => actor.ap_id <> "/statuses/#{i}/activity",
+      "object" => %{
+        "actor" => actor.ap_id,
+        "atomUri" => actor.ap_id <> "/statuses/#{i}",
+        "attachment" => [],
+        "attributedTo" => actor.ap_id,
+        "bcc" => [],
+        "bto" => [],
+        "cc" => [actor.follower_address, user.ap_id],
+        "content" =>
+          "<p><span class=\"h-card\"><a href=\"" <>
+            user.ap_id <>
+            "\" class=\"u-url mention\">@<span>" <> user.nickname <> "</span></a></span></p>",
+        "context" => "tag:mastodon.example.org,#{date}:objectId=#{i}:objectType=Conversation",
+        "conversation" =>
+          "tag:mastodon.example.org,#{date}:objectId=#{i}:objectType=Conversation",
+        "emoji" => %{},
+        "id" => actor.ap_id <> "/statuses/#{i}",
+        "inReplyTo" => nil,
+        "inReplyToAtomUri" => nil,
+        "published" => datetime,
+        "sensitive" => true,
+        "summary" => "cw",
+        "tag" => [
+          %{
+            "href" => user.ap_id,
+            "name" => "@#{user.nickname}@#{host}",
+            "type" => "Mention"
+          }
+        ],
+        "to" => ["https://www.w3.org/ns/activitystreams#Public"],
+        "type" => "Note",
+        "url" => "http://#{host}/@#{actor.nickname}/#{i}"
+      },
+      "published" => datetime,
+      "to" => ["https://www.w3.org/ns/activitystreams#Public"],
+      "type" => "Create"
+    }
+
+    Pleroma.Web.ActivityPub.ActivityPub.insert(map, false)
+  end
+
+  def generate_dms(user, users, opts) do
+    IO.puts("Starting generating #{opts[:dms_max]} DMs")
+    {time, _} = :timer.tc(fn -> do_generate_dms(user, users, opts) end)
+    IO.puts("Inserting dms take #{to_sec(time)} sec.\n")
+  end
+
+  defp do_generate_dms(user, users, opts) do
+    Task.async_stream(
+      1..opts[:dms_max],
+      fn _ ->
+        do_generate_dm(user, users)
+      end,
+      max_concurrency: 10,
+      timeout: 30_000
+    )
+    |> Stream.run()
+  end
+
+  defp do_generate_dm(user, users) do
+    post = %{
+      "status" => "@#{user.nickname} some direct message",
+      "visibility" => "direct"
+    }
+
+    CommonAPI.post(Enum.random(users), post)
+  end
+
+  def generate_long_thread(user, users, opts) do
+    IO.puts("Starting generating long thread with #{opts[:thread_length]} replies")
+    {time, activity} = :timer.tc(fn -> do_generate_long_thread(user, users, opts) end)
+    IO.puts("Inserting long thread replies take #{to_sec(time)} sec.\n")
+    {:ok, activity}
+  end
+
+  defp do_generate_long_thread(user, users, opts) do
+    {:ok, %{id: id} = activity} = CommonAPI.post(user, %{"status" => "Start of long thread"})
+
+    Task.async_stream(
+      1..opts[:thread_length],
+      fn _ -> do_generate_thread(users, id) end,
+      max_concurrency: 10,
+      timeout: 30_000
+    )
+    |> Stream.run()
+
+    activity
+  end
+
+  defp do_generate_thread(users, activity_id) do
+    CommonAPI.post(Enum.random(users), %{
+      "status" => "reply to main post",
+      "in_reply_to_status_id" => activity_id
+    })
+  end
+
+  def generate_non_visible_message(user, users) do
+    IO.puts("Starting generating 1000 non visible posts")
+
+    {time, _} =
+      :timer.tc(fn ->
+        do_generate_non_visible_posts(user, users)
+      end)
+
+    IO.puts("Inserting non visible posts take #{to_sec(time)} sec.\n")
+  end
+
+  defp do_generate_non_visible_posts(user, users) do
+    [not_friend | users] = users
+
+    make_friends(user, users)
+
+    Task.async_stream(1..1000, fn _ -> do_generate_non_visible_post(not_friend, users) end,
+      max_concurrency: 10,
+      timeout: 30_000
+    )
+    |> Stream.run()
+  end
+
+  defp make_friends(_user, []), do: nil
+
+  defp make_friends(user, [friend | users]) do
+    {:ok, _} = User.follow(user, friend)
+    {:ok, _} = User.follow(friend, user)
+    make_friends(user, users)
+  end
+
+  defp do_generate_non_visible_post(not_friend, users) do
+    post = %{
+      "status" => "some non visible post",
+      "visibility" => "private"
+    }
+
+    {:ok, activity} = CommonAPI.post(not_friend, post)
+
+    thread_length = Enum.random([2, 3, 4, 5])
+
+    Enum.each(1..thread_length, fn _ ->
+      user = Enum.random(users)
+
+      post = %{
+        "status" => "@#{not_friend.nickname} reply to non visible post",
+        "in_reply_to_status_id" => activity.id,
+        "visibility" => "private"
+      }
+
+      CommonAPI.post(user, post)
+    end)
+  end
+end

benchmarks/load_testing/helper.ex

@@ -1,14 +1,11 @@
 defmodule Pleroma.LoadTesting.Helper do
-  alias Ecto.Adapters.SQL
-  alias Pleroma.Repo
+  defmacro __using__(_) do
+    quote do
+      import Ecto.Query
+      alias Pleroma.Repo
+      alias Pleroma.User
 
-  def to_sec(microseconds), do: microseconds / 1_000_000
-
-  def clean_tables do
-    IO.puts("Deleting old data...\n")
-    SQL.query!(Repo, "TRUNCATE users CASCADE;")
-    SQL.query!(Repo, "TRUNCATE activities CASCADE;")
-    SQL.query!(Repo, "TRUNCATE objects CASCADE;")
-    SQL.query!(Repo, "TRUNCATE oban_jobs CASCADE;")
+      defp to_sec(microseconds), do: microseconds / 1_000_000
+    end
   end
 end

benchmarks/load_testing/users.ex

@@ -1,189 +0,0 @@
-defmodule Pleroma.LoadTesting.Users do
-  @moduledoc """
-  Module for generating users with friends.
-  """
-  import Ecto.Query
-  import Pleroma.LoadTesting.Helper, only: [to_sec: 1]
-
-  alias Pleroma.Repo
-  alias Pleroma.User
-  alias Pleroma.User.Query
-
-  @defaults [
-    users: 20_000,
-    friends: 100
-  ]
-
-  @max_concurrency 10
-
-  @spec generate(keyword()) :: User.t()
-  def generate(opts \\ []) do
-    opts = Keyword.merge(@defaults, opts)
-
-    generate_users(opts[:users])
-
-    main_user =
-      Repo.one(from(u in User, where: u.local == true, order_by: fragment("RANDOM()"), limit: 1))
-
-    make_friends(main_user, opts[:friends])
-
-    User.get_by_id(main_user.id)
-  end
-
-  def generate_users(max) do
-    IO.puts("Starting generating #{max} users...")
-
-    {time, users} =
-      :timer.tc(fn ->
-        Task.async_stream(
-          1..max,
-          &generate_user(&1),
-          max_concurrency: @max_concurrency,
-          timeout: 30_000
-        )
-        |> Enum.to_list()
-      end)
-
-    IO.puts("Generating users took #{to_sec(time)} sec.\n")
-    users
-  end
-
-  defp generate_user(i) do
-    remote = Enum.random([true, false])
-
-    %User{
-      name: "Test テスト User #{i}",
-      email: "user#{i}@example.com",
-      nickname: "nick#{i}",
-      password_hash: Pleroma.Password.Pbkdf2.hash_pwd_salt("test"),
-      bio: "Tester Number #{i}",
-      local: !remote
-    }
-    |> user_urls()
-    |> Repo.insert!()
-  end
-
-  defp user_urls(%{local: true} = user) do
-    urls = %{
-      ap_id: User.ap_id(user),
-      follower_address: User.ap_followers(user),
-      following_address: User.ap_following(user)
-    }
-
-    Map.merge(user, urls)
-  end
-
-  defp user_urls(%{local: false} = user) do
-    base_domain = Enum.random(["domain1.com", "domain2.com", "domain3.com"])
-
-    ap_id = "https://#{base_domain}/users/#{user.nickname}"
-
-    urls = %{
-      ap_id: ap_id,
-      follower_address: ap_id <> "/followers",
-      following_address: ap_id <> "/following"
-    }
-
-    Map.merge(user, urls)
-  end
-
-  def make_friends(main_user, max) when is_integer(max) do
-    IO.puts("Starting making friends for #{max} users...")
-
-    {time, _} =
-      :timer.tc(fn ->
-        number_of_users =
-          (max / 2)
-          |> Kernel.trunc()
-
-        main_user
-        |> get_users(%{limit: number_of_users, local: :local})
-        |> run_stream(main_user)
-
-        main_user
-        |> get_users(%{limit: number_of_users, local: :external})
-        |> run_stream(main_user)
-      end)
-
-    IO.puts("Making friends took #{to_sec(time)} sec.\n")
-  end
-
-  def make_friends(%User{} = main_user, %User{} = user) do
-    {:ok, _, _} = User.follow(main_user, user)
-    {:ok, _, _} = User.follow(user, main_user)
-  end
-
-  @spec get_users(User.t(), keyword()) :: [User.t()]
-  def get_users(user, opts) do
-    criteria = %{limit: opts[:limit]}
-
-    criteria =
-      if opts[:local] do
-        Map.put(criteria, opts[:local], true)
-      else
-        criteria
-      end
-
-    criteria =
-      if opts[:friends?] do
-        Map.put(criteria, :friends, user)
-      else
-        criteria
-      end
-
-    query =
-      criteria
-      |> Query.build()
-      |> random_without_user(user)
-
-    query =
-      if opts[:friends?] == false do
-        friends_ids =
-          %{friends: user}
-          |> Query.build()
-          |> Repo.all()
-          |> Enum.map(& &1.id)
-
-        from(u in query, where: u.id not in ^friends_ids)
-      else
-        query
-      end
-
-    Repo.all(query)
-  end
-
-  defp random_without_user(query, user) do
-    from(u in query,
-      where: u.id != ^user.id,
-      order_by: fragment("RANDOM()")
-    )
-  end
-
-  defp run_stream(users, main_user) do
-    Task.async_stream(users, &make_friends(main_user, &1),
-      max_concurrency: @max_concurrency,
-      timeout: 30_000
-    )
-    |> Stream.run()
-  end
-
-  @spec prepare_users(User.t(), keyword()) :: map()
-  def prepare_users(user, opts) do
-    friends_limit = opts[:friends_used]
-    non_friends_limit = opts[:non_friends_used]
-
-    %{
-      user: user,
-      friends_local: fetch_users(user, friends_limit, :local, true),
-      friends_remote: fetch_users(user, friends_limit, :external, true),
-      non_friends_local: fetch_users(user, non_friends_limit, :local, false),
-      non_friends_remote: fetch_users(user, non_friends_limit, :external, false)
-    }
-  end
-
-  defp fetch_users(user, limit, local, friends?) do
-    user
-    |> get_users(limit: limit, local: local, friends?: friends?)
-    |> Enum.shuffle()
-  end
-end

benchmarks/mix/tasks/pleroma/benchmarks/tags.ex

@@ -1,10 +1,8 @@
 defmodule Mix.Tasks.Pleroma.Benchmarks.Tags do
   use Mix.Task
-
-  import Pleroma.LoadTesting.Helper, only: [clean_tables: 0]
-  import Ecto.Query
-
   alias Pleroma.Repo
+  alias Pleroma.LoadTesting.Generator
+  import Ecto.Query
 
   def run(_args) do
     Mix.Pleroma.start_pleroma()
@@ -13,8 +11,8 @@ def run(_args) do
     if activities_count == 0 do
       IO.puts("Did not find any activities, cleaning and generating")
       clean_tables()
-      Pleroma.LoadTesting.Users.generate_users(10)
-      Pleroma.LoadTesting.Activities.generate_tagged_activities()
+      Generator.generate_users(users_max: 10)
+      Generator.generate_tagged_activities()
     else
       IO.puts("Found #{activities_count} activities, won't generate new ones")
     end
@@ -36,7 +34,7 @@ def run(_args) do
     Benchee.run(
       %{
         "Hashtag fetching, any" => fn tags ->
-          hashtag_fetching(
+          Pleroma.Web.MastodonAPI.TimelineController.hashtag_fetching(
             %{
               "any" => tags
             },
@@ -46,7 +44,7 @@ def run(_args) do
         end,
         # Will always return zero results because no overlapping hashtags are generated.
         "Hashtag fetching, all" => fn tags ->
-          hashtag_fetching(
+          Pleroma.Web.MastodonAPI.TimelineController.hashtag_fetching(
             %{
               "all" => tags
             },
@@ -66,7 +64,7 @@ def run(_args) do
     Benchee.run(
       %{
         "Hashtag fetching" => fn tag ->
-          hashtag_fetching(
+          Pleroma.Web.MastodonAPI.TimelineController.hashtag_fetching(
             %{
               "tag" => tag
             },
@@ -80,35 +78,10 @@ def run(_args) do
     )
   end
 
-  defp hashtag_fetching(params, user, local_only) do
-    tags =
-      [params["tag"], params["any"]]
-      |> List.flatten()
-      |> Enum.uniq()
-      |> Enum.filter(& &1)
-      |> Enum.map(&String.downcase(&1))
-
-    tag_all =
-      params
-      |> Map.get("all", [])
-      |> Enum.map(&String.downcase(&1))
-
-    tag_reject =
-      params
-      |> Map.get("none", [])
-      |> Enum.map(&String.downcase(&1))
-
-    _activities =
-      %{
-        type: "Create",
-        local_only: local_only,
-        blocking_user: user,
-        muting_user: user,
-        user: user,
-        tag: tags,
-        tag_all: tag_all,
-        tag_reject: tag_reject,
-      }
-      |> Pleroma.Web.ActivityPub.ActivityPub.fetch_public_activities()
+  defp clean_tables do
+    IO.puts("Deleting old data...\n")
+    Ecto.Adapters.SQL.query!(Repo, "TRUNCATE users CASCADE;")
+    Ecto.Adapters.SQL.query!(Repo, "TRUNCATE activities CASCADE;")
+    Ecto.Adapters.SQL.query!(Repo, "TRUNCATE objects CASCADE;")
   end
 end

benchmarks/mix/tasks/pleroma/benchmarks/timelines.ex

@@ -1,70 +0,0 @@
-defmodule Mix.Tasks.Pleroma.Benchmarks.Timelines do
-  use Mix.Task
-
-  import Pleroma.LoadTesting.Helper, only: [clean_tables: 0]
-
-  alias Pleroma.Web.CommonAPI
-  alias Plug.Conn
-
-  def run(_args) do
-    Mix.Pleroma.start_pleroma()
-
-    # Cleaning tables
-    clean_tables()
-
-    [{:ok, user} | users] = Pleroma.LoadTesting.Users.generate_users(1000)
-
-    # Let the user make 100 posts
-
-    1..100
-    |> Enum.each(fn i -> CommonAPI.post(user, %{status: to_string(i)}) end)
-
-    # Let 10 random users post
-    posts =
-      users
-      |> Enum.take_random(10)
-      |> Enum.map(fn {:ok, random_user} ->
-        {:ok, activity} = CommonAPI.post(random_user, %{status: "."})
-        activity
-      end)
-
-    # let our user repeat them
-    posts
-    |> Enum.each(fn activity ->
-      CommonAPI.repeat(activity.id, user)
-    end)
-
-    Benchee.run(
-      %{
-        "user timeline, no followers" => fn reading_user ->
-          conn =
-            Phoenix.ConnTest.build_conn()
-            |> Conn.assign(:user, reading_user)
-            |> Conn.assign(:skip_link_headers, true)
-
-          Pleroma.Web.MastodonAPI.AccountController.statuses(conn, %{id: user.id})
-        end
-      },
-      inputs: %{"user" => user, "no user" => nil},
-      time: 60
-    )
-
-    users
-    |> Enum.each(fn {:ok, follower} -> Pleroma.User.follow(follower, user) end)
-
-    Benchee.run(
-      %{
-        "user timeline, all following" => fn reading_user ->
-          conn =
-            Phoenix.ConnTest.build_conn()
-            |> Conn.assign(:user, reading_user)
-            |> Conn.assign(:skip_link_headers, true)
-
-          Pleroma.Web.MastodonAPI.AccountController.statuses(conn, %{id: user.id})
-        end
-      },
-      inputs: %{"user" => user, "no user" => nil},
-      time: 60
-    )
-  end
-end

benchmarks/mix/tasks/pleroma/load_testing.ex

@@ -1,56 +1,114 @@
 defmodule Mix.Tasks.Pleroma.LoadTesting do
   use Mix.Task
-  import Ecto.Query
-  import Pleroma.LoadTesting.Helper, only: [clean_tables: 0]
-
-  alias Pleroma.Repo
-  alias Pleroma.User
+  use Pleroma.LoadTesting.Helper
+  import Mix.Pleroma
+  import Pleroma.LoadTesting.Generator
+  import Pleroma.LoadTesting.Fetcher
 
   @shortdoc "Factory for generation data"
   @moduledoc """
   Generates data like:
   - local/remote users
-  - local/remote activities with differrent visibility:
-    - simple activiities
-    - with emoji
-    - with mentions
-    - hellthreads
-    - with attachments
-    - with tags
-    - likes
-    - reblogs
-    - simple threads
-    - long threads
+  - local/remote activities with notifications
+  - direct messages
+  - long thread
+  - non visible posts
 
   ## Generate data
-      MIX_ENV=benchmark mix pleroma.load_testing --users 20000 --friends 1000 --iterations 170 --friends_used 20 --non_friends_used 20
-      MIX_ENV=benchmark mix pleroma.load_testing -u 20000 -f 1000 -i 170 -fu 20 -nfu 20
+      MIX_ENV=benchmark mix pleroma.load_testing --users 20000 --dms 20000 --thread_length 2000
+      MIX_ENV=benchmark mix pleroma.load_testing -u 20000 -d 20000 -t 2000
 
   Options:
   - `--users NUMBER` - number of users to generate. Defaults to: 20000. Alias: `-u`
-  - `--friends NUMBER` - number of friends for main user. Defaults to: 1000. Alias: `-f`
-  - `--iterations NUMBER` - number of iterations to generate activities. For each iteration in database is inserted about 120+ activities with different visibility, actors and types.Defaults to: 170. Alias: `-i`
-  - `--friends_used NUMBER` - number of main user friends used in activity generation. Defaults to: 20. Alias: `-fu`
-  - `--non_friends_used NUMBER` - number of non friends used in activity generation. Defaults to: 20. Alias: `-nfu`
+  - `--dms NUMBER` - number of direct messages to generate. Defaults to: 20000. Alias `-d`
+  - `--thread_length` - number of messages in thread. Defaults to: 2000. ALias `-t`
   """
 
-  @aliases [u: :users, f: :friends, i: :iterations, fu: :friends_used, nfu: :non_friends_used]
+  @aliases [u: :users, d: :dms, t: :thread_length]
   @switches [
     users: :integer,
-    friends: :integer,
-    iterations: :integer,
-    friends_used: :integer,
-    non_friends_used: :integer
+    dms: :integer,
+    thread_length: :integer
   ]
+  @users_default 20_000
+  @dms_default 1_000
+  @thread_length_default 2_000
 
   def run(args) do
-    Logger.configure(level: :error)
-    Mix.Pleroma.start_pleroma()
-    clean_tables()
+    start_pleroma()
+    Pleroma.Config.put([:instance, :skip_thread_containment], true)
     {opts, _} = OptionParser.parse!(args, strict: @switches, aliases: @aliases)
 
-    user = Pleroma.LoadTesting.Users.generate(opts)
-    Pleroma.LoadTesting.Activities.generate(user, opts)
+    users_max = Keyword.get(opts, :users, @users_default)
+    dms_max = Keyword.get(opts, :dms, @dms_default)
+    thread_length = Keyword.get(opts, :thread_length, @thread_length_default)
+
+    clean_tables()
+
+    opts =
+      Keyword.put(opts, :users_max, users_max)
+      |> Keyword.put(:dms_max, dms_max)
+      |> Keyword.put(:thread_length, thread_length)
+
+    generate_users(opts)
+
+    # main user for queries
+    IO.puts("Fetching local main user...")
+
+    {time, user} =
+      :timer.tc(fn ->
+        Repo.one(
+          from(u in User, where: u.local == true, order_by: fragment("RANDOM()"), limit: 1)
+        )
+      end)
+
+    IO.puts("Fetching main user take #{to_sec(time)} sec.\n")
+
+    IO.puts("Fetching local users...")
+
+    {time, users} =
+      :timer.tc(fn ->
+        Repo.all(
+          from(u in User,
+            where: u.id != ^user.id,
+            where: u.local == true,
+            order_by: fragment("RANDOM()"),
+            limit: 10
+          )
+        )
+      end)
+
+    IO.puts("Fetching local users take #{to_sec(time)} sec.\n")
+
+    IO.puts("Fetching remote users...")
+
+    {time, remote_users} =
+      :timer.tc(fn ->
+        Repo.all(
+          from(u in User,
+            where: u.id != ^user.id,
+            where: u.local == false,
+            order_by: fragment("RANDOM()"),
+            limit: 10
+          )
+        )
+      end)
+
+    IO.puts("Fetching remote users take #{to_sec(time)} sec.\n")
+
+    generate_activities(user, users)
+
+    generate_remote_activities(user, remote_users)
+
+    generate_like_activities(
+      user, Pleroma.Repo.all(Pleroma.Activity.Queries.by_type("Create"))
+    )
+
+    generate_dms(user, users, opts)
+
+    {:ok, activity} = generate_long_thread(user, users, opts)
+
+    generate_non_visible_message(user, users)
 
     IO.puts("Users in DB: #{Repo.aggregate(from(u in User), :count, :id)}")
 
@@ -62,6 +120,19 @@ def run(args) do
       "Notifications in DB: #{Repo.aggregate(from(n in Pleroma.Notification), :count, :id)}"
     )
 
-    Pleroma.LoadTesting.Fetcher.run_benchmarks(user)
+    fetch_user(user)
+    query_timelines(user)
+    query_notifications(user)
+    query_dms(user)
+    query_long_thread(user, activity)
+    Pleroma.Config.put([:instance, :skip_thread_containment], false)
+    query_timelines(user)
+  end
+
+  defp clean_tables do
+    IO.puts("Deleting old data...\n")
+    Ecto.Adapters.SQL.query!(Repo, "TRUNCATE users CASCADE;")
+    Ecto.Adapters.SQL.query!(Repo, "TRUNCATE activities CASCADE;")
+    Ecto.Adapters.SQL.query!(Repo, "TRUNCATE objects CASCADE;")
   end
 end

ci/Dockerfile

@@ -1,8 +0,0 @@
-FROM elixir:1.11.4
-
-# Single RUN statement, otherwise intermediate images are created
-# https://docs.docker.com/develop/develop-images/dockerfile_best-practices/#run
-RUN apt-get update &&\
-	apt-get install -y libmagic-dev cmake libimage-exiftool-perl ffmpeg &&\
-	mix local.hex --force &&\
-	mix local.rebar --force

ci/README

@@ -1,12 +0,0 @@
-## Dependencies
-
-Assuming an AMD64 Alpine system, you're going to need the following packages
-- `qemu qemu-openrc qemu-arm qemu-aarch64` for binfmt
-- `docker-cli-buildx` for building the images
-
-## Setting up
-
-```
-docker login git.pleroma.social:5050
-doas rc-service qemu-binfmt start
-```

ci/build_and_push.sh

@@ -1 +0,0 @@
-docker buildx build --platform linux/amd64,linux/arm64,linux/arm/v7 -t git.pleroma.social:5050/pleroma/pleroma/ci-base:latest --push .

config/benchmark.exs

@@ -1,10 +1,11 @@
-import Config
+use Mix.Config
 
 # We don't run a server during test. If one is required,
 # you can enable the server option below.
 config :pleroma, Pleroma.Web.Endpoint,
   http: [port: 4001],
-  url: [port: 4001]
+  url: [port: 4001],
+  server: true
 
 # Disable captha for tests
 config :pleroma, Pleroma.Captcha,
@@ -38,13 +39,12 @@
   adapter: Ecto.Adapters.Postgres,
   username: "postgres",
   password: "postgres",
-  database: "pleroma_benchmark",
+  database: "pleroma_test",
   hostname: System.get_env("DB_HOST") || "localhost",
-  port: System.get_env("DB_PORT") || "5432",
   pool_size: 10
 
 # Reduce hash rounds for testing
-config :pleroma, :password, iterations: 1
+config :pbkdf2_elixir, rounds: 1
 
 config :tesla, adapter: Tesla.Mock
 
@@ -59,6 +59,10 @@
     "BLH1qVhJItRGCfxgTtONfsOKDc9VRAraXw-3NsmjMngWSh7NxOizN6bkuRA7iLTMPS82PjwJAr3UoK9EC1IFrz4",
   private_key: "_-XZ0iebPrRfZ_o0-IatTdszYa8VCH1yLN-JauK7HHA"
 
+config :web_push_encryption, :http_client, Pleroma.Web.WebPushHttpClientMock
+
+config :pleroma_job_queue, disabled: true
+
 config :pleroma, Pleroma.ScheduledActivity,
   daily_user_limit: 2,
   total_user_limit: 3,

config/config.exs

@@ -37,16 +37,17 @@
 # FIGURATION! EDIT YOUR SECRET FILE (either prod.secret.exs, dev.secret.exs).
 #
 # This file is responsible for configuring your application
-# and its dependencies with the aid of the Config module.
+# and its dependencies with the aid of the Mix.Config module.
 #
 # This configuration file is loaded before any dependency and
 # is restricted to this project.
-import Config
+use Mix.Config
 
 # General application configuration
 config :pleroma, ecto_repos: [Pleroma.Repo]
 
 config :pleroma, Pleroma.Repo,
+  types: Pleroma.PostgresTypes,
   telemetry_event: [Pleroma.Repo.Instrumenter],
   migration_lock: nil
 
@@ -57,30 +58,41 @@
 
 config :pleroma, Pleroma.Captcha.Kocaptcha, endpoint: "https://captcha.kotobank.ch"
 
+config :pleroma, :hackney_pools,
+  federation: [
+    max_connections: 50,
+    timeout: 150_000
+  ],
+  media: [
+    max_connections: 50,
+    timeout: 150_000
+  ],
+  upload: [
+    max_connections: 25,
+    timeout: 300_000
+  ]
+
 # Upload configuration
 config :pleroma, Pleroma.Upload,
   uploader: Pleroma.Uploaders.Local,
   filters: [Pleroma.Upload.Filter.Dedupe],
   link_name: false,
   proxy_remote: false,
-  filename_display_max_length: 30,
-  default_description: nil,
-  base_url: nil
+  proxy_opts: [
+    redirect_on_failure: false,
+    max_body_length: 25 * 1_048_576,
+    http: [
+      follow_redirect: true,
+      pool: :upload
+    ]
+  ]
 
 config :pleroma, Pleroma.Uploaders.Local, uploads: "uploads"
 
 config :pleroma, Pleroma.Uploaders.S3,
   bucket: nil,
-  bucket_namespace: nil,
-  truncated_namespace: nil,
-  streaming_enabled: true
-
-config :ex_aws, :s3,
-  # host: "s3.wasabisys.com", # required if not Amazon AWS
-  access_key_id: nil,
-  secret_access_key: nil,
-  # region: "us-east-1", # may be required for Amazon AWS
-  scheme: "https://"
+  streaming_enabled: true,
+  public_endpoint: "https://s3.amazonaws.com"
 
 config :pleroma, :emoji,
   shortcode_globs: ["/emoji/custom/**/*.png"],
@@ -98,7 +110,6 @@
     "dat",
     "dweb",
     "gopher",
-    "hyper",
     "ipfs",
     "ipns",
     "irc",
@@ -123,6 +134,7 @@
 
 # Configures the endpoint
 config :pleroma, Pleroma.Web.Endpoint,
+  instrumenters: [Pleroma.Web.Endpoint.Instrumenter],
   url: [host: "localhost"],
   http: [
     ip: {127, 0, 0, 1},
@@ -139,10 +151,9 @@
   ],
   protocol: "https",
   secret_key_base: "aK4Abxf29xU9TTDKre9coZPUgevcVCFQJe/5xP/7Lt4BEif6idBIbjupVbOrbKxl",
-  live_view: [signing_salt: "U5ELgdEwTD3n1+D5s0rY0AMg8/y1STxZ3Zvsl3bWh+oBcGrYdil0rXqPMRd3Glcq"],
   signing_salt: "CqaoopA2",
   render_errors: [view: Pleroma.Web.ErrorView, accepts: ~w(json)],
-  pubsub_server: Pleroma.PubSub,
+  pubsub: [name: Pleroma.PubSub, adapter: Phoenix.PubSub.PG2],
   secure_cookie_flag: true,
   extra_cookie_attrs: [
     "SameSite=Lax"
@@ -160,6 +171,11 @@
   format: "$metadata[$level] $message",
   metadata: [:request_id]
 
+config :quack,
+  level: :warn,
+  meta: [:all],
+  webhook_url: "https://hooks.slack.com/services/YOUR-KEY-HERE"
+
 config :mime, :types, %{
   "application/xml" => ["xml"],
   "application/xrd+xml" => ["xrd+xml"],
@@ -175,18 +191,22 @@
   proxy_url: nil,
   send_user_agent: true,
   user_agent: :default,
-  adapter: []
+  adapter: [
+    ssl_options: [
+      # Workaround for remote server certificate chain issues
+      partial_chain: &:hackney_connect.partial_chain/1,
+      # We don't support TLS v1.3 yet
+      versions: [:tlsv1, :"tlsv1.1", :"tlsv1.2"]
+    ]
+  ]
 
 config :pleroma, :instance,
   name: "Pleroma",
   email: "example@example.com",
   notify_email: "noreply@example.com",
-  description: "Pleroma: An efficient and flexible fediverse server",
-  short_description: "",
-  background_image: "/images/city.jpg",
-  instance_thumbnail: "/instance/thumbnail.jpeg",
+  description: "A Pleroma instance, an alternative fediverse server",
   limit: 5_000,
-  description_limit: 5_000,
+  chat_limit: 5_000,
   remote_limit: 100_000,
   upload_limit: 16_000_000,
   avatar_upload_limit: 2_000_000,
@@ -201,7 +221,6 @@
   registrations_open: true,
   invites_enabled: false,
   account_activation_required: false,
-  account_approval_required: false,
   federating: true,
   federation_incoming_replies_max_depth: 100,
   federation_reachability_timeout_days: 7,
@@ -209,8 +228,10 @@
     Pleroma.Web.ActivityPub.Publisher
   ],
   allow_relay: true,
+  rewrite_policy: Pleroma.Web.ActivityPub.MRF.NoOpPolicy,
   public: true,
   quarantined_instances: [],
+  managed_config: true,
   static_dir: "instance/static/",
   allowed_post_formats: [
     "text/plain",
@@ -218,12 +239,14 @@
     "text/markdown",
     "text/bbcode"
   ],
+  mrf_transparency: true,
+  mrf_transparency_exclusions: [],
   autofollowed_nicknames: [],
-  autofollowing_nicknames: [],
   max_pinned_statuses: 1,
   attachment_links: false,
+  welcome_user_nickname: nil,
+  welcome_message: nil,
   max_report_comment_size: 1000,
-  report_strip_status: true,
   safe_dm_mentions: false,
   healthcheck: false,
   remote_post_retention_days: 90,
@@ -235,64 +258,9 @@
   max_remote_account_fields: 20,
   account_field_name_length: 512,
   account_field_value_length: 2048,
-  registration_reason_length: 500,
   external_user_synchronization: true,
   extended_nickname_format: true,
-  cleanup_attachments: false,
-  multi_factor_authentication: [
-    totp: [
-      # digits 6 or 8
-      digits: 6,
-      period: 30
-    ],
-    backup_codes: [
-      number: 5,
-      length: 16
-    ]
-  ],
-  show_reactions: true,
-  password_reset_token_validity: 60 * 60 * 24,
-  profile_directory: true,
-  admin_privileges: [
-    :users_read,
-    :users_manage_invites,
-    :users_manage_activation_state,
-    :users_manage_tags,
-    :users_manage_credentials,
-    :users_delete,
-    :messages_read,
-    :messages_delete,
-    :instances_delete,
-    :reports_manage_reports,
-    :moderation_log_read,
-    :announcements_manage_announcements,
-    :emoji_manage_emoji,
-    :statistics_read
-  ],
-  moderator_privileges: [:messages_delete, :reports_manage_reports],
-  max_endorsed_users: 20,
-  birthday_required: false,
-  birthday_min_age: 0,
-  max_media_attachments: 1_000
-
-config :pleroma, :welcome,
-  direct_message: [
-    enabled: false,
-    sender_nickname: nil,
-    message: nil
-  ],
-  chat_message: [
-    enabled: false,
-    sender_nickname: nil,
-    message: nil
-  ],
-  email: [
-    enabled: false,
-    sender: nil,
-    subject: "Welcome to <%= instance_name %>",
-    html: "Welcome to <%= instance_name %>",
-    text: "Welcome to <%= instance_name %>"
-  ]
+  cleanup_attachments: false
 
 config :pleroma, :feed,
   post_title: %{
@@ -314,33 +282,23 @@
 
 config :pleroma, :frontend_configurations,
   pleroma_fe: %{
-    alwaysShowSubjectInput: true,
-    background: "/images/city.jpg",
-    collapseMessageWithSubject: false,
-    disableChat: false,
-    greentext: false,
-    hideFilteredStatuses: false,
-    hideMutedPosts: false,
-    hidePostStats: false,
-    hideSitename: false,
-    hideUserStats: false,
-    loginMethod: "password",
-    logo: "/static/logo.svg",
-    logoMargin: ".1em",
-    logoMask: true,
-    minimalScopesMode: false,
-    noAttachmentLinks: false,
-    nsfwCensorImage: "",
-    postContentType: "text/plain",
-    redirectRootLogin: "/main/friends",
-    redirectRootNoLogin: "/main/all",
-    scopeCopy: true,
-    sidebarRight: false,
-    showFeaturesPanel: true,
-    showInstanceSpecificPanel: false,
-    subjectLineBehavior: "email",
     theme: "pleroma-dark",
-    webPushNotifications: false
+    logo: "/static/logo.png",
+    background: "/images/city.jpg",
+    redirectRootNoLogin: "/main/all",
+    redirectRootLogin: "/main/friends",
+    showInstanceSpecificPanel: true,
+    scopeOptionsEnabled: false,
+    formattingOptionsEnabled: false,
+    collapseMessageWithSubject: false,
+    hidePostStats: false,
+    hideUserStats: false,
+    scopeCopy: true,
+    subjectLineBehavior: "email",
+    alwaysShowSubjectInput: true
+  },
+  masto_fe: %{
+    showInstanceSpecificPanel: true
   }
 
 config :pleroma, :assets,
@@ -359,8 +317,8 @@
 config :pleroma, :manifest,
   icons: [
     %{
-      src: "/static/logo.svg",
-      type: "image/svg+xml"
+      src: "/static/logo.png",
+      type: "image/png"
     }
   ],
   theme_color: "#282c37",
@@ -369,7 +327,6 @@
 config :pleroma, :activitypub,
   unfollow_blocked: true,
   outgoing_blocks: true,
-  blockers_visible: true,
   follow_handshake_timeout: 500,
   note_replies_output_limit: 5,
   sign_object_fetches: true,
@@ -397,59 +354,41 @@
   federated_timeline_removal: [],
   report_removal: [],
   reject: [],
-  followers_only: [],
   accept: [],
   avatar_removal: [],
-  banner_removal: [],
-  reject_deletes: []
+  banner_removal: []
 
 config :pleroma, :mrf_keyword,
   reject: [],
   federated_timeline_removal: [],
   replace: []
 
-config :pleroma, :mrf_hashtag,
-  sensitive: ["nsfw"],
-  reject: [],
-  federated_timeline_removal: []
-
 config :pleroma, :mrf_subchain, match_actor: %{}
 
-config :pleroma, :mrf_activity_expiration, days: 365
-
 config :pleroma, :mrf_vocabulary,
   accept: [],
   reject: []
 
-# threshold of 7 days
 config :pleroma, :mrf_object_age,
-  threshold: 604_800,
+  threshold: 172_800,
   actions: [:delist, :strip_followers]
 
-config :pleroma, :mrf_follow_bot, follower_nickname: nil
-
 config :pleroma, :rich_media,
   enabled: true,
   ignore_hosts: [],
   ignore_tld: ["local", "localdomain", "lan"],
   parsers: [
     Pleroma.Web.RichMedia.Parsers.TwitterCard,
+    Pleroma.Web.RichMedia.Parsers.OGP,
     Pleroma.Web.RichMedia.Parsers.OEmbed
   ],
-  failure_backoff: 60_000,
   ttl_setters: [Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl]
 
 config :pleroma, :media_proxy,
   enabled: false,
-  invalidation: [
-    enabled: false,
-    provider: Pleroma.Web.MediaProxy.Invalidation.Script
-  ],
   proxy_opts: [
     redirect_on_failure: false,
     max_body_length: 25 * 1_048_576,
-    # Note: max_read_duration defaults to Pleroma.ReverseProxy.max_read_duration_default/1
-    max_read_duration: 30_000,
     http: [
       follow_redirect: true,
       pool: :media
@@ -457,28 +396,9 @@
   ],
   whitelist: []
 
-config :pleroma, Pleroma.Web.MediaProxy.Invalidation.Http,
-  method: :purge,
-  headers: [],
-  options: []
+config :pleroma, :chat, enabled: true
 
-config :pleroma, Pleroma.Web.MediaProxy.Invalidation.Script,
-  script_path: nil,
-  url_format: nil
-
-# Note: media preview proxy depends on media proxy to be enabled
-config :pleroma, :media_preview_proxy,
-  enabled: false,
-  thumbnail_max_width: 600,
-  thumbnail_max_height: 600,
-  image_quality: 85,
-  min_content_length: 100 * 1024
-
-config :pleroma, :shout,
-  enabled: true,
-  limit: 5_000
-
-config :phoenix, :format_encoders, json: Jason, "activity+json": Jason
+config :phoenix, :format_encoders, json: Jason
 
 config :phoenix, :json_library, Jason
 
@@ -492,15 +412,12 @@
 config :pleroma, Pleroma.Web.Metadata,
   providers: [
     Pleroma.Web.Metadata.Providers.OpenGraph,
-    Pleroma.Web.Metadata.Providers.TwitterCard
+    Pleroma.Web.Metadata.Providers.TwitterCard,
+    Pleroma.Web.Metadata.Providers.RelMe,
+    Pleroma.Web.Metadata.Providers.Feed
   ],
   unfurl_nsfw: false
 
-config :pleroma, Pleroma.Web.Preload,
-  providers: [
-    Pleroma.Web.Preload.Providers.Instance
-  ]
-
 config :pleroma, :http_security,
   enabled: true,
   sts: false,
@@ -553,40 +470,30 @@
     "user-search",
     "user_exists",
     "users",
-    "web",
-    "verify_credentials",
-    "update_credentials",
-    "relationships",
-    "search",
-    "confirmation_resend",
-    "mfa"
-  ],
-  email_blacklist: []
+    "web"
+  ]
 
 config :pleroma, Oban,
   repo: Pleroma.Repo,
-  log: false,
+  verbose: false,
+  prune: {:maxlen, 1500},
   queues: [
     activity_expiration: 10,
-    token_expiration: 5,
-    filter_expiration: 1,
-    backup: 1,
-    federator_incoming: 5,
-    federator_outgoing: 5,
-    ingestion_queue: 50,
+    federator_incoming: 50,
+    federator_outgoing: 50,
     web_push: 50,
     mailer: 10,
     transmogrifier: 20,
     scheduled_activities: 10,
-    poll_notifications: 10,
     background: 5,
     remote_fetcher: 2,
-    attachments_cleanup: 1,
-    new_users_digest: 1,
-    mute_expire: 5
+    attachments_cleanup: 5,
+    new_users_digest: 1
   ],
-  plugins: [Oban.Plugins.Pruner],
   crontab: [
+    {"0 0 * * *", Pleroma.Workers.Cron.ClearOauthTokenWorker},
+    {"0 * * * *", Pleroma.Workers.Cron.StatsWorker},
+    {"* * * * *", Pleroma.Workers.Cron.PurgeExpiredActivitiesWorker},
     {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
     {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
   ]
@@ -597,14 +504,20 @@
     federator_outgoing: 5
   ]
 
-config :pleroma, Pleroma.Formatter,
-  class: false,
-  rel: "ugc",
-  new_window: false,
-  truncate: false,
-  strip_prefix: false,
-  extra: true,
-  validate_tld: :no_scheme
+config :pleroma, :fetch_initial_posts,
+  enabled: false,
+  pages: 5
+
+config :auto_linker,
+  opts: [
+    extra: true,
+    # TODO: Set to :no_scheme when it works properly
+    validate_tld: true,
+    class: false,
+    strip_prefix: false,
+    new_window: false,
+    rel: "ugc"
+  ]
 
 config :pleroma, :ldap,
   enabled: System.get_env("LDAP_ENABLED") == "true",
@@ -638,7 +551,10 @@
        base_path: "/oauth",
        providers: ueberauth_providers
 
-config :pleroma, :auth, oauth_consumer_strategies: oauth_consumer_strategies
+config :pleroma,
+       :auth,
+       enforce_oauth_admin_scope_usage: true,
+       oauth_consumer_strategies: oauth_consumer_strategies
 
 config :pleroma, Pleroma.Emails.Mailer, adapter: Swoosh.Adapters.Sendmail, enabled: false
 
@@ -655,12 +571,7 @@
 
 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 :prometheus, Pleroma.Web.Endpoint.MetricsExporter, path: "/api/pleroma/app_metrics"
 
 config :pleroma, Pleroma.ScheduledActivity,
   daily_user_limit: 25,
@@ -675,18 +586,12 @@
   }
 
 config :pleroma, :oauth2,
-  token_expires_in: 3600 * 24 * 365 * 100,
+  token_expires_in: 600,
   issue_new_refresh_token: true,
   clean_expired_tokens: false
 
 config :pleroma, :database, rum_enabled: false
 
-config :pleroma, :features, improved_hashtag_timeline: :auto
-
-config :pleroma, :populate_hashtags_table, fault_rate_allowance: 0.01
-
-config :pleroma, :delete_context_objects, fault_rate_allowance: 0.01
-
 config :pleroma, :env, Mix.env()
 
 config :http_signatures,
@@ -705,87 +610,12 @@
   account_confirmation_resend: {8_640_000, 5},
   ap_routes: {60_000, 15}
 
-config :pleroma, Pleroma.Workers.PurgeExpiredActivity, enabled: true, min_lifetime: 600
+config :pleroma, Pleroma.ActivityExpiration, enabled: true
 
-config :pleroma, Pleroma.Web.Plugs.RemoteIp,
-  enabled: true,
-  headers: ["x-forwarded-for"],
-  proxies: [],
-  reserved: [
-    "127.0.0.0/8",
-    "::1/128",
-    "fc00::/7",
-    "10.0.0.0/8",
-    "172.16.0.0/12",
-    "192.168.0.0/16"
-  ]
+config :pleroma, Pleroma.Plugs.RemoteIp, enabled: true
 
 config :pleroma, :static_fe, enabled: false
 
-# Example of frontend configuration
-# This example will make us serve the primary frontend from the
-# frontends directory within your `:pleroma, :instance, static_dir`.
-# e.g., instance/static/frontends/pleroma/develop/
-#
-# With no frontend configuration, the bundled files from the `static` directory will
-# be used.
-#
-# config :pleroma, :frontends,
-# primary: %{"name" => "pleroma-fe", "ref" => "develop"},
-# admin: %{"name" => "admin-fe", "ref" => "stable"},
-# available: %{...}
-
-config :pleroma, :frontends,
-  available: %{
-    "kenoma" => %{
-      "name" => "kenoma",
-      "git" => "https://git.pleroma.social/lambadalambda/kenoma",
-      "build_url" =>
-        "https://git.pleroma.social/lambadalambda/kenoma/-/jobs/artifacts/${ref}/download?job=build",
-      "ref" => "master"
-    },
-    "pleroma-fe" => %{
-      "name" => "pleroma-fe",
-      "git" => "https://git.pleroma.social/pleroma/pleroma-fe",
-      "build_url" =>
-        "https://git.pleroma.social/pleroma/pleroma-fe/-/jobs/artifacts/${ref}/download?job=build",
-      "ref" => "develop"
-    },
-    "fedi-fe" => %{
-      "name" => "fedi-fe",
-      "git" => "https://git.pleroma.social/pleroma/fedi-fe",
-      "build_url" =>
-        "https://git.pleroma.social/pleroma/fedi-fe/-/jobs/artifacts/${ref}/download?job=build_release",
-      "ref" => "master",
-      "custom-http-headers" => [
-        {"service-worker-allowed", "/"}
-      ]
-    },
-    "admin-fe" => %{
-      "name" => "admin-fe",
-      "git" => "https://git.pleroma.social/pleroma/admin-fe",
-      "build_url" =>
-        "https://git.pleroma.social/pleroma/admin-fe/-/jobs/artifacts/${ref}/download?job=build",
-      "ref" => "develop"
-    },
-    "soapbox" => %{
-      "name" => "soapbox",
-      "git" => "https://gitlab.com/soapbox-pub/soapbox",
-      "build_url" =>
-        "https://gitlab.com/soapbox-pub/soapbox/-/jobs/artifacts/${ref}/download?job=build-production",
-      "ref" => "v3.0.0-beta.1",
-      "build_dir" => "static"
-    },
-    "glitch-lily" => %{
-      "name" => "glitch-lily",
-      "git" => "https://lily-is.land/infra/glitch-lily",
-      "build_url" =>
-        "https://lily-is.land/infra/glitch-lily/-/jobs/artifacts/${ref}/download?job=build",
-      "ref" => "servant",
-      "build_dir" => "public"
-    }
-  }
-
 config :pleroma, :web_cache_ttl,
   activity_pub: nil,
   activity_pub_question: 30_000
@@ -798,91 +628,6 @@
   parameters: [gin_fuzzy_search_limit: "500"],
   prepare: :unnamed
 
-config :pleroma, :connections_pool,
-  reclaim_multiplier: 0.1,
-  connection_acquisition_wait: 250,
-  connection_acquisition_retries: 5,
-  max_connections: 250,
-  max_idle_time: 30_000,
-  retry: 0,
-  connect_timeout: 5_000
-
-config :pleroma, :pools,
-  federation: [
-    size: 50,
-    max_waiting: 10,
-    recv_timeout: 10_000
-  ],
-  media: [
-    size: 50,
-    max_waiting: 20,
-    recv_timeout: 15_000
-  ],
-  upload: [
-    size: 25,
-    max_waiting: 5,
-    recv_timeout: 15_000
-  ],
-  default: [
-    size: 10,
-    max_waiting: 2,
-    recv_timeout: 5_000
-  ]
-
-config :pleroma, :hackney_pools,
-  federation: [
-    max_connections: 50,
-    timeout: 150_000
-  ],
-  media: [
-    max_connections: 50,
-    timeout: 150_000
-  ],
-  upload: [
-    max_connections: 25,
-    timeout: 300_000
-  ]
-
-config :pleroma, :majic_pool, size: 2
-
-private_instance? = :if_instance_is_private
-
-config :pleroma, :restrict_unauthenticated,
-  timelines: %{local: private_instance?, federated: private_instance?},
-  profiles: %{local: private_instance?, remote: private_instance?},
-  activities: %{local: private_instance?, remote: private_instance?}
-
-config :pleroma, Pleroma.Web.ApiSpec.CastAndValidate, strict: false
-
-config :pleroma, :mrf,
-  policies: [Pleroma.Web.ActivityPub.MRF.ObjectAgePolicy, Pleroma.Web.ActivityPub.MRF.TagPolicy],
-  transparency: true,
-  transparency_exclusions: []
-
-config :tzdata, :http_client, Pleroma.HTTP.Tzdata
-
-config :ex_aws, http_client: Pleroma.HTTP.ExAws
-
-config :web_push_encryption, http_client: Pleroma.HTTP.WebPush
-
-config :pleroma, :instances_favicons, enabled: false
-
-config :floki, :html_parser, Floki.HTMLParser.FastHtml
-
-config :pleroma, Pleroma.Web.Auth.Authenticator, Pleroma.Web.Auth.PleromaAuthenticator
-
-config :pleroma, Pleroma.User.Backup,
-  purge_after_days: 30,
-  limit_days: 7,
-  dir: nil
-
-config :pleroma, ConcurrentLimiter, [
-  {Pleroma.Web.RichMedia.Helpers, [max_running: 5, max_waiting: 5]},
-  {Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy, [max_running: 5, max_waiting: 5]}
-]
-
-config :pleroma, Pleroma.Web.WebFinger, domain: nil, update_nickname_on_user_fetch: true
-
 # Import environment specific config. This must remain at the bottom
 # of this file so it overrides the configuration defined above.
 import_config "#{Mix.env()}.exs"

config/dev.exs

@@ -1,4 +1,4 @@
-import Config
+use Mix.Config
 
 # For development, we disable any cache and enable
 # debugging and code reloading.
@@ -52,17 +52,10 @@
   hostname: "localhost",
   pool_size: 10
 
-config :pleroma, Pleroma.Web.ApiSpec.CastAndValidate, strict: true
-
-# Reduce recompilation time
-# https://dashbit.co/blog/speeding-up-re-compilation-of-elixir-projects
-config :phoenix, :plug_init_mode, :runtime
-
 if File.exists?("./config/dev.secret.exs") do
   import_config "dev.secret.exs"
 else
   IO.puts(
-    :stderr,
     "!!! RUNNING IN LOCALHOST DEV MODE! !!!\nFEDERATION WON'T WORK UNTIL YOU CONFIGURE A dev.secret.exs"
   )
 end

config/docker.exs

@@ -18,7 +18,6 @@
   password: System.fetch_env!("DB_PASS"),
   database: System.get_env("DB_NAME", "pleroma"),
   hostname: System.get_env("DB_HOST", "db"),
-  port: System.get_env("DB_PORT", "5432"),
   pool_size: 10
 
 # Configure web push notifications

config/dokku.exs

@@ -1,4 +1,4 @@
-import Config
+use Mix.Config
 
 config :pleroma, Pleroma.Web.Endpoint,
   http: [

config/emoji.txt

@@ -1,3 +1,2 @@
 firefox, /emoji/Firefox.gif, Gif,Fun
 blank, /emoji/blank.png, Fun
-dinosaur, /emoji/dino walking.gif, Gif

config/prod.exs

@@ -1,4 +1,4 @@
-import Config
+use Mix.Config
 
 # For production, we often load configuration from external
 # sources, such as your system environment. For this reason,
@@ -63,12 +63,7 @@
 
 # Finally import the config/prod.secret.exs
 # which should be versioned separately.
-if File.exists?("./config/prod.secret.exs") do
-  import_config "prod.secret.exs"
-else
-  "`config/prod.secret.exs` not found. You may want to create one by running `mix pleroma.instance gen`"
-  |> IO.warn([])
-end
+import_config "prod.secret.exs"
 
 if File.exists?("./config/prod.exported_from_db.secret.exs"),
   do: import_config("prod.exported_from_db.secret.exs")

config/releases.exs

@@ -0,0 +1,31 @@
+import Config
+
+config :pleroma, :instance, static_dir: "/var/lib/pleroma/static"
+config :pleroma, Pleroma.Uploaders.Local, uploads: "/var/lib/pleroma/uploads"
+config :pleroma, :modules, runtime_dir: "/var/lib/pleroma/modules"
+
+config_path = System.get_env("PLEROMA_CONFIG_PATH") || "/etc/pleroma/config.exs"
+
+config :pleroma, release: true, config_path: config_path
+
+if File.exists?(config_path) do
+  import_config config_path
+else
+  warning = [
+    IO.ANSI.red(),
+    IO.ANSI.bright(),
+    "!!! #{config_path} not found! Please ensure it exists and that PLEROMA_CONFIG_PATH is unset or points to an existing file",
+    IO.ANSI.reset()
+  ]
+
+  IO.puts(warning)
+end
+
+exported_config =
+  config_path
+  |> Path.dirname()
+  |> Path.join("prod.exported_from_db.secret.exs")
+
+if File.exists?(exported_config) do
+  import_config exported_config
+end

config/test.exs

@@ -1,10 +1,11 @@
-import Config
+use Mix.Config
 
 # We don't run a server during test. If one is required,
 # you can enable the server option below.
 config :pleroma, Pleroma.Web.Endpoint,
+  web_endpoint: nil,
   http: [port: 4001],
-  url: [port: 4001],
+  url: [host: "localhost", port: 4001],
   server: true
 
 # Disable captha for tests
@@ -21,10 +22,7 @@
 
 config :pleroma, :auth, oauth_consumer_strategies: []
 
-config :pleroma, Pleroma.Upload,
-  filters: [],
-  link_name: false,
-  default_description: :filename
+config :pleroma, Pleroma.Upload, filters: [], link_name: false
 
 config :pleroma, Pleroma.Uploaders.Local, uploads: "test/uploads"
 
@@ -38,7 +36,7 @@
   external_user_synchronization: false,
   static_dir: "test/instance_static/"
 
-config :pleroma, :activitypub, sign_object_fetches: false, follow_handshake_timeout: 0
+config :pleroma, :activitypub, sign_object_fetches: false
 
 # Configure your database
 config :pleroma, Pleroma.Repo,
@@ -47,14 +45,10 @@
   password: "postgres",
   database: "pleroma_test",
   hostname: System.get_env("DB_HOST") || "localhost",
-  port: System.get_env("DB_PORT") || "5432",
-  pool: Ecto.Adapters.SQL.Sandbox,
-  pool_size: 50
-
-config :pleroma, :dangerzone, override_repo_pool_size: true
+  pool: Ecto.Adapters.SQL.Sandbox
 
 # Reduce hash rounds for testing
-config :pleroma, :password, iterations: 1
+config :pbkdf2_elixir, rounds: 1
 
 config :tesla, adapter: Tesla.Mock
 
@@ -63,26 +57,18 @@
   ignore_hosts: [],
   ignore_tld: ["local", "localdomain", "lan"]
 
-config :pleroma, :instance,
-  multi_factor_authentication: [
-    totp: [
-      # digits 6 or 8
-      digits: 6,
-      period: 30
-    ],
-    backup_codes: [
-      number: 2,
-      length: 6
-    ]
-  ]
-
 config :web_push_encryption, :vapid_details,
   subject: "mailto:administrator@example.com",
   public_key:
     "BLH1qVhJItRGCfxgTtONfsOKDc9VRAraXw-3NsmjMngWSh7NxOizN6bkuRA7iLTMPS82PjwJAr3UoK9EC1IFrz4",
   private_key: "_-XZ0iebPrRfZ_o0-IatTdszYa8VCH1yLN-JauK7HHA"
 
-config :pleroma, Oban, testing: :manual
+config :web_push_encryption, :http_client, Pleroma.Web.WebPushHttpClientMock
+
+config :pleroma, Oban,
+  queues: false,
+  prune: :disabled,
+  crontab: false
 
 config :pleroma, Pleroma.ScheduledActivity,
   daily_user_limit: 2,
@@ -105,38 +91,8 @@
 
 config :pleroma, :modules, runtime_dir: "test/fixtures/modules"
 
-config :pleroma, Pleroma.Gun, Pleroma.GunMock
-
 config :pleroma, Pleroma.Emails.NewUsersDigestEmail, enabled: true
 
-config :pleroma, Pleroma.Web.Plugs.RemoteIp, enabled: false
-
-config :pleroma, Pleroma.Web.ApiSpec.CastAndValidate, strict: true
-
-config :tzdata, :autoupdate, :disabled
-
-config :pleroma, :mrf, policies: []
-
-config :pleroma, :pipeline,
-  object_validator: Pleroma.Web.ActivityPub.ObjectValidatorMock,
-  mrf: Pleroma.Web.ActivityPub.MRFMock,
-  activity_pub: Pleroma.Web.ActivityPub.ActivityPubMock,
-  side_effects: Pleroma.Web.ActivityPub.SideEffectsMock,
-  federator: Pleroma.Web.FederatorMock,
-  config: Pleroma.ConfigMock
-
-config :pleroma, :cachex, provider: Pleroma.CachexMock
-
-config :pleroma, Pleroma.Web.WebFinger, update_nickname_on_user_fetch: false
-
-config :pleroma, :side_effects,
-  ap_streamer: Pleroma.Web.ActivityPub.ActivityPubMock,
-  logger: Pleroma.LoggerMock
-
-# Reduce recompilation time
-# https://dashbit.co/blog/speeding-up-re-compilation-of-elixir-projects
-config :phoenix, :plug_init_mode, :runtime
-
 if File.exists?("./config/test.secret.exs") do
   import_config "test.secret.exs"
 else

coveralls.json

@@ -1,7 +0,0 @@
-{
-  "skip_files": [
-    "test/support",
-    "lib/mix/tasks/pleroma/benchmark.ex",
-    "lib/credo/check/consistency/file_location.ex"
-  ]
-}

docker-entrypoint.sh

@@ -3,7 +3,7 @@
 set -e
 
 echo "-- Waiting for database..."
-while ! pg_isready -U ${DB_USER:-pleroma} -d postgres://${DB_HOST:-db}:${DB_PORT:-5432}/${DB_NAME:-pleroma} -t 1; do
+while ! pg_isready -U ${DB_USER:-pleroma} -d postgres://${DB_HOST:-db}:5432/${DB_NAME:-pleroma} -t 1; do
     sleep 1s
 done
 

docs/API/admin_api.md

@@ -0,0 +1,985 @@
+# Admin API
+
+Authentication is required and the user must be an admin.
+
+Configuration options:
+
+* `[:auth, :enforce_oauth_admin_scope_usage]` — OAuth admin scope requirement toggle.
+    If `true`, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token (client app must support admin scopes).
+    If `false` and token doesn't have admin scope(s), `is_admin` user flag grants access to admin-specific actions.
+    Note that client app needs to explicitly support admin scopes and request them when obtaining auth token.
+
+## `GET /api/pleroma/admin/users`
+
+### List users
+
+- Query Params:
+  - *optional* `query`: **string** search term (e.g. nickname, domain, nickname@domain)
+  - *optional* `filters`: **string** comma-separated string of filters:
+    - `local`: only local users
+    - `external`: only external users
+    - `active`: only active users
+    - `deactivated`: only deactivated users
+    - `is_admin`: users with admin role
+    - `is_moderator`: users with moderator role
+  - *optional* `page`: **integer** page number
+  - *optional* `page_size`: **integer** number of users per page (default is `50`)
+  - *optional* `tags`: **[string]** tags list
+  - *optional* `name`: **string** user display name
+  - *optional* `email`: **string** user email
+- Example: `https://mypleroma.org/api/pleroma/admin/users?query=john&filters=local,active&page=1&page_size=10&tags[]=some_tag&tags[]=another_tag&name=display_name&email=email@example.com`
+- Response:
+
+```json
+{
+  "page_size": integer,
+  "count": integer,
+  "users": [
+    {
+      "deactivated": bool,
+      "id": integer,
+      "nickname": string,
+      "roles": {
+        "admin": bool,
+        "moderator": bool
+      },
+      "local": bool,
+      "tags": array,
+      "avatar": string,
+      "display_name": string
+    },
+    ...
+  ]
+}
+```
+
+## DEPRECATED `DELETE /api/pleroma/admin/users`
+
+### Remove a user
+
+- Params:
+  - `nickname`
+- Response: User’s nickname
+
+## `DELETE /api/pleroma/admin/users`
+
+### Remove a user
+
+- Params:
+  - `nicknames`
+- Response: Array of user nicknames
+
+### Create a user
+
+- Method: `POST`
+- Params:
+  `users`: [
+    {
+      `nickname`,
+      `email`,
+      `password`
+    }
+  ]
+- Response: User’s nickname
+
+## `POST /api/pleroma/admin/users/follow`
+
+### Make a user follow another user
+
+- Params:
+  - `follower`: The nickname of the follower
+  - `followed`: The nickname of the followed
+- Response:
+  - "ok"
+
+## `POST /api/pleroma/admin/users/unfollow`
+
+### Make a user unfollow another user
+
+- Params:
+  - `follower`: The nickname of the follower
+  - `followed`: The nickname of the followed
+- Response:
+  - "ok"
+
+## `PATCH /api/pleroma/admin/users/:nickname/toggle_activation`
+
+### Toggle user activation
+
+- Params:
+  - `nickname`
+- Response: User’s object
+
+```json
+{
+  "deactivated": bool,
+  "id": integer,
+  "nickname": string
+}
+```
+
+## `PUT /api/pleroma/admin/users/tag`
+
+### Tag a list of users
+
+- Params:
+  - `nicknames` (array)
+  - `tags` (array)
+
+## `DELETE /api/pleroma/admin/users/tag`
+
+### Untag a list of users
+
+- Params:
+  - `nicknames` (array)
+  - `tags` (array)
+
+## `GET /api/pleroma/admin/users/:nickname/permission_group`
+
+### Get user user permission groups membership
+
+- Params: none
+- Response:
+
+```json
+{
+  "is_moderator": bool,
+  "is_admin": bool
+}
+```
+
+## `GET /api/pleroma/admin/users/:nickname/permission_group/:permission_group`
+
+Note: Available `:permission_group` is currently moderator and admin. 404 is returned when the permission group doesn’t exist.
+
+### Get user user permission groups membership per permission group
+
+- Params: none
+- Response:
+
+```json
+{
+  "is_moderator": bool,
+  "is_admin": bool
+}
+```
+
+## DEPRECATED `POST /api/pleroma/admin/users/:nickname/permission_group/:permission_group`
+
+### Add user to permission group
+
+- Params: none
+- Response:
+  - On failure: `{"error": "…"}`
+  - On success: JSON of the user
+
+## `POST /api/pleroma/admin/users/permission_group/:permission_group`
+
+### Add users to permission group
+
+- Params:
+  - `nicknames`: nicknames array
+- Response:
+  - On failure: `{"error": "…"}`
+  - On success: JSON of the user
+
+## DEPRECATED `DELETE /api/pleroma/admin/users/:nickname/permission_group/:permission_group`
+
+## `DELETE /api/pleroma/admin/users/:nickname/permission_group/:permission_group`
+
+### Remove user from permission group
+
+- Params: none
+- Response:
+  - On failure: `{"error": "…"}`
+  - On success: JSON of the user
+- Note: An admin cannot revoke their own admin status.
+
+## `DELETE /api/pleroma/admin/users/permission_group/:permission_group`
+
+### Remove users from permission group
+
+- Params:
+  - `nicknames`: nicknames array
+- Response:
+  - On failure: `{"error": "…"}`
+  - On success: JSON of the user
+- Note: An admin cannot revoke their own admin status.
+
+## `PATCH /api/pleroma/admin/users/activate`
+
+### Activate user
+
+- Params:
+  - `nicknames`: nicknames array
+- Response:
+
+```json
+{
+  users: [
+    {
+      // user object
+    }
+  ]
+}
+```
+
+## `PATCH /api/pleroma/admin/users/deactivate`
+
+### Deactivate user
+
+- Params:
+  - `nicknames`: nicknames array
+- Response:
+
+```json
+{
+  users: [
+    {
+      // user object
+    }
+  ]
+}
+```
+
+## `GET /api/pleroma/admin/users/:nickname_or_id`
+
+### Retrive the details of a user
+
+- Params:
+  - `nickname` or `id`
+- Response:
+  - On failure: `Not found`
+  - On success: JSON of the user
+
+## `GET /api/pleroma/admin/users/:nickname_or_id/statuses`
+
+### Retrive user's latest statuses
+
+- Params:
+  - `nickname` or `id`
+  - *optional* `page_size`: number of statuses to return (default is `20`)
+  - *optional* `godmode`: `true`/`false` – allows to see private statuses
+  - *optional* `with_reblogs`: `true`/`false` – allows to see reblogs (default is false)
+- Response:
+  - On failure: `Not found`
+  - On success: JSON array of user's latest statuses
+
+## `GET /api/pleroma/admin/instances/:instance/statuses`
+
+### Retrive instance's latest statuses
+
+- Params:
+  - `instance`: instance name
+  - *optional* `page_size`: number of statuses to return (default is `20`)
+  - *optional* `godmode`: `true`/`false` – allows to see private statuses
+  - *optional* `with_reblogs`: `true`/`false` – allows to see reblogs (default is false)
+- Response:
+  - On failure: `Not found`
+  - On success: JSON array of instance's latest statuses
+
+## `GET /api/pleroma/admin/statuses`
+
+### Retrives all latest statuses
+
+- Params:
+  - *optional* `page_size`: number of statuses to return (default is `20`)
+  - *optional* `local_only`: excludes remote statuses
+  - *optional* `godmode`: `true`/`false` – allows to see private statuses
+  - *optional* `with_reblogs`: `true`/`false` – allows to see reblogs (default is false)
+- Response:
+  - On failure: `Not found`
+  - On success: JSON array of user's latest statuses
+
+## `POST /api/pleroma/admin/relay`
+
+### Follow a Relay
+
+- Params:
+  - `relay_url`
+- Response:
+  - On success: URL of the followed relay
+
+## `DELETE /api/pleroma/admin/relay`
+
+### Unfollow a Relay
+
+- Params:
+  - `relay_url`
+- Response:
+  - On success: URL of the unfollowed relay
+
+## `GET /api/pleroma/admin/relay`
+
+### List Relays
+
+- Params: none
+- Response:
+  - On success: JSON array of relays
+
+## `POST /api/pleroma/admin/users/invite_token`
+
+### Create an account registration invite token
+
+- Params:
+  - *optional* `max_use` (integer)
+  - *optional* `expires_at` (date string e.g. "2019-04-07")
+- Response:
+
+```json
+{
+  "id": integer,
+  "token": string,
+  "used": boolean,
+  "expires_at": date,
+  "uses": integer,
+  "max_use": integer,
+  "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
+}
+```
+
+## `GET /api/pleroma/admin/users/invites`
+
+### Get a list of generated invites
+
+- Params: none
+- Response:
+
+```json
+{
+
+  "invites": [
+    {
+      "id": integer,
+      "token": string,
+      "used": boolean,
+      "expires_at": date,
+      "uses": integer,
+      "max_use": integer,
+      "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
+    },
+    ...
+  ]
+}
+```
+
+## `POST /api/pleroma/admin/users/revoke_invite`
+
+### Revoke invite by token
+
+- Params:
+  - `token`
+- Response:
+
+```json
+{
+  "id": integer,
+  "token": string,
+  "used": boolean,
+  "expires_at": date,
+  "uses": integer,
+  "max_use": integer,
+  "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
+
+}
+```
+
+## `POST /api/pleroma/admin/users/email_invite`
+
+### Sends registration invite via email
+
+- Params:
+  - `email`
+  - `name`, optional
+
+## `GET /api/pleroma/admin/users/:nickname/password_reset`
+
+### Get a password reset token for a given nickname
+
+- Params: none
+- Response:
+
+```json
+{
+  "token": "base64 reset token",
+  "link": "https://pleroma.social/api/pleroma/password_reset/url-encoded-base64-token"
+}
+```
+
+## `PATCH /api/pleroma/admin/users/force_password_reset`
+
+### Force passord reset for a user with a given nickname
+
+- Params:
+  - `nicknames`
+- Response: none (code `204`)
+
+## `GET /api/pleroma/admin/reports`
+
+### Get a list of reports
+
+- Params:
+  - *optional* `state`: **string** the state of reports. Valid values are `open`, `closed` and `resolved`
+  - *optional* `limit`: **integer** the number of records to retrieve
+  - *optional* `page`: **integer** page number
+  - *optional* `page_size`: **integer** number of log entries per page (default is `50`)
+- Response:
+  - On failure: 403 Forbidden error `{"error": "error_msg"}` when requested by anonymous or non-admin
+  - On success: JSON, returns a list of reports, where:
+    - `account`: the user who has been reported
+    - `actor`: the user who has sent the report
+    - `statuses`: list of statuses that have been included to the report
+
+```json
+{
+  "totalReports" : 1,
+  "reports": [
+    {
+      "account": {
+        "acct": "user",
+        "avatar": "https://pleroma.example.org/images/avi.png",
+        "avatar_static": "https://pleroma.example.org/images/avi.png",
+        "bot": false,
+        "created_at": "2019-04-23T17:32:04.000Z",
+        "display_name": "User",
+        "emojis": [],
+        "fields": [],
+        "followers_count": 1,
+        "following_count": 1,
+        "header": "https://pleroma.example.org/images/banner.png",
+        "header_static": "https://pleroma.example.org/images/banner.png",
+        "id": "9i6dAJqSGSKMzLG2Lo",
+        "locked": false,
+        "note": "",
+        "pleroma": {
+          "confirmation_pending": false,
+          "hide_favorites": true,
+          "hide_followers": false,
+          "hide_follows": false,
+          "is_admin": false,
+          "is_moderator": false,
+          "relationship": {},
+          "tags": []
+        },
+        "source": {
+          "note": "",
+          "pleroma": {},
+          "sensitive": false
+        },
+        "tags": ["force_unlisted"],
+        "statuses_count": 3,
+        "url": "https://pleroma.example.org/users/user",
+        "username": "user"
+      },
+      "actor": {
+        "acct": "lain",
+        "avatar": "https://pleroma.example.org/images/avi.png",
+        "avatar_static": "https://pleroma.example.org/images/avi.png",
+        "bot": false,
+        "created_at": "2019-03-28T17:36:03.000Z",
+        "display_name": "Roger Braun",
+        "emojis": [],
+        "fields": [],
+        "followers_count": 1,
+        "following_count": 1,
+        "header": "https://pleroma.example.org/images/banner.png",
+        "header_static": "https://pleroma.example.org/images/banner.png",
+        "id": "9hEkA5JsvAdlSrocam",
+        "locked": false,
+        "note": "",
+        "pleroma": {
+          "confirmation_pending": false,
+          "hide_favorites": false,
+          "hide_followers": false,
+          "hide_follows": false,
+          "is_admin": false,
+          "is_moderator": false,
+          "relationship": {},
+          "tags": []
+        },
+        "source": {
+          "note": "",
+          "pleroma": {},
+          "sensitive": false
+        },
+        "tags": ["force_unlisted"],
+        "statuses_count": 1,
+        "url": "https://pleroma.example.org/users/lain",
+        "username": "lain"
+      },
+      "content": "Please delete it",
+      "created_at": "2019-04-29T19:48:15.000Z",
+      "id": "9iJGOv1j8hxuw19bcm",
+      "state": "open",
+      "statuses": [
+        {
+          "account": { ... },
+          "application": {
+            "name": "Web",
+            "website": null
+          },
+          "bookmarked": false,
+          "card": null,
+          "content": "<span class=\"h-card\"><a data-user=\"9hEkA5JsvAdlSrocam\" class=\"u-url mention\" href=\"https://pleroma.example.org/users/lain\">@<span>lain</span></a></span> click on my link <a href=\"https://www.google.com/\">https://www.google.com/</a>",
+          "created_at": "2019-04-23T19:15:47.000Z",
+          "emojis": [],
+          "favourited": false,
+          "favourites_count": 0,
+          "id": "9i6mQ9uVrrOmOime8m",
+          "in_reply_to_account_id": null,
+          "in_reply_to_id": null,
+          "language": null,
+          "media_attachments": [],
+          "mentions": [
+            {
+              "acct": "lain",
+              "id": "9hEkA5JsvAdlSrocam",
+              "url": "https://pleroma.example.org/users/lain",
+              "username": "lain"
+            },
+            {
+              "acct": "user",
+              "id": "9i6dAJqSGSKMzLG2Lo",
+              "url": "https://pleroma.example.org/users/user",
+              "username": "user"
+            }
+          ],
+          "muted": false,
+          "pinned": false,
+          "pleroma": {
+            "content": {
+              "text/plain": "@lain click on my link https://www.google.com/"
+            },
+            "conversation_id": 28,
+            "in_reply_to_account_acct": null,
+            "local": true,
+            "spoiler_text": {
+              "text/plain": ""
+            }
+          },
+          "reblog": null,
+          "reblogged": false,
+          "reblogs_count": 0,
+          "replies_count": 0,
+          "sensitive": false,
+          "spoiler_text": "",
+          "tags": [],
+          "uri": "https://pleroma.example.org/objects/8717b90f-8e09-4b58-97b0-e3305472b396",
+          "url": "https://pleroma.example.org/notice/9i6mQ9uVrrOmOime8m",
+          "visibility": "direct"
+        }
+      ]
+    }
+  ]
+}
+```
+
+## `GET /api/pleroma/admin/grouped_reports`
+
+### Get a list of reports, grouped by status
+
+- Params: none
+- On success: JSON, returns a list of reports, where:
+  - `date`: date of the latest report
+  - `account`: the user who has been reported (see `/api/pleroma/admin/reports` for reference)
+  - `status`: reported status (see `/api/pleroma/admin/reports` for reference)
+  - `actors`: users who had reported this status (see `/api/pleroma/admin/reports` for reference)
+  - `reports`: reports (see `/api/pleroma/admin/reports` for reference)
+
+```json
+  "reports": [
+    {
+      "date": "2019-10-07T12:31:39.615149Z",
+      "account": { ... },
+      "status": { ... },
+      "actors": [{ ... }, { ... }],
+      "reports": [{ ... }]
+    }
+  ]
+```
+
+## `GET /api/pleroma/admin/reports/:id`
+
+### Get an individual report
+
+- Params:
+  - `id`
+- Response:
+  - On failure:
+    - 403 Forbidden `{"error": "error_msg"}`
+    - 404 Not Found `"Not found"`
+  - On success: JSON, Report object (see above)
+
+## `PATCH /api/pleroma/admin/reports`
+
+### Change the state of one or multiple reports
+
+- Params:
+
+```json
+  `reports`: [
+    {
+      `id`, // required, report id
+      `state` // required, the new state. Valid values are `open`, `closed` and `resolved`
+    },
+    ...
+  ]
+```
+
+- Response:
+  - On failure:
+    - 400 Bad Request, JSON:
+
+    ```json
+      [
+        {
+          `id`, // report id
+          `error` // error message
+        }
+      ]
+    ```
+
+  - On success: `204`, empty response
+
+## `POST /api/pleroma/admin/reports/:id/notes`
+
+### Create report note
+
+- Params:
+  - `id`: required, report id
+  - `content`: required, the message
+- Response:
+  - On failure:
+    - 400 Bad Request `"Invalid parameters"` when `status` is missing
+  - On success: `204`, empty response
+
+## `POST /api/pleroma/admin/reports/:report_id/notes/:id`
+
+### Delete report note
+
+- Params:
+  - `report_id`: required, report id
+  - `id`: required, note id
+- Response:
+  - On failure:
+    - 400 Bad Request `"Invalid parameters"` when `status` is missing
+  - On success: `204`, empty response
+
+## `PUT /api/pleroma/admin/statuses/:id`
+
+### Change the scope of an individual reported status
+
+- Params:
+  - `id`
+  - `sensitive`: optional, valid values are `true` or `false`
+  - `visibility`: optional, valid values are `public`, `private` and `unlisted`
+- Response:
+  - On failure:
+    - 400 Bad Request `"Unsupported visibility"`
+    - 403 Forbidden `{"error": "error_msg"}`
+    - 404 Not Found `"Not found"`
+  - On success: JSON, Mastodon Status entity
+
+## `DELETE /api/pleroma/admin/statuses/:id`
+
+### Delete an individual reported status
+
+- Params:
+  - `id`
+- Response:
+  - On failure:
+    - 403 Forbidden `{"error": "error_msg"}`
+    - 404 Not Found `"Not found"`
+  - On success: 200 OK `{}`
+
+## `GET /api/pleroma/admin/restart`
+
+### Restarts pleroma application
+
+- Params: none
+- Response:
+  - On failure:
+    - 400 Bad Request `"To use this endpoint you need to enable configuration from database."`
+
+```json
+{}
+```
+
+## `GET /api/pleroma/admin/config`
+
+### Get list of merged default settings with saved in database.
+
+*If `need_reboot` flag exists in response, instance must be restarted, so reboot time settings can take effect.*
+
+**Only works when configuration from database is enabled.**
+
+- Params:
+  - `only_db`: true (*optional*, get only saved in database settings)
+- Response:
+  - On failure:
+    - 400 Bad Request `"To use this endpoint you need to enable configuration from database."`
+
+```json
+{
+  "configs": [
+    {
+      "group": ":pleroma",
+      "key": "Pleroma.Upload",
+      "value": []
+     }
+  ],
+  "need_reboot": true
+}
+```
+ need_reboot - *optional*, if were changed reboot time settings.
+
+## `POST /api/pleroma/admin/config`
+
+### Update config settings
+
+*If `need_reboot` flag exists in response, instance must be restarted, so reboot time settings can take effect.*
+
+**Only works when configuration from database is enabled.**
+
+Some modifications are necessary to save the config settings correctly:
+
+- strings which start with `Pleroma.`, `Phoenix.`, `Tesla.` or strings like `Oban`, `Ueberauth` will be converted to modules;
+```
+"Pleroma.Upload" -> Pleroma.Upload
+"Oban" -> Oban
+```
+- strings starting with `:` will be converted to atoms;
+```
+":pleroma" -> :pleroma
+```
+- objects with `tuple` key and array value will be converted to tuples;
+```
+{"tuple": ["string", "Pleroma.Upload", []]} -> {"string", Pleroma.Upload, []}
+```
+- arrays with *tuple objects* will be converted to keywords;
+```
+[{"tuple": [":key1", "value"]}, {"tuple": [":key2", "value"]}] -> [key1: "value", key2: "value"]
+```
+
+Most of the settings will be applied in `runtime`, this means that you don't need to restart the instance. But some settings are applied in `compile time` and require a reboot of the instance, such as:
+- all settings inside these keys:
+  - `:hackney_pools`
+  - `:chat`
+- partially settings inside these keys:
+  - `:seconds_valid` in `Pleroma.Captcha`
+  - `:proxy_remote` in `Pleroma.Upload`
+  - `:upload_limit` in `:instance`
+
+- Params:
+  - `configs` - array of config objects
+  - config object params:
+    - `group` - string (**required**)
+    - `key` - string (**required**)
+    - `value` - string, [], {} or {"tuple": []} (**required**)
+    - `delete` - true (*optional*, if setting must be deleted)
+    - `subkeys` - array of strings (*optional*, only works when `delete=true` parameter is passed, otherwise will be ignored)
+
+*When a value have several nested settings, you can delete only some nested settings by passing a parameter `subkeys`, without deleting all settings by key.*
+```
+[subkey: val1, subkey2: val2, subkey3: val3] \\ initial value
+{"group": ":pleroma", "key": "some_key", "delete": true, "subkeys": [":subkey", ":subkey3"]} \\ passing json for deletion
+[subkey2: val2] \\ value after deletion
+```
+
+*Most of the settings can be partially updated through merge old values with new values, except settings value of which is list or is not keyword.*
+
+Example of setting without keyword in value:
+```elixir
+config :tesla, :adapter, Tesla.Adapter.Hackney
+```
+
+List of settings which support only full update by key:
+```elixir
+@full_key_update [
+    {:pleroma, :ecto_repos},
+    {:quack, :meta},
+    {:mime, :types},
+    {:cors_plug, [:max_age, :methods, :expose, :headers]},
+    {:auto_linker, :opts},
+    {:swarm, :node_blacklist},
+    {:logger, :backends}
+  ]
+```
+
+List of settings which support only full update by subkey:
+```elixir
+@full_subkey_update [
+    {:pleroma, :assets, :mascots},
+    {:pleroma, :emoji, :groups},
+    {:pleroma, :workers, :retries},
+    {:pleroma, :mrf_subchain, :match_actor},
+    {:pleroma, :mrf_keyword, :replace}
+  ]
+```
+
+*Settings without explicit key must be sended in separate config object params.*
+```elixir
+config :quack,
+  level: :debug,
+  meta: [:all],
+  ...
+```
+```json
+{
+  "configs": [
+    {"group": ":quack", "key": ":level", "value": ":debug"},
+    {"group": ":quack", "key": ":meta", "value": [":all"]},
+    ...
+  ]
+}
+```
+- Request:
+
+```json
+{
+  "configs": [
+    {
+      "group": ":pleroma",
+      "key": "Pleroma.Upload",
+      "value": [
+        {"tuple": [":uploader", "Pleroma.Uploaders.Local"]},
+        {"tuple": [":filters", ["Pleroma.Upload.Filter.Dedupe"]]},
+        {"tuple": [":link_name", true]},
+        {"tuple": [":proxy_remote", false]},
+        {"tuple": [":proxy_opts", [
+          {"tuple": [":redirect_on_failure", false]},
+          {"tuple": [":max_body_length", 1048576]},
+          {"tuple": [":http", [
+            {"tuple": [":follow_redirect", true]},
+            {"tuple": [":pool", ":upload"]},
+          ]]}
+        ]
+        ]},
+        {"tuple": [":dispatch", {
+          "tuple": ["/api/v1/streaming", "Pleroma.Web.MastodonAPI.WebsocketHandler", []]
+        }]}
+      ]
+    }
+  ]
+}
+```
+
+- Response:
+  - On failure:
+    - 400 Bad Request `"To use this endpoint you need to enable configuration from database."`
+```json
+{
+  "configs": [
+    {
+      "group": ":pleroma",
+      "key": "Pleroma.Upload",
+      "value": [...]
+     }
+  ],
+  "need_reboot": true
+}
+```
+need_reboot - *optional*, if were changed reboot time settings.
+
+## ` GET /api/pleroma/admin/config/descriptions`
+
+### Get JSON with config descriptions.
+Loads json generated from `config/descriptions.exs`.
+
+- Params: none
+- Response:
+
+```json
+[{
+    "group": ":pleroma", // string
+    "key": "ModuleName", // string
+    "type": "group", // string or list with possible values,
+    "description": "Upload general settings", // string
+    "children": [
+      {
+        "key": ":uploader", // string or module name `Pleroma.Upload`
+        "type": "module",
+        "description": "Module which will be used for uploads",
+        "suggestions": ["module1", "module2"]
+      },
+      {
+        "key": ":filters",
+        "type": ["list", "module"],
+        "description": "List of filter modules for uploads",
+        "suggestions": [
+          "module1", "module2", "module3"
+        ]
+      }
+    ]
+}]
+```
+
+## `GET /api/pleroma/admin/moderation_log`
+
+### Get moderation log
+
+- Params:
+  - *optional* `page`: **integer** page number
+  - *optional* `page_size`: **integer** number of log entries per page (default is `50`)
+  - *optional* `start_date`: **datetime (ISO 8601)** filter logs by creation date, start from `start_date`. Accepts datetime in ISO 8601 format (YYYY-MM-DDThh:mm:ss), e.g. `2005-08-09T18:31:42`
+  - *optional* `end_date`: **datetime (ISO 8601)** filter logs by creation date, end by from `end_date`. Accepts datetime in ISO 8601 format (YYYY-MM-DDThh:mm:ss), e.g. 2005-08-09T18:31:42
+  - *optional* `user_id`: **integer** filter logs by actor's id
+  - *optional* `search`: **string** search logs by the log message
+- Response:
+
+```json
+[
+  {
+    "data": {
+      "actor": {
+        "id": 1,
+        "nickname": "lain"
+      },
+      "action": "relay_follow"
+    },
+    "time": 1502812026, // timestamp
+    "message": "[2017-08-15 15:47:06] @nick0 followed relay: https://example.org/relay" // log message
+  }
+]
+```
+
+## `POST /api/pleroma/admin/reload_emoji`
+
+### Reload the instance's custom emoji
+
+- Authentication: required
+- Params: None
+- Response: JSON, "ok" and 200 status
+
+## `PATCH /api/pleroma/admin/users/confirm_email`
+
+### Confirm users' emails
+
+- Params:
+  - `nicknames`
+- Response: Array of user nicknames
+
+## `PATCH /api/pleroma/admin/users/resend_confirmation_email`
+
+### Resend confirmation email
+
+- Params:
+  - `nicknames`
+- Response: Array of user nicknames
+
+## `GET /api/pleroma/admin/stats`
+
+### Stats
+
+- Response:
+
+```json
+{
+  "status_visibility": {
+    "direct": 739,
+    "private": 9,
+    "public": 17,
+    "unlisted": 14
+  }
+}
+```

docs/API/differences_in_mastoapi_responses.md

@@ -0,0 +1,188 @@
+# Differences in Mastodon API responses from vanilla Mastodon
+
+A Pleroma instance can be identified by "<Mastodon version> (compatible; Pleroma <version>)" present in `version` field in response from `/api/v1/instance`
+
+## Flake IDs
+
+Pleroma uses 128-bit ids as opposed to Mastodon's 64 bits. However just like Mastodon's ids they are sortable strings
+
+## Attachment cap
+
+Some apps operate under the assumption that no more than 4 attachments can be returned or uploaded. Pleroma however does not enforce any limits on attachment count neither when returning the status object nor when posting.
+
+## Timelines
+
+Adding the parameter `with_muted=true` to the timeline queries will also return activities by muted (not by blocked!) users.
+Adding the parameter `exclude_visibilities` to the timeline queries will exclude the statuses with the given visibilities. The parameter accepts an array of visibility types (`public`, `unlisted`, `private`, `direct`), e.g., `exclude_visibilities[]=direct&exclude_visibilities[]=private`.
+
+## Statuses
+
+- `visibility`: has an additional possible value `list`
+
+Has these additional fields under the `pleroma` object:
+
+- `local`: true if the post was made on the local instance
+- `conversation_id`: the ID of the AP context the status is associated with (if any)
+- `direct_conversation_id`: the ID of the Mastodon direct message conversation the status is associated with (if any)
+- `in_reply_to_account_acct`: the `acct` property of User entity for replied user (if any)
+- `content`: a map consisting of alternate representations of the `content` property with the key being it's mimetype. Currently the only alternate representation supported is `text/plain`
+- `spoiler_text`: a map consisting of alternate representations of the `spoiler_text` property with the key being it's mimetype. Currently the only alternate representation supported is `text/plain`
+- `expires_at`: a datetime (iso8601) that states when the post will expire (be deleted automatically), or empty if the post won't expire
+- `thread_muted`: true if the thread the post belongs to is muted
+- `emoji_reactions`: A list with emoji / reaction maps. The format is `{name: "☕", count: 1, me: true}`. Contains no information about the reacting users, for that use the `/statuses/:id/reactions` endpoint.
+
+## Attachments
+
+Has these additional fields under the `pleroma` object:
+
+- `mime_type`: mime type of the attachment.
+
+## Accounts
+
+The `id` parameter can also be the `nickname` of the user. This only works in these endpoints, not the deeper nested ones for following etc.
+
+- `/api/v1/accounts/:id`
+- `/api/v1/accounts/:id/statuses`
+
+Has these additional fields under the `pleroma` object:
+
+- `tags`: Lists an array of tags for the user
+- `relationship{}`: Includes fields as documented for Mastodon API https://docs.joinmastodon.org/entities/relationship/
+- `is_moderator`: boolean, nullable,  true if user is a moderator
+- `is_admin`: boolean, nullable, true if user is an admin
+- `confirmation_pending`: boolean, true if a new user account is waiting on email confirmation to be activated
+- `hide_followers`: boolean, true when the user has follower hiding enabled
+- `hide_follows`: boolean, true when the user has follow hiding enabled
+- `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 `verify_credentials` and `update_credentials`
+- `chat_token`: The token needed for Pleroma chat. Only returned in `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.
+
+### Source
+
+Has these additional fields under the `pleroma` object:
+
+- `show_role`: boolean, nullable, true when the user wants his role (e.g admin, moderator) to be shown
+- `no_rich_text` - boolean, nullable, true when html tags are stripped from all statuses requested from the API
+- `discoverable`: boolean, true when the user allows discovery of the account in search results and other services.
+- `actor_type`: string, the type of this account.
+
+## Conversations
+
+Has an additional field under the `pleroma` object:
+
+- `recipients`: The list of the recipients of this Conversation. These will be addressed when replying to this conversation.
+
+## GET `/api/v1/conversations`
+
+Accepts additional parameters:
+
+- `recipients`: Only return conversations with the given recipients (a list of user ids). Usage example: `GET /api/v1/conversations?recipients[]=1&recipients[]=2`
+
+## Account Search
+
+Behavior has changed:
+
+- `/api/v1/accounts/search`: Does not require authentication
+
+## Search (global)
+
+Unlisted posts are available in search results, they are considered to be public posts that shouldn't be shown in local/federated timeline.
+
+## Notifications
+
+Has these additional fields under the `pleroma` object:
+
+- `is_seen`: true if the notification was read by the user
+
+### Move Notification
+
+The `type` value is `move`. Has an additional field:
+
+- `target`: new account
+
+### EmojiReact Notification
+
+The `type` value is `pleroma:emoji_reaction`. Has these fields:
+
+- `emoji`: The used emoji
+- `account`: The account of the user who reacted
+- `status`: The status that was reacted on
+
+## GET `/api/v1/notifications`
+
+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`.
+- `with_move`: boolean, when set to `true` will include Move notifications. `false` by default.
+
+## POST `/api/v1/statuses`
+
+Additional parameters can be added to the JSON body/Form data:
+
+- `preview`: boolean, if set to `true` the post won't be actually posted, but the status entitiy would still be rendered back. This could be useful for previewing rich text/custom emoji, for example.
+- `content_type`: string, contain the MIME type of the status, it is transformed into HTML by the backend. You can get the list of the supported MIME types with the nodeinfo endpoint.
+- `to`: A list of nicknames (like `lain@soykaf.club` or `lain` on the local server) that will be used to determine who is going to be addressed by this post. Using this will disable the implicit addressing by mentioned names in the `status` body, only the people in the `to` list will be addressed. The normal rules for for post visibility are not affected by this and will still apply.
+- `visibility`: string, besides standard MastoAPI values (`direct`, `private`, `unlisted` or `public`) it can be used to address a List by setting it to `list:LIST_ID`.
+- `expires_in`: The number of seconds the posted activity should expire in. When a posted activity expires it will be deleted from the server, and a delete request for it will be federated. This needs to be longer than an hour.
+- `in_reply_to_conversation_id`: Will reply to a given conversation, addressing only the people who are part of the recipient set of that conversation. Sets the visibility to `direct`.
+
+## GET `/api/v1/statuses`
+
+An endpoint to get multiple statuses by IDs.
+
+Required parameters:
+
+- `ids`: array of activity ids
+
+Usage example: `GET /api/v1/statuses/?ids[]=1&ids[]=2`.
+
+Returns: array of Status.
+
+The maximum number of statuses is limited to 100 per request.
+
+## PATCH `/api/v1/update_credentials`
+
+Additional parameters can be added to the JSON body/Form data:
+
+- `no_rich_text` - if true, html tags are stripped from all statuses requested from the API
+- `hide_followers` - if true, user's followers will be hidden
+- `hide_follows` - if true, user's follows will be hidden
+- `hide_followers_count` - if true, user's follower count will be hidden
+- `hide_follows_count` - if true, user's follow count will be hidden
+- `hide_favorites` - if true, user's favorites timeline will be hidden
+- `show_role` - if true, user's role (e.g admin, moderator) will be exposed to anyone in the API
+- `default_scope` - the scope returned under `privacy` key in Source subentity
+- `pleroma_settings_store` - Opaque user settings to be saved on the backend.
+- `skip_thread_containment` - if true, skip filtering out broken threads
+- `allow_following_move` - if true, allows automatically follow moved following accounts
+- `pleroma_background_image` - sets the background image of the user.
+- `discoverable` - if true, discovery of this account in search results and other services is allowed.
+- `actor_type` - the type of this account.
+
+### Pleroma Settings Store
+Pleroma has mechanism that allows frontends to save blobs of json for each user on the backend. This can be used to save frontend-specific settings for a user that the backend does not need to know about.
+
+The parameter should have a form of `{frontend_name: {...}}`, with `frontend_name` identifying your type of client, e.g. `pleroma_fe`. It will overwrite everything under this property, but will not overwrite other frontend's settings.
+
+This information is returned in the `verify_credentials` endpoint.
+
+## Authentication
+
+*Pleroma supports refreshing tokens.
+
+`POST /oauth/token`
+Post here request with grant_type=refresh_token to obtain new access token. Returns an access token.
+
+## Account Registration
+`POST /api/v1/accounts`
+
+Has theses additionnal parameters (which are the same as in Pleroma-API):
+    * `fullname`: optional
+    * `bio`: optional
+    * `captcha_solution`: optional, contains provider-specific captcha solution,
+    * `captcha_token`: optional, contains provider-specific captcha token
+    * `token`: invite token required when the registerations aren't public.

docs/API/pleroma_api.md

@@ -0,0 +1,474 @@
+# Pleroma API
+
+Requests that require it can be authenticated with [an OAuth token](https://tools.ietf.org/html/rfc6749), the `_pleroma_key` cookie, or [HTTP Basic Authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization).
+
+Request parameters can be passed via [query strings](https://en.wikipedia.org/wiki/Query_string) or as [form data](https://www.w3.org/TR/html401/interact/forms.html). Files must be uploaded as `multipart/form-data`.
+
+## `/api/pleroma/emoji`
+### Lists the custom emoji on that server.
+* Method: `GET`
+* Authentication: not required
+* Params: none
+* Response: JSON
+* Example response:
+```json
+{
+  "girlpower": {
+    "tags": [
+      "Finmoji"
+    ],
+    "image_url": "/finmoji/128px/girlpower-128.png"
+  },
+  "education": {
+    "tags": [
+      "Finmoji"
+    ],
+    "image_url": "/finmoji/128px/education-128.png"
+  },
+  "finnishlove": {
+    "tags": [
+      "Finmoji"
+    ],
+    "image_url": "/finmoji/128px/finnishlove-128.png"
+  }
+}
+```
+* Note: Same data as Mastodon API’s `/api/v1/custom_emojis` but in a different format
+
+## `/api/pleroma/follow_import`
+### Imports your follows, for example from a Mastodon CSV file.
+* Method: `POST`
+* Authentication: required
+* Params:
+    * `list`: STRING or FILE containing a whitespace-separated list of accounts to follow
+* Response: HTTP 200 on success, 500 on error
+* Note: Users that can't be followed are silently skipped.
+
+## `/api/pleroma/captcha`
+### Get a new captcha
+* Method: `GET`
+* Authentication: not required
+* Params: none
+* Response: Provider specific JSON, the only guaranteed parameter is `type`
+* Example response: `{"type": "kocaptcha", "token": "whatever", "url": "https://captcha.kotobank.ch/endpoint"}`
+
+## `/api/pleroma/delete_account`
+### Delete an account
+* Method `POST`
+* Authentication: required
+* Params:
+    * `password`: user's password
+* Response: JSON. Returns `{"status": "success"}` if the deletion was successful, `{"error": "[error message]"}` otherwise
+* Example response: `{"error": "Invalid password."}`
+
+## `/api/pleroma/disable_account`
+### Disable an account
+* Method `POST`
+* Authentication: required
+* Params:
+    * `password`: user's password
+* Response: JSON. Returns `{"status": "success"}` if the account was successfully disabled, `{"error": "[error message]"}` otherwise
+* Example response: `{"error": "Invalid password."}`
+
+## `/api/pleroma/admin/`…
+See [Admin-API](admin_api.md)
+
+## `/api/v1/pleroma/notifications/read`
+### Mark notifications as read
+* Method `POST`
+* Authentication: required
+* Params (mutually exclusive):
+    * `id`: a single notification id to read
+    * `max_id`: read all notifications up to this id
+* Response: Notification entity/Array of Notification entities that were read. In case of `max_id`, only the first 80 read notifications will be returned.
+
+## `/api/v1/pleroma/accounts/:id/subscribe`
+### Subscribe to receive notifications for all statuses posted by a user
+* Method `POST`
+* Authentication: required
+* Params:
+    * `id`: account id to subscribe to
+* Response: JSON, returns a mastodon relationship object on success, otherwise returns `{"error": "error_msg"}`
+* Example response:
+```json
+{
+  "id": "abcdefg",
+  "following": true,
+  "followed_by": false,
+  "blocking": false,
+  "muting": false,
+  "muting_notifications": false,
+  "subscribing": true,
+  "requested": false,
+  "domain_blocking": false,
+  "showing_reblogs": true,
+  "endorsed": false
+}
+```
+
+## `/api/v1/pleroma/accounts/:id/unsubscribe`
+### Unsubscribe to stop receiving notifications from user statuses
+* Method `POST`
+* Authentication: required
+* Params:
+    * `id`: account id to unsubscribe from
+* Response: JSON, returns a mastodon relationship object on success, otherwise returns `{"error": "error_msg"}`
+* Example response:
+```json
+{
+  "id": "abcdefg",
+  "following": true,
+  "followed_by": false,
+  "blocking": false,
+  "muting": false,
+  "muting_notifications": false,
+  "subscribing": false,
+  "requested": false,
+  "domain_blocking": false,
+  "showing_reblogs": true,
+  "endorsed": false
+}
+```
+
+## `/api/v1/pleroma/accounts/:id/favourites`
+### Returns favorites timeline of any user
+* Method `GET`
+* Authentication: not required
+* Params:
+    * `id`: the id of the account for whom to return results
+    * `limit`: optional, the number of records to retrieve
+    * `since_id`: optional, returns results that are more recent than the specified id
+    * `max_id`: optional, returns results that are older than the specified id
+* Response: JSON, returns a list of Mastodon Status entities on success, otherwise returns `{"error": "error_msg"}`
+* Example response:
+```json
+[
+  {
+    "account": {
+      "id": "9hptFmUF3ztxYh3Svg",
+      "url": "https://pleroma.example.org/users/nick2",
+      "username": "nick2",
+      ...
+    },
+    "application": {"name": "Web", "website": null},
+    "bookmarked": false,
+    "card": null,
+    "content": "This is :moominmamma: note 0",
+    "created_at": "2019-04-15T15:42:15.000Z",
+    "emojis": [],
+    "favourited": false,
+    "favourites_count": 1,
+    "id": "9hptFmVJ02khbzYJaS",
+    "in_reply_to_account_id": null,
+    "in_reply_to_id": null,
+    "language": null,
+    "media_attachments": [],
+    "mentions": [],
+    "muted": false,
+    "pinned": false,
+    "pleroma": {
+      "content": {"text/plain": "This is :moominmamma: note 0"},
+      "conversation_id": 13679,
+      "local": true,
+      "spoiler_text": {"text/plain": "2hu"}
+    },
+    "reblog": null,
+    "reblogged": false,
+    "reblogs_count": 0,
+    "replies_count": 0,
+    "sensitive": false,
+    "spoiler_text": "2hu",
+    "tags": [{"name": "2hu", "url": "/tag/2hu"}],
+    "uri": "https://pleroma.example.org/objects/198ed2a1-7912-4482-b559-244a0369e984",
+    "url": "https://pleroma.example.org/notice/9hptFmVJ02khbzYJaS",
+    "visibility": "public"
+  }
+]
+```
+
+## `/api/v1/pleroma/accounts/update_*`
+### Set and clear account avatar, banner, and background
+
+- PATCH `/api/v1/pleroma/accounts/update_avatar`: Set/clear user avatar image
+- PATCH `/api/v1/pleroma/accounts/update_banner`: Set/clear user banner image
+- PATCH `/api/v1/pleroma/accounts/update_background`: Set/clear user background image
+
+## `/api/v1/pleroma/accounts/confirmation_resend`
+### Resend confirmation email
+* Method `POST`
+* Params:
+    * `email`: email of that needs to be verified
+* Authentication: not required
+* Response: 204 No Content
+
+## `/api/v1/pleroma/mascot`
+### Gets user mascot image
+* Method `GET`
+* Authentication: required
+
+* Response: JSON. Returns a mastodon media attachment entity.
+* Example response:
+```json
+{
+    "id": "abcdefg",
+    "url": "https://pleroma.example.org/media/abcdefg.png",
+    "type": "image",
+    "pleroma": {
+        "mime_type": "image/png"
+    }
+}
+```
+
+### Updates user mascot image
+* Method `PUT`
+* Authentication: required
+* Params:
+    * `image`: Multipart image
+* Response: JSON. Returns a mastodon media attachment entity
+  when successful, otherwise returns HTTP 415 `{"error": "error_msg"}`
+* Example response:
+```json
+{
+    "id": "abcdefg",
+    "url": "https://pleroma.example.org/media/abcdefg.png",
+    "type": "image",
+    "pleroma": {
+        "mime_type": "image/png"
+    }
+}
+```
+* Note: Behaves exactly the same as `POST /api/v1/upload`.
+  Can only accept images - any attempt to upload non-image files will be met with `HTTP 415 Unsupported Media Type`.
+
+## `/api/pleroma/notification_settings`
+### Updates user notification settings
+* Method `PUT`
+* Authentication: required
+* Params:
+    * `followers`: BOOLEAN field, receives notifications from followers
+    * `follows`: BOOLEAN field, receives notifications from people the user follows
+    * `remote`: BOOLEAN field, receives notifications from people on remote instances
+    * `local`: BOOLEAN field, receives notifications from people on the local instance
+    * `privacy_option`: BOOLEAN field. When set to true, it removes the contents of a message from the push notification.
+* Response: JSON. Returns `{"status": "success"}` if the update was successful, otherwise returns `{"error": "error_msg"}`
+
+## `/api/pleroma/healthcheck`
+### Healthcheck endpoint with additional system data.
+* Method `GET`
+* Authentication: not required
+* Params: none
+* Response: JSON, statuses (200 - healthy, 503 unhealthy).
+* Example response:
+```json
+{
+  "pool_size": 0, # database connection pool
+  "active": 0, # active processes
+  "idle": 0, # idle processes
+  "memory_used": 0.00, # Memory used
+  "healthy": true, # Instance state
+  "job_queue_stats": {} # Job queue stats
+}
+```
+
+## `/api/pleroma/change_email`
+### Change account email
+* Method `POST`
+* Authentication: required
+* Params:
+    * `password`: user's password
+    * `email`: new email
+* Response: JSON. Returns `{"status": "success"}` if the change was successful, `{"error": "[error message]"}` otherwise
+* Note: Currently, Mastodon has no API for changing email. If they add it in future it might be incompatible with Pleroma.
+
+# Pleroma Conversations
+
+Pleroma Conversations have the same general structure that Mastodon Conversations have. The behavior differs in the following ways when using these endpoints:
+
+1. Pleroma Conversations never add or remove recipients, unless explicitly changed by the user.
+2. Pleroma Conversations statuses can be requested by Conversation id.
+3. Pleroma Conversations can be replied to.
+
+Conversations have the additional field "recipients" under the "pleroma" key. This holds a list of all the accounts that will receive a message in this conversation.
+
+The status posting endpoint takes an additional parameter, `in_reply_to_conversation_id`, which, when set, will set the visiblity to direct and address only the people who are the recipients of that Conversation.
+
+
+## `GET /api/v1/pleroma/conversations/:id/statuses`
+### Timeline for a given conversation
+* Method `GET`
+* Authentication: required
+* Params: Like other timelines
+* Response: JSON, statuses (200 - healthy, 503 unhealthy).
+
+## `GET /api/v1/pleroma/conversations/:id`
+### The conversation with the given ID.
+* Method `GET`
+* Authentication: required
+* Params: None
+* Response: JSON, statuses (200 - healthy, 503 unhealthy).
+
+## `PATCH /api/v1/pleroma/conversations/:id`
+### Update a conversation. Used to change the set of recipients.
+* Method `PATCH`
+* Authentication: required
+* Params:
+    * `recipients`: A list of ids of users that should receive posts to this conversation. This will replace the current list of recipients, so submit the full list. The owner of owner of the conversation will always be part of the set of recipients, though.
+* Response: JSON, statuses (200 - healthy, 503 unhealthy)
+
+## `GET /api/v1/pleroma/conversations/read`
+### Marks all user's conversations as read.
+* Method `POST`
+* Authentication: required
+* Params: None
+* Response: JSON, returns a list of Mastodon Conversation entities that were marked as read (200 - healthy, 503 unhealthy).
+
+## `GET /api/pleroma/emoji/packs`
+### Lists the custom emoji packs on the server
+* Method `GET`
+* Authentication: not required
+* Params: None
+* Response: JSON, "ok" and 200 status and the JSON hashmap of "pack name" to "pack contents"
+
+## `PUT /api/pleroma/emoji/packs/:name`
+### Creates an empty custom emoji pack
+* Method `PUT`
+* Authentication: required
+* Params: None
+* Response: JSON, "ok" and 200 status or 409 if the pack with that name already exists
+
+## `DELETE /api/pleroma/emoji/packs/:name`
+### Delete a custom emoji pack
+* Method `DELETE`
+* Authentication: required
+* Params: None
+* Response: JSON, "ok" and 200 status or 500 if there was an error deleting the pack
+
+## `POST /api/pleroma/emoji/packs/:name/update_file`
+### Update a file in a custom emoji pack
+* Method `POST`
+* Authentication: required
+* Params:
+    * if the `action` is `add`, adds an emoji named `shortcode` to the pack `pack_name`,
+      that means that the emoji file needs to be uploaded with the request
+      (thus requiring it to be a multipart request) and be named `file`.
+      There can also be an optional `filename` that will be the new emoji file name
+      (if it's not there, the name will be taken from the uploaded file).
+    * if the `action` is `update`, changes emoji shortcode
+      (from `shortcode` to `new_shortcode` or moves the file (from the current filename to `new_filename`)
+    * if the `action` is `remove`, removes the emoji named `shortcode` and it's associated file
+* Response: JSON, updated "files" section of the pack and 200 status, 409 if the trying to use a shortcode
+  that is already taken, 400 if there was an error with the shortcode, filename or file (additional info
+  in the "error" part of the response JSON)
+
+## `POST /api/pleroma/emoji/packs/:name/update_metadata`
+### Updates (replaces) pack metadata
+* Method `POST`
+* Authentication: required
+* Params:
+  * `new_data`: new metadata to replace the old one
+* Response: JSON, updated "metadata" section of the pack and 200 status or 400 if there was a
+  problem with the new metadata (the error is specified in the "error" part of the response JSON)
+
+## `POST /api/pleroma/emoji/packs/download_from`
+### Requests the instance to download the pack from another instance
+* Method `POST`
+* Authentication: required
+* Params:
+  * `instance_address`: the address of the instance to download from
+  * `pack_name`: the pack to download from that instance
+* Response: JSON, "ok" and 200 status if the pack was downloaded, or 500 if there were
+  errors downloading the pack
+
+## `POST /api/pleroma/emoji/packs/list_from`
+### Requests the instance to list the packs from another instance
+* Method `POST`
+* Authentication: required
+* Params:
+  * `instance_address`: the address of the instance to download from
+* Response: JSON with the pack list, same as if the request was made to that instance's
+  list endpoint directly + 200 status
+
+## `GET /api/pleroma/emoji/packs/:name/download_shared`
+### Requests a local pack from the instance
+* Method `GET`
+* Authentication: not required
+* Params: None
+* 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.
+
+## `PUT /api/v1/pleroma/statuses/:id/reactions/:emoji`
+### React to a post with a unicode emoji
+* Method: `PUT`
+* Authentication: required
+* Params: `emoji`: A single character unicode emoji
+* Response: JSON, the status.
+
+## `DELETE /api/v1/pleroma/statuses/:id/reactions/:emoji`
+### Remove a reaction to a post with a unicode emoji
+* Method: `DELETE`
+* Authentication: required
+* Params: `emoji`: A single character unicode emoji
+* Response: JSON, the status.
+
+## `GET /api/v1/pleroma/statuses/:id/reactions`
+### Get an object of emoji to account mappings with accounts that reacted to the post
+* Method: `GET`
+* Authentication: optional
+* Params: None
+* Response: JSON, a list of emoji/account list tuples, sorted by emoji insertion date, in ascending order, e.g, the first emoji in the list is the oldest.
+* Example Response:
+```json
+[
+  {"name": "😀", "count": 2, "me": true, "accounts": [{"id" => "xyz.."...}, {"id" => "zyx..."}]},
+  {"name": "☕", "count": 1, "me": false, "accounts": [{"id" => "abc..."}]}
+]
+```
+
+## `GET /api/v1/pleroma/statuses/:id/reactions/:emoji`
+### Get an object of emoji to account mappings with accounts that reacted to the post for a specific emoji`
+* Method: `GET`
+* Authentication: optional
+* Params: None
+* Response: JSON, a list of emoji/account list tuples
+* Example Response:
+```json
+[
+  {"name": "😀", "count": 2, "me": true, "accounts": [{"id" => "xyz.."...}, {"id" => "zyx..."}]}
+]
+```

docs/API/prometheus.md

@@ -0,0 +1,22 @@
+# Prometheus Metrics
+
+Pleroma includes support for exporting metrics via the [prometheus_ex](https://github.com/deadtrickster/prometheus.ex) library.
+
+## `/api/pleroma/app_metrics`
+### Exports Prometheus application metrics
+* Method: `GET`
+* Authentication: not required
+* Params: none
+* Response: JSON
+
+## Grafana
+### Config example
+The following is a config example to use with [Grafana](https://grafana.com)
+
+```
+  - job_name: 'beam'
+    metrics_path: /api/pleroma/app_metrics
+    scheme: https
+    static_configs:
+    - targets: ['pleroma.soykaf.com']
+```

docs/administration/CLI_tasks/config.md

@@ -11,17 +11,14 @@
     config :pleroma, configurable_from_database: true
     ```
 
-=== "OTP"
+```sh tab="OTP"
+ ./bin/pleroma_ctl config migrate_to_db
+```
 
-    ```sh
-    ./bin/pleroma_ctl config migrate_to_db
-    ```
+```sh tab="From Source"
+mix pleroma.config migrate_to_db
+```
 
-=== "From Source"
-
-    ```sh
-    mix pleroma.config migrate_to_db
-    ```
 
 ## Transfer config from DB to `config/env.exported_from_db.secret.exs`
 
@@ -32,126 +29,12 @@
     config :pleroma, configurable_from_database: false
     ```
 
-Options:
+To delete transfered settings from database optional flag `-d` can be used. `<env>` is `prod` by default.
 
-- `<path>` - where to save migrated config. E.g. `--path=/tmp`. If file saved into non standart folder, you must manually copy file into directory where Pleroma can read it. For OTP install path will be `PLEROMA_CONFIG_PATH` or `/etc/pleroma`. For installation from source - `config` directory in the pleroma folder.
-- `<env>` - environment, for which is migrated config. By default is `prod`.
-- To delete transferred settings from database optional flag `-d` can be used
+```sh tab="OTP"
+ ./bin/pleroma_ctl config migrate_from_db [--env=<env>] [-d]
+```
 
-=== "OTP"
-    ```sh
-     ./bin/pleroma_ctl config migrate_from_db [--env=<env>] [-d] [--path=<path>]
-    ```
-
-=== "From Source"
-    ```sh
-    mix pleroma.config migrate_from_db [--env=<env>] [-d] [--path=<path>]
-    ```
-
-## Dump all of the config settings defined in the database
-
-=== "OTP"
-
-    ```sh
-     ./bin/pleroma_ctl config dump
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.config dump
-    ```
-
-## List individual configuration groups in the database
-
-=== "OTP"
-
-    ```sh
-     ./bin/pleroma_ctl config groups
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.config groups
-    ```
-
-## Dump the saved configuration values for a specific group or key
-
-e.g., this shows all the settings under `config :pleroma`
-
-=== "OTP"
-
-    ```sh
-    ./bin/pleroma_ctl config dump pleroma
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.config dump pleroma
-    ```
-
-To get values under a specific key:
-
-e.g., this shows all the settings under `config :pleroma, :instance`
-
-=== "OTP"
-
-    ```sh
-    ./bin/pleroma_ctl config dump pleroma instance
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.config dump pleroma instance
-    ```
-
-## Delete the saved configuration values for a specific group or key
-
-e.g., this deletes all the settings under `config :tesla`
-
-=== "OTP"
-
-    ```sh
-    ./bin/pleroma_ctl config delete [--force] tesla
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.config delete [--force] tesla
-    ```
-
-To delete values under a specific key:
-
-e.g., this deletes all the settings under `config :phoenix, :stacktrace_depth`
-
-=== "OTP"
-
-    ```sh
-    ./bin/pleroma_ctl config delete [--force] phoenix stacktrace_depth
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.config delete [--force] phoenix stacktrace_depth
-    ```
-
-## Remove all settings from the database
-
-This forcibly removes all saved values in the database.
-
-=== "OTP"
-
-    ```sh
-    ./bin/pleroma_ctl config [--force] reset
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.config [--force] reset
-    ```
+```sh tab="From Source"
+mix pleroma.config migrate_from_db [--env=<env>] [-d]
+```

docs/administration/CLI_tasks/database.md

@@ -9,18 +9,13 @@
 
 Replaces embedded objects with references to them in the `objects` table. Only needs to be ran once if the instance was created before Pleroma 1.0.5. The reason why this is not a migration is because it could significantly increase the database size after being ran, however after this `VACUUM FULL` will be able to reclaim about 20% (really depends on what is in the database, your mileage may vary) of the db size before the migration.
 
-=== "OTP"
-
-    ```sh
-    ./bin/pleroma_ctl database remove_embedded_objects [option ...]
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.database remove_embedded_objects [option ...]
-    ```
+```sh tab="OTP"
+./bin/pleroma_ctl database remove_embedded_objects [<options>]
+```
 
+```sh tab="From Source"
+mix pleroma.database remove_embedded_objects [<options>]
+```
 
 ### Options
 - `--vacuum` - run `VACUUM FULL` after the embedded objects are replaced with their references
@@ -32,17 +27,13 @@ This will prune remote posts older than 90 days (configurable with [`config :ple
 !!! danger
     The disk space will only be reclaimed after `VACUUM FULL`. You may run out of disk space during the execution of the task or vacuuming if you don't have about 1/3rds of the database size free.
 
-=== "OTP"
+```sh tab="OTP"
+./bin/pleroma_ctl database prune_objects [<options>]
+```
 
-    ```sh
-    ./bin/pleroma_ctl database prune_objects [option ...]
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.database prune_objects [option ...]
-    ```
+```sh tab="From Source"
+mix pleroma.database prune_objects [<options>]
+```
 
 ### Options
 - `--vacuum` - run `VACUUM FULL` after the objects are pruned
@@ -51,111 +42,30 @@ This will prune remote posts older than 90 days (configurable with [`config :ple
 
 Can be safely re-run
 
-=== "OTP"
+```sh tab="OTP"
+./bin/pleroma_ctl database bump_all_conversations
+```
 
-    ```sh
-    ./bin/pleroma_ctl database bump_all_conversations
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.database bump_all_conversations
-    ```
+```sh tab="From Source"
+mix pleroma.database bump_all_conversations
+```
 
 ## Remove duplicated items from following and update followers count for all users
 
-=== "OTP"
+```sh tab="OTP"
+./bin/pleroma_ctl database update_users_following_followers_counts
+```
 
-    ```sh
-    ./bin/pleroma_ctl database update_users_following_followers_counts
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.database update_users_following_followers_counts
-    ```
+```sh tab="From Source"
+mix pleroma.database update_users_following_followers_counts
+```
 
 ## Fix the pre-existing "likes" collections for all objects
 
-=== "OTP"
+```sh tab="OTP"
+./bin/pleroma_ctl database fix_likes_collections
+```
 
-    ```sh
-    ./bin/pleroma_ctl database fix_likes_collections
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.database fix_likes_collections
-    ```
-
-## Vacuum the database
-
-### Analyze
-
-Running an `analyze` vacuum job can improve performance by updating statistics used by the query planner. **It is safe to cancel this.**
-
-=== "OTP"
-
-    ```sh
-    ./bin/pleroma_ctl database vacuum analyze
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.database vacuum analyze
-    ```
-
-### Full
-
-Running a `full` vacuum job rebuilds your entire database by reading all of the data and rewriting it into smaller
-and more compact files with an optimized layout. This process will take a long time and use additional disk space as
-it builds the files side-by-side the existing database files. It can make your database faster and use less disk space,
-but should only be run if necessary. **It is safe to cancel this.**
-
-=== "OTP"
-
-    ```sh
-    ./bin/pleroma_ctl database vacuum full
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.database vacuum full
-    ```
-
-## Add expiration to all local statuses
-
-=== "OTP"
-
-    ```sh
-    ./bin/pleroma_ctl database ensure_expiration
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.database ensure_expiration
-    ```
-
-## Change Text Search Configuration
-
-Change `default_text_search_config` for database and (if necessary) text_search_config used in index, then rebuild index (it may take time). 
-
-=== "OTP"
-
-    ```sh
-    ./bin/pleroma_ctl database set_text_search_config english
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.database set_text_search_config english
-    ```
-
-See [PostgreSQL documentation](https://www.postgresql.org/docs/current/textsearch-configuration.html) and `docs/configuration/howto_search_cjk.md` for more detail.
+```sh tab="From Source"
+mix pleroma.database fix_likes_collections
+```

docs/administration/CLI_tasks/digest.md

@@ -4,30 +4,22 @@
 
 ## Send digest email since given date (user registration date by default) ignoring user activity status.
 
-=== "OTP"
+```sh tab="OTP"
+ ./bin/pleroma_ctl digest test <nickname> [<since_date>]
+```
 
-    ```sh
-     ./bin/pleroma_ctl digest test <nickname> [since_date]
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.digest test <nickname> [since_date]
-    ```
+```sh tab="From Source"
+mix pleroma.digest test <nickname> [<since_date>]
+```
 
 
 Example: 
 
-=== "OTP"
+```sh tab="OTP"
+./bin/pleroma_ctl digest test donaldtheduck 2019-05-20
+```
 
-    ```sh
-    ./bin/pleroma_ctl digest test donaldtheduck 2019-05-20
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.digest test donaldtheduck 2019-05-20
-    ```
+```sh tab="From Source"
+mix pleroma.digest test donaldtheduck 2019-05-20
+```
 

docs/administration/CLI_tasks/email.md

@@ -1,45 +1,24 @@
-# EMail administration tasks
+# Managing emails
 
 {! backend/administration/CLI_tasks/general_cli_task_info.include !}
 
 ## Send test email (instance email by default)
 
-=== "OTP"
+```sh tab="OTP"
+ ./bin/pleroma_ctl email test [--to <destination email address>]
+```
 
-    ```sh
-     ./bin/pleroma_ctl email test [--to <destination email address>]
-    ```
+```sh tab="From Source"
+mix pleroma.email test [--to <destination email address>]
+```
 
-=== "From Source"
 
-    ```sh
-    mix pleroma.email test [--to <destination email address>]
-    ```
+Example: 
 
-Example:
+```sh tab="OTP"
+./bin/pleroma_ctl email test --to root@example.org
+```
 
-=== "OTP"
-
-    ```sh
-    ./bin/pleroma_ctl email test --to root@example.org
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.email test --to root@example.org
-    ```
-
-## Send confirmation emails to all unconfirmed user accounts
-
-=== "OTP"
-
-    ```sh
-     ./bin/pleroma_ctl email resend_confirmation_emails
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.email resend_confirmation_emails
-    ```
+```sh tab="From Source"
+mix pleroma.email test --to root@example.org
+```

docs/administration/CLI_tasks/emoji.md

@@ -4,15 +4,13 @@
 
 ## Lists emoji packs and metadata specified in the manifest
 
-=== "OTP"
-    ```sh
-    ./bin/pleroma_ctl emoji ls-packs [option ...]
-    ```
+```sh tab="OTP"
+./bin/pleroma_ctl emoji ls-packs [<options>]
+```
 
-=== "From Source"
-    ```sh
-    mix pleroma.emoji ls-packs [option ...]
-    ```
+```sh tab="From Source"
+mix pleroma.emoji ls-packs [<options>]
+```
 
 
 ### Options
@@ -20,42 +18,29 @@
 
 ## Fetch, verify and install the specified packs from the manifest into `STATIC-DIR/emoji/PACK-NAME`
 
-=== "OTP"
-    ```sh
-    ./bin/pleroma_ctl emoji get-packs [option ...] <pack ...>
-    ```
+```sh tab="OTP"
+./bin/pleroma_ctl emoji get-packs [<options>] <packs>
+```
 
-=== "From Source"
-    ```sh
-    mix pleroma.emoji get-packs [option ...] <pack ...>
-    ```
+```sh tab="From Source"
+mix pleroma.emoji get-packs [<options>] <packs>
+```
 
 ### Options
 - `-m, --manifest PATH/URL` - same as [`ls-packs`](#ls-packs)
 
 ## Create a new manifest entry and a file list from the specified remote pack file
 
-=== "OTP"
-    ```sh
-    ./bin/pleroma_ctl emoji gen-pack PACK-URL
-    ```
+```sh tab="OTP"
+./bin/pleroma_ctl emoji gen-pack PACK-URL
+```
 
-=== "From Source"
-    ```sh
-    mix pleroma.emoji gen-pack PACK-URL
-    ```
+```sh tab="From Source"
+mix pleroma.emoji gen-pack PACK-URL
+```
 
-Currently, only .zip archives are recognized as remote pack files and packs are therefore assumed to be zip archives. This command is intended to run interactively and will first ask you some basic questions about the pack, then download the remote file and generate an SHA256 checksum for it, then generate an emoji file list for you.
+Currently, only .zip archives are recognized as remote pack files and packs are therefore assumed to be zip archives. This command is intended to run interactively and will first ask you some basic questions about the pack, then download the remote file and generate an SHA256 checksum for it, then generate an emoji file list for you. 
 
-  The manifest entry will either be written to a newly created `pack_name.json` file (pack name is asked in questions) or appended to the existing one, *replacing* the old pack with the same name if it was in the file previously.
+  The manifest entry will either be written to a newly created `index.json` file or appended to the existing one, *replacing* the old pack with the same name if it was in the file previously.
 
   The file list will be written to the file specified previously, *replacing* that file. You _should_ check that the file list doesn't contain anything you don't need in the pack, that is, anything that is not an emoji (the whole pack is downloaded, but only emoji files are extracted).
-
-## Reload emoji packs
-
-=== "OTP"
-    ```sh
-    ./bin/pleroma_ctl emoji reload
-    ```
-
-This command only works with OTP releases.

docs/administration/CLI_tasks/frontend.md

@@ -1,96 +0,0 @@
-# Managing frontends
-
-=== "OTP"
-
-    ```sh
-    ./bin/pleroma_ctl frontend install <frontend> [--ref <ref>] [--file <file>] [--build-url <build-url>] [--path <path>] [--build-dir <build-dir>]
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.frontend install <frontend> [--ref <ref>] [--file <file>] [--build-url <build-url>] [--path <path>] [--build-dir <build-dir>]
-    ```
-
-Frontend can be installed either from local zip file, or automatically downloaded from the web.
-
-You can give all the options directly on the command line, but missing information will be filled out by looking at the data configured under `frontends.available` in the config files.
-
-Currently, known `<frontend>` values are:
-
-- [admin-fe](https://git.pleroma.social/pleroma/admin-fe)
-- [kenoma](http://git.pleroma.social/lambadalambda/kenoma)
-- [pleroma-fe](http://git.pleroma.social/pleroma/pleroma-fe)
-- [fedi-fe](https://git.pleroma.social/pleroma/fedi-fe)
-- [soapbox](https://gitlab.com/soapbox-pub/soapbox)
-
-You can still install frontends that are not configured, see below.
-
-## Example installations for a known frontend
-
-For a frontend configured under the `available` key, it's enough to install it by name.
-
-=== "OTP"
-
-    ```sh
-    ./bin/pleroma_ctl frontend install pleroma
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.frontend install pleroma
-    ```
-
-This will download the latest build for the pre-configured `ref` and install it. It can then be configured as the one of the served frontends in the config file (see `primary` or `admin`).
-
-You can override any of the details. To install a pleroma build from a different URL, you could do this:
-
-=== "OTP"
-
-    ```sh
-    ./bin/pleroma_ctl frontend install pleroma --ref 2hu_edition --build-url https://example.org/raymoo.zip
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.frontend install pleroma --ref 2hu_edition --build-url https://example.org/raymoo.zip
-    ```
-
-Similarly, you can also install from a local zip file.
-
-=== "OTP"
-
-    ```sh
-    ./bin/pleroma_ctl frontend install pleroma --ref mybuild --file ~/Downloads/doomfe.zip
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.frontend install pleroma --ref mybuild --file ~/Downloads/doomfe.zip
-    ```
-
-The resulting frontend will always be installed into a folder of this template: `${instance_static}/frontends/${name}/${ref}`.
-
-Careful: This folder will be completely replaced on installation.
-
-## Example installation for an unknown frontend
-
-The installation process is the same, but you will have to give all the needed options on the command line. For example:
-
-=== "OTP"
-
-    ```sh
-    ./bin/pleroma_ctl frontend install gensokyo --ref master --build-url https://gensokyo.2hu/builds/marisa.zip
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.frontend install gensokyo --ref master --build-url https://gensokyo.2hu/builds/marisa.zip
-    ```
-
-If you don't have a zip file but just want to install a frontend from a local path, you can simply copy the files over a folder of this template: `${instance_static}/frontends/${name}/${ref}`.
-

docs/administration/CLI_tasks/instance.md

@@ -3,17 +3,13 @@
 {! backend/administration/CLI_tasks/general_cli_task_info.include !}
 
 ## Generate a new configuration file
-=== "OTP"
+```sh tab="OTP"
+ ./bin/pleroma_ctl instance gen [<options>]
+```
 
-    ```sh
-     ./bin/pleroma_ctl instance gen [option ...]
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.instance gen [option ...]
-    ```
+```sh tab="From Source"
+mix pleroma.instance gen [<options>]
+```
 
 
 If any of the options are left unspecified, you will be prompted interactively.
@@ -37,9 +33,3 @@ If any of the options are left unspecified, you will be prompted interactively.
 - `--static-dir <path>` - the directory custom public files should be read from (custom emojis, frontend bundle overrides, robots.txt, etc.)
 - `--listen-ip <ip>` - the ip the app should listen to, defaults to 127.0.0.1
 - `--listen-port <port>` - the port the app should listen to, defaults to 4000
-- `--strip-uploads-location <Y|N>` - use ExifTool to strip uploads of sensitive location data
-- `--read-uploads-description <Y|N>` - use ExifTool to read image descriptions from uploads
-- `--anonymize-uploads <Y|N>` - randomize uploaded filenames
-- `--dedupe-uploads <Y|N>` - store files based on their hash to reduce data storage requirements if duplicates are uploaded with different filenames
-- `--skip-release-env` - skip generation the release environment file
-- `--release-env-file` - release environment file path

docs/administration/CLI_tasks/oauth_app.md

@@ -1,20 +0,0 @@
-# Creating trusted OAuth App
-
-{! backend/administration/CLI_tasks/general_cli_task_info.include !}
-
-## Create trusted OAuth App.
-
-Optional params:
-  * `-s SCOPES` - scopes for app, e.g. `read,write,follow,push`.
-
-=== "OTP"
-
-    ```sh
-     ./bin/pleroma_ctl app create -n APP_NAME -r REDIRECT_URI
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.app create -n APP_NAME -r REDIRECT_URI
-    ```

docs/administration/CLI_tasks/relay.md

@@ -4,42 +4,30 @@
 
 ## Follow a relay
 
-=== "OTP"
+```sh tab="OTP"
+./bin/pleroma_ctl relay follow <relay_url>
+```
 
-    ```sh
-    ./bin/pleroma_ctl relay follow <relay_url>
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.relay follow <relay_url>
-    ```
+```sh tab="From Source"
+mix pleroma.relay follow <relay_url>
+```
 
 ## Unfollow a remote relay
 
-=== "OTP"
+```sh tab="OTP"
+./bin/pleroma_ctl relay unfollow <relay_url>
+```
 
-    ```sh
-    ./bin/pleroma_ctl relay unfollow <relay_url>
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.relay unfollow <relay_url>
-    ```
+```sh tab="From Source"
+mix pleroma.relay unfollow <relay_url>
+```
 
 ## List relay subscriptions
 
-=== "OTP"
+```sh tab="OTP"
+./bin/pleroma_ctl relay list
+```
 
-    ```sh
-    ./bin/pleroma_ctl relay list
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.relay list
-    ```
+```sh tab="From Source"
+mix pleroma.relay list
+```

docs/administration/CLI_tasks/robots_txt.md

@@ -1,21 +0,0 @@
-# Managing robots.txt
-
-{! backend/administration/CLI_tasks/general_cli_task_info.include !}
-
-## Generate a new robots.txt file and add it to the static directory
-
-The `robots.txt` that ships by default is permissive. It allows well-behaved search engines to index all of your instance's URIs.
-
-If you want to generate a restrictive `robots.txt`, you can run the following mix task. The generated `robots.txt` will be written in your instance [static directory](../../../configuration/static_dir/).
-
-=== "OTP"
-
-    ```sh
-    ./bin/pleroma_ctl robots_txt disallow_all
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.robots_txt disallow_all
-    ```

docs/administration/CLI_tasks/uploads.md

@@ -3,17 +3,13 @@
 {! backend/administration/CLI_tasks/general_cli_task_info.include !}
 
 ## Migrate uploads from local to remote storage
-=== "OTP"
+```sh tab="OTP"
+ ./bin/pleroma_ctl uploads migrate_local <target_uploader> [<options>]
+```
 
-    ```sh
-     ./bin/pleroma_ctl uploads migrate_local <target_uploader> [option ...]
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.uploads migrate_local <target_uploader> [option ...]
-    ```
+```sh tab="From Source"
+mix pleroma.uploads migrate_local <target_uploader> [<options>]
+```
 
 ### Options
 - `--delete` - delete local uploads after migrating them to the target uploader

docs/administration/CLI_tasks/user.md

@@ -4,17 +4,13 @@
 
 ## Create a user
 
-=== "OTP"
+```sh tab="OTP"
+./bin/pleroma_ctl user new <email> [<options>]
+```
 
-    ```sh
-    ./bin/pleroma_ctl user new <nickname> <email> [option ...]
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.user new <nickname> <email> [option ...]
-    ```
+```sh tab="From Source"
+mix pleroma.user new <email> [<options>]
+```
 
 
 ### Options
@@ -26,33 +22,23 @@
 - `-y`, `--assume-yes`/`--no-assume-yes` - whether to assume yes to all questions
 
 ## List local users
+```sh tab="OTP"
+ ./bin/pleroma_ctl user list
+```
 
-=== "OTP"
-
-    ```sh
-     ./bin/pleroma_ctl user list
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.user list
-    ```
+```sh tab="From Source"
+mix pleroma.user list
+```
 
 
 ## Generate an invite link
+```sh tab="OTP"
+ ./bin/pleroma_ctl user invite [<options>]
+```
 
-=== "OTP"
-
-    ```sh
-     ./bin/pleroma_ctl user invite [option ...]
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.user invite [option ...]
-    ```
+```sh tab="From Source"
+mix pleroma.user invite [<options>]
+```
 
 
 ### Options
@@ -60,243 +46,135 @@
 - `--max-use NUMBER` - maximum numbers of token uses
 
 ## List generated invites
+```sh tab="OTP"
+ ./bin/pleroma_ctl user invites
+```
 
-=== "OTP"
-
-    ```sh
-     ./bin/pleroma_ctl user invites
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.user invites
-    ```
+```sh tab="From Source"
+mix pleroma.user invites
+```
 
 
 ## Revoke invite
+```sh tab="OTP"
+ ./bin/pleroma_ctl user revoke_invite <token_or_id>
+```
 
-=== "OTP"
-
-    ```sh
-     ./bin/pleroma_ctl user revoke_invite <token>
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.user revoke_invite <token>
-    ```
+```sh tab="From Source"
+mix pleroma.user revoke_invite <token_or_id>
+```
 
 
 ## Delete a user
+```sh tab="OTP"
+ ./bin/pleroma_ctl user rm <nickname>
+```
 
-=== "OTP"
-
-    ```sh
-     ./bin/pleroma_ctl user rm <nickname>
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.user rm <nickname>
-    ```
+```sh tab="From Source"
+mix pleroma.user rm <nickname>
+```
 
 
 ## Delete user's posts and interactions
+```sh tab="OTP"
+ ./bin/pleroma_ctl user delete_activities <nickname>
+```
 
-=== "OTP"
-
-    ```sh
-     ./bin/pleroma_ctl user delete_activities <nickname>
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.user delete_activities <nickname>
-    ```
+```sh tab="From Source"
+mix pleroma.user delete_activities <nickname>
+```
 
 
 ## Sign user out from all applications (delete user's OAuth tokens and authorizations)
+```sh tab="OTP"
+ ./bin/pleroma_ctl user sign_out <nickname>
+```
 
-=== "OTP"
-
-    ```sh
-     ./bin/pleroma_ctl user sign_out <nickname>
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.user sign_out <nickname>
-    ```
-
-## Activate a user
-
-=== "OTP"
-
-    ```sh
-     ./bin/pleroma_ctl user activate NICKNAME
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.user activate NICKNAME
-    ```
-
-## Deactivate a user and unsubscribes local users from the user
-
-=== "OTP"
-
-    ```sh
-     ./bin/pleroma_ctl user deactivate NICKNAME
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.user deactivate NICKNAME
-    ```
+```sh tab="From Source"
+mix pleroma.user sign_out <nickname>
+```
 
 
-## Deactivate all accounts from an instance and unsubscribe local users on it
+## Deactivate or activate a user 
+```sh tab="OTP"
+ ./bin/pleroma_ctl user toggle_activated <nickname> 
+```
 
-=== "OTP"
+```sh tab="From Source"
+mix pleroma.user toggle_activated <nickname> 
+```
 
-    ```sh
-     ./bin/pleroma_ctl user deactivate_all_from_instance <instance>
-    ```
 
-=== "From Source"
+## Unsubscribe local users from a user and deactivate the user
+```sh tab="OTP"
+ ./bin/pleroma_ctl user unsubscribe NICKNAME
+```
 
-    ```sh
-    mix pleroma.user deactivate_all_from_instance <instance>
-    ```
+```sh tab="From Source"
+mix pleroma.user unsubscribe NICKNAME
+```
+
+
+## Unsubscribe local users from an instance and deactivate all accounts on it
+```sh tab="OTP"
+ ./bin/pleroma_ctl user unsubscribe_all_from_instance <instance>
+```
+
+```sh tab="From Source"
+mix pleroma.user unsubscribe_all_from_instance <instance>
+```
 
 
 ## Create a password reset link for user
+```sh tab="OTP"
+ ./bin/pleroma_ctl user reset_password <nickname>
+```
 
-=== "OTP"
-
-    ```sh
-     ./bin/pleroma_ctl user reset_password <nickname>
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.user reset_password <nickname>
-    ```
-
-
-## Disable Multi Factor Authentication (MFA/2FA) for a user
-
-=== "OTP"
-
-    ```sh
-     ./bin/pleroma_ctl user reset_mfa <nickname>
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.user reset_mfa <nickname>
-    ```
+```sh tab="From Source"
+mix pleroma.user reset_password <nickname>
+```
 
 
 ## Set the value of the given user's settings
+```sh tab="OTP"
+ ./bin/pleroma_ctl user set <nickname> [<options>]
+```
 
-=== "OTP"
-
-    ```sh
-     ./bin/pleroma_ctl user set <nickname> [option ...]
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.user set <nickname> [option ...]
-    ```
+```sh tab="From Source"
+mix pleroma.user set <nickname> [<options>]
+```
 
 ### Options
-- `--admin`/`--no-admin` - whether the user should be an admin
-- `--confirmed`/`--no-confirmed` - whether the user account is confirmed
 - `--locked`/`--no-locked` - whether the user should be locked
 - `--moderator`/`--no-moderator` - whether the user should be a moderator
+- `--admin`/`--no-admin` - whether the user should be an admin
 
 ## Add tags to a user
+```sh tab="OTP"
+ ./bin/pleroma_ctl user tag <nickname> <tags>
+```
 
-=== "OTP"
-
-    ```sh
-     ./bin/pleroma_ctl user tag <nickname> <tags>
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.user tag <nickname> <tags>
-    ```
+```sh tab="From Source"
+mix pleroma.user tag <nickname> <tags>
+```
 
 
 ## Delete tags from a user
+```sh tab="OTP"
+ ./bin/pleroma_ctl user untag <nickname> <tags>
+```
 
-=== "OTP"
-
-    ```sh
-     ./bin/pleroma_ctl user untag <nickname> <tags>
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.user untag <nickname> <tags>
-    ```
+```sh tab="From Source"
+mix pleroma.user untag <nickname> <tags>
+```
 
 
 ## Toggle confirmation status of the user
+```sh tab="OTP"
+ ./bin/pleroma_ctl user toggle_confirmed <nickname>
+```
 
-=== "OTP"
+```sh tab="From Source"
+mix pleroma.user toggle_confirmed <nickname>
+```
 
-    ```sh
-     ./bin/pleroma_ctl user confirm <nickname>
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.user confirm <nickname>
-    ```
-
-## Set confirmation status for all regular active users
-*Admins and moderators are excluded*
-
-=== "OTP"
-
-    ```sh
-     ./bin/pleroma_ctl user confirm_all
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.user confirm_all
-    ```
-
-## Revoke confirmation status for all regular active users
-*Admins and moderators are excluded*
-
-=== "OTP"
-
-    ```sh
-     ./bin/pleroma_ctl user unconfirm_all
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.user unconfirm_all
-    ```

docs/administration/backup.md

@@ -5,26 +5,22 @@
 1. Stop the Pleroma service.
 2. Go to the working directory of Pleroma (default is `/opt/pleroma`)
 3. Run `sudo -Hu postgres pg_dump -d <pleroma_db> --format=custom -f </path/to/backup_location/pleroma.pgdump>` (make sure the postgres user has write access to the destination file)
-4. Copy `pleroma.pgdump`, `config/prod.secret.exs`, `config/setup_db.psql` (if still available) and the `uploads` folder to your backup destination. If you have other modifications, copy those changes too.
+4. Copy `pleroma.pgdump`, `config/prod.secret.exs` and the `uploads` folder to your backup destination. If you have other modifications, copy those changes too.
 5. Restart the Pleroma service.
 
 ## Restore/Move
 
-1. Optionally reinstall Pleroma (either on the same server or on another server if you want to move servers).
+1. Optionally reinstall Pleroma (either on the same server or on another server if you want to move servers). Try to use the same database name.
 2. Stop the Pleroma service.
 3. Go to the working directory of Pleroma (default is `/opt/pleroma`)
 4. Copy the above mentioned files back to their original position.
-5. Drop the existing database and user if restoring in-place. `sudo -Hu postgres psql -c 'DROP DATABASE <pleroma_db>;';` `sudo -Hu postgres psql -c 'DROP USER <pleroma_db>;'`
-6. Restore the database schema and pleroma postgres role the with the original `setup_db.psql` if you have it: `sudo -Hu postgres psql -f config/setup_db.psql`. 
-
-  Alternatively, run the `mix pleroma.instance gen` task again. You can ignore most of the questions, but make the database user, name, and password the same as found in your backup of `config/prod.secret.exs`. Then run the restoration of the pleroma role and schema with of the generated `config/setup_db.psql` as instructed above. You may delete the `config/generated_config.exs` file as it is not needed.
-
-7. Now restore the Pleroma instance's data into the empty database schema: `sudo -Hu postgres pg_restore -d <pleroma_db> -v -1 </path/to/backup_location/pleroma.pgdump>`
-8. If you installed a newer Pleroma version, you should run `mix ecto.migrate`[^1]. This task performs database migrations, if there were any.
-9. Restart the Pleroma service.
-10. Run `sudo -Hu postgres vacuumdb --all --analyze-in-stages`. This will quickly generate the statistics so that postgres can properly plan queries.
-11. If setting up on a new server configure Nginx by using the `installation/pleroma.nginx` config sample or reference the Pleroma installation guide for your OS which contains the Nginx configuration instructions.
-
+5. Drop the existing database and recreate an empty one `sudo -Hu postgres psql -c 'DROP DATABASE <pleroma_db>;';` `sudo -Hu postgres psql -c 'CREATE DATABASE <pleroma_db>;';`
+6. Run `sudo -Hu postgres pg_restore -d <pleroma_db> -v -1 </path/to/backup_location/pleroma.pgdump>`
+7. If you installed a newer Pleroma version, you should run `mix ecto.migrate`[^1]. This task performs database migrations, if there were any.
+8. Restart the Pleroma service.
+9. After you've restarted Pleroma, you will notice that postgres will take up more cpu resources than usual. A lot in fact. To fix this you must do a VACUUM ANLAYZE. This can also be done while the instance is still running like so: 
+   $ sudo -u postgres psql pleroma_database_name
+   pleroma=# VACUUM ANALYZE;
 [^1]: Prefix with `MIX_ENV=prod` to run it using the production config file.
 
 ## Remove
@@ -36,6 +32,6 @@
 3. Disable pleroma from systemd `systemctl disable pleroma`
 4. Remove the files and folders you created during installation (see installation guide). This includes the pleroma, nginx and systemd files and folders.
 5. Reload nginx now that the configuration is removed `systemctl reload nginx`
-6. Remove the database and database user `sudo -Hu postgres psql -c 'DROP DATABASE <pleroma_db>;';` `sudo -Hu postgres psql -c 'DROP USER <pleroma_db>;'`
+6. Remove the database and database user `sudo -Hu postgres psql -c 'DROP DATABASE <pleroma_db>;';` `sudo -Hu postgres psql -c 'DROP USER <pleroma_db>;';`
 7. Remove the system user `userdel pleroma`
 8. Remove the dependencies that you don't need anymore (see installation guide). Make sure you don't remove packages that are still needed for other software that you have running!

docs/administration/updating.md

@@ -1,6 +1,6 @@
 # Updating your instance
 
-You should **always check the [release notes/changelog](https://git.pleroma.social/pleroma/pleroma/-/releases)** in case there are config deprecations, special update steps, etc.
+You should **always check the release notes/changelog** in case there are config deprecations, special update special update steps, etc.
 
 Besides that, doing the following is generally enough:
 
@@ -17,11 +17,10 @@ su pleroma -s $SHELL -lc "./bin/pleroma_ctl migrate"
 ## For from source installations (using git)
 
 1. Go to the working directory of Pleroma (default is `/opt/pleroma`)
-2. Run `git checkout <tagged release>` [^1]. e.g. `git checkout v2.4.5` This pulls the [tagged release](https://git.pleroma.social/pleroma/pleroma/-/releases) from upstream.
-3. Run `mix deps.get` [^1]. This pulls in any new dependencies.
+2. Run `git pull`. This pulls the latest changes from upstream.
+3. Run `mix deps.get`. This pulls in any new dependencies.
 4. Stop the Pleroma service.
-5. Run `mix ecto.migrate` [^1] [^2]. This task performs database migrations, if there were any.
+5. Run `mix ecto.migrate`[^1]. This task performs database migrations, if there were any.
 6. Start the Pleroma service.
 
-[^1]: Depending on which install guide you followed (for example on Debian/Ubuntu), you want to run `git` and `mix` tasks as `pleroma` user by adding `sudo -Hu pleroma` before the command.
-[^2]: Prefix with `MIX_ENV=prod` to run it using the production config file.
+[^1]: Prefix with `MIX_ENV=prod` to run it using the production config file.

docs/clients.md

@@ -1,124 +1,99 @@
 # Pleroma Clients
-Note: Additional clients may be working but theses are officially supporting Pleroma.
+Note: Additionnal clients may be working but theses are officially supporting Pleroma.
 Feel free to contact us to be added to this list!
 
 ## Desktop
 ### Roma for Desktop
 - Homepage: <https://www.pleroma.com/#desktopApp>
 - Source Code: <https://github.com/roma-apps/roma-desktop>
-- Platforms: Windows, Mac, Linux
-- Features: MastoAPI, Streaming Ready
+- Platforms: Windows, Mac, (Linux?)
+- Features: Streaming Ready
 
 ### Social
-- Source Code: <https://gitlab.gnome.org/World/Social>
+- Source Code: <https://gitlab.gnome.org/BrainBlasted/Social>
 - Contact: [@brainblasted@social.libre.fi](https://social.libre.fi/users/brainblasted)
 - Platforms: Linux (GNOME)
 - Note(2019-01-28): Not at a pre-alpha stage yet
-- Features: MastoAPI
 
 ### Whalebird
-- Homepage: <https://whalebird.social/>
+- Homepage: <https://whalebird.org/>
 - Source Code: <https://github.com/h3poteto/whalebird-desktop>
 - Contact: [@h3poteto@pleroma.io](https://pleroma.io/users/h3poteto)
 - Platforms: Windows, Mac, Linux
-- Features: MastoAPI, Streaming Ready
+- Features: Streaming Ready
 
 ## Handheld
-### AndStatus
-- Homepage: <http://andstatus.org/>
-- Source Code: <https://github.com/andstatus/andstatus/>
-- Platforms: Android
-- Features: MastoAPI, ActivityPub (Client-to-Server)
-
 ### Amaroq
 - Homepage: <https://itunes.apple.com/us/app/amaroq-for-mastodon/id1214116200>
 - Source Code: <https://github.com/ReticentJohn/Amaroq>
 - Contact: [@eurasierboy@mastodon.social](https://mastodon.social/users/eurasierboy)
 - Platforms: iOS
-- Features: MastoAPI, No Streaming
+- Features: No Streaming
 
 ### Fedilab
 - Homepage: <https://fedilab.app/>
 - Source Code: <https://framagit.org/tom79/fedilab/>
 - Contact: [@fedilab@framapiaf.org](https://framapiaf.org/users/fedilab)
 - Platforms: Android
-- Features: MastoAPI, Streaming Ready, Moderation, Text Formatting
+- Features: Streaming Ready, Moderation, Text Formatting 
 
 ### Kyclos
 - Source Code: <https://git.pleroma.social/pleroma/harbour-kyclos>
 - Platforms: SailfishOS
-- Features: MastoAPI, No Streaming
+- Features: No Streaming
 
-### Husky
-- Source code: <https://git.mentality.rip/FWGS/Husky>
-- Contact: [@Husky@enigmatic.observer](https://enigmatic.observer/users/Husky)
+### Nekonium
+- Homepage: [F-Droid Repository](https://repo.gdgd.jp.net/), [Google Play](https://play.google.com/store/apps/details?id=com.apps.nekonium), [Amazon](https://www.amazon.co.jp/dp/B076FXPRBC/)
+- Source: <https://gogs.gdgd.jp.net/lin/nekonium>
+- Contact: [@lin@pleroma.gdgd.jp.net](https://pleroma.gdgd.jp.net/users/lin)
 - Platforms: Android
-- Features: MastoAPI, No Streaming, Emoji Reactions, Text Formatting, FE Stickers
+- Features: Streaming Ready
 
-### Fedi
-- Homepage: <https://www.fediapp.com/>
-- Source Code: Proprietary, but gratis
+### Roma
+- Homepage: <https://www.pleroma.com/#mobileApps>
+- Source Code: [iOS](https://github.com/roma-apps/roma-ios), [Android](https://github.com/roma-apps/roma-android)
 - Platforms: iOS, Android
-- Features: MastoAPI, Pleroma-specific features like Reactions
+- Features: No Streaming
 
 ### Tusky
 - Homepage: <https://tuskyapp.github.io/>
 - Source Code: <https://github.com/tuskyapp/Tusky>
 - Contact: [@ConnyDuck@mastodon.social](https://mastodon.social/users/ConnyDuck)
 - Platforms: Android
-- Features: MastoAPI, No Streaming
+- Features: No Streaming
 
 ### Twidere
 - Homepage: <https://twidere.mariotaku.org/>
-- Source Code: <https://github.com/TwidereProject/Twidere-Android/>
+- Source Code: <https://github.com/TwidereProject/Twidere-Android/>, <https://github.com/TwidereProject/Twidere-iOS/>
 - Contact: <me@mariotaku.org>
-- Platform: Android
-- Features: MastoAPI, No Streaming
-
-### Indigenous
-- Homepage: <https://indigenous.realize.be/>
-- Source Code: <https://github.com/swentel/indigenous-android/>
-- Contact: [@swentel@realize.be](https://realize.be)
-- Platforms: Android
-- Features: MastoAPI, No Streaming
+- Platform: Android, iOS
+- Features: No Streaming
 
 ## Alternative Web Interfaces
 ### Brutaldon
 - Homepage: <https://jfm.carcosa.net/projects/software/brutaldon/>
 - Source Code: <https://git.carcosa.net/jmcbray/brutaldon>
 - Contact: [@gcupc@glitch.social](https://glitch.social/users/gcupc)
-- Features: MastoAPI, No Streaming
+- Features: No Streaming
+
+### Feather
+- Source Code: <https://github.com/kaniini/feather>
+- Contact: [@kaniini@pleroma.site](https://pleroma.site/kaniini)
+- Features: No Streaming
 
 ### Halcyon
 - Source Code: <https://notabug.org/halcyon-suite/halcyon>
 - Contact: [@halcyon@social.csswg.org](https://social.csswg.org/users/halcyon)
-- Features: MastoAPI, Streaming Ready
+- Features: Streaming Ready
 
 ### Pinafore
 - Homepage: <https://pinafore.social/>
 - Source Code: <https://github.com/nolanlawson/pinafore>
 - Contact: [@pinafore@mastodon.technology](https://mastodon.technology/users/pinafore)
 - Note: Pleroma support is a secondary goal
-- Features: MastoAPI, No Streaming
+- Features: No Streaming
 
 ### Sengi
-- Homepage: <https://nicolasconstant.github.io/sengi/>
 - Source Code: <https://github.com/NicolasConstant/sengi>
 - Contact: [@sengi_app@mastodon.social](https://mastodon.social/users/sengi_app)
-- Features: MastoAPI
-
-### DashFE
-- Source Code: <https://notabug.org/daisuke/DashboardFE>
-- Contact: [@dashfe@stereophonic.space](https://stereophonic.space/users/dashfe)
-
-### BloatFE
-- Source Code: <https://git.freesoftwareextremist.com/bloat/>
-- Contact: [@r@freesoftwareextremist.com](https://freesoftwareextremist.com/users/r)
-- Features: Does not requires JavaScript
-- Features: MastoAPI
-
-### Glitch-lily
-- Source Code: <https://lily.kazv.moe/infra/glitch-lily>
-- Contact: [@tusooa@kazv.moe](https://kazv.moe/users/tusooa)
-- Features: MastoAPI
-- Based on [glitch-soc](https://github.com/glitch-soc/mastodon) frontend
+- Note(2019-01-28): The development is currently in a early stage.

docs/configuration/auth.md

@@ -1 +0,0 @@
-See `Authentication` section of [the configuration cheatsheet](../configuration/cheatsheet.md#authentication).

docs/configuration/cheatsheet.md

@@ -8,19 +8,13 @@ For from source installations Pleroma 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://git.pleroma.social/pleroma/pleroma/blob/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.
 * `notify_email`: Email used for notifications.
 * `description`: The instance’s description, can be seen in nodeinfo and ``/api/v1/instance``.
-* `short_description`: Shorter version of instance description, can be seen on ``/api/v1/instance``.
 * `limit`: Posts character limit (CW/Subject included in the counter).
-* `description_limit`: The character limit for image descriptions.
+* `chat_limit`: Character limit of the instance chat messages.
 * `remote_limit`: Hard character limit beyond which remote posts will be dropped.
 * `upload_limit`: File size limit of uploads (except for avatar, background, banner).
 * `avatar_upload_limit`: File size limit of user’s profile avatars.
@@ -34,114 +28,11 @@ To add configuration to your config file, you can copy it from the base config.
 * `registrations_open`: Enable registrations for anyone, invitations can be enabled when false.
 * `invites_enabled`: Enable user invitations for admins (depends on `registrations_open: false`).
 * `account_activation_required`: Require users to confirm their emails before signing in.
-* `account_approval_required`: Require users to be manually approved by an admin before signing in.
 * `federating`: Enable federation with other instances.
 * `federation_incoming_replies_max_depth`: Max. depth of reply-to activities fetching on incoming federation, to prevent out-of-memory situations while fetching very long threads. If set to `nil`, threads of any depth will be fetched. Lower this value if you experience out-of-memory crashes.
 * `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.
-* `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.
-* `max_pinned_statuses`: The maximum number of pinned statuses. `0` will disable the feature.
-* `autofollowed_nicknames`: Set to nicknames of (local) users that every new user should automatically follow.
-* `autofollowing_nicknames`: Set to nicknames of (local) users that automatically follows every newly registered user.
-* `attachment_links`: Set to true to enable automatically adding attachment link text to statuses.
-* `max_report_comment_size`: The maximum size of the report comment (Default: `1000`).
-* `report_strip_status`: Strip associated statuses in reports to ids when closed/resolved, otherwise keep a copy.
-* `safe_dm_mentions`: If set to true, only mentions at the beginning of a post will be used to address people in direct messages. This is to prevent accidental mentioning of people when talking about them (e.g. "@friend hey i really don't like @enemy"). Default: `false`.
-* `healthcheck`: If set to true, system data will be shown on ``/api/v1/pleroma/healthcheck``.
-* `remote_post_retention_days`: The default amount of days to retain remote posts when pruning the database.
-* `user_bio_length`: A user bio maximum length (default: `5000`).
-* `user_name_length`: A user name maximum length (default: `100`).
-* `skip_thread_containment`: Skip filter out broken threads. The default is `false`.
-* `limit_to_local_content`: Limit unauthenticated users to search for local statutes and users only. Possible values: `:unauthenticated`, `:all` and `false`. The default is `:unauthenticated`.
-* `max_account_fields`: The maximum number of custom fields in the user profile (default: `10`).
-* `max_remote_account_fields`: The maximum number of custom fields in the remote user profile (default: `20`).
-* `account_field_name_length`: An account field name maximum length (default: `512`).
-* `account_field_value_length`: An account field value maximum length (default: `2048`).
-* `registration_reason_length`: Maximum registration reason length (default: `500`).
-* `external_user_synchronization`: Enabling following/followers counters synchronization for external users.
-* `cleanup_attachments`: Remove attachments along with statuses. Does not affect duplicate files and attachments without status. Enabling this will increase load to database when deleting statuses on larger instances.
-* `show_reactions`: Let favourites and emoji reactions be viewed through the API (default: `true`).
-* `password_reset_token_validity`: The time after which reset tokens aren't accepted anymore, in seconds (default: one day).
-* `admin_privileges`: A list of privileges an admin has (e.g. delete messages, manage reports...)
-    * Possible values are:
-      * `:users_read`
-        * Allows admins to fetch users through the admin API.
-      * `:users_manage_invites`
-        * Allows admins to manage invites. This includes sending, resending, revoking and approving invites.
-      * `:users_manage_activation_state`
-        * Allows admins to activate and deactivate accounts. This also allows them to see deactivated users through the Mastodon API.
-      * `:users_manage_tags`
-        * Allows admins to set and remove tags for users. This can be useful in combination with MRF policies, such as `Pleroma.Web.ActivityPub.MRF.TagPolicy`.
-      * `:users_manage_credentials`
-        * Allows admins to trigger a password reset and set new credentials for an user.
-      * `:users_delete`
-        * Allows admins to delete accounts. Note that deleting an account is actually deactivating it and removing all data like posts, profile information, etc.
-      * `:messages_read`
-        * Allows admins to read messages through the admin API, including non-public posts and chats.
-      * `:messages_delete`
-        * Allows admins to delete messages from other users.
-      * `:instances_delete,`
-        * Allows admins to remove a whole remote instance from your instance. This will delete all users and messages from that remote instance.
-      * `:reports_manage_reports`
-        * Allows admins to see and manage reports.
-      * `:moderation_log_read,`
-        * Allows admins to read the entries in the moderation log.
-      * `:emoji_manage_emoji`
-        * Allows admins to manage custom emoji on the instance.
-      * `:statistics_read,`
-        * Allows admins to see some simple statistics about the instance.
-* `moderator_privileges`: A list of privileges a moderator has (e.g. delete messages, manage reports...)
-    * Possible values are the same as for `admin_privileges`
-
-## :database
-* `improved_hashtag_timeline`: Setting to force toggle / force disable improved hashtags timeline. `:enabled` forces hashtags to be fetched from `hashtags` table for hashtags timeline. `:disabled` forces object-embedded hashtags to be used (slower). Keep it `:auto` for automatic behaviour (it is auto-set to `:enabled` [unless overridden] when HashtagsTableMigrator completes).
-
-## Background migrations
-* `populate_hashtags_table/sleep_interval_ms`: Sleep interval between each chunk of processed records in order to decrease the load on the system (defaults to 0 and should be keep default on most instances).
-* `populate_hashtags_table/fault_rate_allowance`: Max rate of failed objects to actually processed objects in order to enable the feature (any value from 0.0 which tolerates no errors to 1.0 which will enable the feature even if hashtags transfer failed for all records).
-
-## Welcome
-* `direct_message`: - welcome message sent as a direct message.
-  * `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.
-  * `subject`: A subject of welcome email.
-  * `html`: A html that will be send to a newly registered users as a email.
-  * `text`: A text that will be send to a newly registered users as a email.
-
-    Example:
-
-  ```elixir
-  config :pleroma, :welcome,
-      direct_message: [
-        enabled: true,
-        sender_nickname: "lain",
-        message: "Hi! Welcome on board!"
-        ],
-      email: [
-        enabled: true,
-        sender: {"Pleroma App", "welcome@pleroma.app"},
-        subject: "Welcome to <%= instance_name %>",
-        html: "Welcome to <%= instance_name %>",
-        text: "Welcome to <%= instance_name %>"
-    ]
-  ```
-
-## Message rewrite facility
-
-### :mrf
-* `policies`: Message Rewrite Policy, either one or a list. Here are the ones available by default:
+* `allow_relay`: Enable Pleroma’s Relay, which makes it possible to follow a whole instance.
+* `rewrite_policy`: Message Rewrite Policy, either one or a list. Here are the ones available by default:
     * `Pleroma.Web.ActivityPub.MRF.NoOpPolicy`: Doesn’t modify activities (default).
     * `Pleroma.Web.ActivityPub.MRF.DropPolicy`: Drops all activities. It generally doesn’t makes sense to use in production.
     * `Pleroma.Web.ActivityPub.MRF.SimplePolicy`: Restrict the visibility of activities from certains instances (See [`:mrf_simple`](#mrf_simple)).
@@ -154,32 +45,49 @@ To add configuration to your config file, you can copy it from the base config.
     * `Pleroma.Web.ActivityPub.MRF.MentionPolicy`: Drops posts mentioning configurable users. (See [`:mrf_mention`](#mrf_mention)).
     * `Pleroma.Web.ActivityPub.MRF.VocabularyPolicy`: Restricts activities to a configured set of vocabulary. (See [`:mrf_vocabulary`](#mrf_vocabulary)).
     * `Pleroma.Web.ActivityPub.MRF.ObjectAgePolicy`: Rejects or delists posts based on their age when received. (See [`:mrf_object_age`](#mrf_object_age)).
-    * `Pleroma.Web.ActivityPub.MRF.ActivityExpirationPolicy`: Sets a default expiration on all posts made by users of the local instance. Requires `Pleroma.Workers.PurgeExpiredActivity` to be enabled for processing the scheduled delections.
-    * `Pleroma.Web.ActivityPub.MRF.ForceBotUnlistedPolicy`: Makes all bot posts to disappear from public timelines.
-    * `Pleroma.Web.ActivityPub.MRF.FollowBotPolicy`: Automatically follows newly discovered users from the specified bot account. Local accounts, locked accounts, and users with "#nobot" in their bio are respected and excluded from being followed.
-    * `Pleroma.Web.ActivityPub.MRF.AntiFollowbotPolicy`: Drops follow requests from followbots. Users can still allow bots to follow them by first following the bot.
-    * `Pleroma.Web.ActivityPub.MRF.KeywordPolicy`: Rejects or removes from the federated timeline or replaces keywords. (See [`:mrf_keyword`](#mrf_keyword)).
-    * `Pleroma.Web.ActivityPub.MRF.ForceMentionsInContent`: Forces every mentioned user to be reflected in the post content.
-* `transparency`: Make the content of your Message Rewrite Facility settings public (via nodeinfo).
-* `transparency_exclusions`: Exclude specific instance names from MRF transparency.  The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.
+* `public`: Makes the client API in authentificated mode-only except for user-profiles. Useful for disabling the Local Timeline and The Whole Known Network.
+* `quarantined_instances`: List of ActivityPub instances where private(DMs, followers-only) activities will not be send.
+* `managed_config`: Whenether the config for pleroma-fe is configured in [:frontend_configurations](#frontend_configurations) or in ``static/config.json``.
+* `allowed_post_formats`: MIME-type list of formats allowed to be posted (transformed into HTML).
+* `mrf_transparency`: Make the content of your Message Rewrite Facility settings public (via nodeinfo).
+* `mrf_transparency_exclusions`: Exclude specific instance names from MRF transparency.  The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.
+* `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.
+* `max_pinned_statuses`: The maximum number of pinned statuses. `0` will disable the feature.
+* `autofollowed_nicknames`: Set to nicknames of (local) users that every new user should automatically follow.
+* `no_attachment_links`: Set to true to disable automatically adding attachment link text to statuses.
+* `welcome_message`: A message that will be send to a newly registered users as a direct message.
+* `welcome_user_nickname`: The nickname of the local user that sends the welcome message.
+* `max_report_comment_size`: The maximum size of the report comment (Default: `1000`).
+* `safe_dm_mentions`: If set to true, only mentions at the beginning of a post will be used to address people in direct messages. This is to prevent accidental mentioning of people when talking about them (e.g. "@friend hey i really don't like @enemy"). Default: `false`.
+* `healthcheck`: If set to true, system data will be shown on ``/api/pleroma/healthcheck``.
+* `remote_post_retention_days`: The default amount of days to retain remote posts when pruning the database.
+* `user_bio_length`: A user bio maximum length (default: `5000`).
+* `user_name_length`: A user name maximum length (default: `100`).
+* `skip_thread_containment`: Skip filter out broken threads. The default is `false`.
+* `limit_to_local_content`: Limit unauthenticated users to search for local statutes and users only. Possible values: `:unauthenticated`, `:all` and `false`. The default is `:unauthenticated`.
+* `max_account_fields`: The maximum number of custom fields in the user profile (default: `10`).
+* `max_remote_account_fields`: The maximum number of custom fields in the remote user profile (default: `20`).
+* `account_field_name_length`: An account field name maximum length (default: `512`).
+* `account_field_value_length`: An account field value maximum length (default: `2048`).
+* `external_user_synchronization`: Enabling following/followers counters synchronization for external users.
+* `cleanup_attachments`: Remove attachments along with statuses. Does not affect duplicate files and attachments without status. Enabling this will increase load to database when deleting statuses on larger instances.
 
 ## Federation
 ### MRF policies
 
 !!! note
-    Configuring MRF policies is not enough for them to take effect. You have to enable them by specifying their module in `policies` under [:mrf](#mrf) section.
+    Configuring MRF policies is not enough for them to take effect. You have to enable them by specifying their module in `rewrite_policy` under [:instance](#instance) section.
 
 #### :mrf_simple
-* `media_removal`: List of instances to strip media attachments from and the reason for doing so.
-* `media_nsfw`: List of instances to tag all media as NSFW (sensitive) from and the reason for doing so.
-* `federated_timeline_removal`: List of instances to remove from the Federated Timeline (aka The Whole Known Network) and the reason for doing so.
-* `reject`: List of instances to reject activities (except deletes) from and the reason for doing so.
-* `accept`: List of instances to only accept activities (except deletes) from and the reason for doing so.
-* `followers_only`: Force posts from the given instances to be visible by followers only and the reason for doing so.
-* `report_removal`: List of instances to reject reports from and the reason for doing so.
-* `avatar_removal`: List of instances to strip avatars from and the reason for doing so.
-* `banner_removal`: List of instances to strip banners from and the reason for doing so.
-* `reject_deletes`: List of instances to reject deletions from and the reason for doing so.
+* `media_removal`: List of instances to remove media from.
+* `media_nsfw`: List of instances to put media as NSFW(sensitive) from.
+* `federated_timeline_removal`: List of instances to remove from Federated (aka The Whole Known Network) Timeline.
+* `reject`: List of instances to reject any activities from.
+* `accept`: List of instances to accept any activities from.
+* `report_removal`: List of instances to reject reports from.
+* `avatar_removal`: List of instances to strip avatars from.
+* `banner_removal`: List of instances to strip banners from.
 
 #### :mrf_subchain
 This policy processes messages through an alternate pipeline when a given message matches certain criteria.
@@ -225,55 +133,31 @@ their ActivityPub ID.
 An example:
 
 ```elixir
-config :pleroma, :mrf_user_allowlist, %{
-  "example.org" => ["https://example.org/users/admin"]
-}
+config :pleroma, :mrf_user_allowlist,
+  "example.org": ["https://example.org/users/admin"]
 ```
 
 #### :mrf_object_age
-* `threshold`: Required time offset (in seconds) compared to your server clock of an incoming post before actions are taken.
-  e.g., A value of 900 results in any post with a timestamp older than 15 minutes will be acted upon.
+* `threshold`: Required age (in seconds) of a post before actions are taken.
 * `actions`: A list of actions to apply to the post:
   * `:delist` removes the post from public timelines
-  * `:strip_followers` removes followers from the ActivityPub recipient list, ensuring they won't be delivered to home timelines, additionally for followers-only it degrades to a direct message
+  * `:strip_followers` removes followers from the ActivityPub recipient list, ensuring they won't be delivered to home timelines
   * `:reject` rejects the message entirely
 
-#### :mrf_steal_emoji
-* `hosts`: List of hosts to steal emojis from
-* `rejected_shortcodes`: Regex-list of shortcodes to reject
-* `size_limit`: File size limit (in bytes), checked before an emoji is saved to the disk
-
-#### :mrf_activity_expiration
-
-* `days`: Default global expiration time for all local Create activities (in days)
-
-#### :mrf_hashtag
-
-* `sensitive`: List of hashtags to mark activities as sensitive (default: `nsfw`)
-* `federated_timeline_removal`: List of hashtags to remove activities from the federated timeline (aka TWNK)
-* `reject`: List of hashtags to reject activities from
-
-Notes:
-- The hashtags in the configuration do not have a leading `#`.
-- This MRF Policy is always enabled, if you want to disable it you have to set empty lists
-
-#### :mrf_follow_bot
-
-* `follower_nickname`: The name of the bot account to use for following newly discovered users. Using `followbot` or similar is strongly suggested.
-
-
 ### :activitypub
 * `unfollow_blocked`: Whether blocks result in people getting unfollowed
 * `outgoing_blocks`: Whether to federate blocks to other instances
-* `blockers_visible`: Whether a user can see the posts of users who blocked them
 * `deny_follow_blocked`: Whether to disallow following an account that has blocked the user in question
 * `sign_object_fetches`: Sign object fetches with HTTP signatures
 * `authorized_fetch_mode`: Require HTTP signatures for AP fetches
 
-## Pleroma.User
+### :fetch_initial_posts
 
-* `restricted_nicknames`: List of nicknames users may not register with.
-* `email_blacklist`: List of email domains users may not register with.
+!!! warning
+    Be careful with this setting, fetching posts may lead to new users being discovered whose posts will then also be fetched. This can lead to serious load on your instance and database.
+
+* `enabled`: If enabled, when a new user is discovered by your instance, fetch some of their latest posts.
+* `pages`: The amount of pages to fetch
 
 ## Pleroma.ScheduledActivity
 
@@ -281,11 +165,17 @@ 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
 
+## Pleroma.ActivityExpiration
+
+* `enabled`: whether expired activities will be sent to the job queue to be deleted
+
+## Frontends
+
 ### :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` 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](/frontend/CONFIGURATION/#options).
 
-Frontends can access these settings at `/api/v1/pleroma/frontend_configurations`
+Frontends can access these settings at `/api/pleroma/frontend_configurations`
 
 To add your own configuration for PleromaFE, use it like this:
 
@@ -294,7 +184,10 @@ config :pleroma, :frontend_configurations,
   pleroma_fe: %{
     theme: "pleroma-dark",
     # ... see /priv/static/static/config.json for the available keys.
-}
+},
+  masto_fe: %{
+    showInstanceSpecificPanel: true
+  }
 ```
 
 These settings **need to be complete**, they will override the defaults.
@@ -347,7 +240,6 @@ This section describe PWA manifest instance-specific values. Currently this opti
 * `background_color`: Describe the background color of the app. (Example: `"#191b22"`, `"aliceblue"`).
 
 ## :emoji
-
 * `shortcode_globs`: Location of custom emoji files. `*` can be used as a wildcard. Example `["/emoji/custom/**/*.png"]`
 * `pack_extensions`: A list of file extensions for emojis, when no emoji.txt for a pack is present. Example `[".png", ".gif"]`
 * `groups`: Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the groupname and the value the location or array of locations. `*` can be used as a wildcard. Example `[Custom: ["/emoji/*.png", "/emoji/custom/*.png"]]`
@@ -356,55 +248,10 @@ This section describe PWA manifest instance-specific values. Currently this opti
   memory for this amount of seconds multiplied by the number of files.
 
 ## :media_proxy
-
 * `enabled`: Enables proxying of remote media to the instance’s proxy
 * `base_url`: The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.
 * `proxy_opts`: All options defined in `Pleroma.ReverseProxy` documentation, defaults to `[max_body_length: (25*1_048_576)]`.
-* `whitelist`: List of hosts with scheme to bypass the mediaproxy (e.g. `https://example.com`)
-* `invalidation`: options for remove media from cache after delete object:
-  * `enabled`: Enables purge cache
-  * `provider`: Which one of  the [purge cache strategy](#purge-cache-strategy) to use.
-
-## :media_preview_proxy
-
-* `enabled`: Enables proxying of remote media preview to the instance’s proxy. Requires enabled media proxy (`media_proxy/enabled`).
-* `thumbnail_max_width`: Max width of preview thumbnail for images (video preview always has original dimensions).
-* `thumbnail_max_height`: Max height of preview thumbnail for images (video preview always has original dimensions).
-* `image_quality`: Quality of the output. Ranges from 0 (min quality) to 100 (max quality).
-* `min_content_length`: Min content length to perform preview, in bytes. If greater than 0, media smaller in size will be served as is, without thumbnailing.
-
-### Purge cache strategy
-
-#### Pleroma.Web.MediaProxy.Invalidation.Script
-
-This strategy allow perform external shell script to purge cache.
-Urls of attachments are passed to the script as arguments.
-
-* `script_path`: Path to the external script.
-* `url_format`: Set to `:htcacheclean` if using Apache's htcacheclean utility.
-
-Example:
-
-```elixir
-config :pleroma, Pleroma.Web.MediaProxy.Invalidation.Script,
-  script_path: "./installation/nginx-cache-purge.example"
-```
-
-#### Pleroma.Web.MediaProxy.Invalidation.Http
-
-This strategy allow perform custom http request to purge cache.
-
-* `method`: http method. default is `purge`
-* `headers`: http headers.
-* `options`: request options.
-
-Example:
-```elixir
-config :pleroma, Pleroma.Web.MediaProxy.Invalidation.Http,
-  method: :purge,
-  headers: [],
-  options: []
-```
+* `whitelist`: List of domains to bypass the mediaproxy
 
 ## Link previews
 
@@ -412,6 +259,8 @@ config :pleroma, Pleroma.Web.MediaProxy.Invalidation.Http,
 * `providers`: a list of metadata providers to enable. Providers available:
     * `Pleroma.Web.Metadata.Providers.OpenGraph`
     * `Pleroma.Web.Metadata.Providers.TwitterCard`
+    * `Pleroma.Web.Metadata.Providers.RelMe` - add links from user bio with rel=me into the `<header>` as `<link rel=me>`.
+    * `Pleroma.Web.Metadata.Providers.Feed` - add a link to a user's Atom feed into the `<header>` as `<link rel=alternate>`.
 * `unfurl_nsfw`: If set to `true` nsfw attachments will be shown in previews.
 
 ### :rich_media (consumer)
@@ -419,7 +268,6 @@ config :pleroma, Pleroma.Web.MediaProxy.Invalidation.Http,
 * `ignore_hosts`: list of hosts which will be ignored by the metadata parser. For example `["accounts.google.com", "xss.website"]`, defaults to `[]`.
 * `ignore_tld`: list TLDs (top-level domains) which will ignore for parse metadata. default is ["local", "localdomain", "lan"].
 * `parsers`: list of Rich Media parsers.
-* `failure_backoff`: Amount of milliseconds after request failure, during which the request will not be retried.
 
 ## HTTP server
 
@@ -458,25 +306,25 @@ This will make Pleroma listen on `127.0.0.1` port `8080` and generate urls start
 * ``referrer_policy``: The referrer policy to use, either `"same-origin"` or `"no-referrer"`.
 * ``report_uri``: Adds the specified url to `report-uri` and `report-to` group in CSP header.
 
-### Pleroma.Web.Plugs.RemoteIp
+### Pleroma.Plugs.RemoteIp
 
 !!! warning
     If your instance is not behind at least one reverse proxy, you should not enable this plug.
 
-`Pleroma.Web.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
+`Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
 
 Available options:
 
 * `enabled` - Enable/disable the plug. Defaults to `false`.
-* `headers` - A list of strings naming the HTTP headers to use when deriving the true client IP address. Defaults to `["x-forwarded-for"]`.
-* `proxies` - A list of upstream proxy IP subnets in CIDR notation from which we will parse the content of `headers`. Defaults to `[]`. IPv4 entries without a bitmask will be assumed to be /32 and IPv6 /128.
-* `reserved` - A list of reserved IP subnets in CIDR notation which should be ignored if found in `headers`. Defaults to `["127.0.0.0/8", "::1/128", "fc00::/7", "10.0.0.0/8", "172.16.0.0/12", "192.168.0.0/16"]`.
+* `headers` - A list of strings naming the `req_headers` to use when deriving the `remote_ip`. Order does not matter. Defaults to `["x-forwarded-for"]`.
+* `proxies` - A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Defaults to `[]`.
+* `reserved` - Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network).
 
 
 ### :rate_limit
 
 !!! note
-   If your instance is behind a reverse proxy ensure [`Pleroma.Web.Plugs.RemoteIp`](#pleroma-plugs-remoteip) is enabled (it is enabled by default).
+   If your instance is behind a reverse proxy ensure [`Pleroma.Plugs.RemoteIp`](#pleroma-plugs-remoteip) is enabled (it is enabled by default).
 
 A keyword list of rate limiters where a key is a limiter name and value is the limiter configuration. The basic configuration is a tuple where:
 
@@ -528,7 +376,8 @@ Available caches:
 * `proxy_url`: an upstream proxy to fetch posts and/or media with, (default: `nil`)
 * `send_user_agent`: should we include a user agent with HTTP requests? (default: `true`)
 * `user_agent`: what user agent should we use? (default: `:default`), must be string or `:default`
-* `adapter`: array of adapter options
+* `adapter`: array of hackney options
+
 
 ### :hackney_pools
 
@@ -547,37 +396,6 @@ For each pool, the options are:
 * `timeout` - retention duration for connections
 
 
-### :connections_pool
-
-*For `gun` adapter*
-
-Settings for HTTP connection pool.
-
-* `:connection_acquisition_wait` - Timeout to acquire a connection from pool.The total max time is this value multiplied by the number of retries.
-* `connection_acquisition_retries` - Number of attempts to acquire the connection from the pool if it is overloaded. Each attempt is timed `:connection_acquisition_wait` apart.
-* `:max_connections` - Maximum number of connections in the pool.
-* `:connect_timeout` - Timeout to connect to the host.
-* `:reclaim_multiplier` - Multiplied by `:max_connections` this will be the maximum number of idle connections that will be reclaimed in case the pool is overloaded.
-
-### :pools
-
-*For `gun` adapter*
-
-Settings for request pools. These pools are limited on top of `:connections_pool`.
-
-There are four pools used:
-
-* `:federation` for the federation jobs. You may want this pool's max_connections to be at least equal to the number of federator jobs + retry queue jobs.
-* `:media` - for rich media, media proxy.
-* `:upload` - for proxying media when a remote uploader is used and `proxy_remote: true`.
-* `:default` - for other requests.
-
-For each pool, the options are:
-
-* `:size` - limit to how much requests can be concurrently executed.
-* `:recv_timeout` - timeout while `gun` will wait for response
-* `:max_waiting` - limit to how much requests can be waiting for others to finish, after this is reached, subsequent requests will be dropped.
-
 ## Captcha
 
 ### Pleroma.Captcha
@@ -595,7 +413,7 @@ A built-in captcha provider. Enabled by default.
 #### Pleroma.Captcha.Kocaptcha
 
 Kocaptcha is a very simple captcha service with a single API endpoint,
-the source code is here: [kocaptcha](https://github.com/koto-bank/kocaptcha). The default endpoint
+the source code is here: https://github.com/koto-bank/kocaptcha. The default endpoint
 `https://captcha.kotobank.ch` is hosted by the developer.
 
 * `endpoint`: the Kocaptcha endpoint to use.
@@ -603,51 +421,40 @@ the source code is here: [kocaptcha](https://github.com/koto-bank/kocaptcha). Th
 ## Uploads
 
 ### Pleroma.Upload
-
 * `uploader`: Which one of the [uploaders](#uploaders) to use.
 * `filters`: List of [upload filters](#upload-filters) to use.
 * `link_name`: When enabled Pleroma will add a `name` parameter to the url of the upload, for example `https://instance.tld/media/corndog.png?name=corndog.png`. This is needed to provide the correct filename in Content-Disposition headers when using filters like `Pleroma.Upload.Filter.Dedupe`
-* `base_url`: The base URL to access a user-uploaded file. Useful when you want to host the media files via another domain or are using a 3rd party S3 provider.
+* `base_url`: The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host.
 * `proxy_remote`: If you're using a remote uploader, Pleroma will proxy media requests instead of redirecting to it.
 * `proxy_opts`: Proxy options, see `Pleroma.ReverseProxy` documentation.
-* `filename_display_max_length`: Set max length of a filename to display. 0 = no limit. Default: 30.
-* `default_description`: Sets which default description an image has if none is set explicitly. Options: nil (default) - Don't set a default, :filename - use the filename of the file, a string (e.g. "attachment") - Use this string
 
 !!! warning
     `strip_exif` has been replaced by `Pleroma.Upload.Filter.Mogrify`.
 
 ### Uploaders
-
 #### Pleroma.Uploaders.Local
-
 * `uploads`: Which directory to store the user-uploads in, relative to pleroma’s working directory.
 
 #### Pleroma.Uploaders.S3
-
-Don't forget to configure [Ex AWS S3](#ex-aws-s3-settings)
-
 * `bucket`: S3 bucket name.
 * `bucket_namespace`: S3 bucket namespace.
+* `public_endpoint`: S3 endpoint that the user finally accesses(ex. "https://s3.dualstack.ap-northeast-1.amazonaws.com")
 * `truncated_namespace`: If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or "" etc.
+For example, when using CDN to S3 virtual host format, set "".
+At this time, write CNAME to CDN in public_endpoint.
 * `streaming_enabled`: Enable streaming uploads, when enabled the file will be sent to the server in chunks as it's being read. This may be unsupported by some providers, try disabling this if you have upload problems.
 
-#### Ex AWS S3 settings
-
-* `access_key_id`: Access key ID
-* `secret_access_key`: Secret access key
-* `host`: S3 host
-
-Example:
-
-```elixir
-config :ex_aws, :s3,
-  access_key_id: "xxxxxxxxxx",
-  secret_access_key: "yyyyyyyyyy",
-  host: "s3.eu-central-1.amazonaws.com"
-```
 
 ### Upload filters
 
+#### Pleroma.Upload.Filter.Mogrify
+
+* `args`: List of actions for the `mogrify` command like `"strip"` or `["strip", "auto-orient", {"implode", "1"}]`.
+
+#### Pleroma.Upload.Filter.Dedupe
+
+No specific configuration.
+
 #### Pleroma.Upload.Filter.AnonymizeFilename
 
 This filter replaces the filename (not the path) of an upload. For complete obfuscation, add
@@ -655,26 +462,6 @@ This filter replaces the filename (not the path) of an upload. For complete obfu
 
 * `text`: Text to replace filenames in links. If empty, `{random}.extension` will be used. You can get the original filename extension by using `{extension}`, for example `custom-file-name.{extension}`.
 
-#### Pleroma.Upload.Filter.Dedupe
-
-No specific configuration.
-
-#### Pleroma.Upload.Filter.Exiftool.StripLocation
-
-This filter only strips the GPS and location metadata with Exiftool leaving color profiles and attributes intact.
-
-No specific configuration.
-
-#### Pleroma.Upload.Filter.Exiftool.ReadDescription
-
-This filter reads the ImageDescription and iptc:Caption-Abstract fields with Exiftool so clients can prefill the media description field.
-
-No specific configuration.
-
-#### Pleroma.Upload.Filter.Mogrify
-
-* `args`: List of actions for the `mogrify` command like `"strip"` or `["strip", "auto-orient", {"implode", "1"}]`.
-
 ## Email
 
 ### Pleroma.Emails.Mailer
@@ -735,7 +522,8 @@ Email notifications settings.
 Configuration options described in [Oban readme](https://github.com/sorentwo/oban#usage):
 
 * `repo` - app's Ecto repo (`Pleroma.Repo`)
-* `log` - logs verbosity
+* `verbose` - logs verbosity
+* `prune` - non-retryable jobs [pruning settings](https://github.com/sorentwo/oban#pruning) (`:disabled` / `{:maxlen, value}` / `{:maxage, value}`)
 * `queues` - job queues (see below)
 * `crontab` - periodic jobs, see [`Oban.Cron`](#obancron)
 
@@ -753,8 +541,9 @@ Pleroma has the following queues:
 
 Pleroma has these periodic job workers:
 
-* `Pleroma.Workers.Cron.DigestEmailsWorker` - digest emails for users with new mentions and follows
-* `Pleroma.Workers.Cron.NewUsersDigestWorker` - digest emails for admins with new registrations
+`Pleroma.Workers.Cron.ClearOauthTokenWorker` - a job worker to cleanup expired oauth tokens.
+
+Example:
 
 ```elixir
 config :pleroma, Oban,
@@ -766,8 +555,7 @@ config :pleroma, Oban,
     federator_outgoing: 50
   ],
   crontab: [
-    {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
-    {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
+    {"0 0 * * *", Pleroma.Workers.Cron.ClearOauthTokenWorker}
   ]
 ```
 
@@ -799,6 +587,24 @@ config :pleroma, :workers,
 * `enabled: false` corresponds to `config :pleroma, :workers, retries: [federator_outgoing: 1]`
 * deprecated options: `max_jobs`, `initial_timeout`
 
+### Pleroma.Scheduler
+
+Configuration for [Quantum](https://github.com/quantum-elixir/quantum-core) jobs scheduler.
+
+See [Quantum readme](https://github.com/quantum-elixir/quantum-core#usage) for the list of supported options.
+
+Example:
+
+```elixir
+config :pleroma, Pleroma.Scheduler,
+  global: true,
+  overlap: true,
+  timezone: :utc,
+  jobs: [{"0 */6 * * * *", {Pleroma.Web.Websub, :refresh_subscriptions, []}}]
+```
+
+The above example defines a single job which invokes `Pleroma.Web.Websub.refresh_subscriptions()` every 6 hours ("0 */6 * * * *", [crontab format](https://en.wikipedia.org/wiki/Cron)).
+
 ## :web_push_encryption, :vapid_details
 
 Web Push Notifications configuration. You can use the mix task `mix web_push.gen.keypair` to generate it.
@@ -808,7 +614,7 @@ Web Push Notifications configuration. You can use the mix task `mix web_push.gen
 * ``private_key``: VAPID private key
 
 ## :logger
-* `backends`: `:console` is used to send logs to stdout, `{ExSyslogger, :ex_syslogger}` to log to syslog
+* `backends`: `:console` is used to send logs to stdout, `{ExSyslogger, :ex_syslogger}` to log to syslog, and `Quack.Logger` to log to Slack
 
 An example to enable ONLY ExSyslogger (f/ex in ``prod.secret.exs``) with info and debug suppressed:
 ```elixir
@@ -831,10 +637,10 @@ config :logger, :ex_syslogger,
 
 See: [logger’s documentation](https://hexdocs.pm/logger/Logger.html) and [ex_syslogger’s documentation](https://hexdocs.pm/ex_syslogger/)
 
-An example of logging info to local syslog, but debug to console:
+An example of logging info to local syslog, but warn to a Slack channel:
 ```elixir
 config :logger,
-  backends: [ {ExSyslogger, :ex_syslogger}, :console ],
+  backends: [ {ExSyslogger, :ex_syslogger}, Quack.Logger ],
   level: :info
 
 config :logger, :ex_syslogger,
@@ -842,12 +648,14 @@ config :logger, :ex_syslogger,
   ident: "pleroma",
   format: "$metadata[$level] $message"
 
-config :logger, :console,
-  level: :debug,
-  format: "\n$time $metadata[$level] $message\n",
-  metadata: [:request_id]
+config :quack,
+  level: :warn,
+  meta: [:all],
+  webhook_url: "https://hooks.slack.com/services/YOUR-API-KEY-HERE"
 ```
 
+See the [Quack Github](https://github.com/azohra/quack) for more details
+
 
 
 ## Database options
@@ -909,19 +717,20 @@ config :pleroma, :admin_token, "somerandomtoken"
 You can then do
 
 ```shell
-curl "http://localhost:4000/api/v1/pleroma/admin/users/invites?admin_token=somerandomtoken"
+curl "http://localhost:4000/api/pleroma/admin/users/invites?admin_token=somerandomtoken"
 ```
 
 or
 
 ```shell
-curl -H "X-Admin-Token: somerandomtoken" "http://localhost:4000/api/v1/pleroma/admin/users/invites"
+curl -H "X-Admin-Token: somerandomtoken" "http://localhost:4000/api/pleroma/admin/users/invites"
 ```
 
-Warning: it's discouraged to use this feature because of the associated security risk: static / rarely changed instance-wide token is much weaker compared to email-password pair of a real admin user; consider using HTTP Basic Auth or OAuth-based authentication instead.
-
 ### :auth
 
+* `Pleroma.Web.Auth.PleromaAuthenticator`: default database authenticator.
+* `Pleroma.Web.Auth.LDAPAuthenticator`: LDAP authentication.
+
 Authentication / authorization settings.
 
 * `auth_template`: authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.eex`.
@@ -951,25 +760,6 @@ Pleroma account will be created with the same name as the LDAP user name.
 * `base`: LDAP base, e.g. "dc=example,dc=com"
 * `uid`: LDAP attribute name to authenticate the user, e.g. when "cn", the filter will be "cn=username,base"
 
-Note, if your LDAP server is an Active Directory server the correct value is commonly `uid: "cn"`, but if you use an
-OpenLDAP server the value may be `uid: "uid"`.
-
-### :oauth2 (Pleroma as OAuth 2.0 provider settings)
-
-OAuth 2.0 provider settings:
-
-* `token_expires_in` - The lifetime in seconds of the access token.
-* `issue_new_refresh_token` - Keeps old refresh token or generate new refresh token when to obtain an access token.
-* `clean_expired_tokens` - Enable a background job to clean expired oauth tokens. Defaults to `false`.
-
-OAuth 2.0 provider and related endpoints:
-
-* `POST /api/v1/apps` creates client app basing on provided params.
-* `GET/POST /oauth/authorize` renders/submits authorization form.
-* `POST /oauth/token` creates/renews OAuth token.
-* `POST /oauth/revoke` revokes provided OAuth token.
-* `GET /api/v1/accounts/verify_credentials` (with proper `Authorization` header or `access_token` URI param) returns user info on requester (with `acct` field containing local nickname and `fqn` field containing fully-qualified nickname which could generally be used as email stub for OAuth software that demands email field in identity endpoint response, like Peertube).
-
 ### OAuth consumer mode
 
 OAuth consumer mode allows sign in / sign up via external OAuth providers (e.g. Twitter, Facebook, Google, Microsoft, etc.).
@@ -1042,153 +832,50 @@ config :ueberauth, Ueberauth,
   ]
 ```
 
+### OAuth 2.0 provider - :oauth2
+
+Configure OAuth 2 provider capabilities:
+
+* `token_expires_in` - The lifetime in seconds of the access token.
+* `issue_new_refresh_token` - Keeps old refresh token or generate new refresh token when to obtain an access token.
+* `clean_expired_tokens` - Enable a background job to clean expired oauth tokens. Defaults to `false`. Interval settings sets in configuration periodic jobs [`Oban.Cron`](#obancron)
+
 ## Link parsing
 
 ### :uri_schemes
 * `valid_schemes`: List of the scheme part that is considered valid to be an URL.
 
-### Pleroma.Formatter
+### :auto_linker
 
-Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.
+Configuration for the `auto_linker` library:
 
-* `class` - specify the class to be added to the generated link (default: `false`)
-* `rel` - specify the rel attribute (default: `ugc`)
-* `new_window` - adds `target="_blank"` attribute (default: `false`)
-* `truncate` - Set to a number to truncate URLs longer then the number. Truncated URLs will end in `...` (default: `false`)
-* `strip_prefix` - Strip the scheme prefix (default: `false`)
-* `extra` - link URLs with rarely used schemes (magnet, ipfs, irc, etc.) (default: `true`)
-* `validate_tld` - Set to false to disable TLD validation for URLs/emails. Can be set to :no_scheme to validate TLDs only for urls without a scheme (e.g `example.com` will be validated, but `http://example.loki` won't) (default: `:no_scheme`)
+* `class: "auto-linker"` - specify the class to be added to the generated link. false to clear.
+* `rel: "noopener noreferrer"` - override the rel attribute. false to clear.
+* `new_window: true` - set to false to remove `target='_blank'` attribute.
+* `scheme: false` - Set to true to link urls with schema `http://google.com`.
+* `truncate: false` - Set to a number to truncate urls longer then the number. Truncated urls will end in `..`.
+* `strip_prefix: true` - Strip the scheme prefix.
+* `extra: false` - link urls with rarely used schemes (magnet, ipfs, irc, etc.).
 
 Example:
 
 ```elixir
-config :pleroma, Pleroma.Formatter,
-  class: false,
-  rel: "ugc",
-  new_window: false,
-  truncate: false,
-  strip_prefix: false,
-  extra: true,
-  validate_tld: :no_scheme
+config :auto_linker,
+  opts: [
+    scheme: true,
+    extra: true,
+    class: false,
+    strip_prefix: false,
+    new_window: false,
+    rel: "ugc"
+  ]
 ```
 
 ## Custom Runtime Modules (`:modules`)
 
 * `runtime_dir`: A path to custom Elixir modules (such as MRF policies).
 
+
 ## :configurable_from_database
 
 Boolean, enables/disables in-database configuration. Read [Transfering the config to/from the database](../administration/CLI_tasks/config.md) for more information.
-
-## :database_config_whitelist
-
-List of valid configuration sections which are allowed to be configured from the
-database. Settings stored in the database before the whitelist is configured are
-still applied, so it is suggested to only use the whitelist on instances that
-have not migrated the config to the database.
-
-Example:
-```elixir
-config :pleroma, :database_config_whitelist, [
-  {:pleroma, :instance},
-  {:pleroma, Pleroma.Web.Metadata},
-  {:auto_linker}
-]
-```
-
-### Multi-factor authentication -  :two_factor_authentication
-* `totp` - a list containing TOTP configuration
-  - `digits` - Determines the length of a one-time pass-code in characters. Defaults to 6 characters.
-  - `period` - a period for which the TOTP code will be valid in seconds. Defaults to 30 seconds.
-* `backup_codes` - a list containing backup codes configuration
-  - `number` - number of backup codes to generate.
-  - `length` - backup code length. Defaults to 16 characters.
-
-## Restrict entities access for unauthenticated users
-
-### :restrict_unauthenticated
-
-Restrict access for unauthenticated users to timelines (public and federated), user profiles and statuses.
-
-* `timelines`: public and federated timelines
-  * `local`: public timeline
-  * `federated`: federated timeline (includes public timeline)
-* `profiles`: user profiles
-  * `local`
-  * `remote`
-* `activities`: statuses
-  * `local`
-  * `remote`
-
-Note: when `:instance, :public` is set to `false`, all `:restrict_unauthenticated` items be effectively set to `true` by default. If you'd like to allow unauthenticated access to specific API endpoints on a private instance, please explicitly set `:restrict_unauthenticated` to non-default value in `config/prod.secret.exs`.
-
-Note: setting `restrict_unauthenticated/timelines/local` to `true` has no practical sense if `restrict_unauthenticated/timelines/federated` is set to `false` (since local public activities will still be delivered to unauthenticated users as part of federated timeline).
-
-## Pleroma.Web.ApiSpec.CastAndValidate
-
-* `:strict` a boolean, enables strict input validation (useful in development, not recommended in production). Defaults to `false`.
-
-## :instances_favicons
-
-Control favicons for instances.
-
-* `enabled`: Allow/disallow displaying and getting instances favicons
-
-## Pleroma.User.Backup
-
-!!! note
-    Requires enabled email
-
-* `:purge_after_days` an integer, remove backup achives after N days.
-* `:limit_days` an integer, limit user to export not more often than once per N days.
-* `:dir` a string with a path to backup temporary directory or `nil` to let Pleroma choose temporary directory in the following order:
-    1. the directory named by the TMPDIR environment variable
-    2. the directory named by the TEMP environment variable
-    3. the directory named by the TMP environment variable
-    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 Pleroma 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 Pleroma 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, the bundled frontends will be used.
-
-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.
-
-## Ephemeral activities (Pleroma.Workers.PurgeExpiredActivity)
-
-Settings to enable and configure expiration for ephemeral activities
-
-* `:enabled` - enables ephemeral activities creation
-* `:min_lifetime` - minimum lifetime for ephemeral activities (in seconds). Default: 10 minutes.
-
-## ConcurrentLimiter
-
-Settings to restrict concurrently running jobs. Jobs which can be configured:
-
-* `Pleroma.Web.RichMedia.Helpers` - generating link previews of URLs in activities
-* `Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy` - warming remote media cache via MediaProxyWarmingPolicy
-
-Each job has these settings:
-
-* `:max_running` - max concurrently runnings jobs
-* `:max_waiting` - max waiting jobs

docs/configuration/hardening.md

@@ -36,7 +36,7 @@ content-security-policy:
   default-src 'none';
   base-uri 'self';
   frame-ancestors 'none';
-  img-src 'self' data: blob: https:;
+  img-src 'self' data: https:;
   media-src 'self' https:;
   style-src 'self' 'unsafe-inline';
   font-src 'self';

docs/configuration/how_to_serve_another_domain_for_webfinger.md

@@ -1,62 +0,0 @@
-# How to use a different domain name for Pleroma and the users it serves
-
-Pleroma users are primarily identified by a `user@example.org` handle, and you might want this identifier to be the same as your email or jabber account, for instance.
-However, in this case, you are almost certainly serving some web content on `https://example.org` already, and you might want to use another domain (say `pleroma.example.org`) for Pleroma itself.
-
-Pleroma supports that, but it might be tricky to set up, and any error might prevent you from federating with other instances.
-
-*If you are already running Pleroma on `example.org`, it is no longer possible to move it to `pleroma.example.org`.*
-
-## Account identifiers
-
-It is important to understand that for federation purposes, a user in Pleroma has two unique identifiers associated:
-
-- A webfinger `acct:` URI, used for discovery and as a verifiable global name for the user across Pleroma instances. In our example, our account's acct: URI is `acct:user@example.org`
-- An author/actor URI, used in every other aspect of federation. This is the way in which users are identified in ActivityPub, the underlying protocol used for federation with other Pleroma instances.
-In our case, it is `https://pleroma.example.org/users/user`.
-
-Both account identifiers are unique and required for Pleroma. An important risk if you set up your Pleroma instance incorrectly is to create two users (with different acct: URIs) with conflicting author/actor URIs.
-
-## WebFinger
-
-As said earlier, each Pleroma user has an `acct`: URI, which is used for discovery and authentication. When you add @user@example.org, a webfinger query is performed. This is done in two steps:
-
-1. Querying `https://example.org/.well-known/host-meta` (where the domain of the URL matches the domain part of the `acct`: URI) to get information on how to perform the query.
-This file will indeed contain a URL template of the form `https://example.org/.well-known/webfinger?resource={uri}` that will be used in the second step.
-2. Fill the returned template with the `acct`: URI to be queried and perform the query: `https://example.org/.well-known/webfinger?resource=acct:user@example.org`
-
-## Configuring your Pleroma instance
-
-**_DO NOT ATTEMPT TO CONFIGURE YOUR INSTANCE THIS WAY IF YOU DID NOT UNDERSTAND THE ABOVE_**
-
-### Configuring Pleroma
-
-Pleroma has a two configuration settings to enable using different domains for your users and Pleroma itself. `host` in `Pleroma.Web.Endpoint` and `domain` in `Pleroma.Web.WebFinger`. When the latter is not set, it defaults to the value of `host`.
-
-*Be extra careful when configuring your Pleroma instance, as changing `host` may cause remote instances to register different accounts with the same author/actor URI, which will result in federation issues!*
-
-```elixir
-config :pleroma, Pleroma.Web.Endpoint,
-  url: [host: "pleroma.example.org"]
-
-config :pleroma, Pleroma.Web.WebFinger, domain: "example.org"
-```
-
-- `domain` - is the domain for which your Pleroma instance has authority, it's the domain used in `acct:` URI. In our example, `domain` would be set to `example.org`. This is used in WebFinger account ids, which are the canonical account identifier in some other fediverse software like Mastodon. **If you change `domain`, the accounts on your server will be shown as different accounts in those software**.
-- `host` - is the domain used for any URL generated for your instance, including the author/actor URL's. In our case, that would be `pleroma.example.org`. This is used in AP ids, which are the canonical account identifier in Pleroma and some other fediverse software. **You should not change this after you have set up the instance**.
-
-### Configuring WebFinger domain
-
-Now, you have Pleroma running at `https://pleroma.example.org` as well as a website at `https://example.org`. If you recall how webfinger queries work, the first step is to query `https://example.org/.well-known/host-meta`, which will contain an URL template.
-
-Therefore, the easiest way to configure `example.org` is to redirect `/.well-known/host-meta` to `pleroma.example.org`.
-
-With nginx, it would be as simple as adding:
-
-```nginx
-location = /.well-known/host-meta {
-       return 301 https://pleroma.example.org$request_uri;
-}
-```
-
-in example.org's server block.

docs/configuration/howto_database_config.md

@@ -1,155 +0,0 @@
-# How to activate Pleroma in-database configuration
-## Explanation
-
-The configuration of Pleroma has traditionally been managed with a config file, e.g. `config/prod.secret.exs`. This method requires a restart of the application for any configuration changes to take effect. We have made it possible to control most settings in the AdminFE interface after running a migration script.
-
-## Migration to database config
-
-1. Run the mix task to migrate to the database.
-
-  **Source:**
-
-  ```
-  $ mix pleroma.config migrate_to_db
-  ```
-
-  or
-
-  **OTP:**
-
-  *Note: OTP users need Pleroma to be running for `pleroma_ctl` commands to work*
-
-  ```
-  $ ./bin/pleroma_ctl config migrate_to_db
-  ```
-
-  ```
-    Migrating settings from file: /home/pleroma/config/dev.secret.exs
-
-   Settings for key instance migrated.
-   Settings for group :pleroma migrated.
-  ```
-
-2. It is recommended to backup your config file now.
-
-  ```
-  cp config/dev.secret.exs config/dev.secret.exs.orig
-  ```
-
-3. Edit your Pleroma config to enable database configuration:
-
-  ```
-  config :pleroma, configurable_from_database: true
-  ```
-
-4. ⚠️ **THIS IS NOT REQUIRED** ⚠️
-
-  Now you can edit your config file and strip it down to the only settings which are not possible to control in the database. e.g., the Postgres (Repo) and webserver (Endpoint) settings cannot be controlled in the database because the application needs the settings to start up and access the database.
-
-  Any settings in the database will override those in the config file, but you may find it less confusing if the setting is only declared in one place.
-
-  A non-exhaustive list of settings that are only possible in the config file include the following:
-
-  * config :pleroma, Pleroma.Web.Endpoint
-  * config :pleroma, Pleroma.Repo
-  * config :pleroma, configurable\_from\_database
-  * config :pleroma, :database, rum_enabled
-  * config :pleroma, :connections_pool
-
-  Here is an example of a server config stripped down after migration:
-
-  ```
-  import Config
-
-  config :pleroma, Pleroma.Web.Endpoint,
-    url: [host: "cool.pleroma.site", scheme: "https", port: 443]
-
-  config :pleroma, Pleroma.Repo,
-    adapter: Ecto.Adapters.Postgres,
-    username: "pleroma",
-    password: "MySecretPassword",
-    database: "pleroma_prod",
-    hostname: "localhost"
-
-  config :pleroma, configurable_from_database: true
-  ```
-
-5. Restart your instance and you can now access the Settings tab in AdminFE.
-
-
-## Reverting back from database config
-
-1. Run the mix task to migrate back from the database. You'll receive some debugging output and a few messages informing you of what happened.
-
-  **Source:**
-
-  ```
-  $ mix pleroma.config migrate_from_db
-  ```
-
-  or
-
-  **OTP:**
-
-  ```
-  $ ./bin/pleroma_ctl config migrate_from_db
-  ```
-
-  ```
-  10:26:30.593 [debug] QUERY OK source="config" db=9.8ms decode=1.2ms queue=26.0ms idle=0.0ms
-  SELECT c0."id", c0."key", c0."group", c0."value", c0."inserted_at", c0."updated_at" FROM "config" AS c0 []
-
-  10:26:30.659 [debug] QUERY OK source="config" db=1.1ms idle=80.7ms
-  SELECT c0."id", c0."key", c0."group", c0."value", c0."inserted_at", c0."updated_at" FROM "config" AS c0 []
-  Database configuration settings have been saved to config/dev.exported_from_db.secret.exs
-  ```
-
-2. Remove `config :pleroma, configurable_from_database: true` from your config. The in-database configuration still exists, but it will not be used. Future migrations will erase the database config before importing your config file again.
-
-3. Restart your instance.
-
-## Debugging
-
-### Clearing database config
-You can clear the database config with the following command:
-
-  **Source:**
-
-  ```
-  $ mix pleroma.config reset
-  ```
-
-  or
-
-  **OTP:**
-
-  ```
-  $ ./bin/pleroma_ctl config reset
-  ```
-
-Additionally, every time you migrate the configuration to the database the config table is automatically truncated to ensure a clean migration.
-
-### Manually removing a setting
-If you encounter a situation where the server cannot run properly because of an invalid setting in the database and this is preventing you from accessing AdminFE, you can manually remove the offending setting if you know which one it is.
-
-e.g., here is an example showing a the removal of the `config :pleroma, :instance` settings:
-
-  **Source:**
-
-  ```
-  $ mix pleroma.config delete pleroma instance
-  Are you sure you want to continue? [n]  y
-  config :pleroma, :instance deleted from the ConfigDB.
-  ```
-
-  or
-
-  **OTP:**
-
-  ```
-  $ ./bin/pleroma_ctl config delete pleroma instance
-  Are you sure you want to continue? [n]  y
-  config :pleroma, :instance deleted from the ConfigDB.
-  ```
-
-Now the `config :pleroma, :instance` settings have been removed from the database.

docs/configuration/howto_ejabberd.md

@@ -1,136 +0,0 @@
-# Configuring Ejabberd (XMPP Server) to use Pleroma for authentication
-
-If you want to give your Pleroma users an XMPP (chat) account, you can configure [Ejabberd](https://github.com/processone/ejabberd) to use your Pleroma server for user authentication, automatically giving every local user an XMPP account.
-
-In general, you just have to follow the configuration described at [https://docs.ejabberd.im/admin/configuration/authentication/#external-script](https://docs.ejabberd.im/admin/configuration/authentication/#external-script). Please read this section carefully. 
-
-Copy the script below to suitable path on your system and set owner and permissions. Also do not forget adjusting `PLEROMA_HOST` and `PLEROMA_PORT`, if necessary.
-
-```bash
-cp pleroma_ejabberd_auth.py /etc/ejabberd/pleroma_ejabberd_auth.py
-chown ejabberd /etc/ejabberd/pleroma_ejabberd_auth.py
-chmod 700 /etc/ejabberd/pleroma_ejabberd_auth.py
-```
-
-Set external auth params in ejabberd.yaml file:
-
-```bash
-auth_method: [external]
-extauth_program: "python3 /etc/ejabberd/pleroma_ejabberd_auth.py"
-extauth_instances: 3
-auth_use_cache: false
-```
-
-Restart / reload your ejabberd service.
-
-After restarting your Ejabberd server, your users should now be able to connect with their Pleroma credentials.
-
-
-```python
-import sys
-import struct
-import http.client
-from base64 import b64encode
-import logging
-
-
-PLEROMA_HOST = "127.0.0.1"
-PLEROMA_PORT = "4000"
-AUTH_ENDPOINT = "/api/v1/accounts/verify_credentials"
-USER_ENDPOINT = "/api/v1/accounts"
-LOGFILE = "/var/log/ejabberd/pleroma_auth.log"
-
-logging.basicConfig(filename=LOGFILE, level=logging.INFO)
-
-
-# Pleroma functions
-def create_connection():
-    return http.client.HTTPConnection(PLEROMA_HOST, PLEROMA_PORT)
-
-
-def verify_credentials(user: str, password: str) -> bool:
-    user_pass_b64 = b64encode("{}:{}".format(
-        user, password).encode('utf-8')).decode("ascii")
-    params = {}
-    headers = {
-        "Authorization": "Basic {}".format(user_pass_b64)
-    }
-
-    try:
-        conn = create_connection()
-        conn.request("GET", AUTH_ENDPOINT, params, headers)
-
-        response = conn.getresponse()
-        if response.status == 200:
-            return True
-
-        return False
-    except Exception as e:
-        logging.info("Can not connect: %s", str(e))
-        return False
-
-
-def does_user_exist(user: str) -> bool:
-    conn = create_connection()
-    conn.request("GET", "{}/{}".format(USER_ENDPOINT, user))
-
-    response = conn.getresponse()
-    if response.status == 200:
-        return True
-
-    return False
-
-
-def auth(username: str, server: str, password: str) -> bool:
-    return verify_credentials(username, password)
-
-
-def isuser(username, server):
-    return does_user_exist(username)
-
-
-def read():
-    (pkt_size,) = struct.unpack('>H', bytes(sys.stdin.read(2), encoding='utf8'))
-    pkt = sys.stdin.read(pkt_size)
-    cmd = pkt.split(':')[0]
-    if cmd == 'auth':
-        username, server, password = pkt.split(':', 3)[1:]
-        write(auth(username, server, password))
-    elif cmd == 'isuser':
-        username, server = pkt.split(':', 2)[1:]
-        write(isuser(username, server))
-    elif cmd == 'setpass':
-        # u, s, p = pkt.split(':', 3)[1:]
-        write(False)
-    elif cmd == 'tryregister':
-        # u, s, p = pkt.split(':', 3)[1:]
-        write(False)
-    elif cmd == 'removeuser':
-        # u, s = pkt.split(':', 2)[1:]
-        write(False)
-    elif cmd == 'removeuser3':
-        # u, s, p = pkt.split(':', 3)[1:]
-        write(False)
-    else:
-        write(False)
-
-
-def write(result):
-    if result:
-        sys.stdout.write('\x00\x02\x00\x01')
-    else:
-        sys.stdout.write('\x00\x02\x00\x00')
-    sys.stdout.flush()
-
-
-if __name__ == "__main__":
-    logging.info("Starting pleroma ejabberd auth daemon...")
-    while True:
-        try:
-            read()
-        except Exception as e:
-            logging.info(
-                "Error while processing data from ejabberd %s", str(e))
-            pass
-
-```

docs/configuration/howto_search_cjk.md

@@ -1,42 +0,0 @@
-# How to enable text search for Chinese, Japanese and Korean
-
-Pleroma's full text search feature is powered by PostgreSQL's native [text search](https://www.postgresql.org/docs/current/textsearch.html), it works well out of box for most of languages, but needs extra configurations for some asian languages like Chinese, Japanese and Korean (CJK).
-
-
-## Setup and test the new search config
-
-In most cases, you would need an extension installed to support parsing CJK text. Here are a few extensions you may choose from, or you are more than welcome to share additional ones you found working for you with the rest of Pleroma community.
-
- * [a generic n-gram parser](https://github.com/huangjimmy/pg_cjk_parser) supports Simplifed/Traditional Chinese, Japanese, and Korean
- * [a Korean parser](https://github.com/i0seph/textsearch_ko) based on mecab
- * [a Japanese parser](https://www.amris.co.jp/tsja/index.html) based on mecab
- * [zhparser](https://github.com/amutu/zhparser/) is a PostgreSQL extension base on the Simple Chinese Word Segmentation(SCWS)
- * [another Chinese parser](https://github.com/jaiminpan/pg_jieba) based on Jieba Chinese Word Segmentation
- 
-Once you have the new search config , make sure you test it with the `pleroma` user in PostgreSQL (change `YOUR.CONFIG` to your real configuration name)
-```
-SELECT ts_debug('YOUR.CONFIG', '安装和配置Nginx, ElixirとErlangをインストールします');
-```
-Check output of the query, and see if it matches your expectation.
-
-
-## Update text search config and index in database
-
-=== "OTP"
-
-    ```sh
-    ./bin/pleroma_ctl database set_text_search_config YOUR.CONFIG
-    ```
-
-=== "From Source"
-
-    ```sh
-    mix pleroma.database set_text_search_config YOUR.CONFIG
-    ```
-
-Note: index update may take a while, and it can be done while the instance is up and running, so you may restart db connection as soon as you see `Recreate index` in task output.
-
-## Restart database connection
-Since some changes above will only apply with a new database connection, you will have to restart either Pleroma or PostgreSQL process, or use `pg_terminate_backend` SQL command without restarting either. 
-
-Now the search results of statuses should be much more friendly for your language of choice, the results for searching users and tags were not changed, as the default parsing/matching should work for most cases. 

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](General-tips-for-customizing-Pleroma-FE.md).
 
 Example of adding the new theme in the back-end config files
 ```elixir

docs/configuration/mrf.md

@@ -34,39 +34,35 @@ config :pleroma, :instance,
 To use `SimplePolicy`, you must enable it. Do so by adding the following to your `:instance` config object, so that it looks like this:
 
 ```elixir
-config :pleroma, :mrf,
+config :pleroma, :instance,
   [...]
-  policies: Pleroma.Web.ActivityPub.MRF.SimplePolicy
+  rewrite_policy: Pleroma.Web.ActivityPub.MRF.SimplePolicy
 ```
 
 Once `SimplePolicy` is enabled, you can configure various groups in the `:mrf_simple` config object. These groups are:
 
-* `reject`: Servers in this group will have their messages rejected.
-* `accept`: If not empty, only messages from these instances will be accepted (whitelist federation).
-* `media_nsfw`: Servers in this group will have the #nsfw tag and sensitive setting injected into incoming messages which contain media.
 * `media_removal`: Servers in this group will have media stripped from incoming messages.
-* `avatar_removal`: Avatars from these servers will be stripped from incoming messages.
-* `banner_removal`: Banner images from these servers will be stripped from incoming messages.
-* `report_removal`: Servers in this group will have their reports (flags) rejected.
+* `media_nsfw`: Servers in this group will have the #nsfw tag and sensitive setting injected into incoming messages which contain media.
+* `reject`: Servers in this group will have their messages rejected.
 * `federated_timeline_removal`: Servers in this group will have their messages unlisted from the public timelines by flipping the `to` and `cc` fields.
-* `reject_deletes`: Deletion requests will be rejected from these servers.
+* `report_removal`: Servers in this group will have their reports (flags) rejected.
 
 Servers should be configured as lists.
 
 ### Example
 
-This example will enable `SimplePolicy`, block media from `illegalporn.biz`, mark media as NSFW from `porn.biz` and `porn.business`, reject messages from `spam.com`, remove messages from `spam.university` from the federated timeline and block reports (flags) from `whiny.whiner`. We also give a reason why the moderation was done:
+This example will enable `SimplePolicy`, block media from `illegalporn.biz`, mark media as NSFW from `porn.biz` and `porn.business`, reject messages from `spam.com`, remove messages from `spam.university` from the federated timeline and block reports (flags) from `whiny.whiner`:
 
 ```elixir
-config :pleroma, :mrf,
-  policies: [Pleroma.Web.ActivityPub.MRF.SimplePolicy]
+config :pleroma, :instance,
+  rewrite_policy: [Pleroma.Web.ActivityPub.MRF.SimplePolicy]
 
 config :pleroma, :mrf_simple,
-  media_removal: [{"illegalporn.biz", "Media can contain illegal contant"}],
-  media_nsfw: [{"porn.biz", "unmarked nsfw media"}, {"porn.business", "A lot of unmarked nsfw media"}],
-  reject: [{"spam.com", "They keep spamming our users"}],
-  federated_timeline_removal: [{"spam.university", "Annoying low-quality posts who otherwise fill up TWKN"}],
-  report_removal: [{"whiny.whiner", "Keep spamming us with irrelevant reports"}]
+  media_removal: ["illegalporn.biz"],
+  media_nsfw: ["porn.biz", "porn.business"],
+  reject: ["spam.com"],
+  federated_timeline_removal: ["spam.university"],
+  report_removal: ["whiny.whiner"]
 ```
 
 ### Use with Care
@@ -75,14 +71,14 @@ The effects of MRF policies can be very drastic. It is important to use this fun
 
 ## Writing your own MRF Policy
 
-As discussed above, the MRF system is a modular system that supports pluggable policies. This means that an admin may write a custom MRF policy in Elixir or any other language that runs on the Erlang VM, by specifying the module name in the `policies` config setting.
+As discussed above, the MRF system is a modular system that supports pluggable policies. This means that an admin may write a custom MRF policy in Elixir or any other language that runs on the Erlang VM, by specifying the module name in the `rewrite_policy` config setting.
 
 For example, here is a sample policy module which rewrites all messages to "new message content":
 
 ```elixir
 defmodule Pleroma.Web.ActivityPub.MRF.RewritePolicy do
   @moduledoc "MRF policy which rewrites all Notes to have 'new message content'."
-  @behaviour Pleroma.Web.ActivityPub.MRF.Policy
+  @behaviour Pleroma.Web.ActivityPub.MRF
 
   # Catch messages which contain Note objects with actual data to filter.
   # Capture the object as `object`, the message content as `content` and the
@@ -117,7 +113,7 @@ defmodule Pleroma.Web.ActivityPub.MRF.RewritePolicy do
 
   @impl true
   def describe do
-    {:ok, %{mrf_sample: %{content: "new message content"}}}
+    {:ok, %{mrf_sample: %{content: "new message content"}}}`
   end
 end
 ```
@@ -125,34 +121,11 @@ end
 If you save this file as `lib/pleroma/web/activity_pub/mrf/rewrite_policy.ex`, it will be included when you next rebuild Pleroma.  You can enable it in the configuration like so:
 
 ```elixir
-config :pleroma, :mrf,
-  policies: [
+config :pleroma, :instance,
+  rewrite_policy: [
     Pleroma.Web.ActivityPub.MRF.SimplePolicy,
     Pleroma.Web.ActivityPub.MRF.RewritePolicy
   ]
 ```
 
 Please note that the Pleroma developers consider custom MRF policy modules to fall under the purview of the AGPL. As such, you are obligated to release the sources to your custom MRF policy modules upon request.
-
-### MRF policies descriptions
-
-If MRF policy depends on config, it can be added into MRF tab to adminFE by adding `config_description/0` method, which returns a map with a specific structure. See existing MRF's like `lib/pleroma/web/activity_pub/mrf/activity_expiration_policy.ex` for examples. Note that more complex inputs, like tuples or maps, may need extra changes in the adminFE and just adding it to `config_description/0` may not be enough to get these inputs working from the adminFE.
-
-Example:
-
-```elixir
-%{
-      key: :mrf_activity_expiration,
-      related_policy: "Pleroma.Web.ActivityPub.MRF.ActivityExpirationPolicy",
-      label: "MRF Activity Expiration Policy",
-      description: "Adds automatic expiration to all local activities",
-      children: [
-        %{
-          key: :days,
-          type: :integer,
-          description: "Default global expiration time for all local activities (in days)",
-          suggestions: [90, 365]
-        }
-      ]
-    }
-```

docs/configuration/optimizing_beam.md

@@ -1,66 +0,0 @@
-# Optimizing the BEAM
-
-Pleroma is built upon the Erlang/OTP VM known as BEAM. The BEAM VM is highly optimized for latency, but this has drawbacks in environments without dedicated hardware. One of the tricks used by the BEAM VM is [busy waiting](https://en.wikipedia.org/wiki/Busy_waiting). This allows the application to pretend to be busy working so the OS kernel does not pause the application process and switch to another process waiting for the CPU to execute its workload. It does this by spinning for a period of time which inflates the apparent CPU usage of the application so it is immediately ready to execute another task. This can be observed with utilities like **top(1)** which will show consistently high CPU usage for the process. Switching between procesess is a rather expensive operation and also clears CPU caches further affecting latency and performance. The goal of busy waiting is to avoid this penalty.
-
-This strategy is very successful in making a performant and responsive application, but is not desirable on Virtual Machines or hardware with few CPU cores. Pleroma instances are often deployed on the same server as the required PostgreSQL database which can lead to situations where the Pleroma application is holding the CPU in a busy-wait loop and as a result the database cannot process requests in a timely manner. The fewer CPUs available, the more this problem is exacerbated. The latency is further amplified by the OS being installed on a Virtual Machine as the Hypervisor uses CPU time-slicing to pause the entire OS and switch between other tasks.
-
-More adventurous admins can be creative with CPU affinity (e.g., *taskset* for Linux and *cpuset* on FreeBSD) to pin processes to specific CPUs and eliminate much of this contention. The most important advice is to run as few processes as possible on your server to achieve the best performance. Even idle background processes can occasionally create [software interrupts](https://en.wikipedia.org/wiki/Interrupt) and take attention away from the executing process creating latency spikes and invalidation of the CPU caches as they must be cleared when switching between processes for security.
-
-Please only change these settings if you are experiencing issues or really know what you are doing. In general, there's no need to change these settings.
-
-## VPS Provider Recommendations
-
-### Good
-
-* Hetzner Cloud
-
-### Bad
-
-* AWS (known to use burst scheduling)
-
-
-## Example configurations
-
-Tuning the BEAM requires you provide a config file normally called [vm.args](http://erlang.org/doc/man/erl.html#emulator-flags). If you are using systemd to manage the service you can modify the unit file as such:
-
-`ExecStart=/usr/bin/elixir --erl '-args_file /opt/pleroma/config/vm.args' -S /usr/bin/mix phx.server`
-
-Check your OS documentation to adopt a similar strategy on other platforms.
-
-### Virtual Machine and/or few CPU cores
-
-Disable the busy-waiting. This should generally only be done if you're on a platform that does burst scheduling, like AWS.
-
-**vm.args:**
-
-```
-+sbwt none
-+sbwtdcpu none
-+sbwtdio none
-```
-
-### Dedicated Hardware
-
-Enable more busy waiting, increase the internal maximum limit of BEAM processes and ports. You can use this if you run on dedicated hardware, but it is not necessary.
-
-**vm.args:**
-
-```
-+P 16777216
-+Q 16777216
-+K true
-+A 128
-+sbt db
-+sbwt very_long
-+swt very_low
-+sub true
-+Mulmbcs 32767
-+Mumbcgs 1
-+Musmbcs 2047
-```
-
-## Additional Reading
-
-* [WhatsApp: Scaling to Millions of Simultaneous Connections](https://www.erlang-factory.com/upload/presentations/558/efsf2012-whatsapp-scaling.pdf)
-* [Preemptive Scheduling and Spinlocks](https://www.uio.no/studier/emner/matnat/ifi/nedlagte-emner/INF3150/h03/annet/slides/preemptive.pdf)
-* [The Curious Case of BEAM CPU Usage](https://stressgrid.com/blog/beam_cpu_usage/)

docs/configuration/postgresql.md

@@ -1,48 +0,0 @@
-# Optimizing PostgreSQL performance
-
-Pleroma performance is largely dependent on performance of the underlying database. Better performance can be achieved by adjusting a few settings.
-
-## PGTune
-
-[PgTune](https://pgtune.leopard.in.ua) can be used to get recommended settings. Be sure to set "Number of Connections" to 20, otherwise it might produce settings hurtful to database performance. It is also recommended to not use "Network Storage" option.
-
-## Disable generic query plans
-
-When PostgreSQL receives a query, it decides on a strategy for searching the requested data, this is called a query plan. The query planner has two modes: generic and custom. Generic makes a plan for all queries of the same shape, ignoring the parameters, which is then cached and reused. Custom, on the contrary, generates a unique query plan based on query parameters.
-
-By default PostgreSQL has an algorithm to decide which mode is more efficient for particular query, however this algorithm has been observed to be wrong on some of the queries Pleroma sends, leading to serious performance loss. Therefore, it is recommended to disable generic mode.
-
-
-Pleroma already avoids generic query plans by default, however the method it uses is not the most efficient because it needs to be compatible with all supported PostgreSQL versions. For PostgreSQL 12 and higher additional performance can be gained by adding the following to Pleroma configuration:
-```elixir
-config :pleroma, Pleroma.Repo,
-  prepare: :named,
-  parameters: [
-    plan_cache_mode: "force_custom_plan"
-  ]
-```
-
-A more detailed explaination of the issue can be found at <https://blog.soykaf.com/post/postgresql-elixir-troubles/>.
-
-## Example configurations
-
-Here are some configuration suggestions for PostgreSQL 10+.
-
-### 1GB RAM, 1 CPU
-```
-shared_buffers = 256MB
-effective_cache_size = 768MB
-maintenance_work_mem = 64MB
-work_mem = 13107kB
-```
-
-### 2GB RAM, 2 CPU
-```
-shared_buffers = 512MB
-effective_cache_size = 1536MB
-maintenance_work_mem = 128MB
-work_mem = 26214kB
-max_worker_processes = 2
-max_parallel_workers_per_gather = 1
-max_parallel_workers = 2
-```

docs/configuration/static_dir.md

@@ -1,61 +1,45 @@
 # Static Directory
 
-Static frontend files are shipped with pleroma. If you want to overwrite or update these without problems during upgrades, you can write your custom versions to the static directory.
+Static frontend files are shipped in `priv/static/` and tracked by version control in this repository. If you want to overwrite or update these without the possibility of merge conflicts, you can write your custom versions to `instance/static/`.
 
-You can find the location of the static directory in the [configuration](../cheatsheet/#instance).
+```
+config :pleroma, :instance,
+  static_dir: "instance/static/",
+```
 
-=== "OTP"
-
-    ```elixir
-    config :pleroma, :instance,
-      static_dir: "/var/lib/pleroma/static/"
-    ```
-
-=== "From Source"
-
-    ```elixir
-    config :pleroma, :instance,
-    static_dir: "instance/static/"
-    ```
+For example, edit `instance/static/instance/panel.html` .
 
 Alternatively, you can overwrite this value in your configuration to use a different static instance directory.
 
-This document is written using `$static_dir` as the value of the `config :pleroma, :instance, static_dir` setting.
+This document is written assuming `instance/static/`.
 
-If you use a From Source installation and want to manage your custom files in the git repository, you can remove the `instance/` entry from `.gitignore`.
+Or, if you want to manage your custom file in git repository, basically remove the `instance/` entry from `.gitignore`.
 
 ## robots.txt
 
-There's a mix tasks to [generate a new robot.txt](../../administration/CLI_tasks/robots_txt/).
+By default, the `robots.txt` that ships in `priv/static/` is permissive. It allows well-behaved search engines to index all of your instance's URIs.
 
-For more complex things, you can write your own robots.txt to `$static_dir/robots.txt`.
-
-E.g. if you want to block all crawlers except for [fediverse.network](https://fediverse.network/about) you can use
+If you want to generate a restrictive `robots.txt`, you can run the following mix task. The generated `robots.txt` will be written in your instance static directory.
 
 ```
-User-Agent: *
-Disallow: /
-
-User-Agent: crawler-us-il-1.fediverse.network
-Allow: /
-
-User-Agent: makhnovtchina.random.sh
-Allow: /
+mix pleroma.robots_txt disallow_all
 ```
 
 ## Thumbnail
 
-Add `$static_dir/instance/thumbnail.jpeg` with your selfie or other neat picture. It will be available on `http://your-domain.tld/instance/thumbnail.jpeg` and can be used by external applications.
+Put on `instance/static/instance/thumbnail.jpeg` with your selfie or other neat picture. It will appear in [Pleroma Instances](http://distsn.org/pleroma-instances.html).
 
 ## Instance-specific panel
 
-Create and Edit your file at `$static_dir/instance/panel.html`.
+![instance-specific panel demo](/uploads/296b19ec806b130e0b49b16bfe29ce8a/image.png)
+
+Create and Edit your file on `instance/static/instance/panel.html`.
 
 ## Background
 
-You can change the background of your Pleroma instance by uploading it to `$static_dir/`, and then changing `background` in [your configuration](../cheatsheet/#frontend_configurations) accordingly.
+You can change the background of your Pleroma instance by uploading it to `instance/static/`, and then changing `background` in `config/prod.secret.exs` accordingly.
 
-E.g. if you put `$static_dir/images/background.jpg`
+If you put `instance/static/images/background.jpg`
 
 ```
 config :pleroma, :frontend_configurations,
@@ -66,14 +50,12 @@ config :pleroma, :frontend_configurations,
 
 ## Logo
 
-!!! important
-    Note the extra `static` folder for the default logo.png location
+![logo modification demo](/uploads/c70b14de60fa74245e7f0dcfa695ebff/image.png)
 
-If you want to give a brand to your instance, You can change the logo of your instance by uploading it to the static directory `$static_dir/static/logo.png`.
+If you want to give a brand to your instance, You can change the logo of your instance by uploading it to `instance/static/`.
 
-Alternatively, you can specify the path to your logo in [your configuration](../cheatsheet/#frontend_configurations).
-
-E.g. if you put `$static_dir/static/mylogo-file.png`
+Alternatively, you can specify the path with config.
+If you put `instance/static/static/mylogo-file.png`
 
 ```
 config :pleroma, :frontend_configurations,
@@ -84,12 +66,4 @@ config :pleroma, :frontend_configurations,
 
 ## Terms of Service
 
-!!! important
-    Note the extra `static` folder for the terms-of-service.html
-
-Terms of Service will be shown to all users on the registration page. It's the best place where to write down the rules for your instance. You can modify the rules by adding and changing `$static_dir/static/terms-of-service.html`.
-
- 	
-## Styling rendered pages
-
-To overwrite the CSS stylesheet of the OAuth form and other static pages, you can upload your own CSS file to `instance/static/static.css`. This will completely replace the CSS used by those pages, so it might be a good idea to copy the one from `priv/static/instance/static.css` and make your changes.
+Terms of Service will be shown to all users on the registration page. It's the best place where to write down the rules for your instance. You can modify the rules by changing `instance/static/static/terms-of-service.html`.

docs/configuration/storing_remote_media.md

@@ -1,38 +0,0 @@
-# Storing Remote Media
-
-Pleroma does not store remote/federated media by default. The best way to achieve this is to change Nginx to keep its reverse proxy cache
-for a year and to activate the `MediaProxyWarmingPolicy` MRF policy in Pleroma which will automatically fetch all media through the proxy
-as soon as the post is received by your instance.
-
-## Nginx
-
-```
-    proxy_cache_path /long/term/storage/path/pleroma-media-cache levels=1:2
-        keys_zone=pleroma_media_cache:10m inactive=1y use_temp_path=off;
-
-    location ~ ^/(media|proxy) {
-        proxy_cache        pleroma_media_cache;
-        slice              1m;
-        proxy_cache_key    $host$uri$is_args$args$slice_range;
-        proxy_set_header   Range $slice_range;
-        proxy_http_version 1.1;
-        proxy_cache_valid  206 301 302 304 1h;
-        proxy_cache_valid  200 1y;
-        proxy_cache_use_stale error timeout invalid_header updating;
-        proxy_ignore_client_abort on;
-        proxy_buffering    on;
-        chunked_transfer_encoding on;
-        proxy_ignore_headers Cache-Control Expires;
-        proxy_hide_header  Cache-Control Expires;
-        proxy_pass         http://127.0.0.1:4000;
-    }
-```
-
-## Pleroma
-
-Add to your `prod.secret.exs`:
-
-```
-config :pleroma, :mrf,
-  policies: [Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy]
-```

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 Pleroma 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/API/differences_in_mastoapi_responses.md

@@ -1,390 +0,0 @@
-# Differences in Mastodon API responses from vanilla Mastodon
-
-A Pleroma instance can be identified by "<Mastodon version> (compatible; Pleroma <version>)" present in `version` field in response from `/api/v1/instance`
-
-## Flake IDs
-
-Pleroma uses 128-bit ids as opposed to Mastodon's 64 bits. However, just like Mastodon's ids, they are lexically sortable strings
-
-## Timelines
-
-Adding the parameter `with_muted=true` to the timeline queries will also return activities by muted (not by blocked!) users.
-
-Adding the parameter `exclude_visibilities` to the timeline queries will exclude the statuses with the given visibilities. The parameter accepts an array of visibility types (`public`, `unlisted`, `private`, `direct`), e.g., `exclude_visibilities[]=direct&exclude_visibilities[]=private`.
-
-Adding the parameter `reply_visibility` to the public and home timelines queries will filter replies. Possible values: without parameter (default) shows all replies, `following` - replies directed to you or users you follow, `self` - replies directed to you.
-
-Adding the parameter `instance=lain.com` to the public timeline will show only statuses originating from `lain.com` (or any remote instance).
-
-Home, public, hashtag & list timelines accept these parameters:
-
-- `only_media`: show only statuses with media attached
-- `local`: show only local statuses
-- `remote`: show only remote statuses
-
-## Statuses
-
-- `visibility`: has additional possible values `list` and `local` (for local-only statuses)
-
-Has these additional fields under the `pleroma` object:
-
-- `local`: true if the post was made on the local instance
-- `conversation_id`: the ID of the AP context the status is associated with (if any)
-- `direct_conversation_id`: the ID of the Mastodon direct message conversation the status is associated with (if any)
-- `in_reply_to_account_acct`: the `acct` property of User entity for replied user (if any)
-- `content`: a map consisting of alternate representations of the `content` property with the key being its mimetype. Currently, the only alternate representation supported is `text/plain`
-- `spoiler_text`: a map consisting of alternate representations of the `spoiler_text` property with the key being its mimetype. Currently, the only alternate representation supported is `text/plain`
-- `expires_at`: a datetime (iso8601) that states when the post will expire (be deleted automatically), or empty if the post won't expire
-- `thread_muted`: true if the thread the post belongs to is muted
-- `emoji_reactions`: A list with emoji / reaction maps. The format is `{name: "☕", count: 1, me: true}`. Contains no information about the reacting users, for that use the `/statuses/:id/reactions` endpoint.
-- `parent_visible`: If the parent of this post is visible to the user or not.
-- `pinned_at`: a datetime (iso8601) when status was pinned, `null` otherwise.
-
-The `GET /api/v1/statuses/:id/source` endpoint additionally has the following attributes:
-
-- `content_type`: The content type of the status source.
-
-## Scheduled statuses
-
-Has these additional fields in `params`:
-
-- `expires_in`: the number of seconds the posted activity should expire in.
-
-## Media Attachments
-
-Has these additional fields under the `pleroma` object:
-
-- `mime_type`: mime type of the attachment.
-
-### Attachment cap
-
-Some apps operate under the assumption that no more than 4 attachments can be returned or uploaded. Pleroma however does not enforce any limits on attachment count neither when returning the status object nor when posting.
-
-### Limitations
-
-Pleroma does not process remote images and therefore cannot include fields such as `meta` and `blurhash`. It does not support focal points or aspect ratios. The frontend is expected to handle it.
-
-## Accounts
-
-The `id` parameter can also be the `nickname` of the user. This only works in these endpoints, not the deeper nested ones for following etc.
-
-- `/api/v1/accounts/:id`
-- `/api/v1/accounts/:id/statuses`
-
-`/api/v1/accounts/:id/statuses` endpoint accepts these parameters:
-
-- `pinned`: include only pinned statuses
-- `tagged`: with tag
-- `only_media`: include only statuses with media attached
-- `with_muted`: include statuses/reactions from muted accounts
-- `exclude_reblogs`: exclude reblogs
-- `exclude_replies`: exclude replies
-- `exclude_visibilities`: exclude visibilities
-
-Endpoints which accept `with_relationships` parameter:
-
-- `/api/v1/accounts/:id`
-- `/api/v1/accounts/:id/followers`
-- `/api/v1/accounts/:id/following`
-- `/api/v1/mutes`
-
-Has these additional fields under the `pleroma` object:
-
-- `ap_id`: nullable URL string, ActivityPub id of the user
-- `background_image`: nullable URL string, background image of the user
-- `tags`: Lists an array of tags for the user
-- `relationship` (object): Includes fields as documented for Mastodon API https://docs.joinmastodon.org/entities/relationship/
-- `is_moderator`: boolean, nullable,  true if user is a moderator
-- `is_admin`: boolean, nullable, true if user is an admin
-- `confirmation_pending`: boolean, true if a new user account is waiting on email confirmation to be activated
-- `hide_favorites`: boolean, true when the user has hiding favorites enabled
-- `hide_followers`: boolean, true when the user has follower hiding enabled
-- `hide_follows`: boolean, true when the user has follow hiding enabled
-- `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 Pleroma 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
-
-Has these additional fields under the `pleroma` object:
-
-- `show_role`: boolean, nullable, true when the user wants his role (e.g admin, moderator) to be shown
-- `no_rich_text` - boolean, nullable, true when html tags are stripped from all statuses requested from the API
-- `discoverable`: boolean, true when the user allows external services (search bots) etc. to index / list the account (regardless of this setting, user will still appear in regular search results)
-- `actor_type`: string, the type of this account.
-
-## Conversations
-
-Has an additional field under the `pleroma` object:
-
-- `recipients`: The list of the recipients of this Conversation. These will be addressed when replying to this conversation.
-
-## GET `/api/v1/conversations`
-
-Accepts additional parameters:
-
-- `recipients`: Only return conversations with the given recipients (a list of user ids). Usage example: `GET /api/v1/conversations?recipients[]=1&recipients[]=2`
-
-## Account Search
-
-Behavior has changed:
-
-- `/api/v1/accounts/search`: Does not require authentication
-
-## Search (global)
-
-Unlisted posts are available in search results, they are considered to be public posts that shouldn't be shown in local/federated timeline.
-
-## Notifications
-
-Has these additional fields under the `pleroma` object:
-
-- `is_seen`: true if the notification was read by the user
-
-### Move Notification
-
-The `type` value is `move`. Has an additional field:
-
-- `target`: new account
-
-### EmojiReact Notification
-
-The `type` value is `pleroma:emoji_reaction`. Has these fields:
-
-- `emoji`: The used emoji
-- `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.
-
-The `type` value is `pleroma:report`
-
-- `account`: The account who reported
-- `report`: The report
-
-## GET `/api/v1/notifications`
-
-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`.
-
-## DELETE `/api/v1/notifications/destroy_multiple`
-
-An endpoint to delete multiple statuses by IDs.
-
-Required parameters:
-
-- `ids`: array of activity ids
-
-Usage example: `DELETE /api/v1/notifications/destroy_multiple/?ids[]=1&ids[]=2`.
-
-Returns on success: 200 OK `{}`
-
-## POST `/api/v1/statuses`
-
-Additional parameters can be added to the JSON body/Form data:
-
-- `preview`: boolean, if set to `true` the post won't be actually posted, but the status entity would still be rendered back. This could be useful for previewing rich text/custom emoji, for example.
-- `content_type`: string, contain the MIME type of the status, it is transformed into HTML by the backend. You can get the list of the supported MIME types with the nodeinfo endpoint.
-- `to`: A list of nicknames (like `lain@soykaf.club` or `lain` on the local server) that will be used to determine who is going to be addressed by this post. Using this will disable the implicit addressing by mentioned names in the `status` body, only the people in the `to` list will be addressed. The normal rules for post visibility are not affected by this and will still apply.
-- `visibility`: string, besides standard MastoAPI values (`direct`, `private`, `unlisted`, `local` or `public`) it can be used to address a List by setting it to `list:LIST_ID`.
-- `expires_in`: The number of seconds the posted activity should expire in. When a posted activity expires it will be deleted from the server, and a delete request for it will be federated. This needs to be longer than an hour.
-- `in_reply_to_conversation_id`: Will reply to a given conversation, addressing only the people who are part of the recipient set of that conversation. Sets the visibility to `direct`.
-
-## GET `/api/v1/statuses`
-
-An endpoint to get multiple statuses by IDs.
-
-Required parameters:
-
-- `ids`: array of activity ids
-
-Usage example: `GET /api/v1/statuses/?ids[]=1&ids[]=2`.
-
-Returns: array of Status.
-
-The maximum number of statuses is limited to 100 per request.
-
-## PATCH `/api/v1/accounts/update_credentials`
-
-Additional parameters can be added to the JSON body/Form data:
-
-- `no_rich_text` - if true, html tags are stripped from all statuses requested from the API
-- `hide_followers` - if true, user's followers will be hidden
-- `hide_follows` - if true, user's follows will be hidden
-- `hide_followers_count` - if true, user's follower count will be hidden
-- `hide_follows_count` - if true, user's follow count will be hidden
-- `hide_favorites` - if true, user's favorites timeline will be hidden
-- `show_role` - if true, user's role (e.g admin, moderator) will be exposed to anyone in the API
-- `default_scope` - the scope returned under `privacy` key in Source subentity
-- `pleroma_settings_store` - Opaque user settings to be saved on the backend.
-- `skip_thread_containment` - if true, skip filtering out broken threads
-- `allow_following_move` - if true, allows automatically follow moved following accounts
-- `also_known_as` - array of ActivityPub IDs, needed for following move
-- `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.
-
-### Pleroma Settings Store
-
-Pleroma has mechanism that allows frontends to save blobs of json for each user on the backend. This can be used to save frontend-specific settings for a user that the backend does not need to know about.
-
-The parameter should have a form of `{frontend_name: {...}}`, with `frontend_name` identifying your type of client, e.g. `pleroma_fe`. It will overwrite everything under this property, but will not overwrite other frontend's settings.
-
-This information is returned in the `/api/v1/accounts/verify_credentials` endpoint.
-
-## Authentication
-
-*Pleroma supports refreshing tokens.*
-
-### POST `/oauth/token`
-
-You can obtain access tokens for a user in a few additional ways.
-
-#### Refreshing a token
-
-To obtain a new access token from a refresh token, pass `grant_type=refresh_token` with the following extra parameters:
-
-- `refresh_token`: The refresh token.
-
-#### Getting a token with a password
-
-To obtain a token from a user's password, pass `grant_type=password` with the following extra parameters:
-
-- `username`: Username to authenticate.
-- `password`: The user's password.
-
-#### Response body
-
-Additional fields are returned in the response:
-
-- `id`: The primary key of this token in Pleroma's database.
-- `me` (user tokens only): The ActivityPub ID of the user who owns the token.
-
-## Account Registration
-
-`POST /api/v1/accounts`
-
-Has these additional parameters (which are the same as in Pleroma-API):
-
-- `fullname`: optional
-- `bio`: optional
-- `captcha_solution`: optional, contains provider-specific captcha solution,
-- `captcha_token`: optional, contains provider-specific captcha token
-- `captcha_answer_data`: optional, contains provider-specific captcha data
-- `token`: invite token required when the registrations aren't public.
-- `language`: optional, user's preferred language for receiving emails (digest, confirmation, etc.), default to the language set in the `userLanguage` cookies or `Accept-Language` header.
-
-## Instance
-
-`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
-- `avatar_upload_limit`: The same for avatars
-- `background_upload_limit`: The same for backgrounds
-- `banner_upload_limit`: The same for banners
-- `background_image`: A background image that frontends can use
-- `pleroma.metadata.features`: A list of supported features
-- `pleroma.metadata.federation`: The federation restrictions of this instance
-- `pleroma.metadata.fields_limits`: A list of values detailing the length and count limitation for various instance-configurable fields.
-- `pleroma.metadata.post_formats`: A list of the allowed post format types
-- `vapid_public_key`: The public key needed for push messages
-
-## Push Subscription
-
-`POST /api/v1/push/subscription`
-`PUT /api/v1/push/subscription`
-
-Permits these additional alert types:
-
-- pleroma:chat_mention
-- pleroma:emoji_reaction
-
-## Markers
-
-Has these additional fields under the `pleroma` object:
-
-- `unread_count`: contains number unread notifications
-
-## 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`.
-
-### Follow relationships updates
-
-Pleroma streams follow relationships updates as `pleroma:follow_relationships_update` events to the `user` stream.
-
-The message payload consist of:
-
-- `state`: a relationship state, one of `follow_pending`, `follow_accept` or `follow_reject`.
-
-- `follower` and `following` maps with following fields:
-  - `id`: user ID
-  - `follower_count`: follower count
-  - `following_count`: following count
-
-## User muting and thread muting
-
-Both user muting and thread muting can be done for only a certain time by adding an `expires_in` parameter to the API calls and giving the expiration time in seconds.
-
-## Not implemented
-
-Pleroma is generally compatible with the Mastodon 2.7.2 API, but some newer features and non-essential features are omitted. These features usually return an HTTP 200 status code, but with an empty response. While they may be added in the future, they are considered low priority.
-
-### Suggestions
-
-*Added in Mastodon 2.4.3*
-
-- `GET /api/v1/suggestions`: Returns an empty array, `[]`
-
-### Trends
-
-*Added in Mastodon 3.0.0*
-
-- `GET /api/v1/trends`: Returns an empty array, `[]`
-
-### Identity proofs
-
-*Added in Mastodon 2.8.0*
-
-- `GET /api/v1/identity_proofs`: Returns an empty array, `[]`
-
-### Featured tags
-
-*Added in Mastodon 3.0.0*
-
-- `GET /api/v1/featured_tags`: Returns HTTP 404

docs/development/API/nodeinfo.md

@@ -1,347 +0,0 @@
-# Nodeinfo
-
-See also [the Nodeinfo standard](https://nodeinfo.diaspora.software/).
-
-## `/.well-known/nodeinfo`
-### The well-known path
-* Method: `GET`
-* Authentication: not required
-* Params: none
-* Response: JSON
-* Example response:
-```json
-{
-   "links":[
-      {
-         "href":"https://example.com/nodeinfo/2.0.json",
-         "rel":"http://nodeinfo.diaspora.software/ns/schema/2.0"
-      },
-      {
-         "href":"https://example.com/nodeinfo/2.1.json",
-         "rel":"http://nodeinfo.diaspora.software/ns/schema/2.1"
-      }
-   ]
-}
-```
-
-## `/nodeinfo/2.0.json`
-### Nodeinfo 2.0
-* Method: `GET`
-* Authentication: not required
-* Params: none
-* Response: JSON
-* Example response:
-```json
-{
-   "metadata":{
-      "accountActivationRequired":false,
-      "features":[
-         "pleroma_api",
-         "mastodon_api",
-         "mastodon_api_streaming",
-         "polls",
-         "pleroma_explicit_addressing",
-         "shareable_emoji_packs",
-         "multifetch",
-         "pleroma:api/v1/notifications:include_types_filter",
-         "chat",
-         "shout",
-         "relay",
-         "pleroma_emoji_reactions",
-         "pleroma_chat_messages"
-      ],
-      "federation":{
-         "enabled":true,
-         "exclusions":false,
-         "mrf_hashtag":{
-            "federated_timeline_removal":[
-               
-            ],
-            "reject":[
-               
-            ],
-            "sensitive":[
-               "nsfw"
-            ]
-         },
-         "mrf_object_age":{
-            "actions":[
-               "delist",
-               "strip_followers"
-            ],
-            "threshold":604800
-         },
-         "mrf_policies":[
-            "ObjectAgePolicy",
-            "TagPolicy",
-            "HashtagPolicy"
-         ],
-         "quarantined_instances":[
-            
-         ]
-      },
-      "fieldsLimits":{
-         "maxFields":10,
-         "maxRemoteFields":20,
-         "nameLength":512,
-         "valueLength":2048
-      },
-      "invitesEnabled":false,
-      "mailerEnabled":false,
-      "nodeDescription":"Pleroma: An efficient and flexible fediverse server",
-      "nodeName":"Example",
-      "pollLimits":{
-         "max_expiration":31536000,
-         "max_option_chars":200,
-         "max_options":20,
-         "min_expiration":0
-      },
-      "postFormats":[
-         "text/plain",
-         "text/html",
-         "text/markdown",
-         "text/bbcode"
-      ],
-      "private":false,
-      "restrictedNicknames":[
-         ".well-known",
-         "~",
-         "about",
-         "activities",
-         "api",
-         "auth",
-         "check_password",
-         "dev",
-         "friend-requests",
-         "inbox",
-         "internal",
-         "main",
-         "media",
-         "nodeinfo",
-         "notice",
-         "oauth",
-         "objects",
-         "ostatus_subscribe",
-         "pleroma",
-         "proxy",
-         "push",
-         "registration",
-         "relay",
-         "settings",
-         "status",
-         "tag",
-         "user-search",
-         "user_exists",
-         "users",
-         "web",
-         "verify_credentials",
-         "update_credentials",
-         "relationships",
-         "search",
-         "confirmation_resend",
-         "mfa"
-      ],
-      "skipThreadContainment":true,
-      "staffAccounts":[
-         "https://example.com/users/admin",
-         "https://example.com/users/staff"
-      ],
-      "suggestions":{
-         "enabled":false
-      },
-      "uploadLimits":{
-         "avatar":2000000,
-         "background":4000000,
-         "banner":4000000,
-         "general":16000000
-      }
-   },
-   "openRegistrations":true,
-   "protocols":[
-      "activitypub"
-   ],
-   "services":{
-      "inbound":[
-         
-      ],
-      "outbound":[
-         
-      ]
-   },
-   "software":{
-      "name":"pleroma",
-      "version":"2.4.1"
-   },
-   "usage":{
-      "localPosts":27,
-      "users":{
-         "activeHalfyear":129,
-         "activeMonth":70,
-         "total":235
-      }
-   },
-   "version":"2.0"
-}
-```
-
-## `/nodeinfo/2.1.json`
-### Nodeinfo 2.1
-* Method: `GET`
-* Authentication: not required
-* Params: none
-* Response: JSON
-* Example response:
-```json
-{
-   "metadata":{
-      "accountActivationRequired":false,
-      "features":[
-         "pleroma_api",
-         "mastodon_api",
-         "mastodon_api_streaming",
-         "polls",
-         "pleroma_explicit_addressing",
-         "shareable_emoji_packs",
-         "multifetch",
-         "pleroma:api/v1/notifications:include_types_filter",
-         "chat",
-         "shout",
-         "relay",
-         "pleroma_emoji_reactions",
-         "pleroma_chat_messages"
-      ],
-      "federation":{
-         "enabled":true,
-         "exclusions":false,
-         "mrf_hashtag":{
-            "federated_timeline_removal":[
-               
-            ],
-            "reject":[
-               
-            ],
-            "sensitive":[
-               "nsfw"
-            ]
-         },
-         "mrf_object_age":{
-            "actions":[
-               "delist",
-               "strip_followers"
-            ],
-            "threshold":604800
-         },
-         "mrf_policies":[
-            "ObjectAgePolicy",
-            "TagPolicy",
-            "HashtagPolicy"
-         ],
-         "quarantined_instances":[
-            
-         ]
-      },
-      "fieldsLimits":{
-         "maxFields":10,
-         "maxRemoteFields":20,
-         "nameLength":512,
-         "valueLength":2048
-      },
-      "invitesEnabled":false,
-      "mailerEnabled":false,
-      "nodeDescription":"Pleroma: An efficient and flexible fediverse server",
-      "nodeName":"Example",
-      "pollLimits":{
-         "max_expiration":31536000,
-         "max_option_chars":200,
-         "max_options":20,
-         "min_expiration":0
-      },
-      "postFormats":[
-         "text/plain",
-         "text/html",
-         "text/markdown",
-         "text/bbcode"
-      ],
-      "private":false,
-      "restrictedNicknames":[
-         ".well-known",
-         "~",
-         "about",
-         "activities",
-         "api",
-         "auth",
-         "check_password",
-         "dev",
-         "friend-requests",
-         "inbox",
-         "internal",
-         "main",
-         "media",
-         "nodeinfo",
-         "notice",
-         "oauth",
-         "objects",
-         "ostatus_subscribe",
-         "pleroma",
-         "proxy",
-         "push",
-         "registration",
-         "relay",
-         "settings",
-         "status",
-         "tag",
-         "user-search",
-         "user_exists",
-         "users",
-         "web",
-         "verify_credentials",
-         "update_credentials",
-         "relationships",
-         "search",
-         "confirmation_resend",
-         "mfa"
-      ],
-      "skipThreadContainment":true,
-      "staffAccounts":[
-         "https://example.com/users/admin",
-         "https://example.com/users/staff"
-      ],
-      "suggestions":{
-         "enabled":false
-      },
-      "uploadLimits":{
-         "avatar":2000000,
-         "background":4000000,
-         "banner":4000000,
-         "general":16000000
-      }
-   },
-   "openRegistrations":true,
-   "protocols":[
-      "activitypub"
-   ],
-   "services":{
-      "inbound":[
-         
-      ],
-      "outbound":[
-         
-      ]
-   },
-   "software":{
-      "name":"pleroma",
-      "repository":"https://git.pleroma.social/pleroma/pleroma",
-      "version":"2.4.1"
-   },
-   "usage":{
-      "localPosts":27,
-      "users":{
-         "activeHalfyear":129,
-         "activeMonth":70,
-         "total":235
-      }
-   },
-   "version":"2.1"
-}
-```
-

docs/development/API/pleroma_api.md

@@ -1,766 +0,0 @@
-# Pleroma API
-
-Requests that require it can be authenticated with [an OAuth token](https://tools.ietf.org/html/rfc6749), the `_pleroma_key` cookie, or [HTTP Basic Authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization).
-
-Request parameters can be passed via [query strings](https://en.wikipedia.org/wiki/Query_string) or as [form data](https://www.w3.org/TR/html401/interact/forms.html). Files must be uploaded as `multipart/form-data`.
-
-The `/api/v1/pleroma/*` path is backwards compatible with `/api/pleroma/*` (`/api/pleroma/*` will be deprecated in the future).
-
-## `/api/v1/pleroma/emoji`
-### Lists the custom emoji on that server.
-* Method: `GET`
-* Authentication: not required
-* Params: none
-* Response: JSON
-* Example response:
-```json
-{
-  "girlpower": {
-    "tags": [
-      "Finmoji"
-    ],
-    "image_url": "/finmoji/128px/girlpower-128.png"
-  },
-  "education": {
-    "tags": [
-      "Finmoji"
-    ],
-    "image_url": "/finmoji/128px/education-128.png"
-  },
-  "finnishlove": {
-    "tags": [
-      "Finmoji"
-    ],
-    "image_url": "/finmoji/128px/finnishlove-128.png"
-  }
-}
-```
-* Note: Same data as Mastodon API’s `/api/v1/custom_emojis` but in a different format
-
-## `/api/pleroma/follow_import`
-### Imports your follows, for example from a Mastodon CSV file.
-* Method: `POST`
-* Authentication: required
-* Params:
-    * `list`: STRING or FILE containing a whitespace-separated list of accounts to follow
-* Response: HTTP 200 on success, 500 on error
-* Note: Users that can't be followed are silently skipped.
-
-## `/api/pleroma/blocks_import`
-### Imports your blocks.
-* Method: `POST`
-* Authentication: required
-* Params:
-    * `list`: STRING or FILE containing a whitespace-separated list of accounts to block
-* Response: HTTP 200 on success, 500 on error
-
-## `/api/pleroma/mutes_import`
-### Imports your mutes.
-* Method: `POST`
-* Authentication: required
-* Params:
-    * `list`: STRING or FILE containing a whitespace-separated list of accounts to mute
-* Response: HTTP 200 on success, 500 on error
-
-## `/api/v1/pleroma/captcha`
-### Get a new captcha
-* Method: `GET`
-* Authentication: not required
-* Params: none
-* Response: Provider specific JSON, the only guaranteed parameter is `type`
-* Example response: `{"type": "kocaptcha", "token": "whatever", "url": "https://captcha.kotobank.ch/endpoint", "seconds_valid": 300}`
-
-## `/api/pleroma/delete_account`
-### Delete an account
-* Method `POST`
-* Authentication: required
-* Params:
-    * `password`: user's password
-* Response: JSON. Returns `{"status": "success"}` if the deletion was successful, `{"error": "[error message]"}` otherwise
-* Example response: `{"error": "Invalid password."}`
-
-## `/api/pleroma/disable_account`
-### Disable an account
-* Method `POST`
-* Authentication: required
-* Params:
-    * `password`: user's password
-* Response: JSON. Returns `{"status": "success"}` if the account was successfully disabled, `{"error": "[error message]"}` otherwise
-* Example response: `{"error": "Invalid password."}`
-
-## `/api/pleroma/accounts/mfa`
-#### Gets current MFA settings
-* method: `GET`
-* Authentication: required
-* OAuth scope: `read:security`
-* Response: JSON. Returns `{"settings": {"enabled": "false", "totp": false }}`
-* Note: `enabled` is whether multi-factor auth is enabled for the user in general, while `totp` is one type of MFA.
-
-## `/api/pleroma/accounts/mfa/setup/totp`
-#### Pre-setup the MFA/TOTP method
-* method: `GET`
-* Authentication: required
-* OAuth scope: `write:security`
-* Response: JSON. Returns `{"key": [secret_key], "provisioning_uri": "[qr code uri]"  }` when successful, otherwise returns HTTP 422 `{"error": "error_msg"}`
-
-## `/api/pleroma/accounts/mfa/confirm/totp`
-#### Confirms & enables MFA/TOTP support for user account.
-* method: `POST`
-* Authentication: required
-* OAuth scope: `write:security`
-* Params:
-    * `password`: user's password
-    * `code`: token from TOTP App
-* Response: JSON. Returns `{}` if the enable was successful, HTTP 422 `{"error": "[error message]"}` otherwise
-
-
-## `/api/pleroma/accounts/mfa/totp`
-####  Disables MFA/TOTP method for user account.
-* method: `DELETE`
-* Authentication: required
-* OAuth scope: `write:security`
-* Params:
-    * `password`: user's password
-* Response: JSON. Returns `{}` if the disable was successful, HTTP 422 `{"error": "[error message]"}` otherwise
-* Example response: `{"error": "Invalid password."}`
-
-## `/api/pleroma/accounts/mfa/backup_codes`
-####  Generstes backup codes MFA for user account.
-* method: `GET`
-* Authentication: required
-* OAuth scope: `write:security`
-* Response: JSON. Returns `{"codes": codes}`when successful, otherwise HTTP 422 `{"error": "[error message]"}`
-
-## `/api/v1/pleroma/admin/`
-See [Admin-API](admin_api.md)
-
-## `/api/v1/pleroma/notifications/read`
-### Mark notifications as read
-* Method `POST`
-* Authentication: required
-* Params (mutually exclusive):
-    * `id`: a single notification id to read
-    * `max_id`: read all notifications up to this id
-* Response: Notification entity/Array of Notification entities that were read. In case of `max_id`, only the first 80 read notifications will be returned.
-
-## `/api/v1/pleroma/accounts/:id/subscribe`
-### Subscribe to receive notifications for all statuses posted by a user
-* Method `POST`
-* Authentication: required
-* Params:
-    * `id`: account id to subscribe to
-* Response: JSON, returns a mastodon relationship object on success, otherwise returns `{"error": "error_msg"}`
-* Example response:
-```json
-{
-  "id": "abcdefg",
-  "following": true,
-  "followed_by": false,
-  "blocking": false,
-  "muting": false,
-  "muting_notifications": false,
-  "subscribing": true,
-  "notifying": true,
-  "requested": false,
-  "domain_blocking": false,
-  "showing_reblogs": true,
-  "endorsed": false,
-  "note": ""
-}
-```
-
-## `/api/v1/pleroma/accounts/:id/unsubscribe`
-### Unsubscribe to stop receiving notifications from user statuses
-* Method `POST`
-* Authentication: required
-* Params:
-    * `id`: account id to unsubscribe from
-* Response: JSON, returns a mastodon relationship object on success, otherwise returns `{"error": "error_msg"}`
-* Example response:
-```json
-{
-  "id": "abcdefg",
-  "following": true,
-  "followed_by": false,
-  "blocking": false,
-  "muting": false,
-  "muting_notifications": false,
-  "subscribing": false,
-  "notifying": false,
-  "requested": false,
-  "domain_blocking": false,
-  "showing_reblogs": true,
-  "endorsed": false,
-  "note": ""
-}
-```
-
-## `/api/v1/pleroma/accounts/:id/favourites`
-### Returns favorites timeline of any user
-* Method `GET`
-* Authentication: not required
-* Params:
-    * `id`: the id of the account for whom to return results
-    * `limit`: optional, the number of records to retrieve
-    * `since_id`: optional, returns results that are more recent than the specified id
-    * `max_id`: optional, returns results that are older than the specified id
-* Response: JSON, returns a list of Mastodon Status entities on success, otherwise returns `{"error": "error_msg"}`
-* Example response:
-```json
-[
-  {
-    "account": {
-      "id": "9hptFmUF3ztxYh3Svg",
-      "url": "https://pleroma.example.org/users/nick2",
-      "username": "nick2",
-      ...
-    },
-    "application": {"name": "Web", "website": null},
-    "bookmarked": false,
-    "card": null,
-    "content": "This is :moominmamma: note 0",
-    "created_at": "2019-04-15T15:42:15.000Z",
-    "emojis": [],
-    "favourited": false,
-    "favourites_count": 1,
-    "id": "9hptFmVJ02khbzYJaS",
-    "in_reply_to_account_id": null,
-    "in_reply_to_id": null,
-    "language": null,
-    "media_attachments": [],
-    "mentions": [],
-    "muted": false,
-    "pinned": false,
-    "pleroma": {
-      "content": {"text/plain": "This is :moominmamma: note 0"},
-      "conversation_id": 13679,
-      "local": true,
-      "spoiler_text": {"text/plain": "2hu"}
-    },
-    "reblog": null,
-    "reblogged": false,
-    "reblogs_count": 0,
-    "replies_count": 0,
-    "sensitive": false,
-    "spoiler_text": "2hu",
-    "tags": [{"name": "2hu", "url": "/tag/2hu"}],
-    "uri": "https://pleroma.example.org/objects/198ed2a1-7912-4482-b559-244a0369e984",
-    "url": "https://pleroma.example.org/notice/9hptFmVJ02khbzYJaS",
-    "visibility": "public"
-  }
-]
-```
-
-## `/api/v1/pleroma/accounts/update_*`
-### Set and clear account avatar, banner, and background
-
-- PATCH `/api/v1/pleroma/accounts/update_avatar`: Set/clear user avatar image
-- PATCH `/api/v1/pleroma/accounts/update_banner`: Set/clear user banner image
-- PATCH `/api/v1/pleroma/accounts/update_background`: Set/clear user background image
-
-## `/api/v1/pleroma/accounts/confirmation_resend`
-### Resend confirmation email
-* Method `POST`
-* Params:
-    * `email`: email of that needs to be verified
-* Authentication: not required
-* Response: 204 No Content
-
-## `/api/v1/pleroma/mascot`
-### Gets user mascot image
-* Method `GET`
-* Authentication: required
-
-* Response: JSON. Returns a mastodon media attachment entity.
-* Example response:
-```json
-{
-    "id": "abcdefg",
-    "url": "https://pleroma.example.org/media/abcdefg.png",
-    "type": "image",
-    "pleroma": {
-        "mime_type": "image/png"
-    }
-}
-```
-
-### Updates user mascot image
-* Method `PUT`
-* Authentication: required
-* Params:
-    * `file`: Multipart image
-* Response: JSON. Returns a mastodon media attachment entity
-  when successful, otherwise returns HTTP 415 `{"error": "error_msg"}`
-* Example response:
-```json
-{
-    "id": "abcdefg",
-    "url": "https://pleroma.example.org/media/abcdefg.png",
-    "type": "image",
-    "pleroma": {
-        "mime_type": "image/png"
-    }
-}
-```
-* Note: Behaves exactly the same as `POST /api/v1/upload`.
-  Can only accept images - any attempt to upload non-image files will be met with `HTTP 415 Unsupported Media Type`.
-
-## `/api/pleroma/notification_settings`
-### Updates user notification settings
-* Method `PUT`
-* Authentication: required
-* Params:
-    * `block_from_strangers`: BOOLEAN field, blocks notifications from accounts you do not follow
-    * `hide_notification_contents`: BOOLEAN field. When set to true, it removes the contents of a message from the push notification.
-* Response: JSON. Returns `{"status": "success"}` if the update was successful, otherwise returns `{"error": "error_msg"}`
-
-## `/api/v1/pleroma/healthcheck`
-### Healthcheck endpoint with additional system data.
-* Method `GET`
-* Authentication: not required
-* Params: none
-* Response: JSON, statuses (200 - healthy, 503 unhealthy).
-* Example response:
-```json
-{
-  "pool_size": 0, # database connection pool
-  "active": 0, # active processes
-  "idle": 0, # idle processes
-  "memory_used": 0.00, # Memory used
-  "healthy": true, # Instance state
-  "job_queue_stats": {} # Job queue stats
-}
-```
-
-## `/api/pleroma/change_email`
-### Change account email
-* Method `POST`
-* Authentication: required
-* Params:
-    * `password`: user's password
-    * `email`: new email
-* Response: JSON. Returns `{"status": "success"}` if the change was successful, `{"error": "[error message]"}` otherwise
-* Note: Currently, Mastodon has no API for changing email. If they add it in future it might be incompatible with Pleroma.
-
-## `/api/pleroma/move_account`
-### Move account
-* Method `POST`
-* Authentication: required
-* Params:
-    * `password`: user's password
-    * `target_account`: the nickname of the target account (e.g. `foo@example.org`)
-* Response: JSON. Returns `{"status": "success"}` if the change was successful, `{"error": "[error message]"}` otherwise
-* Note: This endpoint emits a `Move` activity to all followers of the current account. Some remote servers will automatically unfollow the current account and follow the target account upon seeing this, but this depends on the remote server implementation and cannot be guaranteed. For local followers , they will automatically unfollow and follow if and only if they have set the `allow_following_move` preference ("Allow auto-follow when following account moves").
-
-## `/api/pleroma/aliases`
-### Get aliases of the current account
-* Method `GET`
-* Authentication: required
-* Response: JSON. Returns `{"aliases": [alias, ...]}`, where `alias` is the nickname of an alias, e.g. `foo@example.org`.
-
-### Add alias to the current account
-* Method `PUT`
-* Authentication: required
-* Params:
-    * `alias`: the nickname of the alias to add, e.g. `foo@example.org`.
-* Response: JSON. Returns `{"status": "success"}` if the change was successful, `{"error": "[error message]"}` otherwise
-
-### Delete alias from the current account
-* Method `DELETE`
-* Authentication: required
-* Params:
-    * `alias`: the nickname of the alias to delete, e.g. `foo@example.org`.
-* Response: JSON. Returns `{"status": "success"}` if the change was successful, `{"error": "[error message]"}` otherwise
-
-# Pleroma Conversations
-
-Pleroma Conversations have the same general structure that Mastodon Conversations have. The behavior differs in the following ways when using these endpoints:
-
-1. Pleroma Conversations never add or remove recipients, unless explicitly changed by the user.
-2. Pleroma Conversations statuses can be requested by Conversation id.
-3. Pleroma Conversations can be replied to.
-
-Conversations have the additional field `recipients` under the `pleroma` key. This holds a list of all the accounts that will receive a message in this conversation.
-
-The status posting endpoint takes an additional parameter, `in_reply_to_conversation_id`, which, when set, will set the visiblity to direct and address only the people who are the recipients of that Conversation.
-
-⚠ Conversation IDs can be found in direct messages with the `pleroma.direct_conversation_id` key, do not confuse it with `pleroma.conversation_id`.
-
-## `GET /api/v1/pleroma/conversations/:id/statuses`
-### Timeline for a given conversation
-* Method `GET`
-* Authentication: required
-* Params: Like other timelines
-* Response: JSON, statuses (200 - healthy, 503 unhealthy).
-
-## `GET /api/v1/pleroma/conversations/:id`
-### The conversation with the given ID.
-* Method `GET`
-* Authentication: required
-* Params: None
-* Response: JSON, statuses (200 - healthy, 503 unhealthy).
-
-## `PATCH /api/v1/pleroma/conversations/:id`
-### Update a conversation. Used to change the set of recipients.
-* Method `PATCH`
-* Authentication: required
-* Params:
-    * `recipients`: A list of ids of users that should receive posts to this conversation. This will replace the current list of recipients, so submit the full list. The owner of owner of the conversation will always be part of the set of recipients, though.
-* Response: JSON, statuses (200 - healthy, 503 unhealthy)
-
-## `POST /api/v1/pleroma/conversations/read`
-### Marks all user's conversations as read.
-* Method `POST`
-* Authentication: required
-* Params: None
-* Response: JSON, returns a list of Mastodon Conversation entities that were marked as read (200 - healthy, 503 unhealthy).
-
-## `GET /api/v1/pleroma/emoji/pack?name=:name`
-
-### Get pack.json for the pack
-
-* Method `GET`
-* Authentication: not required
-* Params:
-  * `page`: page number for files (default 1)
-  * `page_size`: page size for files (default 30)
-* Response: JSON, pack json with `files`, `files_count` and `pack` keys with 200 status or 404 if the pack does not exist.
-
-```json
-{
-  "files": {...},
-  "files_count": 0, // emoji count in pack
-  "pack": {...}
-}
-```
-
-## `POST /api/v1/pleroma/emoji/pack?name=:name`
-
-### Creates an empty pack
-
-* Method `POST`
-* Authentication: required (admin)
-* Params:
-  * `name`: pack name
-* Response: JSON, "ok" and 200 status or 409 if the pack with that name already exists
-
-## `PATCH /api/v1/pleroma/emoji/pack?name=:name`
-
-### Updates (replaces) pack metadata
-
-* Method `PATCH`
-* Authentication: required (admin)
-* Params:
-  * `name`: pack name
-  * `metadata`: metadata to replace the old one
-    * `license`: Pack license
-    * `homepage`: Pack home page url
-    * `description`: Pack description
-    * `fallback-src`: Fallback url to download pack from
-    * `fallback-src-sha256`: SHA256 encoded for fallback pack archive
-    * `share-files`: is pack allowed for sharing (boolean)
-* Response: JSON, updated "metadata" section of the pack and 200 status or 400 if there was a
-  problem with the new metadata (the error is specified in the "error" part of the response JSON)
-
-## `DELETE /api/v1/pleroma/emoji/pack?name=:name`
-
-### Delete a custom emoji pack
-
-* Method `DELETE`
-* Authentication: required (admin)
-* Params:
-  * `name`: pack name
-* Response: JSON, "ok" and 200 status or 500 if there was an error deleting the pack
-
-## `GET /api/v1/pleroma/emoji/packs/import`
-
-### Imports packs from filesystem
-
-* Method `GET`
-* Authentication: required (admin)
-* Params: None
-* Response: JSON, returns a list of imported packs.
-
-## `GET /api/v1/pleroma/emoji/packs/remote`
-
-### Make request to another instance for packs list
-
-* Method `GET`
-* Authentication: required (admin)
-* Params:
-  * `url`: url of the instance to get packs from
-  * `page`: page number for packs (default 1)
-  * `page_size`: page size for packs (default 50)
-* Response: JSON with the pack list, hashmap with pack name and pack contents
-
-## `POST /api/v1/pleroma/emoji/packs/download`
-
-### Download pack from another instance
-
-* Method `POST`
-* Authentication: required (admin)
-* Params:
-  * `url`: url of the instance to download from
-  * `name`: pack to download from that instance
-  * `as`: (*optional*) name how to save pack
-* Response: JSON, "ok" with 200 status if the pack was downloaded, or 500 if there were
-  errors downloading the pack
-
-## `POST /api/v1/pleroma/emoji/packs/files?name=:name`
-
-### Add new file to the pack
-
-* Method `POST`
-* Authentication: required (admin)
-* Params:
-  * `name`: pack name
-  * `file`: file needs to be uploaded with the multipart request or link to remote file.
-  * `shortcode`: (*optional*) shortcode for new emoji, must be unique for all emoji. If not sended, shortcode will be taken from original filename.
-  * `filename`: (*optional*) new emoji file name. If not specified will be taken from original filename.
-* Response: JSON, list of files for updated pack (hashmap -> shortcode => filename) with status 200, either error status with error message.
-
-## `PATCH /api/v1/pleroma/emoji/packs/files?name=:name`
-
-### Update emoji file from pack
-
-* Method `PATCH`
-* Authentication: required (admin)
-* Params:
-  * `name`: pack name
-  * `shortcode`: emoji file shortcode
-  * `new_shortcode`: new emoji file shortcode
-  * `new_filename`: new filename for emoji file
-  * `force`: (*optional*) with true value to overwrite existing emoji with new shortcode
-* Response: JSON, list with updated files for updated pack (hashmap -> shortcode => filename) with status 200, either error status with error message.
-
-## `DELETE /api/v1/pleroma/emoji/packs/files?name=:name`
-
-### Delete emoji file from pack
-
-* Method `DELETE`
-* Authentication: required (admin)
-* Params:
-  * `name`: pack name
-  * `shortcode`: emoji file shortcode
-* Response: JSON, list with updated files for updated pack (hashmap -> shortcode => filename) with status 200, either error status with error message.
-
-## `GET /api/v1/pleroma/emoji/packs`
-
-### Lists local custom emoji packs
-
-* Method `GET`
-* Authentication: not required
-* Params:
-  * `page`: page number for packs (default 1)
-  * `page_size`: page size for packs (default 50)
-* Response: `packs` key with JSON hashmap of pack name to pack contents and `count` key for count of packs.
-
-```json
-{
-  "packs": {
-    "pack_name": {...}, // pack contents
-    ...
-  },
-  "count": 0 // packs count
-}
-```
-
-## `GET /api/v1/pleroma/emoji/packs/archive?name=:name`
-
-### Requests a local pack archive from the instance
-
-* Method `GET`
-* Authentication: not required
-* Params:
-  * `name`: pack name
-* 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.
-
-## `PUT /api/v1/pleroma/statuses/:id/reactions/:emoji`
-### React to a post with a unicode emoji
-* Method: `PUT`
-* Authentication: required
-* Params: `emoji`: A unicode RGI emoji or a regional indicator
-* Response: JSON, the status.
-
-## `DELETE /api/v1/pleroma/statuses/:id/reactions/:emoji`
-### Remove a reaction to a post with a unicode emoji
-* Method: `DELETE`
-* Authentication: required
-* Params: `emoji`: A unicode RGI emoji or a regional indicator
-* Response: JSON, the status.
-
-## `GET /api/v1/pleroma/statuses/:id/reactions`
-### Get an object of emoji to account mappings with accounts that reacted to the post
-* Method: `GET`
-* Authentication: optional
-* Params: None
-* Response: JSON, a list of emoji/account list tuples, sorted by emoji insertion date, in ascending order, e.g, the first emoji in the list is the oldest.
-* Example Response:
-```json
-[
-  {"name": "😀", "count": 2, "me": true, "accounts": [{"id" => "xyz.."...}, {"id" => "zyx..."}]},
-  {"name": "☕", "count": 1, "me": false, "accounts": [{"id" => "abc..."}]}
-]
-```
-
-## `GET /api/v1/pleroma/statuses/:id/reactions/:emoji`
-### Get an object of emoji to account mappings with accounts that reacted to the post for a specific emoji
-* Method: `GET`
-* Authentication: optional
-* Params: None
-* Response: JSON, a list of emoji/account list tuples
-* Example Response:
-```json
-[
-  {"name": "😀", "count": 2, "me": true, "accounts": [{"id" => "xyz.."...}, {"id" => "zyx..."}]}
-]
-```
-
-## `POST /api/v1/pleroma/backups`
-### Create a user backup archive
-
-* Method: `POST`
-* Authentication: required
-* Params: none
-* Response: JSON
-* Example response:
-
-```json
-[{
-    "content_type": "application/zip",
-    "file_size": 0,
-    "inserted_at": "2020-09-10T16:18:03.000Z",
-    "processed": false,
-    "url": "https://example.com/media/backups/archive-foobar-20200910T161803-QUhx6VYDRQ2wfV0SdA2Pfj_2CLM_ATUlw-D5l5TJf4Q.zip"
-}]
-```
-
-## `GET /api/v1/pleroma/backups`
-### Lists user backups
-
-* Method: `GET`
-* Authentication: not required
-* Params: none
-* Response: JSON
-* Example response:
-
-```json
-[{
-    "content_type": "application/zip",
-    "file_size": 55457,
-    "inserted_at": "2020-09-10T16:18:03.000Z",
-    "processed": true,
-    "url": "https://example.com/media/backups/archive-foobar-20200910T161803-QUhx6VYDRQ2wfV0SdA2Pfj_2CLM_ATUlw-D5l5TJf4Q.zip"
-}]
-```
-
-## `GET /api/oauth_tokens`
-### Retrieve a list of active sessions for the user
-* Method: `GET`
-* Authentication: required
-* Params: none
-* Response: JSON
-* Example response:
-
-```json
-[
-  {
-    "app_name": "Pleroma FE",
-    "id": 9275,
-    "valid_until": "2121-11-24T15:51:08.234234"
-  },
-  {
-    "app_name": "Patron",
-    "id": 8805,
-    "valid_until": "2121-10-26T18:09:59.857150"
-  },
-  {
-    "app_name": "Soapbox FE",
-    "id": 9727,
-    "valid_until": "2121-12-25T16:52:39.692877"
-  }
-]
-```
-
-## `DELETE /api/oauth_tokens/:id`
-### Revoke a user session by its ID
-* Method: `DELETE`
-* Authentication: required
-* Params: none
-* Response: HTTP 200 on success, 500 on error
-
-## `/api/v1/pleroma/settings/:app`
-### Gets settings for some application
-* Method `GET`
-* Authentication: `read:accounts`
-
-* Response: JSON. The settings for that application, or empty object if there is none.
-* Example response:
-```json
-{
-  "some key": "some value"
-}
-```
-
-### Updates settings for some application
-* Method `PATCH`
-* Authentication: `write:accounts`
-* Request body: JSON object. The object will be merged recursively with old settings. If some field is set to null, it is removed.
-* Example request:
-```json
-{
-  "some key": "some value",
-  "key to remove": null,
-  "nested field": {
-    "some key": "some value",
-    "key to remove": null
-  }
-}
-```
-* Response: JSON. Updated (merged) settings for that application.
-* Example response:
-```json
-{
-  "some key": "some value",
-  "nested field": {
-    "some key": "some value",
-  }
-}
-```

docs/development/API/prometheus.md

@@ -1,44 +0,0 @@
-# Prometheus Metrics
-
-Pleroma includes support for exporting metrics via the [prometheus_ex](https://github.com/deadtrickster/prometheus.ex) library.
-
-Config example:
-
-```
-config :prometheus, Pleroma.Web.Endpoint.MetricsExporter,
-  enabled: true,
-  auth: {:basic, "myusername", "mypassword"},
-  ip_whitelist: ["127.0.0.1"],
-  path: "/api/pleroma/app_metrics",
-  format: :text
-```
-
-* `enabled` (Pleroma extension) enables the endpoint
-* `ip_whitelist` (Pleroma extension) could be used to restrict access only to specified IPs
-* `auth` sets the authentication (`false` for no auth; configurable to HTTP Basic Auth, see [prometheus-plugs](https://github.com/deadtrickster/prometheus-plugs#exporting) documentation)
-* `format` sets the output format (`:text` or `:protobuf`)
-* `path` sets the path to app metrics page 
-
-
-## `/api/pleroma/app_metrics`
-
-### Exports Prometheus application metrics
-
-* Method: `GET`
-* Authentication: not required by default (see configuration options above)
-* Params: none
-* Response: text
-
-## Grafana
-
-### Config example
-
-The following is a config example to use with [Grafana](https://grafana.com)
-
-```
-  - job_name: 'beam'
-    metrics_path: /api/pleroma/app_metrics
-    scheme: https
-    static_configs:
-    - targets: ['pleroma.soykaf.com']
-```

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/development/authentication_authorization.md

@@ -1,21 +0,0 @@
-# Authentication & Authorization
-
-## OAuth token-based authentication & authorization
-
-* Pleroma supports hierarchical OAuth scopes, just like Mastodon but with added granularity of admin scopes. For a reference, see [Mastodon OAuth scopes](https://docs.joinmastodon.org/api/oauth-scopes/).
-
-* It is important to either define OAuth scope restrictions or explicitly mark OAuth scope check as skipped, for every controller action. To define scopes, call `plug(Pleroma.Web.Plugs.OAuthScopesPlug, %{scopes: [...]})`. To explicitly set OAuth scopes check skipped, call `plug(:skip_plug, Pleroma.Web.Plugs.OAuthScopesPlug <when ...>)`.
-
-* In controllers, `use Pleroma.Web, :controller` will result in `action/2` (see `Pleroma.Web.controller/0` for definition) be called prior to actual controller action, and it'll perform security / privacy checks before passing control to actual controller action.
-
-  For routes with `:authenticated_api` pipeline, authentication & authorization are expected, thus `OAuthScopesPlug` will be run unless explicitly skipped (also `EnsureAuthenticatedPlug` will be executed immediately before action even if there was an early run to give an early error, since `OAuthScopesPlug` supports `:proceed_unauthenticated` option, and other plugs may support similar options as well).
-
-  For `:api` pipeline routes, it'll be verified whether `OAuthScopesPlug` was called or explicitly skipped, and if it was not then auth information will be dropped for request. Then `EnsurePublicOrAuthenticatedPlug` will be called to ensure that either the instance is not private or user is authenticated (unless explicitly skipped). Such automated checks help to prevent human errors and result in higher security / privacy for users.
-
-## Non-OAuth authentication
-
-* With non-OAuth authentication ([HTTP Basic Authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization) or HTTP header- or params-provided auth), OAuth scopes check is _not_ performed for any action (since password is provided during the auth, requester is able to obtain a token with full permissions anyways); auth plugs invoke `Pleroma.Helpers.AuthHelper.skip_oauth(conn)` in this case.
-
-## Auth-related configuration, OAuth consumer mode etc.
-
-See `Authentication` section of [the configuration cheatsheet](../configuration/cheatsheet.md#authentication).

docs/development/index.md

@@ -1 +0,0 @@
-This section contains notes and guidelines for developers.

docs/development/setting_up_a_gitlab_runner.md

@@ -1,9 +0,0 @@
-# Setting up a Gitlab-runner
-
-When you push changes, a pipeline will start some automated jobs. These are done with so called [runners](https://docs.gitlab.com/runner/), services that run somewhere on a server and run these automated jobs. These jobs typically run tests and should pass. If not, you probably need to fix something.
-
-Generally, Pleroma provides a runner, so you don't need to set up your own. However, if for whatever reason you want to set up your own, here's some high level instructions.
-
-1. We use docker to run the jobs, so you should install that. For Debian, you need to allow non-free packages in the [source list](https://wiki.debian.org/SourcesList). Then you can install docker with `apt install docker-compose`.
-2. You can [install](https://docs.gitlab.com/runner/install/index.html) and [configure](https://docs.gitlab.com/runner/register/index.html) a Gitlab-runner. It's probably easiest to install from the packages, but there are other options as well.
-3. When registering the runner, you'll need some values. You can find them in the project under your own name. Choose "Settings", "CI/CD", and then expand "Runners". For executor you can choose "docker". For default image, you can use the image used in <https://git.pleroma.social/pleroma/pleroma/-/blob/develop/.gitlab-ci.yml#L1> (although it shouldn't matter much).

docs/development/setting_up_pleroma_dev.md

@@ -1,70 +0,0 @@
-# Setting up a Pleroma development environment
-
-Pleroma requires some adjustments from the defaults for running the instance locally. The following should help you to get started.
-
-## Installing
-
-1. Install Pleroma as explained in [the docs](../installation/debian_based_en.md), with some exceptions:
-    * You can use your own fork of the repository and add pleroma as a remote `git remote add pleroma 'https://git.pleroma.social/pleroma/pleroma'`
-    * You can skip systemd and nginx and all that stuff
-    * No need to create a dedicated pleroma user, it's easier to just use your own user
-    * For the DB you can still choose a dedicated user, the mix tasks set it up for you so it's no extra work for you
-    * For domain you can use `localhost`
-    * instead of creating a `prod.secret.exs`, create `dev.secret.exs`
-    * No need to prefix with `MIX_ENV=prod`. We're using dev and that's the default MIX_ENV
-2. Change the dev.secret.exs
-    * Change the scheme in `config :pleroma, Pleroma.Web.Endpoint` to http (see examples below)
-    * If you want to change other settings, you can do that too
-3. You can now start the server `mix phx.server`. Once it's build and started, you can access the instance on `http://<host>:<port>` (e.g.http://localhost:4000 ) and should be able to do everything locally you normaly can.
-
-Example config to change the scheme to http. Change the port if you want to run on another port.
-```elixir
-  config :pleroma, Pleroma.Web.Endpoint,
-   url: [host: "localhost", scheme: "http", port: 4000],
-```
-
-Example config to disable captcha. This makes it a bit easier to create test-users.
-```elixir
-config :pleroma, Pleroma.Captcha,
-  enabled: false
-```
-
-Example config to change the log level to info
-```elixir
-config :logger, :console,
-  # :debug :info :warning :error
-  level: :info
-```
-
-## Testing
-
-1. Create a `test.secret.exs` file with the content as shown below
-2. Create the database user and test database.
-    1. You can use the `config/setup_db.psql` as a template. Copy the file if you want and change the database name, user and password to the values for the test-database (e.g. 'pleroma_local_test' for database and user). Then run this file like you did during installation.
-    2. The tests will try to create the Database, so we'll have to allow our test-database user to create databases, `sudo -Hu postgres psql -c "ALTER USER pleroma_local_test WITH CREATEDB;"`
-3. Run the tests with `mix test`. The tests should succeed.
-
-Example content for the `test.secret.exs` file. Feel free to use another user, database name or password, just make sure the database is dedicated for the testing environment.
-```elixir
-# Pleroma test configuration
-
-# NOTE: This file should not be committed to a repo or otherwise made public
-# without removing sensitive information.
-
-import Config
-
-config :pleroma, Pleroma.Repo,
-  username: "pleroma_local_test",
-  password: "mysuperduperpassword",
-  database: "pleroma_local_test",
-  hostname: "localhost"
-
-```
-
-## Updating
-
-Update Pleroma as explained in [the docs](../administration/updating.md). Just make sure you pull from upstream and not from your own fork.
-
-## Working on multiple branches
-
-If you develop on a separate branch, it's possible you did migrations that aren't merged into another branch you're working on. If you have multiple things you're working on, it's probably best to set up multiple pleroma's each with their own database. If you finished with a branch and want to switch back to develop to start a new branch from there, you can drop the database and recreate the database (e.g. by using `config/setup_db.psql`). The commands to drop and recreate the database can be found in [the docs](../administration/backup.md).

docs/index.md

@@ -1,19 +0,0 @@
-# Introduction to Pleroma
-## What is Pleroma?
-Pleroma is a federated social networking platform, compatible with Mastodon and other ActivityPub implementations. It is free software licensed under the AGPLv3.
-It actually consists of two components: a backend, named simply Pleroma, and a user-facing frontend, named Pleroma-FE. It also includes the Mastodon frontend, if that's your thing.
-It's part of what we call the fediverse, a federated network of instances which speak common protocols and can communicate with each other.
-One account on an instance is enough to talk to the entire fediverse!
-
-## How can I use it?
-
-Pleroma instances are already widely deployed, a list can be found at <https://the-federation.info/pleroma> and <https://fediverse.network/pleroma>.
-
-If you don't feel like joining an existing instance, but instead prefer to deploy your own instance, that's easy too!
-Installation instructions can be found in the installation section of these docs.
-
-## I got an account, now what?
-Great! Now you can explore the fediverse! Open the login page for your Pleroma 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 Pleroma is Pleroma-FE. You can find more information on what it is and how to use it in the [Introduction to Pleroma-FE](../frontend).

docs/installation/alpine_linux_en.md

@@ -1,14 +1,24 @@
 # Installing on Alpine Linux
-
-{! backend/installation/otp_vs_from_source_source.include !}
-
 ## Installation
 
 This guide is a step-by-step installation guide for Alpine Linux. The instructions were verified against Alpine v3.10 standard image. You might miss additional dependencies if you use `netboot` instead.
 
 It assumes that you have administrative rights, either as root or a user with [sudo permissions](https://www.linode.com/docs/tools-reference/custom-kernels-distros/install-alpine-linux-on-your-linode/#configuration). 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 pleroma`; in this case, use `su -l <username> -s $SHELL -c 'command'` instead.
 
-{! backend/installation/generic_dependencies.include !}
+### Required packages
+
+* `postgresql`
+* `elixir`
+* `erlang`
+* `erlang-parsetools`
+* `erlang-xmerl`
+* `git`
+* Development Tools
+
+#### Optional packages used in this guide
+
+* `nginx` (preferred, example configs for other reverse proxies can be found in the repo)
+* `certbot` (or any other ACME client for Let’s Encrypt certificates)
 
 ### Prepare the system
 
@@ -18,6 +28,7 @@ It assumes that you have administrative rights, either as root or a user with [s
 awk 'NR==2' /etc/apk/repositories | sed 's/main/community/' | tee -a /etc/apk/repositories
 ```
 
+
 * Then update the system, if not already done:
 
 ```shell
@@ -28,7 +39,7 @@ sudo apk upgrade
 * Install some tools, which are needed later:
 
 ```shell
-sudo apk add git build-base cmake file-dev
+sudo apk add git build-base
 ```
 
 ### Install Elixir and Erlang
@@ -44,7 +55,6 @@ sudo apk add erlang erlang-runtime-tools erlang-xmerl elixir
 ```shell
 sudo apk add erlang-eldap
 ```
-
 ### Install PostgreSQL
 
 * Install Postgresql server:
@@ -65,12 +75,6 @@ sudo /etc/init.d/postgresql start
 sudo rc-update add postgresql
 ```
 
-### Install media / graphics packages (optional, see [`docs/installation/optional/media_graphics_packages.md`](../installation/optional/media_graphics_packages.md))
-
-```shell
-sudo apk add ffmpeg imagemagick exiftool
-```
-
 ### Install PleromaBE
 
 * Add a new system user for the Pleroma service:
@@ -102,7 +106,7 @@ cd /opt/pleroma
 sudo -Hu pleroma mix deps.get
 ```
 
-* Generate the configuration: `sudo -Hu pleroma MIX_ENV=prod mix pleroma.instance gen`
+* Generate the configuration: `sudo -Hu pleroma mix pleroma.instance gen`
   * Answer with `yes` if it asks you to install `rebar3`.
   * This may take some time, because parts of pleroma 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`.
@@ -110,7 +114,7 @@ sudo -Hu pleroma mix deps.get
 * Check the configuration and if all looks right, rename it, so Pleroma will load it (`prod.secret.exs` for productive instance, `dev.secret.exs` for development instances):
 
 ```shell
-sudo -Hu pleroma mv config/{generated_config.exs,prod.secret.exs}
+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:
@@ -221,8 +225,11 @@ sudo -Hu pleroma MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress
 
 #### Further reading
 
-{! backend/installation/further_reading.include !}
+* [Backup your instance](../administration/backup.md)
+* [Hardening your instance](../configuration/hardening.md)
+* [How to activate mediaproxy](../configuration/howto_mediaproxy.md)
+* [Updating your instance](../administration/updating.md)
 
 ## Questions
 
-Questions about the installation or didn’t it work as it should be, ask in [#pleroma:libera.chat](https://matrix.to/#/#pleroma:libera.chat) via Matrix or **#pleroma** on **libera.chat** via IRC.
+Questions about the installation or didn’t it work as it should be, ask in [#pleroma:matrix.org](https://matrix.heldscal.la/#/room/#freenode_#pleroma:matrix.org) or IRC Channel **#pleroma** on **Freenode**.

docs/installation/arch_linux_en.md

@@ -1,7 +1,4 @@
 # Installing on Arch Linux
-
-{! backend/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.archlinux.org/index.php/Sudo). 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 pleroma`; in this case, use `su <username> -s $SHELL -c 'command'` instead.
@@ -12,16 +9,11 @@ This guide will assume that you have administrative rights, either as root or a
 * `elixir`
 * `git`
 * `base-devel`
-* `cmake`
-* `file`
 
 #### Optional packages used in this guide
 
 * `nginx` (preferred, example configs for other reverse proxies can be found in the repo)
 * `certbot` (or any other ACME client for Let’s Encrypt certificates)
-* `ImageMagick`
-* `ffmpeg`
-* `exiftool`
 
 ### Prepare the system
 
@@ -34,7 +26,7 @@ sudo pacman -Syu
 * Install some of the above mentioned programs:
 
 ```shell
-sudo pacman -S git base-devel elixir cmake file
+sudo pacman -S git base-devel elixir
 ```
 
 ### Install PostgreSQL
@@ -59,12 +51,6 @@ sudo -iu postgres initdb -D /var/lib/postgres/data
 sudo systemctl enable --now postgresql.service
 ```
 
-### Install media / graphics packages (optional, see [`docs/installation/optional/media_graphics_packages.md`](../installation/optional/media_graphics_packages.md))
-
-```shell
-sudo pacman -S ffmpeg imagemagick perl-image-exiftool
-```
-
 ### Install PleromaBE
 
 * Add a new system user for the Pleroma service:
@@ -95,7 +81,7 @@ cd /opt/pleroma
 sudo -Hu pleroma mix deps.get
 ```
 
-* Generate the configuration: `sudo -Hu pleroma MIX_ENV=prod mix pleroma.instance gen`
+* Generate the configuration: `sudo -Hu pleroma mix pleroma.instance gen`
   * Answer with `yes` if it asks you to install `rebar3`.
   * This may take some time, because parts of pleroma 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`.
@@ -103,7 +89,7 @@ sudo -Hu pleroma mix deps.get
 * Check the configuration and if all looks right, rename it, so Pleroma will load it (`prod.secret.exs` for productive instance, `dev.secret.exs` for development instances):
 
 ```shell
-sudo -Hu pleroma mv config/{generated_config.exs,prod.secret.exs}
+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:
@@ -214,8 +200,11 @@ sudo -Hu pleroma MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress
 
 #### Further reading
 
-{! backend/installation/further_reading.include !}
+* [Backup your instance](../administration/backup.md)
+* [Hardening your instance](../configuration/hardening.md)
+* [How to activate mediaproxy](../configuration/howto_mediaproxy.md)
+* [Updating your instance](../administration/updating.md)
 
 ## Questions
 
-Questions about the installation or didn’t it work as it should be, ask in [#pleroma:libera.chat](https://matrix.to/#/#pleroma:libera.chat) via Matrix or **#pleroma** on **libera.chat** via IRC.
+Questions about the installation or didn’t it work as it should be, ask in [#pleroma:matrix.org](https://matrix.heldscal.la/#/room/#freenode_#pleroma:matrix.org) or IRC Channel **#pleroma** on **Freenode**.

docs/installation/debian_based_en.md

@@ -1,12 +1,26 @@
 # Installing on Debian Based Distributions
-
-{! backend/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 pleroma`; in this case, use `su <username> -s $SHELL -c 'command'` instead.
+This guide will assume you are on Debian Stretch. This guide should also work with Ubuntu 16.04 and 18.04. 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 pleroma`; in this case, use `su <username> -s $SHELL -c 'command'` instead.
 
-{! backend/installation/generic_dependencies.include !}
+### Required packages
+
+* `postgresql` (9.6+, Ubuntu 16.04 comes with 9.5, you can get a newer version from [here](https://www.postgresql.org/download/linux/ubuntu/))
+* `postgresql-contrib` (9.6+, same situtation as above)
+* `elixir` (1.5+, [install from here, Debian and Ubuntu ship older versions](https://elixir-lang.org/install.html#unix-and-unix-like) or use [asdf](https://github.com/asdf-vm/asdf) as the pleroma user)
+* `erlang-dev`
+* `erlang-tools`
+* `erlang-parsetools`
+* `erlang-eldap`, if you want to enable ldap authenticator
+* `erlang-ssh`
+* `erlang-xmerl`
+* `git`
+* `build-essential`
+
+#### Optional packages used in this guide
+
+* `nginx` (preferred, example configs for other reverse proxies can be found in the repo)
+* `certbot` (or any other ACME client for Let’s Encrypt certificates)
 
 ### Prepare the system
 
@@ -20,23 +34,23 @@ sudo apt full-upgrade
 * Install some of the above mentioned programs:
 
 ```shell
-sudo apt install git build-essential postgresql postgresql-contrib cmake libmagic-dev
+sudo apt install git build-essential postgresql postgresql-contrib
 ```
 
 ### Install Elixir and Erlang
 
-* Install Elixir and Erlang (you might need to use backports or [asdf](https://github.com/asdf-vm/asdf) on old systems):
+* Download and add the Erlang repository:
+
+```shell
+wget -P /tmp/ https://packages.erlang-solutions.com/erlang-solutions_1.0_all.deb
+sudo dpkg -i /tmp/erlang-solutions_1.0_all.deb
+```
+
+* Install Elixir and Erlang:
 
 ```shell
 sudo apt update
-sudo apt install elixir erlang-dev erlang-nox
-```
-
-
-### Optional packages: [`docs/installation/optional/media_graphics_packages.md`](../installation/optional/media_graphics_packages.md)
-
-```shell
-sudo apt install imagemagick ffmpeg libimage-exiftool-perl
+sudo apt install elixir erlang-dev erlang-parsetools erlang-xmerl erlang-tools erlang-ssh
 ```
 
 ### Install PleromaBE
@@ -69,7 +83,7 @@ cd /opt/pleroma
 sudo -Hu pleroma mix deps.get
 ```
 
-* Generate the configuration: `sudo -Hu pleroma MIX_ENV=prod mix pleroma.instance gen`
+* Generate the configuration: `sudo -Hu pleroma mix pleroma.instance gen`
   * Answer with `yes` if it asks you to install `rebar3`.
   * This may take some time, because parts of pleroma 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`.
@@ -77,10 +91,9 @@ sudo -Hu pleroma mix deps.get
 * Check the configuration and if all looks right, rename it, so Pleroma will load it (`prod.secret.exs` for productive instance, `dev.secret.exs` for development instances):
 
 ```shell
-sudo -Hu pleroma mv config/{generated_config.exs,prod.secret.exs}
+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
@@ -177,8 +190,11 @@ sudo -Hu pleroma MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress
 
 #### Further reading
 
-{! backend/installation/further_reading.include !}
+* [Backup your instance](../administration/backup.md)
+* [Hardening your instance](../configuration/hardening.md)
+* [How to activate mediaproxy](../configuration/howto_mediaproxy.md)
+* [Updating your instance](../administration/updating.md)
 
 ## Questions
 
-Questions about the installation or didn’t it work as it should be, ask in [#pleroma:libera.chat](https://matrix.to/#/#pleroma:libera.chat) via Matrix or **#pleroma** on **libera.chat** via IRC.
+Questions about the installation or didn’t it work as it should be, ask in [#pleroma:matrix.org](https://matrix.heldscal.la/#/room/#freenode_#pleroma:matrix.org) or IRC Channel **#pleroma** on **Freenode**.

docs/installation/debian_based_jp.md

@@ -10,22 +10,21 @@
 ### 必要なソフトウェア
 
 - 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) をpleromaユーザーでインストールしてください)
-- `erlang-dev`
-- `erlang-nox`
-- `git`
-- `build-essential`
-- `cmake`
-- `libmagic-dev`
+- postgresql-contrib 9.6以上 (同上)
+- Elixir 1.5 以上 ([Debianのリポジトリからインストールしないこと！！！ ここからインストールすること！](https://elixir-lang.org/install.html#unix-and-unix-like)。または [asdf](https://github.com/asdf-vm/asdf) をpleromaユーザーでインストールしてください)
+  - erlang-dev
+- erlang-tools
+- erlang-parsetools
+- erlang-eldap (LDAP認証を有効化するときのみ必要)
+- erlang-ssh
+- erlang-xmerl
+- git
+- build-essential
 
 #### このガイドで利用している追加パッケージ
 
-- `nginx` (おすすめです。他のリバースプロキシを使う場合は、参考となる設定をこのリポジトリから探してください)
-- `certbot` (または何らかのLet's Encrypt向けACMEクライアント)
-- `ImageMagick`
-- `ffmpeg`
-- `exiftool`
+- nginx (おすすめです。他のリバースプロキシを使う場合は、参考となる設定をこのリポジトリから探してください)
+- certbot (または何らかのLet's Encrypt向けACMEクライアント)
 
 ### システムを準備する
 
@@ -37,27 +36,22 @@ sudo apt full-upgrade
 
 * 上記に挙げたパッケージをインストールしておきます。
 ```
-sudo apt install git build-essential postgresql postgresql-contrib cmake ffmpeg imagemagick libmagic-dev
+sudo apt install git build-essential postgresql postgresql-contrib
 ```
 
+
 ### 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
+wget -P /tmp/ https://packages.erlang-solutions.com/erlang-solutions_1.0_all.deb
+sudo dpkg -i /tmp/erlang-solutions_1.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
+sudo apt install elixir erlang-dev erlang-parsetools erlang-xmerl erlang-tools erlang-ssh
 ```
 
 ### Pleroma BE (バックエンド) をインストールします
@@ -89,7 +83,7 @@ sudo -Hu pleroma mix deps.get
 
 * コンフィギュレーションを生成します。
 ```
-sudo -Hu pleroma MIX_ENV=prod mix pleroma.instance gen
+sudo -Hu pleroma mix pleroma.instance gen
 ```
     * rebar3をインストールしてもよいか聞かれたら、yesを入力してください。
     * このときにpleromaの一部がコンパイルされるため、この処理には時間がかかります。
@@ -98,12 +92,12 @@ sudo -Hu pleroma MIX_ENV=prod mix pleroma.instance gen
 
 * コンフィギュレーションを確認して、もし問題なければ、ファイル名を変更してください。
 ```
-sudo -Hu pleroma mv config/{generated_config.exs,prod.secret.exs}
+mv config/{generated_config.exs,prod.secret.exs}
 ```
 
 * 先程のコマンドで、すでに `config/setup_db.psql` というファイルが作られています。このファイルをもとに、データベースを作成します。
 ```
-sudo -Hu pleroma MIX_ENV=prod mix pleroma.instance gen
+sudo -Hu pleroma mix pleroma.instance gen
 ```
 
 * そして、データベースのマイグレーションを実行します。
@@ -185,11 +179,14 @@ sudo -Hu pleroma MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress
 
 #### その他の設定とカスタマイズ
 
-{! backend/installation/further_reading.include !}
+* [Backup your instance](../administration/backup.md)
+* [Hardening your instance](../configuration/hardening.md)
+* [How to activate mediaproxy](../configuration/howto_mediaproxy.md)
+* [Updating your instance](../administration/updating.md)
 
 ## 質問ある？
 
 インストールについて質問がある、もしくは、うまくいかないときは、以下のところで質問できます。
 
-* [#pleroma:libera.chat](https://matrix.to/#/#pleroma:libera.chat)
-* **libera.chat** の **#pleroma** IRCチャンネル
+* [#pleroma:matrix.org](https://matrix.heldscal.la/#/room/#freenode_#pleroma:matrix.org)
+* **Freenode** の **#pleroma** IRCチャンネル

docs/installation/freebsd_en.md

@@ -1,218 +0,0 @@
-# Installing on FreeBSD
-
-This document was written for FreeBSD 12.1, but should be work on future releases.
-
-{! backend/installation/generic_dependencies.include !}
-
-## Installing software used in this guide
-
-This assumes the target system has `pkg(8)`.
-
-```
-# pkg install elixir postgresql12-server postgresql12-client postgresql12-contrib git-lite sudo nginx gmake acme.sh cmake
-```
-
-Copy the rc.d scripts to the right directory:
-
-Setup the required services to automatically start at boot, using `sysrc(8)`.
-
-```
-# sysrc nginx_enable=YES
-# sysrc postgresql_enable=YES
-```
-
-## Initialize postgres
-
-```
-# service postgresql initdb
-# service postgresql start
-```
-
-### Install media / graphics packages (optional, see [`docs/installation/optional/media_graphics_packages.md`](../installation/optional/media_graphics_packages.md))
-
-```shell
-# pkg install imagemagick ffmpeg p5-Image-ExifTool
-```
-
-## Configuring Pleroma
-
-Create a user for Pleroma:
-
-```
-# pw add user pleroma -m
-# echo 'export LC_ALL="en_US.UTF-8"' >> /home/pleroma/.profile
-# su -l pleroma
-```
-
-Clone the repository:
-
-```
-$ cd $HOME # Should be the same as /home/pleroma
-$ git clone -b stable https://git.pleroma.social/pleroma/pleroma.git
-```
-
-Configure Pleroma. Note that you need a domain name at this point:
-
-```
-$ cd /home/pleroma/pleroma
-$ mix deps.get # Enter "y" when asked to install Hex
-$ MIX_ENV=prod mix pleroma.instance gen # You will be asked a few questions here.
-$ cp config/generated_config.exs config/prod.secret.exs
-```
-
-Since Postgres is configured, we can now initialize the database. There should
-now be a file in `config/setup_db.psql` that makes this easier. Edit it, and
-*change the password* to a password of your choice. Make sure it is secure, since
-it'll be protecting your database. As root, you can now initialize the database:
-
-```
-# cd /home/pleroma/pleroma
-# sudo -Hu postgres -g postgres psql -f config/setup_db.psql
-```
-
-Postgres allows connections from all users without a password by default. To
-fix this, edit `/var/db/postgres/data12/pg_hba.conf`. Change every `trust` to
-`password`.
-
-Once this is done, restart Postgres with:
-```
-# service postgresql restart
-```
-
-Run the database migrations.
-
-Back as the pleroma user, run the following to implement any database migrations.
-
-```
-# su -l pleroma
-$ cd /home/pleroma/pleroma
-$ MIX_ENV=prod mix ecto.migrate
-```
-
-You will need to do this whenever you update with `git pull`:
-
-## Configuring acme.sh
-
-We'll be using acme.sh in Stateless Mode for TLS certificate renewal.
-
-First, as root, allow the user `acme` to have access to the acme log file, as follows:
-
-```
-# touch /var/log/acme.sh.log
-# chown acme:acme /var/log/acme.sh.log
-# chmod 600 /var/log/acme.sh.log
-```
-
-Next, obtain your account fingerprint:
-
-```
-# sudo -Hu acme -g acme acme.sh --register-account
-```
-
-You need to add the following to your nginx configuration for the server
-running on port 80:
-
-```
-  location ~ ^/\.well-known/acme-challenge/([-_a-zA-Z0-9]+)$ {
-    default_type text/plain;
-    return 200 "$1.6fXAG9VyG0IahirPEU2ZerUtItW2DHzDzD9wZaEKpqd";
-  }
-```
-
-Replace the string after after `$1.` with your fingerprint.
-
-Start nginx:
-
-```
-# service nginx start
-```
-
-It should now be possible to issue a cert (replace `example.com`
-with your domain name):
-
-```
-# sudo -Hu acme -g acme acme.sh --issue -d example.com --stateless
-```
-
-Let's add auto-renewal to `/etc/crontab`
-(replace `example.com` with your domain):
-
-```
-/usr/local/bin/sudo -Hu acme -g acme /usr/local/sbin/acme.sh -r -d example.com --stateless
-```
-
-### Configuring nginx
-
-FreeBSD's default nginx configuration does not contain an include directive, which is
-typically used for multiple sites. Therefore, you will need to first create the required
-directory as follows:
-
-
-```
-# mkdir -p /usr/local/etc/nginx/sites-available
-```
-
-Next, add an `include` directive to `/usr/local/etc/nginx/nginx.conf`, within the `http {}`
-block, as follows:
-
-
-```
-http {
-...
-	include /usr/local/etc/nginx/sites-available/*;
-}
-```
-
-As root, copy `/home/pleroma/pleroma/installation/pleroma.nginx` to
-`/usr/local/etc/nginx/sites-available/pleroma.nginx`.
-
-Edit the defaults of `/usr/local/etc/nginx/sites-available/pleroma.nginx`:
-
-* Change `ssl_trusted_certificate` to `/var/db/acme/certs/example.tld/example.tld.cer`.
-* Change `ssl_certificate` to `/var/db/acme/certs/example.tld/fullchain.cer`.
-* Change `ssl_certificate_key` to `/var/db/acme/certs/example.tld/example.tld.key`.
-* Change all references of `example.tld` to your instance's domain name.
-
-## Creating a startup script for Pleroma
-
-Pleroma will need to compile when it initially starts, which typically takes a longer
-period of time. Therefore, it is good practice to initially run pleroma from the
-command-line before utilizing the rc.d script. That is done as follows:
-
-```
-# su -l pleroma
-$ cd $HOME/pleroma
-$ MIX_ENV=prod mix phx.server
-```
-
-Copy the startup script to the correct location and make sure it's executable:
-
-```
-# cp /home/pleroma/pleroma/installation/freebsd/rc.d/pleroma /usr/local/etc/rc.d/pleroma
-# chmod +x /usr/local/etc/rc.d/pleroma
-```
-
-Update the `/etc/rc.conf` and start pleroma with the following commands:
-
-```
-# sysrc pleroma_enable=YES
-# service pleroma start
-```
-
-#### 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 pleroma MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress> --admin
-```
-## Conclusion
-
-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.
-
-## Questions
-
-Questions about the installation or didn’t it work as it should be, ask in [#pleroma:libera.chat](https://matrix.to/#/#pleroma:libera.chat) via Matrix or **#pleroma** on **libera.chat** via IRC.

docs/installation/further_reading.include

@@ -1,5 +0,0 @@
-* [How Federation Works/Why is my Federated Timeline empty?](https://blog.soykaf.com/post/how-federation-works/)
-* [Backup your instance](../administration/backup.md)
-* [Updating your instance](../administration/updating.md)
-* [Hardening your instance](../configuration/hardening.md)
-* [How to activate mediaproxy](../configuration/howto_mediaproxy.md)

docs/installation/generic_dependencies.include

@@ -1,16 +0,0 @@
-## Required dependencies
-
-* PostgreSQL 9.6+
-* Elixir 1.10+
-* Erlang OTP 22.2+
-* git
-* file / libmagic
-* gcc (clang might also work)
-* GNU make
-* CMake
-
-## Optional dependencies
-
-* ImageMagick
-* FFmpeg
-* exiftool

docs/installation/gentoo_en.md

@@ -1,12 +1,11 @@
 # Installing on Gentoo GNU/Linux
-
-{! backend/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. `pleroma$` should be run as the `pleroma` user.
 
-{! backend/installation/generic_dependencies.include !}
+### Configuring your hostname (optional)
+
+If you would like your prompt to permanently include your host/domain, change `/etc/conf.d/hostname` to your hostname. You can reboot or use the `hostname` command to make immediate changes.
 
 ### Your make.conf, package.use, and USE flags
 
@@ -29,17 +28,12 @@ Gentoo quite pointedly does not come with a cron daemon installed, and as such i
 * `dev-db/postgresql`
 * `dev-lang/elixir`
 * `dev-vcs/git`
-* `dev-util/cmake`
-* `sys-apps/file`
 
 #### Optional ebuilds used in this guide
 
 * `www-servers/nginx` (preferred, example configs for other reverse proxies can be found in the repo)
 * `app-crypt/certbot` (or any other ACME client for Let’s Encrypt certificates)
 * `app-crypt/certbot-nginx` (nginx certbot plugin that allows use of the all-powerful `--nginx` flag on certbot)
-* `media-gfx/imagemagick`
-* `media-video/ffmpeg`
-* `media-libs/exiftool`
 
 ### Prepare the system
 
@@ -52,10 +46,10 @@ Gentoo quite pointedly does not come with a cron daemon installed, and as such i
 * Emerge all required the required and suggested software in one go:
 
 ```shell
- # emerge --ask dev-db/postgresql dev-lang/elixir dev-vcs/git www-servers/nginx app-crypt/certbot app-crypt/certbot-nginx dev-util/cmake sys-apps/file
+ # emerge --ask dev-db/postgresql dev-lang/elixir dev-vcs/git www-servers/nginx app-crypt/certbot app-crypt/certbot-nginx
 ```
 
-If you would not like to install the optional packages, remove them from this line.
+If you would not like to install the optional packages, remove them from this line. 
 
 If you're running this from a low-powered virtual machine, it should work though it will take some time. There were no issues on a VPS with a single core and 1GB of RAM; if you are using an even more limited device and run into issues, you can try creating a swapfile or use a more powerful machine running Gentoo to [cross build](https://wiki.gentoo.org/wiki/Cross_build_environment). If you have a wait ahead of you, now would be a good time to take a break, strech a bit, refresh your beverage of choice and/or get a snack, and reply to Arch users' posts with "I use Gentoo btw" as we do.
 
@@ -80,24 +74,18 @@ The output from emerging postgresql should give you a command for initializing t
 ```
 
 * Start postgres and enable the system service
-
+ 
 ```shell
  # /etc/init.d/postgresql-11 start
  # rc-update add postgresql-11 default
  ```
-
+ 
 ### A note on licenses, the AGPL, and deployment procedures
 
 If you do not plan to make any modifications to your Pleroma instance, cloning directly from the main repo will get you what you need. However, if you plan on doing any contributions to upstream development, making changes or modifications to your instance, making custom themes, or want to play around--and let's be honest here, if you're using Gentoo that is most likely you--you will save yourself a lot of headache later if you take the time right now to fork the Pleroma repo and use that in the following section.
 
 Not only does this make it much easier to deploy changes you make, as you can commit and pull from upstream and all that good stuff from the comfort of your local machine then simply `git pull` on your instance server when you're ready to deploy, it also ensures you are compliant with the Affero General Public Licence that Pleroma is licenced under, which stipulates that all network services provided with modified AGPL code must publish their changes on a publicly available internet service and for free. It also makes it much easier to ask for help from and provide help to your fellow Pleroma admins if your public repo always reflects what you are running because it is part of your deployment procedure.
 
-### Install media / graphics packages (optional, see [`docs/installation/optional/media_graphics_packages.md`](docs/installation/optional/media_graphics_packages.md))
-
-```shell
-# emerge --ask media-video/ffmpeg media-gfx/imagemagick media-libs/exiftool
-```
-
 ### Install PleromaBE
 
 * Add a new system user for the Pleroma service and set up default directories:
@@ -136,7 +124,7 @@ pleroma$ mix deps.get
 * Generate the configuration:
 
 ```shell
-pleroma$ MIX_ENV=prod mix pleroma.instance gen
+pleroma$ mix pleroma.instance gen
 ```
 
   * Answer with `yes` if it asks you to install `rebar3`.
@@ -242,7 +230,7 @@ First, ensure that the command you will be installing into your crontab works.
  # /usr/bin/certbot renew --nginx
 ```
 
-Assuming not much time has passed since you got certbot working a few steps ago, you should get a message for all domains you installed certificates for saying `Cert not yet due for renewal`.
+Assuming not much time has passed since you got certbot working a few steps ago, you should get a message for all domains you installed certificates for saying `Cert not yet due for renewal`. 
 
 Now, run crontab as a superuser with `crontab -e` or `sudo crontab -e` as appropriate, and add the following line to your cron:
 
@@ -295,8 +283,11 @@ If you opted to allow sudo for the `pleroma` user but would like to remove the a
 
 #### Further reading
 
-{! backend/installation/further_reading.include !}
+* [Backup your instance](../administration/backup.md)
+* [Hardening your instance](../configuration/hardening.md)
+* [How to activate mediaproxy](../configuration/howto_mediaproxy.md)
+* [Updating your instance](../administration/updating.md)
 
 ## Questions
 
-Questions about the installation or didn’t it work as it should be, ask in [#pleroma:libera.chat](https://matrix.to/#/#pleroma:libera.chat) via Matrix or **#pleroma** on **libera.chat** via IRC.
+Questions about the installation or didn’t it work as it should be, ask in [#pleroma:matrix.org](https://matrix.heldscal.la/#/room/#freenode_#pleroma:matrix.org) or IRC Channel **#pleroma** on **Freenode**.

docs/installation/migrating_from_source_otp_en.md

@@ -1,23 +1,20 @@
 # Switching a from-source install to OTP releases
 
-{! backend/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.
+## What are 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, it is easily administered via the provided shell script to open up a remote console, start/stop/restart the release, start in the background, send remote commands, and more.
 
 ## Pre-requisites
-You will be running commands as root. If you aren't root already, please elevate your privileges by executing `sudo su`/`su`.
+You will be running commands as root. If you aren't root already, please elevate your priviledges by executing `sudo su`/`su`.
 
 The system needs to have `curl` and `unzip` installed for downloading and unpacking release builds.
 
-=== "Alpine"
-    ```sh
-    apk add curl unzip
-    ```
+```sh tab="Alpine"
+apk add curl unzip
+```
 
-=== "Debian/Ubuntu"
-    ```sh
-    apt install curl unzip
-    ```
+```sh tab="Debian/Ubuntu"
+apt install curl unzip
+```
 
 ## Moving content out of the application directory
 When using OTP releases the application directory changes with every version so it would be a bother to keep content there (and also dangerous unless `--no-rm` option is used when updating). Fortunately almost all paths in Pleroma are configurable, so it is possible to move them out of there.
@@ -113,29 +110,27 @@ OTP releases have different service files than from-source installs so they need
 
 **Warning:** The service files assume pleroma user's home directory is `/opt/pleroma`, please make sure all paths fit your installation.
 
-=== "Alpine"
-    ```sh
-    # Copy the service into a proper directory
-    cp -f ~pleroma/installation/init.d/pleroma /etc/init.d/pleroma
+```sh tab="Alpine"
+# Copy the service into a proper directory
+cp -f ~pleroma/installation/init.d/pleroma /etc/init.d/pleroma
 
-    # Start pleroma
-    rc-service pleroma start
-    ```
+# Start pleroma
+rc-service pleroma start
+```
 
-=== "Debian/Ubuntu"
-    ```sh
-    # Copy the service into a proper directory
-    cp ~pleroma/installation/pleroma.service /etc/systemd/system/pleroma.service
+```sh tab="Debian/Ubuntu"
+# Copy the service into a proper directory
+cp ~pleroma/installation/pleroma.service /etc/systemd/system/pleroma.service
 
-    # Reload service files
-    systemctl daemon-reload
+# Reload service files
+systemctl daemon-reload
 
-    # Reenable pleroma to start on boot
-    systemctl reenable pleroma
+# Reenable pleroma to start on boot
+systemctl reenable pleroma
 
-    # Start pleroma
-    systemctl start pleroma
-    ```
+# Start pleroma
+systemctl start pleroma
+```
 
 ## Running mix tasks
 Refer to [Running mix tasks](otp_en.md#running-mix-tasks) section from OTP release installation guide.

docs/installation/netbsd_en.md

@@ -1,8 +1,6 @@
 # Installing on NetBSD
 
-{! backend/installation/generic_dependencies.include !}
-
-## Installing software used in this guide
+## Required software 
 
 pkgin should have been installed by the NetBSD installer if you selected
 the right options. If it isn't installed, install it using pkg_add.
@@ -12,7 +10,7 @@ Pleroma uses.
 
 The `mksh` shell is needed to run the Elixir `mix` script.
 
-`# pkgin install acmesh elixir git-base git-docs mksh nginx postgresql11-server postgresql11-client postgresql11-contrib sudo ffmpeg4 ImageMagick`
+`# pkgin install acmesh elixir git-base git-docs mksh nginx postgresql11-server postgresql11-client postgresql11-contrib sudo`
 
 You can also build these packages using pkgsrc:
 ```
@@ -21,7 +19,6 @@ databases/postgresql11-client
 databases/postgresql11-server
 devel/git-base
 devel/git-docs
-devel/cmake
 lang/elixir
 security/acmesh
 security/sudo
@@ -46,10 +43,6 @@ pgsql=YES
 
 First, run `# /etc/rc.d/pgsql start`. Then, `$ sudo -Hu pgsql -g pgsql createdb`.
 
-### Install media / graphics packages (optional, see [`docs/installation/optional/media_graphics_packages.md`](../installation/optional/media_graphics_packages.md))
-
-`# pkgin install ImageMagick ffmpeg4 p5-Image-ExifTool`
-
 ## Configuring Pleroma
 
 Create a user for Pleroma:
@@ -73,7 +66,7 @@ Configure Pleroma. Note that you need a domain name at this point:
 ```
 $ cd /home/pleroma/pleroma
 $ mix deps.get
-$ MIX_ENV=prod mix pleroma.instance gen # You will be asked a few questions here.
+$ mix pleroma.instance gen # You will be asked a few questions here.
 ```
 
 Since Postgres is configured, we can now initialize the database. There should
@@ -195,17 +188,11 @@ Run `# /etc/rc.d/pleroma start` to start Pleroma.
 
 Restart nginx with `# /etc/rc.d/nginx restart` and you should be up and running.
 
+If you need further help, contact niaa on freenode.
+
 Make sure your time is in sync, or other instances will receive your posts with
 incorrect timestamps. You should have ntpd running.
 
 ## Instances running NetBSD
 
 * <https://catgirl.science>
-
-#### Further reading
-
-{! backend/installation/further_reading.include !}
-
-## Questions
-
-Questions about the installation or didn’t it work as it should be, ask in [#pleroma:libera.chat](https://matrix.to/#/#pleroma:libera.chat) via Matrix or **#pleroma** on **libera.chat** via IRC.

docs/installation/nixos_en.md

@@ -1,15 +0,0 @@
-# Installing on NixOS
-
-NixOS contains a source build package of pleroma and a NixOS module to install it.
-For installation add this to your configuration.nix and add a config.exs next to it:
-```nix
-  services.pleroma = {
-    enable = true;
-    configs = [ (lib.fileContents ./config.exs) ];
-    secretConfigFile = "/var/lib/pleroma/secret.exs";
-  };
-```
-
-## Questions
-The nix community uses matrix for communication: [#nix:nixos.org](https://matrix.to/#/#nix:nixos.org)
-

docs/installation/openbsd_en.md

@@ -4,32 +4,25 @@ This guide describes the installation and configuration of pleroma (and the requ
 
 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 !}
-
-### Preparing the system
 #### Required software
 
+The following packages need to be installed:
+
+  * elixir
+  * gmake
+  * ImageMagick
+  * git
+  * postgresql-server
+  * postgresql-contrib
+
 To install them, run the following command (with doas or as root):
 
 ```
-pkg_add elixir gmake git postgresql-server postgresql-contrib cmake ffmpeg ImageMagick
+pkg_add elixir gmake ImageMagick git postgresql-server postgresql-contrib
 ```
 
 Pleroma requires a reverse proxy, OpenBSD has relayd in base (and is used in this guide) and packages/ports are available for nginx (www/nginx) and apache (www/apache-httpd). Independently of the reverse proxy, [acme-client(1)](https://man.openbsd.org/acme-client) can be used to get a certificate from Let's Encrypt.
 
-#### Optional software
-
-Per [`docs/installation/optional/media_graphics_packages.md`](../installation/optional/media_graphics_packages.md):
-  * ImageMagick
-  * ffmpeg
-  * exiftool
-
-To install the above:
-
-```
-pkg_add ImageMagick ffmpeg p5-Image-ExifTool
-```
-
 #### Creating the pleroma user
 Pleroma will be run by a dedicated user, \_pleroma. Before creating it, insert the following lines in login.conf:
 ```
@@ -231,7 +224,7 @@ Enter a shell as \_pleroma (as root `su _pleroma -`) and enter pleroma's install
 Then follow the main installation guide:
 
   * run `mix deps.get`
-  * run `MIX_ENV=prod mix pleroma.instance gen` and enter your instance's information when asked
+  * run `mix pleroma.instance gen` and enter your instance's information when asked
   * copy config/generated\_config.exs to config/prod.secret.exs. The default values should be sufficient but you should edit it and check that everything seems OK.
   * exit your current shell back to a root one and run `psql -U postgres -f /home/_pleroma/pleroma/config/setup_db.psql` to setup the database.
   * return to a \_pleroma shell into pleroma's installation directory (`su _pleroma -;cd ~/pleroma`) and run `MIX_ENV=prod mix ecto.migrate`
@@ -249,11 +242,3 @@ If your instance is up and running, you can create your first user with administ
 ```
 LC_ALL=en_US.UTF-8 MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress> --admin
 ```
-
-#### Further reading
-
-{! backend/installation/further_reading.include !}
-
-## Questions
-
-Questions about the installation or didn’t it work as it should be, ask in [#pleroma:libera.chat](https://matrix.to/#/#pleroma:libera.chat) via Matrix or **#pleroma** on **libera.chat** via IRC.

docs/installation/openbsd_fi.md

@@ -10,24 +10,13 @@ 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
+Jos asennuksen kanssa on ongelmia, IRC-kanava #pleroma Freenodessa tai
+Matrix-kanava #freenode_#pleroma:matrix.org 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`
+`# pkg_add git elixir gmake postgresql-server-10.3 postgresql-contrib-10.3`
 
 Luo postgresql-tietokanta:
 

docs/installation/optional/media_graphics_packages.md

@@ -1,33 +0,0 @@
-# Optional software packages needed for specific functionality
-
-For specific Pleroma functionality (which is disabled by default) some or all of the below packages are required:
-    * `ImageMagic`
-    * `ffmpeg`
-    * `exiftool`
-  
-Please refer to documentation in `docs/installation` on how to install them on specific OS.
-  
-Note: the packages are not required with the current default settings of Pleroma.
-
-## `ImageMagick`
-
-`ImageMagick` is a set of tools to create, edit, compose, or convert bitmap images.
-
-It is required for the following Pleroma features:
-    * `Pleroma.Upload.Filters.Mogrify`, `Pleroma.Upload.Filters.Mogrifun` upload filters (related config: `Plaroma.Upload/filters` in `config/config.exs`)
-    * Media preview proxy for still images (related config: `media_preview_proxy/enabled` in `config/config.exs`)
-  
-## `ffmpeg`
-
-`ffmpeg` is software to record, convert and stream audio and video.
-
-It is required for the following Pleroma features:
-    * Media preview proxy for videos (related config: `media_preview_proxy/enabled` in `config/config.exs`)
-
-## `exiftool`
-
-`exiftool` is media files metadata reader/writer.
-
-It is required for the following Pleroma features:
-    * `Pleroma.Upload.Filters.Exiftool.StripLocation` upload filter (related config: `Plaroma.Upload/filters` in `config/config.exs`)
-    * `Pleroma.Upload.Filters.Exiftool.ReadDescription` upload filter (related config: `Plaroma.Upload/filters` in `config/config.exs`)

docs/installation/otp_en.md

@@ -1,14 +1,10 @@
 # Installing on Linux using OTP releases
 
-{! backend/installation/otp_vs_from_source.include !}
-
-This guide covers a installation using an OTP release. To install Pleroma 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
 * A (sub)domain pointed to the machine
 
-You will be running commands as root. If you aren't root already, please elevate your privileges by executing `sudo su`/`su`.
+You will be running commands as root. If you aren't root already, please elevate your priviledges by executing `sudo su`/`su`.
 
 While in theory OTP releases are possbile to install on any compatible machine, for the sake of simplicity this guide focuses only on Debian/Ubuntu and Alpine.
 
@@ -31,37 +27,16 @@ Other than things bundled in the OTP release Pleroma depends on:
 * 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
 
-=== "Alpine"
-    ```
-    awk 'NR==2' /etc/apk/repositories | sed 's/main/community/' | tee -a /etc/apk/repositories
-    apk update
-    apk add curl unzip ncurses postgresql postgresql-contrib nginx certbot file-dev
-    ```
+```sh tab="Alpine"
+echo "http://nl.alpinelinux.org/alpine/latest-stable/community" >> /etc/apk/repositories
+apk update
+apk add curl unzip ncurses postgresql postgresql-contrib nginx certbot
+```
 
-=== "Debian/Ubuntu"
-    ```
-    apt install curl unzip libncurses5 postgresql postgresql-contrib nginx certbot libmagic-dev
-    ```
-
-### Installing optional packages
-
-Per [`docs/installation/optional/media_graphics_packages.md`](optional/media_graphics_packages.md):
-  * ImageMagick
-  * ffmpeg
-  * exiftool
-
-=== "Alpine"
-    ```
-    apk update
-    apk add imagemagick ffmpeg exiftool
-    ```
-
-=== "Debian/Ubuntu"
-    ```
-    apt install imagemagick ffmpeg libimage-exiftool-perl
-    ```
+```sh tab="Debian/Ubuntu"
+apt install curl unzip libncurses5 postgresql postgresql-contrib nginx certbot
+```
 
 ## Setup
 ### Configuring PostgreSQL
@@ -72,37 +47,40 @@ Per [`docs/installation/optional/media_graphics_packages.md`](optional/media_gra
 
 RUM indexes are an alternative indexing scheme that is not included in PostgreSQL by default. You can read more about them on the [Configuration page](../configuration/cheatsheet.md#rum-indexing-for-full-text-search). They are completely optional and most of the time are not worth it, especially if you are running a single user instance (unless you absolutely need ordered search results).
 
-=== "Alpine"
-    ```
-    apk add git build-base postgresql-dev
-    git clone https://github.com/postgrespro/rum /tmp/rum
-    cd /tmp/rum
-    make USE_PGXS=1
-    make USE_PGXS=1 install
-    cd
-    rm -r /tmp/rum
-    ```
+```sh tab="Alpine"
+apk add git build-base postgresql-dev
+git clone https://github.com/postgrespro/rum /tmp/rum
+cd /tmp/rum
+make USE_PGXS=1
+make USE_PGXS=1 install
+cd
+rm -r /tmp/rum
+```
 
-=== "Debian/Ubuntu"
-    ```
-    # Available only on Buster/19.04
-    apt install postgresql-11-rum
-    ```
+```sh tab="Debian/Ubuntu"
+# Available only on Buster/19.04
+apt install postgresql-11-rum
+```
 
 #### (Optional) Performance configuration
-It is encouraged to check [Optimizing your PostgreSQL performance](../configuration/postgresql.md) document, for tips on PostgreSQL tuning.
+For optimal performance, you may use [PGTune](https://pgtune.leopard.in.ua), don't forget to restart postgresql after editing the configuration
 
-Restart PostgreSQL to apply configuration changes:
+```sh tab="Alpine"
+rc-service postgresql restart
+```
 
-=== "Alpine"
-    ```
-    rc-service postgresql restart
-    ```
+```sh tab="Debian/Ubuntu"
+systemctl restart postgresql
+```
 
-=== "Debian/Ubuntu"
-    ```
-    systemctl restart postgresql
-    ```
+If you are using PostgreSQL 12 or higher, add this to your Ecto database configuration
+
+```elixir
+prepare: :named,
+parameters: [
+  plan_cache_mode: "force_custom_plan"
+]
+```
 
 ### Installing Pleroma
 ```sh
@@ -173,16 +151,14 @@ certbot certonly --standalone --preferred-challenges http -d yourinstance.tld
 
 The location of nginx configs is dependent on the distro
 
-=== "Alpine"
-    ```
-    cp /opt/pleroma/installation/pleroma.nginx /etc/nginx/conf.d/pleroma.conf
-    ```
+```sh tab="Alpine"
+cp /opt/pleroma/installation/pleroma.nginx /etc/nginx/conf.d/pleroma.conf
+```
 
-=== "Debian/Ubuntu"
-    ```
-    cp /opt/pleroma/installation/pleroma.nginx /etc/nginx/sites-available/pleroma.conf
-    ln -s /etc/nginx/sites-available/pleroma.conf /etc/nginx/sites-enabled/pleroma.conf
-    ```
+```sh tab="Debian/Ubuntu"
+cp /opt/pleroma/installation/pleroma.nginx /etc/nginx/sites-available/pleroma.nginx
+ln -s /etc/nginx/sites-available/pleroma.nginx /etc/nginx/sites-enabled/pleroma.nginx
+```
 
 If your distro does not have either of those you can append `include /etc/nginx/pleroma.conf` to the end of the http section in /etc/nginx/nginx.conf and
 ```sh
@@ -199,43 +175,39 @@ nginx -t
 ```
 #### Start nginx
 
-=== "Alpine"
-    ```
-    rc-service nginx start
-    ```
+```sh tab="Alpine"
+rc-service nginx start
+```
 
-=== "Debian/Ubuntu"
-    ```
-    systemctl start nginx
-    ```
+```sh tab="Debian/Ubuntu"
+systemctl start nginx
+```
 
 At this point if you open your (sub)domain in a browser you should see a 502 error, that's because Pleroma is not started yet.
 
 ### Setting up a system service
 
-=== "Alpine"
-    ```
-    # Copy the service into a proper directory
-    cp /opt/pleroma/installation/init.d/pleroma /etc/init.d/pleroma
+```sh tab="Alpine"
+# Copy the service into a proper directory
+cp /opt/pleroma/installation/init.d/pleroma /etc/init.d/pleroma
 
-    # Start pleroma and enable it on boot
-    rc-service pleroma start
-    rc-update add pleroma
-    ```
+# Start pleroma and enable it on boot
+rc-service pleroma start
+rc-update add pleroma
+```
 
-=== "Debian/Ubuntu"
-    ```
-    # Copy the service into a proper directory
-    cp /opt/pleroma/installation/pleroma.service /etc/systemd/system/pleroma.service
+```sh tab="Debian/Ubuntu"
+# Copy the service into a proper directory
+cp /opt/pleroma/installation/pleroma.service /etc/systemd/system/pleroma.service
 
-    # Start pleroma and enable it on boot
-    systemctl start pleroma
-    systemctl enable pleroma
-    ```
+# Start pleroma and enable it on boot
+systemctl start pleroma
+systemctl enable pleroma
+```
 
 If everything worked, you should see Pleroma-FE when visiting your domain. If that didn't happen, try reviewing the installation steps, starting Pleroma in the foreground and seeing if there are any errrors.
 
-Questions about the installation or didn’t it work as it should be, ask in [#pleroma:libera.chat](https://matrix.to/#/#pleroma:libera.chat) via Matrix or **#pleroma** on **libera.chat** via IRC, you can also [file an issue on our Gitlab](https://git.pleroma.social/pleroma/pleroma-support/issues/new).
+Still doesn't work? Feel free to contact us on [#pleroma on freenode](https://irc.pleroma.social) or via matrix at <https://matrix.heldscal.la/#/room/#freenode_#pleroma:matrix.org>, you can also [file an issue on our Gitlab](https://git.pleroma.social/pleroma/pleroma-support/issues/new)
 
 ## Post installation
 
@@ -251,57 +223,59 @@ $EDITOR path-to-nginx-config
 nginx -t
 ```
 
-=== "Alpine"
-    ```
-    # Restart nginx
-    rc-service nginx restart
+```sh tab="Alpine"
+# Restart nginx
+rc-service nginx restart
 
-    # Start the cron daemon and make it start on boot
-    rc-service crond start
-    rc-update add crond
+# Start the cron daemon and make it start on boot
+rc-service crond start
+rc-update add crond
 
-    # Ensure the webroot menthod and post hook is working
-    certbot renew --cert-name yourinstance.tld --webroot -w /var/lib/letsencrypt/ --dry-run --post-hook 'rc-service nginx reload'
+# Ensure the webroot menthod and post hook is working
+certbot renew --cert-name yourinstance.tld --webroot -w /var/lib/letsencrypt/ --dry-run --post-hook 'rc-service nginx reload'
 
-    # Add it to the daily cron
-    echo '#!/bin/sh
-    certbot renew --cert-name yourinstance.tld --webroot -w /var/lib/letsencrypt/ --post-hook "rc-service nginx reload"
-    ' > /etc/periodic/daily/renew-pleroma-cert
-    chmod +x /etc/periodic/daily/renew-pleroma-cert
+# Add it to the daily cron
+echo '#!/bin/sh
+certbot renew --cert-name yourinstance.tld --webroot -w /var/lib/letsencrypt/ --post-hook "rc-service nginx reload"
+' > /etc/periodic/daily/renew-pleroma-cert
+chmod +x /etc/periodic/daily/renew-pleroma-cert
 
-    # If everything worked the output should contain /etc/cron.daily/renew-pleroma-cert
-    run-parts --test /etc/periodic/daily
-    ```
+# If everything worked the output should contain /etc/cron.daily/renew-pleroma-cert
+run-parts --test /etc/periodic/daily
+```
 
-=== "Debian/Ubuntu"
-    ```
-    # Restart nginx
-    systemctl restart nginx
+```sh tab="Debian/Ubuntu"
+# Restart nginx
+systemctl restart nginx
 
-    # Ensure the webroot menthod and post hook is working
-    certbot renew --cert-name yourinstance.tld --webroot -w /var/lib/letsencrypt/ --dry-run --post-hook 'systemctl reload nginx'
+# Ensure the webroot menthod and post hook is working
+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-pleroma-cert
-    chmod +x /etc/cron.daily/renew-pleroma-cert
+# 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-pleroma-cert
+chmod +x /etc/cron.daily/renew-pleroma-cert
 
-    # If everything worked the output should contain /etc/cron.daily/renew-pleroma-cert
-    run-parts --test /etc/cron.daily
-    ```
+# If everything worked the output should contain /etc/cron.daily/renew-pleroma-cert
+run-parts --test /etc/cron.daily
+```
 
 ## Create your first user and set as admin
 ```sh
-cd /opt/pleroma
+cd /opt/pleroma/bin
 su pleroma -s $SHELL -lc "./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
 
-{! backend/installation/further_reading.include !}
+* [Backup your instance](../administration/backup.md)
+* [Hardening your instance](../configuration/hardening.md)
+* [How to activate mediaproxy](../configuration/howto_mediaproxy.md)
+* [Updating your instance](../administration/updating.md)
 
 ## Questions
 
-Questions about the installation or didn’t it work as it should be, ask in [#pleroma:libera.chat](https://matrix.to/#/#pleroma:libera.chat) via Matrix or **#pleroma** on **libera.chat** via IRC, you can also [file an issue on our Gitlab](https://git.pleroma.social/pleroma/pleroma-support/issues/new).
+Questions about the installation or didn’t it work as it should be, ask in [#pleroma:matrix.org](https://matrix.heldscal.la/#/room/#freenode_#pleroma:matrix.org) or IRC Channel **#pleroma** on **Freenode**.
+

docs/installation/otp_vs_from_source.include

@@ -1,3 +0,0 @@
-## OTP releases vs from-source installations
-
-There are two ways to install Pleroma. You can use OTP releases or do a from-source installation. 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, it is easily administered via the provided shell script to open up a remote console, start/stop/restart the release, start in the background, send remote commands, and more. With from source installations you install Pleroma from source, meaning you have to install certain dependencies like Erlang+Elixir and compile Pleroma yourself.

docs/installation/otp_vs_from_source_source.include

@@ -1,3 +0,0 @@
-{! backend/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/yunohost_en.md

@@ -1,9 +0,0 @@
-# Installing on Yunohost
-
-[YunoHost](https://yunohost.org) is a server operating system aimed at self-hosting. The YunoHost community maintains a package of Pleroma which allows you to install Pleroma on YunoHost. You can install it via the normal way through the admin web interface, or through the CLI. More information can be found at [the repo of the package](https://github.com/YunoHost-Apps/pleroma_ynh).
-
-## Questions
-
-Questions and problems related to the YunoHost parts can be done through the [regular YunoHost channels](https://yunohost.org/en/help).
-
-For questions about Pleroma, ask in [#pleroma:libera.chat](https://matrix.to/#/#pleroma:libera.chat) via Matrix or **#pleroma** on **libera.chat** via IRC.

docs/introduction.md

@@ -0,0 +1,65 @@
+# Introduction to Pleroma
+## What is Pleroma?
+Pleroma is a federated social networking platform, compatible with GNU social, Mastodon and other OStatus and ActivityPub implementations. It is free software licensed under the AGPLv3.
+It actually consists of two components: a backend, named simply Pleroma, and a user-facing frontend, named Pleroma-FE. It also includes the Mastodon frontend, if that's your thing.
+It's part of what we call the fediverse, a federated network of instances which speak common protocols and can communicate with each other.
+One account on an instance is enough to talk to the entire fediverse!
+
+## How can I use it?
+
+Pleroma instances are already widely deployed, a list can be found at <http://distsn.org/pleroma-instances.html>. Information on all existing fediverse instances can be found at <https://fediverse.network/>.
+
+If you don't feel like joining an existing instance, but instead prefer to deploy your own instance, that's easy too!
+Installation instructions can be found in the installation section of these docs.
+
+## I got an account, now what?
+Great! Now you can explore the fediverse! Open the login page for your Pleroma 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)
+
+At this point you will have two columns in front of you.
+
+### Left column
+
+- first block: here you can see your avatar, your nickname and statistics (Statuses, Following, Followers). Clicking your profile pic will open your profile.
+Under that you have a text form which allows you to post new statuses. The number on the bottom of the text form is a character counter, every instance can have a different character limit (the default is 5000).
+If you want to mention someone, type @ + name of the person. A drop-down menu will help you in finding the right person.
+Under the text form there are also several visibility options and there is the option to use rich text.
+Under that the icon on the left is for uploading media files and attach them to your post. There is also an emoji-picker and an option to post a poll.
+To post your status, simply press Submit.
+On the top right you will also see a wrench icon. This opens your personal settings.
+
+- second block: Here you can switch between the different timelines:
+   - Timeline: all the people that you follow
+   - Interactions: here you can switch between different timelines where there was interaction with your account. There is Mentions, Repeats and Favorites, and New follows
+   - Direct Messages: these are the Direct Messages sent to you
+   - Public Timeline: all the statutes from the local instance
+   - The Whole Known Network: all public posts the instance knows about, both local and remote!
+   - About: This isn't a Timeline but shows relevant info about the instance. You can find a list of the moderators and admins, Terms of Service, MRF policies and enabled features.
+- Optional third block: This is the Instance panel that can be activated, but is deactivated by default. It's fully customisable and by default has links to the pleroma-fe and Mastodon-fe.
+- fourth block: This is the Notifications block, here you will get notified whenever somebody mentions you, follows you, repeats or favorites one of your statuses.
+
+### Right column
+This is where the interesting stuff happens!
+Depending on the timeline you will see different statuses, but each status has a standard structure:
+
+- Profile pic, name and link to profile. An optional left-arrow if it's a reply to another status (hovering will reveal the reply-to status). Clicking on the profile pic will uncollapse the user's profile.
+- A `+` button on the right allows you to Expand/Collapse an entire discussion thread. It also updates in realtime!
+- An arrow icon allows you to open the status on the instance where it's originating from.
+- The text of the status, including mentions and attachements. If you click on a mention, it will automatically open the profile page of that person.
+- Three buttons (left to right): Reply, Repeat, Favorite. There is also a forth button, this is a dropdown menu for simple moderation like muting the conversation or, if you have moderation rights, delete the status from the server.
+
+### Top right
+
+- The magnifier icon opens the search screen where you can search for statuses, people and hashtags. It's also possible to import statusses from remote servers by pasting the url to the post in the search field.
+- The gear icon gives you general settings
+- If you have admin rights, you'll see an icon that opens the admin interface
+- The last icon is to log out
+
+### Bottom right
+On the bottom right you have a chatbox. Here you can communicate with people on the same instance in realtime. It is local-only, for now, but there are plans to make it extendable to the entire fediverse!
+
+### Mastodon interface
+If the Pleroma 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!
+Just add a "/web" after your instance url (e.g. <https://pleroma.soycaf.com/web>) and you'll end on the Mastodon web interface, but with a Pleroma backend! MAGIC!
+The Mastodon interface is from the Glitch-soc fork. For more information on the Mastodon interface you can check the [Mastodon](https://docs.joinmastodon.org/) and [Glitch-soc](https://glitch-soc.github.io/docs/) documentation.
+
+Remember, what you see is only the frontend part of Mastodon, the backend is still Pleroma.