1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2018 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"
11 Manages Pleroma instance.
13 ## Generate a new instance config.
15 mix pleroma.instance gen [OPTION...]
17 If any options are left unspecified, you will be prompted interactively
21 - `-f`, `--force` - overwrite any output files
22 - `-o PATH`, `--output PATH` - the output file for the generated configuration
23 - `--output-psql PATH` - the output file for the generated PostgreSQL setup
24 - `--domain DOMAIN` - the domain of your instance
25 - `--instance-name INSTANCE_NAME` - the name of your instance
26 - `--admin-email ADMIN_EMAIL` - the email address of the instance admin
27 - `--notify-email NOTIFY_EMAIL` - email address for notifications
28 - `--dbhost HOSTNAME` - the hostname of the PostgreSQL database to use
29 - `--dbname DBNAME` - the name of the database to use
30 - `--dbuser DBUSER` - the user (aka role) to use for the database connection
31 - `--dbpass DBPASS` - the password to use for the database connection
32 - `--indexable Y/N` - Allow/disallow indexing site by search engines
33 - `--db-configurable Y/N` - Allow/disallow configuring instance from admin part
34 - `--uploads-dir` - the directory uploads go in when using a local uploader
35 - `--static-dir` - the directory custom public files should be read from (custom emojis, frontend bundle overrides, robots.txt, etc.)
38 def run(["gen" | rest]) do
47 instance_name: :string,
49 notify_email: :string,
55 db_configurable: :string,
66 [config_path, psql_path] = [
67 Keyword.get(options, :output, "config/generated_config.exs"),
68 Keyword.get(options, :output_psql, "config/setup_db.psql")
71 will_overwrite = Enum.filter(paths, &File.exists?/1)
72 proceed? = Enum.empty?(will_overwrite) or Keyword.get(options, :force, false)
80 "What domain will your instance use? (e.g pleroma.soykaf.com)"
89 "What is the name of your instance? (e.g. Pleroma/Soykaf)"
92 email = get_option(options, :admin_email, "What is your admin email address?")
98 "What email address do you want to use for sending email notifications?",
106 "Do you want search engines to index your site? (y/n)",
114 "Do you want to store the configuration in the database (allows controlling it from admin-fe)? (y/n)",
118 dbhost = get_option(options, :dbhost, "What is the hostname of your database?", "localhost")
120 dbname = get_option(options, :dbname, "What is the name of your database?", "pleroma")
126 "What is the user used to connect to your database?",
134 "What is the password used to connect to your database?",
135 :crypto.strong_rand_bytes(64) |> Base.encode64() |> binary_part(0, 64),
143 "What directory should media uploads go in (when using the local uploader)?",
144 Pleroma.Config.get([Pleroma.Uploaders.Local, :uploads])
151 "What directory should custom public files be read from (custom emojis, frontend bundle overrides, robots.txt, etc.)?",
152 Pleroma.Config.get([:instance, :static_dir])
155 secret = :crypto.strong_rand_bytes(64) |> Base.encode64() |> binary_part(0, 64)
156 signing_salt = :crypto.strong_rand_bytes(8) |> Base.encode64() |> binary_part(0, 8)
157 {web_push_public_key, web_push_private_key} = :crypto.generate_key(:ecdh, :prime256v1)
158 template_dir = Application.app_dir(:pleroma, "priv") <> "/templates"
162 template_dir <> "/sample_config.eex",
166 notify_email: notify_email,
173 signing_salt: signing_salt,
174 web_push_public_key: Base.url_encode64(web_push_public_key, padding: false),
175 web_push_private_key: Base.url_encode64(web_push_private_key, padding: false),
176 db_configurable?: db_configurable?,
177 static_dir: static_dir,
178 uploads_dir: uploads_dir
183 template_dir <> "/sample_psql.eex",
189 shell_info("Writing config to #{config_path}.")
191 File.write(config_path, result_config)
192 shell_info("Writing the postgres script to #{psql_path}.")
193 File.write(psql_path, result_psql)
195 write_robots_txt(indexable, template_dir)
198 "\n All files successfully written! Refer to the installation instructions for your platform for next steps"
202 "The task would have overwritten the following files:\n" <>
203 (Enum.map(paths, &"- #{&1}\n") |> Enum.join("")) <>
204 "Rerun with `--force` to overwrite them."
209 defp write_robots_txt(indexable, template_dir) do
212 template_dir <> "/robots_txt.eex",
216 static_dir = Pleroma.Config.get([:instance, :static_dir], "instance/static/")
218 unless File.exists?(static_dir) do
219 File.mkdir_p!(static_dir)
222 robots_txt_path = Path.join(static_dir, "robots.txt")
224 if File.exists?(robots_txt_path) do
225 File.cp!(robots_txt_path, "#{robots_txt_path}.bak")
226 shell_info("Backing up existing robots.txt to #{robots_txt_path}.bak")
229 File.write(robots_txt_path, robots_txt)
230 shell_info("Writing #{robots_txt_path}.")