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 - `--rum Y/N` - Whether to enable RUM indexes
33 - `--indexable Y/N` - Allow/disallow indexing site by search engines
34 - `--db-configurable Y/N` - Allow/disallow configuring instance from admin part
35 - `--uploads-dir` - the directory uploads go in when using a local uploader
36 - `--static-dir` - the directory custom public files should be read from (custom emojis, frontend bundle overrides, robots.txt, etc.)
39 def run(["gen" | rest]) do
48 instance_name: :string,
50 notify_email: :string,
57 db_configurable: :string,
68 [config_path, psql_path] = [
69 Keyword.get(options, :output, "config/generated_config.exs"),
70 Keyword.get(options, :output_psql, "config/setup_db.psql")
73 will_overwrite = Enum.filter(paths, &File.exists?/1)
74 proceed? = Enum.empty?(will_overwrite) or Keyword.get(options, :force, false)
82 "What domain will your instance use? (e.g pleroma.soykaf.com)"
91 "What is the name of your instance? (e.g. Pleroma/Soykaf)"
94 email = get_option(options, :admin_email, "What is your admin email address?")
100 "What email address do you want to use for sending email notifications?",
108 "Do you want search engines to index your site? (y/n)",
116 "Do you want to store the configuration in the database (allows controlling it from admin-fe)? (y/n)",
120 dbhost = get_option(options, :dbhost, "What is the hostname of your database?", "localhost")
122 dbname = get_option(options, :dbname, "What is the name of your database?", "pleroma")
128 "What is the user used to connect to your database?",
136 "What is the password used to connect to your database?",
137 :crypto.strong_rand_bytes(64) |> Base.encode64() |> binary_part(0, 64),
145 "Would you like to use RUM indices?",
153 "What directory should media uploads go in (when using the local uploader)?",
154 Pleroma.Config.get([Pleroma.Uploaders.Local, :uploads])
161 "What directory should custom public files be read from (custom emojis, frontend bundle overrides, robots.txt, etc.)?",
162 Pleroma.Config.get([:instance, :static_dir])
165 secret = :crypto.strong_rand_bytes(64) |> Base.encode64() |> binary_part(0, 64)
166 jwt_secret = :crypto.strong_rand_bytes(64) |> Base.encode64() |> binary_part(0, 64)
167 signing_salt = :crypto.strong_rand_bytes(8) |> Base.encode64() |> binary_part(0, 8)
168 {web_push_public_key, web_push_private_key} = :crypto.generate_key(:ecdh, :prime256v1)
169 template_dir = Application.app_dir(:pleroma, "priv") <> "/templates"
173 template_dir <> "/sample_config.eex",
177 notify_email: notify_email,
184 jwt_secret: jwt_secret,
185 signing_salt: signing_salt,
186 web_push_public_key: Base.url_encode64(web_push_public_key, padding: false),
187 web_push_private_key: Base.url_encode64(web_push_private_key, padding: false),
188 db_configurable?: db_configurable?,
189 static_dir: static_dir,
190 uploads_dir: uploads_dir,
191 rum_enabled: rum_enabled
196 template_dir <> "/sample_psql.eex",
200 rum_enabled: rum_enabled
203 shell_info("Writing config to #{config_path}.")
205 File.write(config_path, result_config)
206 shell_info("Writing the postgres script to #{psql_path}.")
207 File.write(psql_path, result_psql)
209 write_robots_txt(indexable, template_dir)
212 "\n All files successfully written! Refer to the installation instructions for your platform for next steps"
216 "The task would have overwritten the following files:\n" <>
217 (Enum.map(paths, &"- #{&1}\n") |> Enum.join("")) <>
218 "Rerun with `--force` to overwrite them."
223 defp write_robots_txt(indexable, template_dir) do
226 template_dir <> "/robots_txt.eex",
230 static_dir = Pleroma.Config.get([:instance, :static_dir], "instance/static/")
232 unless File.exists?(static_dir) do
233 File.mkdir_p!(static_dir)
236 robots_txt_path = Path.join(static_dir, "robots.txt")
238 if File.exists?(robots_txt_path) do
239 File.cp!(robots_txt_path, "#{robots_txt_path}.bak")
240 shell_info("Backing up existing robots.txt to #{robots_txt_path}.bak")
243 File.write(robots_txt_path, robots_txt)
244 shell_info("Writing #{robots_txt_path}.")