1 defmodule Mix.Tasks.Pleroma.Instance do
3 alias Pleroma.{Repo, User}
5 @shortdoc "Manages Pleroma instance"
7 Manages Pleroma instance.
9 ## Generate a new instance config.
11 mix pleroma.instance new [OPTION...]
13 If any options are left unspecified, you will be prompted interactively
17 - `-f`, `--force` - overwrite any output files
18 - `-o PATH`, `--output PATH` - the output file for the generated configuration
19 - `--output-psql PATH` - the output file for the generated PostgreSQL setup
20 - `--domain DOMAIN` - the domain of your instance
21 - `--instance-name INSTANCE_NAME` - the name of your instance
22 - `--admin-email ADMIN_EMAIL` - the email address of the instance admin
23 - `--dbhost HOSTNAME` - the hostname of the PostgreSQL database to use
24 - `--dbname DBNAME` - the name of the database to use
25 - `--dbuser DBUSER` - the user (aka role) to use for the database connection
26 - `--dbpass DBPASS` - the password to use for the database connection
29 def run(["new" | rest]) do
38 instance_name: :string,
52 [config_path, psql_path] = [
53 Keyword.get(options, :output, "config/generated_config.exs"),
54 Keyword.get(options, :output_psql, "config/setup_db.psql")
57 will_overwrite = Enum.filter(paths, &File.exists?/1)
58 proceed? = Enum.empty?(will_overwrite) or Keyword.get(options, :force, false)
60 unless not proceed? do
65 "What domain will your instance use? (e.g pleroma.soykaf.com)"
69 get_option(options, :name, "What is the name of your instance? (e.g. Pleroma/Soykaf)")
71 email = get_option(options, :admin_email, "What is your admin email address?")
73 dbhost = get_option(options, :dbhost, "What is the hostname of your database?", "localhost")
75 dbname = get_option(options, :dbname, "What is the name of your database?", "pleroma_dev")
81 "What is the user used to connect to your database?",
89 "What is the password used to connect to your database?",
90 :crypto.strong_rand_bytes(64) |> Base.encode64() |> binary_part(0, 64),
94 secret = :crypto.strong_rand_bytes(64) |> Base.encode64() |> binary_part(0, 64)
98 "sample_config.eex" |> Path.expand(__DIR__),
106 version: Pleroma.Mixfile.project() |> Keyword.get(:version),
112 "sample_psql.eex" |> Path.expand(__DIR__),
119 "Writing config to #{config_path}. You should rename it to config/prod.secret.exs or config/dev.secret.exs."
122 File.write(config_path, result_config)
123 Mix.shell().info("Writing #{psql_path}.")
124 File.write(psql_path, result_psql)
130 1. Verify the contents of the generated files.
131 2. Run `sudo -u postgres psql -f #{escape_sh_path(psql_path)}`.
133 if config_path in ["config/dev.secret.exs", "config/prod.secret.exs"] do
136 "3. Run `mv #{escape_sh_path(config_path)} 'config/prod.secret.exs'`."
141 "The task would have overwritten the following files:\n" <>
142 (Enum.map(paths, &"- #{&1}\n") |> Enum.join("")) <>
143 "Rerun with `--force` to overwrite them."
149 defp escape_sh_path(path) do
150 ~S(') <> String.replace(path, ~S('), ~S(\')) <> ~S(')
153 defp get_option(options, opt, prompt, def \\ nil, defname \\ nil) do
154 Keyword.get(options, opt) ||
155 case Mix.shell().prompt("#{prompt} [#{defname || def}]") do
158 nil -> get_option(options, opt, prompt, def)