Add migration documentation, update readme #27

Merged
floatingghost merged 6 commits from documentation-migration into develop 2022-07-01 12:16:01 +00:00
2 changed files with 23 additions and 25 deletions
Showing only changes of commit 22090b2fd1 - Show all commits

View file

@ -97,6 +97,7 @@
"http",
"dat",
"dweb",
"gopher",
"hyper",
"ipfs",
"ipns",
@ -148,7 +149,7 @@
]
# Configures Elixir's Logger
config :logger, truncate: 65536
config :logger, truncate: 65_536
config :logger, :console,
level: :info,
@ -187,7 +188,7 @@
name: "Pleroma",
email: "example@example.com",
notify_email: "noreply@example.com",
description: "Pleroma: An efficient and flexible fediverse server",
description: "Akkoma: The cooler fediverse server",
background_image: "/images/city.jpg",
instance_thumbnail: "/instance/thumbnail.jpeg",
limit: 5_000,
@ -602,7 +603,8 @@
uid: System.get_env("LDAP_UID") || "cn"
oauth_consumer_strategies =
System.get_env("OAUTH_CONSUMER_STRATEGIES")
"OAUTH_CONSUMER_STRATEGIES"
|> System.get_env()
|> to_string()
|> String.split()
|> Enum.map(&hd(String.split(&1, ":")))
@ -699,7 +701,7 @@
"192.168.0.0/16"
]
config :pleroma, :static_fe, enabled: false
config :pleroma, :static_fe, enabled: true
# Example of frontend configuration
# This example will make us serve the primary frontend from the
@ -712,17 +714,15 @@
# config :pleroma, :frontends,
# primary: %{"name" => "pleroma-fe", "ref" => "develop"},
# admin: %{"name" => "admin-fe", "ref" => "stable"},
# mastodon: %{"enabled" => true, "name" => "mastodon-fe", "ref" => "develop"}
# available: %{...}
config :pleroma, :frontends,
primary: %{
"name" => "pleroma-fe",
"ref" => "develop"
},
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://akkoma.dev/AkkomaGang/pleroma-fe",
@ -730,21 +730,18 @@
"ref" => "develop",
"build_dir" => "dist"
},
"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",
"ref" => "master",
"custom-http-headers" => [
{"service-worker-allowed", "/"}
]
# mastodon-Fe cannot be set as a primary - this is only here so we can update this seperately
"mastodon-fe" => %{
"name" => "mastodon-fe",
"git" => "https://akkoma.dev/AkkomaGang/masto-fe",
"build_url" => "https://akkoma-updates.s3-website.fr-par.scw.cloud/frontend/masto-fe.zip",
"build_dir" => "distribution",
"ref" => "develop"
},
"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",
"git" => "https://akkoma.dev/AkkomaGang/admin-fe",
"build_url" => "https://akkoma-updates.s3-website.fr-par.scw.cloud/frontend/admin-fe.zip",
"ref" => "develop"
},
"soapbox-fe" => %{

View file

@ -1,10 +1,11 @@
# Migrating to Akkoma
**Akkoma does not currently have a stable release, until 3.0, all builds should be considered "develop**
**Akkoma does not currently have a stable release, until 3.0, all builds should be considered "develop"**
## Why should you migrate?
aside from actually responsive maintainer(s)? let's lookie here, we've got
aside from actually responsive maintainer(s)? let's lookie here, we've got:
- custom emoji reactions
- misskey markdown (MFM) rendering and posting support
- elasticsearch support (because pleroma search is GARBAGE)