+# Pleroma: A lightweight social networking server
+# Copyright © 2017-2018 Pleroma Authors <https://pleroma.social/>
+# SPDX-License-Identifier: AGPL-3.0-only
+
defmodule Mix.Tasks.Pleroma.Instance do
use Mix.Task
- alias Pleroma.{Repo, User}
+ import Mix.Pleroma
@shortdoc "Manages Pleroma instance"
@moduledoc """
Manages Pleroma instance.
- ## Generate a new instance.
-
- mix pleroma.instance new [OPTION...]
+ ## Generate a new instance config.
+
+ mix pleroma.instance gen [OPTION...]
If any options are left unspecified, you will be prompted interactively
- `--domain DOMAIN` - the domain of your instance
- `--instance-name INSTANCE_NAME` - the name of your instance
- `--admin-email ADMIN_EMAIL` - the email address of the instance admin
+ - `--notify-email NOTIFY_EMAIL` - email address for notifications
- `--dbhost HOSTNAME` - the hostname of the PostgreSQL database to use
- `--dbname DBNAME` - the name of the database to use
- `--dbuser DBUSER` - the user (aka role) to use for the database connection
- `--dbpass DBPASS` - the password to use for the database connection
+ - `--rum Y/N` - Whether to enable RUM indexes
+ - `--indexable Y/N` - Allow/disallow indexing site by search engines
+ - `--db-configurable Y/N` - Allow/disallow configuring instance from admin part
+ - `--uploads-dir` - the directory uploads go in when using a local uploader
+ - `--static-dir` - the directory custom public files should be read from (custom emojis, frontend bundle overrides, robots.txt, etc.)
"""
- def run(["new" | rest]) do
+ def run(["gen" | rest]) do
{options, [], []} =
OptionParser.parse(
rest,
domain: :string,
instance_name: :string,
admin_email: :string,
+ notify_email: :string,
dbhost: :string,
dbname: :string,
dbuser: :string,
- dbpass: :string
+ dbpass: :string,
+ rum: :string,
+ indexable: :string,
+ db_configurable: :string,
+ uploads_dir: :string,
+ static_dir: :string
],
aliases: [
o: :output,
will_overwrite = Enum.filter(paths, &File.exists?/1)
proceed? = Enum.empty?(will_overwrite) or Keyword.get(options, :force, false)
- unless not proceed? do
- domain =
- Keyword.get(options, :domain) ||
- Mix.shell().prompt("What domain will your instance use? (e.g. pleroma.soykaf.com)")
- |> String.trim()
+ if proceed? do
+ [domain, port | _] =
+ String.split(
+ get_option(
+ options,
+ :domain,
+ "What domain will your instance use? (e.g pleroma.soykaf.com)"
+ ),
+ ":"
+ ) ++ [443]
name =
- Keyword.get(options, :name) ||
- Mix.shell().prompt("What is the name of your instance? (e.g. Pleroma/Soykaf)")
- |> String.trim()
-
- email =
- Keyword.get(options, :admin_email) ||
- Mix.shell().prompt("What is your admin email address?")
- |> String.trim()
-
- dbhost =
- Keyword.get(options, :dbhost) ||
- case Mix.shell().prompt("What is the hostname of your database? [localhost]") do
- "\n" -> "localhost"
- dbhost -> dbhost |> String.trim()
- end
-
- dbname =
- Keyword.get(options, :dbname) ||
- case Mix.shell().prompt("What is the name of your database? [pleroma_dev]") do
- "\n" -> "pleroma_dev"
- dbname -> dbname |> String.trim()
- end
+ get_option(
+ options,
+ :instance_name,
+ "What is the name of your instance? (e.g. Pleroma/Soykaf)"
+ )
+
+ email = get_option(options, :admin_email, "What is your admin email address?")
+
+ notify_email =
+ get_option(
+ options,
+ :notify_email,
+ "What email address do you want to use for sending email notifications?",
+ email
+ )
+
+ indexable =
+ get_option(
+ options,
+ :indexable,
+ "Do you want search engines to index your site? (y/n)",
+ "y"
+ ) === "y"
+
+ db_configurable? =
+ get_option(
+ options,
+ :db_configurable,
+ "Do you want to store the configuration in the database (allows controlling it from admin-fe)? (y/n)",
+ "n"
+ ) === "y"
+
+ dbhost = get_option(options, :dbhost, "What is the hostname of your database?", "localhost")
+
+ dbname = get_option(options, :dbname, "What is the name of your database?", "pleroma")
dbuser =
- Keyword.get(options, :dbuser) ||
- case Mix.shell().prompt("What is the user used to connect to your database? [pleroma]") do
- "\n" -> "pleroma"
- dbuser -> dbuser |> String.trim()
- end
+ get_option(
+ options,
+ :dbuser,
+ "What is the user used to connect to your database?",
+ "pleroma"
+ )
dbpass =
- Keyword.get(options, :dbpass) ||
- case Mix.shell().prompt(
- "What is the password used to connect to your database? [autogenerated]"
- ) do
- "\n" -> :crypto.strong_rand_bytes(64) |> Base.encode64() |> binary_part(0, 64)
- dbpass -> dbpass |> String.trim()
- end
+ get_option(
+ options,
+ :dbpass,
+ "What is the password used to connect to your database?",
+ :crypto.strong_rand_bytes(64) |> Base.encode64() |> binary_part(0, 64),
+ "autogenerated"
+ )
+
+ rum_enabled =
+ get_option(
+ options,
+ :rum,
+ "Would you like to use RUM indices?",
+ "n"
+ ) === "y"
+
+ uploads_dir =
+ get_option(
+ options,
+ :uploads_dir,
+ "What directory should media uploads go in (when using the local uploader)?",
+ Pleroma.Config.get([Pleroma.Uploaders.Local, :uploads])
+ )
+
+ static_dir =
+ get_option(
+ options,
+ :static_dir,
+ "What directory should custom public files be read from (custom emojis, frontend bundle overrides, robots.txt, etc.)?",
+ Pleroma.Config.get([:instance, :static_dir])
+ )
secret = :crypto.strong_rand_bytes(64) |> Base.encode64() |> binary_part(0, 64)
+ signing_salt = :crypto.strong_rand_bytes(8) |> Base.encode64() |> binary_part(0, 8)
+ {web_push_public_key, web_push_private_key} = :crypto.generate_key(:ecdh, :prime256v1)
+ template_dir = Application.app_dir(:pleroma, "priv") <> "/templates"
result_config =
EEx.eval_file(
- "sample_config.eex" |> Path.expand(__DIR__),
+ template_dir <> "/sample_config.eex",
domain: domain,
+ port: port,
email: email,
+ notify_email: notify_email,
name: name,
dbhost: dbhost,
dbname: dbname,
dbuser: dbuser,
dbpass: dbpass,
- version: Pleroma.Mixfile.project() |> Keyword.get(:version),
- secret: secret
+ secret: secret,
+ signing_salt: signing_salt,
+ web_push_public_key: Base.url_encode64(web_push_public_key, padding: false),
+ web_push_private_key: Base.url_encode64(web_push_private_key, padding: false),
+ db_configurable?: db_configurable?,
+ static_dir: static_dir,
+ uploads_dir: uploads_dir,
+ rum_enabled: rum_enabled
)
result_psql =
EEx.eval_file(
- "sample_psql.eex" |> Path.expand(__DIR__),
+ template_dir <> "/sample_psql.eex",
dbname: dbname,
dbuser: dbuser,
- dbpass: dbpass
+ dbpass: dbpass,
+ rum_enabled: rum_enabled
)
- Mix.shell().info(
- "Writing config to #{config_path}. You should rename it to config/prod.secret.exs or config/dev.secret.exs."
- )
+ shell_info("Writing config to #{config_path}.")
File.write(config_path, result_config)
- Mix.shell().info("Writing #{psql_path}.")
+ shell_info("Writing the postgres script to #{psql_path}.")
File.write(psql_path, result_psql)
- Mix.shell().info(
- "\n" <>
- """
- To get started:
- 1. Verify the contents of the generated files.
- 2. Run `sudo -u postgres psql -f #{escape_sh_path(psql_path)}`.
- """ <>
- if config_path in ["config/dev.secret.exs", "config/prod.secret.exs"] do
- ""
- else
- "3. Run `mv #{escape_sh_path(config_path)} 'config/prod.secret.exs'`."
- end
+ write_robots_txt(indexable, template_dir)
+
+ shell_info(
+ "\n All files successfully written! Refer to the installation instructions for your platform for next steps"
)
else
- Mix.shell().error(
+ shell_error(
"The task would have overwritten the following files:\n" <>
(Enum.map(paths, &"- #{&1}\n") |> Enum.join("")) <>
"Rerun with `--force` to overwrite them."
end
end
- defp escape_sh_path(path) do
- ~S(') <> String.replace(path, ~S('), ~S(\')) <> ~S(')
+ defp write_robots_txt(indexable, template_dir) do
+ robots_txt =
+ EEx.eval_file(
+ template_dir <> "/robots_txt.eex",
+ indexable: indexable
+ )
+
+ static_dir = Pleroma.Config.get([:instance, :static_dir], "instance/static/")
+
+ unless File.exists?(static_dir) do
+ File.mkdir_p!(static_dir)
+ end
+
+ robots_txt_path = Path.join(static_dir, "robots.txt")
+
+ if File.exists?(robots_txt_path) do
+ File.cp!(robots_txt_path, "#{robots_txt_path}.bak")
+ shell_info("Backing up existing robots.txt to #{robots_txt_path}.bak")
+ end
+
+ File.write(robots_txt_path, robots_txt)
+ shell_info("Writing #{robots_txt_path}.")
end
end
-