direct docs to stable
This commit is contained in:
parent
678458ff99
commit
4c007efa9b
26
README.md
26
README.md
|
@ -8,27 +8,27 @@ This is a fork of Pleroma, which is a microblogging server software that can fed
|
||||||
|
|
||||||
Akkoma is written in Elixir and uses PostgresSQL for data storage.
|
Akkoma is written in Elixir and uses PostgresSQL for data storage.
|
||||||
|
|
||||||
For clients it supports the [Mastodon client API](https://docs.joinmastodon.org/api/guidelines/) with Pleroma extensions (see the API section on <https://docs.akkoma.dev/main/>).
|
For clients it supports the [Mastodon client API](https://docs.joinmastodon.org/api/guidelines/) with Pleroma extensions (see the API section on <https://docs.akkoma.dev/stable/>).
|
||||||
|
|
||||||
- [Client Applications for Pleroma](https://docs.akkoma.dev/main/backend/clients/)
|
- [Client Applications for Pleroma](https://docs.akkoma.dev/stable/clients/)
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
### OTP releases (Recommended)
|
### OTP releases (Recommended)
|
||||||
If you are running Linux (glibc or musl) on x86, the recommended way to install Pleroma is by using OTP releases. OTP releases are as close as you can get to binary releases with Erlang/Elixir. The release is self-contained, and provides everything needed to boot it. The installation instructions are available [here](https://docs.akkoma.dev/main/backend/installation/otp_en/).
|
If you are running Linux (glibc or musl) on x86, the recommended way to install Pleroma is by using OTP releases. OTP releases are as close as you can get to binary releases with Erlang/Elixir. The release is self-contained, and provides everything needed to boot it. The installation instructions are available [here](https://docs.akkoma.dev/stable/installation/otp_en/).
|
||||||
|
|
||||||
### From Source
|
### From Source
|
||||||
If your platform is not supported, or you just want to be able to edit the source code easily, you may install Pleroma from source.
|
If your platform is not supported, or you just want to be able to edit the source code easily, you may install Pleroma from source.
|
||||||
|
|
||||||
- [Alpine Linux](https://docs.akkoma.dev/main/backend/installation/alpine_linux_en/)
|
- [Alpine Linux](https://docs.akkoma.dev/stable/installation/alpine_linux_en/)
|
||||||
- [Arch Linux](https://docs.akkoma.dev/main/backend/installation/arch_linux_en/)
|
- [Arch Linux](https://docs.akkoma.dev/stable/installation/arch_linux_en/)
|
||||||
- [Debian-based](https://docs.akkoma.dev/main/backend/installation/debian_based_en/)
|
- [Debian-based](https://docs.akkoma.dev/stable/installation/debian_based_en/)
|
||||||
- [Debian-based (jp)](https://docs.akkoma.dev/main/backend/installation/debian_based_jp/)
|
- [Debian-based (jp)](https://docs.akkoma.dev/stable/installation/debian_based_jp/)
|
||||||
- [FreeBSD](https://docs.akkoma.dev/main/backend/installation/freebsd_en/)
|
- [FreeBSD](https://docs.akkoma.dev/stable/installation/freebsd_en/)
|
||||||
- [Gentoo Linux](https://docs.akkoma.dev/main/backend/installation/gentoo_en/)
|
- [Gentoo Linux](https://docs.akkoma.dev/stable/installation/gentoo_en/)
|
||||||
- [NetBSD](https://docs.akkoma.dev/main/backend/installation/netbsd_en/)
|
- [NetBSD](https://docs.akkoma.dev/stable/installation/netbsd_en/)
|
||||||
- [OpenBSD](https://docs.akkoma.dev/main/backend/installation/openbsd_en/)
|
- [OpenBSD](https://docs.akkoma.dev/stable/installation/openbsd_en/)
|
||||||
- [OpenBSD (fi)](https://docs.akkoma.dev/main/backend/installation/openbsd_fi/)
|
- [OpenBSD (fi)](https://docs.akkoma.dev/stable/installation/openbsd_fi/)
|
||||||
|
|
||||||
### Docker
|
### 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>.
|
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>.
|
||||||
|
@ -42,4 +42,4 @@ If you ever encounter compilation issues during the updating of Pleroma, you can
|
||||||
- `rm -r _build`
|
- `rm -r _build`
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
- https://docs.akkoma.dev/main
|
- https://docs.akkoma.dev/stable
|
||||||
|
|
|
@ -8,7 +8,7 @@
|
||||||
# 'a2ensite akkoma-apache.conf', then restart Apache.
|
# 'a2ensite akkoma-apache.conf', then restart Apache.
|
||||||
#
|
#
|
||||||
# Optional: enable disk-based caching for the media proxy
|
# Optional: enable disk-based caching for the media proxy
|
||||||
# For details, see https://docs.akkoma.dev/main/backend/configuration/howto_mediaproxy/
|
# For details, see https://docs.akkoma.dev/stable/configuration/howto_mediaproxy/
|
||||||
#
|
#
|
||||||
# 1. Create a directory as shown below for the CacheRoot and make sure
|
# 1. Create a directory as shown below for the CacheRoot and make sure
|
||||||
# the Apache user can write to it.
|
# the Apache user can write to it.
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
# SPDX-License-Identifier: AGPL-3.0-only
|
# SPDX-License-Identifier: AGPL-3.0-only
|
||||||
|
|
||||||
defmodule Mix.Tasks.Pleroma.App do
|
defmodule Mix.Tasks.Pleroma.App do
|
||||||
@moduledoc File.read!("docs/administration/CLI_tasks/oauth_app.md")
|
@moduledoc File.read!("docs/docs/administration/CLI_tasks/oauth_app.md")
|
||||||
use Mix.Task
|
use Mix.Task
|
||||||
|
|
||||||
import Mix.Pleroma
|
import Mix.Pleroma
|
||||||
|
|
|
@ -12,7 +12,7 @@ defmodule Mix.Tasks.Pleroma.Config do
|
||||||
alias Pleroma.Repo
|
alias Pleroma.Repo
|
||||||
|
|
||||||
@shortdoc "Manages the location of the config"
|
@shortdoc "Manages the location of the config"
|
||||||
@moduledoc File.read!("docs/administration/CLI_tasks/config.md")
|
@moduledoc File.read!("docs/docs/administration/CLI_tasks/config.md")
|
||||||
|
|
||||||
def run(["migrate_to_db"]) do
|
def run(["migrate_to_db"]) do
|
||||||
check_configdb(fn ->
|
check_configdb(fn ->
|
||||||
|
|
|
@ -18,7 +18,7 @@ defmodule Mix.Tasks.Pleroma.Database do
|
||||||
use Mix.Task
|
use Mix.Task
|
||||||
|
|
||||||
@shortdoc "A collection of database related tasks"
|
@shortdoc "A collection of database related tasks"
|
||||||
@moduledoc File.read!("docs/administration/CLI_tasks/database.md")
|
@moduledoc File.read!("docs/docs/administration/CLI_tasks/database.md")
|
||||||
|
|
||||||
def run(["remove_embedded_objects" | args]) do
|
def run(["remove_embedded_objects" | args]) do
|
||||||
{options, [], []} =
|
{options, [], []} =
|
||||||
|
|
|
@ -7,7 +7,7 @@ defmodule Mix.Tasks.Pleroma.Digest do
|
||||||
import Mix.Pleroma
|
import Mix.Pleroma
|
||||||
|
|
||||||
@shortdoc "Manages digest emails"
|
@shortdoc "Manages digest emails"
|
||||||
@moduledoc File.read!("docs/administration/CLI_tasks/digest.md")
|
@moduledoc File.read!("docs/docs/administration/CLI_tasks/digest.md")
|
||||||
|
|
||||||
def run(["test", nickname | opts]) do
|
def run(["test", nickname | opts]) do
|
||||||
Mix.Pleroma.start_pleroma()
|
Mix.Pleroma.start_pleroma()
|
||||||
|
|
|
@ -7,7 +7,7 @@ defmodule Mix.Tasks.Pleroma.Email do
|
||||||
import Mix.Pleroma
|
import Mix.Pleroma
|
||||||
|
|
||||||
@shortdoc "Email administrative tasks"
|
@shortdoc "Email administrative tasks"
|
||||||
@moduledoc File.read!("docs/administration/CLI_tasks/email.md")
|
@moduledoc File.read!("docs/docs/administration/CLI_tasks/email.md")
|
||||||
|
|
||||||
def run(["test" | args]) do
|
def run(["test" | args]) do
|
||||||
start_pleroma()
|
start_pleroma()
|
||||||
|
|
|
@ -7,7 +7,7 @@ defmodule Mix.Tasks.Pleroma.Emoji do
|
||||||
import Mix.Pleroma
|
import Mix.Pleroma
|
||||||
|
|
||||||
@shortdoc "Manages emoji packs"
|
@shortdoc "Manages emoji packs"
|
||||||
@moduledoc File.read!("docs/administration/CLI_tasks/emoji.md")
|
@moduledoc File.read!("docs/docs/administration/CLI_tasks/emoji.md")
|
||||||
|
|
||||||
def run(["ls-packs" | args]) do
|
def run(["ls-packs" | args]) do
|
||||||
start_pleroma()
|
start_pleroma()
|
||||||
|
|
|
@ -9,7 +9,7 @@ defmodule Mix.Tasks.Pleroma.Frontend do
|
||||||
|
|
||||||
@shortdoc "Manages bundled Pleroma frontends"
|
@shortdoc "Manages bundled Pleroma frontends"
|
||||||
|
|
||||||
@moduledoc File.read!("docs/administration/CLI_tasks/frontend.md")
|
@moduledoc File.read!("docs/docs/administration/CLI_tasks/frontend.md")
|
||||||
|
|
||||||
def run(["install", "none" | _args]) do
|
def run(["install", "none" | _args]) do
|
||||||
shell_info("Skipping frontend installation because none was requested")
|
shell_info("Skipping frontend installation because none was requested")
|
||||||
|
|
|
@ -9,7 +9,7 @@ defmodule Mix.Tasks.Pleroma.Instance do
|
||||||
alias Pleroma.Config
|
alias Pleroma.Config
|
||||||
|
|
||||||
@shortdoc "Manages Pleroma instance"
|
@shortdoc "Manages Pleroma instance"
|
||||||
@moduledoc File.read!("docs/administration/CLI_tasks/instance.md")
|
@moduledoc File.read!("docs/docs/administration/CLI_tasks/instance.md")
|
||||||
|
|
||||||
def run(["gen" | rest]) do
|
def run(["gen" | rest]) do
|
||||||
{options, [], []} =
|
{options, [], []} =
|
||||||
|
|
|
@ -8,7 +8,7 @@ defmodule Mix.Tasks.Pleroma.Relay do
|
||||||
alias Pleroma.Web.ActivityPub.Relay
|
alias Pleroma.Web.ActivityPub.Relay
|
||||||
|
|
||||||
@shortdoc "Manages remote relays"
|
@shortdoc "Manages remote relays"
|
||||||
@moduledoc File.read!("docs/administration/CLI_tasks/relay.md")
|
@moduledoc File.read!("docs/docs/administration/CLI_tasks/relay.md")
|
||||||
|
|
||||||
def run(["follow", target]) do
|
def run(["follow", target]) do
|
||||||
start_pleroma()
|
start_pleroma()
|
||||||
|
|
|
@ -12,7 +12,7 @@ defmodule Mix.Tasks.Pleroma.Uploads do
|
||||||
@log_every 50
|
@log_every 50
|
||||||
|
|
||||||
@shortdoc "Migrates uploads from local to remote storage"
|
@shortdoc "Migrates uploads from local to remote storage"
|
||||||
@moduledoc File.read!("docs/administration/CLI_tasks/uploads.md")
|
@moduledoc File.read!("docs/docs/administration/CLI_tasks/uploads.md")
|
||||||
|
|
||||||
def run(["migrate_local", target_uploader | args]) do
|
def run(["migrate_local", target_uploader | args]) do
|
||||||
delete? = Enum.member?(args, "--delete")
|
delete? = Enum.member?(args, "--delete")
|
||||||
|
|
|
@ -13,7 +13,7 @@ defmodule Mix.Tasks.Pleroma.User do
|
||||||
alias Pleroma.Web.ActivityPub.Pipeline
|
alias Pleroma.Web.ActivityPub.Pipeline
|
||||||
|
|
||||||
@shortdoc "Manages Pleroma users"
|
@shortdoc "Manages Pleroma users"
|
||||||
@moduledoc File.read!("docs/administration/CLI_tasks/user.md")
|
@moduledoc File.read!("docs/docs/administration/CLI_tasks/user.md")
|
||||||
|
|
||||||
def run(["new", nickname, email | rest]) do
|
def run(["new", nickname, email | rest]) do
|
||||||
{options, [], []} =
|
{options, [], []} =
|
||||||
|
|
|
@ -25,7 +25,7 @@ defmodule Pleroma.Docs.JSON do
|
||||||
|
|
||||||
@spec process(keyword()) :: {:ok, String.t()}
|
@spec process(keyword()) :: {:ok, String.t()}
|
||||||
def process(descriptions) do
|
def process(descriptions) do
|
||||||
with path <- "docs/generated_config.json",
|
with path <- "docs/docs/generated_config.json",
|
||||||
{:ok, file} <- File.open(path, [:write, :utf8]),
|
{:ok, file} <- File.open(path, [:write, :utf8]),
|
||||||
formatted_descriptions <-
|
formatted_descriptions <-
|
||||||
Pleroma.Docs.Generator.convert_to_strings(descriptions),
|
Pleroma.Docs.Generator.convert_to_strings(descriptions),
|
||||||
|
|
|
@ -7,7 +7,7 @@ defmodule Pleroma.Docs.Markdown do
|
||||||
|
|
||||||
@spec process(keyword()) :: {:ok, String.t()}
|
@spec process(keyword()) :: {:ok, String.t()}
|
||||||
def process(descriptions) do
|
def process(descriptions) do
|
||||||
config_path = "docs/generated_config.md"
|
config_path = "docs/docs/generated_config.md"
|
||||||
{:ok, file} = File.open(config_path, [:utf8, :write])
|
{:ok, file} = File.open(config_path, [:utf8, :write])
|
||||||
IO.write(file, "# Generated configuration\n")
|
IO.write(file, "# Generated configuration\n")
|
||||||
IO.write(file, "Date of generation: #{Date.utc_today()}\n\n")
|
IO.write(file, "Date of generation: #{Date.utc_today()}\n\n")
|
||||||
|
|
|
@ -5,4 +5,4 @@ modifying anything here.
|
||||||
|
|
||||||
Please use the instance static directory instead, it has the same directory
|
Please use the instance static directory instead, it has the same directory
|
||||||
structure and files placed there will override files placed here. See
|
structure and files placed there will override files placed here. See
|
||||||
https://docs.akkoma.dev/main/backend/configuration/static_dir/ for more info.
|
https://docs.akkoma.dev/stable/configuration/static_dir/ for more info.
|
||||||
|
|
|
@ -7,6 +7,6 @@
|
||||||
<h3>Welcome to Akkoma!</h3>
|
<h3>Welcome to Akkoma!</h3>
|
||||||
<p>If you're seeing this page, your server works!</p>
|
<p>If you're seeing this page, your server works!</p>
|
||||||
<p>In order to get a frontend to show here, you'll need to set up <code>:pleroma, :frontends, primary</code> and install your frontend of choice</p>
|
<p>In order to get a frontend to show here, you'll need to set up <code>:pleroma, :frontends, primary</code> and install your frontend of choice</p>
|
||||||
<a href="https://docs.akkoma.dev/main/backend/configuration/cheatsheet/#frontend-management">Documentation</a>
|
<a href="https://docs.akkoma.dev/stable/configuration/cheatsheet/#frontend-management">Documentation</a>
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
|
Loading…
Reference in a new issue