Document the mix tasks in ex_doc instead
This commit is contained in:
parent
e1814bb322
commit
8b2541e4e7
16
README.md
16
README.md
|
@ -70,22 +70,6 @@ Add the following to your `dev.secret.exs` or `prod.secret.exs` if you want to p
|
||||||
|
|
||||||
This is useful for running pleroma inside Tor or i2p.
|
This is useful for running pleroma inside Tor or i2p.
|
||||||
|
|
||||||
## Admin Tasks
|
|
||||||
|
|
||||||
### Register a User
|
|
||||||
|
|
||||||
Run `mix register_user <name> <nickname> <email> <bio> <password>`. The `name` appears on statuses, while the nickname corresponds to the user, e.g. `@nickname@instance.tld`
|
|
||||||
|
|
||||||
### Password reset
|
|
||||||
|
|
||||||
Run `mix generate_password_reset username` to generate a password reset link that you can then send to the user.
|
|
||||||
|
|
||||||
### Moderators
|
|
||||||
|
|
||||||
You can make users moderators. They will then be able to delete any post.
|
|
||||||
|
|
||||||
Run `mix set_moderator username [true|false]` to make user a moderator or not.
|
|
||||||
|
|
||||||
## Troubleshooting
|
## Troubleshooting
|
||||||
|
|
||||||
### No incoming federation
|
### No incoming federation
|
||||||
|
|
|
@ -2,7 +2,13 @@ defmodule Mix.Tasks.DeactivateUser do
|
||||||
use Mix.Task
|
use Mix.Task
|
||||||
alias Pleroma.User
|
alias Pleroma.User
|
||||||
|
|
||||||
@shortdoc "Deactivate a user"
|
@moduledoc """
|
||||||
|
Deactivates a user (local or remote)
|
||||||
|
|
||||||
|
Usage: ``mix deactivate_user <nickname>``
|
||||||
|
|
||||||
|
Example: ``mix deactivate_user lain``
|
||||||
|
"""
|
||||||
def run([nickname]) do
|
def run([nickname]) do
|
||||||
Mix.Task.run("app.start")
|
Mix.Task.run("app.start")
|
||||||
|
|
||||||
|
|
|
@ -1,7 +1,15 @@
|
||||||
defmodule Mix.Tasks.GenerateConfig do
|
defmodule Mix.Tasks.GenerateConfig do
|
||||||
use Mix.Task
|
use Mix.Task
|
||||||
|
|
||||||
@shortdoc "Generates a new config"
|
@moduledoc """
|
||||||
|
Generate a new config
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
``mix generate_config``
|
||||||
|
|
||||||
|
This mix task is interactive, and will overwrite the config present at ``config/generated_config.exs``.
|
||||||
|
"""
|
||||||
|
|
||||||
def run(_) do
|
def run(_) do
|
||||||
IO.puts("Answer a few questions to generate a new config\n")
|
IO.puts("Answer a few questions to generate a new config\n")
|
||||||
IO.puts("--- THIS WILL OVERWRITE YOUR config/generated_config.exs! ---\n")
|
IO.puts("--- THIS WILL OVERWRITE YOUR config/generated_config.exs! ---\n")
|
||||||
|
|
|
@ -1,7 +1,14 @@
|
||||||
defmodule Mix.Tasks.GenerateInviteToken do
|
defmodule Mix.Tasks.GenerateInviteToken do
|
||||||
use Mix.Task
|
use Mix.Task
|
||||||
|
|
||||||
@shortdoc "Generate invite token for user"
|
@moduledoc """
|
||||||
|
Generates invite token
|
||||||
|
|
||||||
|
This is in the form of a URL to be used by the Invited user to register themselves.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
``mix generate_invite_token``
|
||||||
|
"""
|
||||||
def run([]) do
|
def run([]) do
|
||||||
Mix.Task.run("app.start")
|
Mix.Task.run("app.start")
|
||||||
|
|
||||||
|
|
|
@ -2,7 +2,7 @@ defmodule Mix.Tasks.SetModerator do
|
||||||
@moduledoc """
|
@moduledoc """
|
||||||
Set moderator to a local user
|
Set moderator to a local user
|
||||||
|
|
||||||
Usage: ``mix set_moderator <username>``
|
Usage: ``mix set_moderator <nickname>``
|
||||||
|
|
||||||
Example: ``mix set_moderator lain``
|
Example: ``mix set_moderator lain``
|
||||||
"""
|
"""
|
||||||
|
|
|
@ -2,7 +2,13 @@ defmodule Mix.Tasks.RmUser do
|
||||||
use Mix.Task
|
use Mix.Task
|
||||||
alias Pleroma.User
|
alias Pleroma.User
|
||||||
|
|
||||||
@shortdoc "Permanently delete a user"
|
@moduledoc """
|
||||||
|
Permanently deletes a user
|
||||||
|
|
||||||
|
Usage: ``mix rm_user [nickname]``
|
||||||
|
|
||||||
|
Example: ``mix rm_user lain``
|
||||||
|
"""
|
||||||
def run([nickname]) do
|
def run([nickname]) do
|
||||||
Mix.Task.run("app.start")
|
Mix.Task.run("app.start")
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue