1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2019 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
5 defmodule Mix.Tasks.Pleroma.Instance do
9 @shortdoc "Manages Pleroma instance"
10 @moduledoc File.read!("docs/administration/CLI_tasks/instance.md")
12 def run(["gen" | rest]) do
21 instance_name: :string,
23 notify_email: :string,
30 db_configurable: :string,
43 [config_path, psql_path] = [
44 Keyword.get(options, :output, "config/generated_config.exs"),
45 Keyword.get(options, :output_psql, "config/setup_db.psql")
48 will_overwrite = Enum.filter(paths, &File.exists?/1)
49 proceed? = Enum.empty?(will_overwrite) or Keyword.get(options, :force, false)
57 "What domain will your instance use? (e.g pleroma.soykaf.com)"
66 "What is the name of your instance? (e.g. Pleroma/Soykaf)"
69 email = get_option(options, :admin_email, "What is your admin email address?")
75 "What email address do you want to use for sending email notifications?",
83 "Do you want search engines to index your site? (y/n)",
91 "Do you want to store the configuration in the database (allows controlling it from admin-fe)? (y/n)",
95 dbhost = get_option(options, :dbhost, "What is the hostname of your database?", "localhost")
97 dbname = get_option(options, :dbname, "What is the name of your database?", "pleroma")
103 "What is the user used to connect to your database?",
111 "What is the password used to connect to your database?",
112 :crypto.strong_rand_bytes(64) |> Base.encode64() |> binary_part(0, 64),
120 "Would you like to use RUM indices?",
128 "What port will the app listen to (leave it if you are using the default setup with nginx)?",
136 "What ip will the app listen to (leave it if you are using the default setup with nginx)?",
144 "What directory should media uploads go in (when using the local uploader)?",
145 Pleroma.Config.get([Pleroma.Uploaders.Local, :uploads])
152 "What directory should custom public files be read from (custom emojis, frontend bundle overrides, robots.txt, etc.)?",
153 Pleroma.Config.get([:instance, :static_dir])
156 secret = :crypto.strong_rand_bytes(64) |> Base.encode64() |> binary_part(0, 64)
157 jwt_secret = :crypto.strong_rand_bytes(64) |> Base.encode64() |> binary_part(0, 64)
158 signing_salt = :crypto.strong_rand_bytes(8) |> Base.encode64() |> binary_part(0, 8)
159 {web_push_public_key, web_push_private_key} = :crypto.generate_key(:ecdh, :prime256v1)
160 template_dir = Application.app_dir(:pleroma, "priv") <> "/templates"
164 template_dir <> "/sample_config.eex",
168 notify_email: notify_email,
175 jwt_secret: jwt_secret,
176 signing_salt: signing_salt,
177 web_push_public_key: Base.url_encode64(web_push_public_key, padding: false),
178 web_push_private_key: Base.url_encode64(web_push_private_key, padding: false),
179 db_configurable?: db_configurable?,
180 static_dir: static_dir,
181 uploads_dir: uploads_dir,
182 rum_enabled: rum_enabled,
183 listen_ip: listen_ip,
184 listen_port: listen_port
189 template_dir <> "/sample_psql.eex",
193 rum_enabled: rum_enabled
196 shell_info("Writing config to #{config_path}.")
198 File.write(config_path, result_config)
199 shell_info("Writing the postgres script to #{psql_path}.")
200 File.write(psql_path, result_psql)
202 write_robots_txt(indexable, template_dir)
205 "\n All files successfully written! Refer to the installation instructions for your platform for next steps"
209 "The task would have overwritten the following files:\n" <>
210 (Enum.map(paths, &"- #{&1}\n") |> Enum.join("")) <>
211 "Rerun with `--force` to overwrite them."
216 defp write_robots_txt(indexable, template_dir) do
219 template_dir <> "/robots_txt.eex",
223 static_dir = Pleroma.Config.get([:instance, :static_dir], "instance/static/")
225 unless File.exists?(static_dir) do
226 File.mkdir_p!(static_dir)
229 robots_txt_path = Path.join(static_dir, "robots.txt")
231 if File.exists?(robots_txt_path) do
232 File.cp!(robots_txt_path, "#{robots_txt_path}.bak")
233 shell_info("Backing up existing robots.txt to #{robots_txt_path}.bak")
236 File.write(robots_txt_path, robots_txt)
237 shell_info("Writing #{robots_txt_path}.")