git.squeep.com Git - akkoma/blob - lib/mix/tasks/pleroma/instance.ex

   1 # Pleroma: A lightweight social networking server
   2 # Copyright © 2017-2018 Pleroma Authors <https://pleroma.social/>
   3 # SPDX-License-Identifier: AGPL-3.0-only
   4
   5 defmodule Mix.Tasks.Pleroma.Instance do
   6   use Mix.Task
   7   import Mix.Pleroma
   8
   9   @shortdoc "Manages Pleroma instance"
  10   @moduledoc """
  11   Manages Pleroma instance.
  12
  13   ## Generate a new instance config.
  14
  15     mix pleroma.instance gen [OPTION...]
  16
  17   If any options are left unspecified, you will be prompted interactively
  18
  19   ## Options
  20
  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.)
  37   - `--listen-ip` - the ip the app should listen to, defaults to 127.0.0.1
  38   - `--listen-port` - the port the app should listen to, defaults to 4000
  39   """
  40
  41   def run(["gen" | rest]) do
  42     {options, [], []} =
  43       OptionParser.parse(
  44         rest,
  45         strict: [
  46           force: :boolean,
  47           output: :string,
  48           output_psql: :string,
  49           domain: :string,
  50           instance_name: :string,
  51           admin_email: :string,
  52           notify_email: :string,
  53           dbhost: :string,
  54           dbname: :string,
  55           dbuser: :string,
  56           dbpass: :string,
  57           rum: :string,
  58           indexable: :string,
  59           db_configurable: :string,
  60           uploads_dir: :string,
  61           static_dir: :string,
  62           listen_ip: :string,
  63           listen_port: :string
  64         ],
  65         aliases: [
  66           o: :output,
  67           f: :force
  68         ]
  69       )
  70
  71     paths =
  72       [config_path, psql_path] = [
  73         Keyword.get(options, :output, "config/generated_config.exs"),
  74         Keyword.get(options, :output_psql, "config/setup_db.psql")
  75       ]
  76
  77     will_overwrite = Enum.filter(paths, &File.exists?/1)
  78     proceed? = Enum.empty?(will_overwrite) or Keyword.get(options, :force, false)
  79
  80     if proceed? do
  81       [domain, port | _] =
  82         String.split(
  83           get_option(
  84             options,
  85             :domain,
  86             "What domain will your instance use? (e.g pleroma.soykaf.com)"
  87           ),
  88           ":"
  89         ) ++ [443]
  90
  91       name =
  92         get_option(
  93           options,
  94           :instance_name,
  95           "What is the name of your instance? (e.g. Pleroma/Soykaf)"
  96         )
  97
  98       email = get_option(options, :admin_email, "What is your admin email address?")
  99
 100       notify_email =
 101         get_option(
 102           options,
 103           :notify_email,
 104           "What email address do you want to use for sending email notifications?",
 105           email
 106         )
 107
 108       indexable =
 109         get_option(
 110           options,
 111           :indexable,
 112           "Do you want search engines to index your site? (y/n)",
 113           "y"
 114         ) === "y"
 115
 116       db_configurable? =
 117         get_option(
 118           options,
 119           :db_configurable,
 120           "Do you want to store the configuration in the database (allows controlling it from admin-fe)? (y/n)",
 121           "n"
 122         ) === "y"
 123
 124       dbhost = get_option(options, :dbhost, "What is the hostname of your database?", "localhost")
 125
 126       dbname = get_option(options, :dbname, "What is the name of your database?", "pleroma")
 127
 128       dbuser =
 129         get_option(
 130           options,
 131           :dbuser,
 132           "What is the user used to connect to your database?",
 133           "pleroma"
 134         )
 135
 136       dbpass =
 137         get_option(
 138           options,
 139           :dbpass,
 140           "What is the password used to connect to your database?",
 141           :crypto.strong_rand_bytes(64) |> Base.encode64() |> binary_part(0, 64),
 142           "autogenerated"
 143         )
 144
 145       rum_enabled =
 146         get_option(
 147           options,
 148           :rum,
 149           "Would you like to use RUM indices?",
 150           "n"
 151         ) === "y"
 152
 153       listen_port =
 154         get_option(
 155           options,
 156           :listen_port,
 157           "What port will the app listen to (leave it if you are using the default setup with nginx)?",
 158           4000
 159         )
 160
 161       listen_ip =
 162         get_option(
 163           options,
 164           :listen_ip,
 165           "What ip will the app listen to (leave it if you are using the default setup with nginx)?",
 166           "127.0.0.1"
 167         )
 168
 169       uploads_dir =
 170         get_option(
 171           options,
 172           :uploads_dir,
 173           "What directory should media uploads go in (when using the local uploader)?",
 174           Pleroma.Config.get([Pleroma.Uploaders.Local, :uploads])
 175         )
 176
 177       static_dir =
 178         get_option(
 179           options,
 180           :static_dir,
 181           "What directory should custom public files be read from (custom emojis, frontend bundle overrides, robots.txt, etc.)?",
 182           Pleroma.Config.get([:instance, :static_dir])
 183         )
 184
 185       secret = :crypto.strong_rand_bytes(64) |> Base.encode64() |> binary_part(0, 64)
 186       signing_salt = :crypto.strong_rand_bytes(8) |> Base.encode64() |> binary_part(0, 8)
 187       {web_push_public_key, web_push_private_key} = :crypto.generate_key(:ecdh, :prime256v1)
 188       template_dir = Application.app_dir(:pleroma, "priv") <> "/templates"
 189
 190       result_config =
 191         EEx.eval_file(
 192           template_dir <> "/sample_config.eex",
 193           domain: domain,
 194           port: port,
 195           email: email,
 196           notify_email: notify_email,
 197           name: name,
 198           dbhost: dbhost,
 199           dbname: dbname,
 200           dbuser: dbuser,
 201           dbpass: dbpass,
 202           secret: secret,
 203           signing_salt: signing_salt,
 204           web_push_public_key: Base.url_encode64(web_push_public_key, padding: false),
 205           web_push_private_key: Base.url_encode64(web_push_private_key, padding: false),
 206           db_configurable?: db_configurable?,
 207           static_dir: static_dir,
 208           uploads_dir: uploads_dir,
 209           rum_enabled: rum_enabled,
 210           listen_ip: listen_ip,
 211           listen_port: listen_port
 212         )
 213
 214       result_psql =
 215         EEx.eval_file(
 216           template_dir <> "/sample_psql.eex",
 217           dbname: dbname,
 218           dbuser: dbuser,
 219           dbpass: dbpass,
 220           rum_enabled: rum_enabled
 221         )
 222
 223       shell_info("Writing config to #{config_path}.")
 224
 225       File.write(config_path, result_config)
 226       shell_info("Writing the postgres script to #{psql_path}.")
 227       File.write(psql_path, result_psql)
 228
 229       write_robots_txt(indexable, template_dir)
 230
 231       shell_info(
 232         "\n All files successfully written! Refer to the installation instructions for your platform for next steps"
 233       )
 234     else
 235       shell_error(
 236         "The task would have overwritten the following files:\n" <>
 237           (Enum.map(paths, &"- #{&1}\n") |> Enum.join("")) <>
 238           "Rerun with `--force` to overwrite them."
 239       )
 240     end
 241   end
 242
 243   defp write_robots_txt(indexable, template_dir) do
 244     robots_txt =
 245       EEx.eval_file(
 246         template_dir <> "/robots_txt.eex",
 247         indexable: indexable
 248       )
 249
 250     static_dir = Pleroma.Config.get([:instance, :static_dir], "instance/static/")
 251
 252     unless File.exists?(static_dir) do
 253       File.mkdir_p!(static_dir)
 254     end
 255
 256     robots_txt_path = Path.join(static_dir, "robots.txt")
 257
 258     if File.exists?(robots_txt_path) do
 259       File.cp!(robots_txt_path, "#{robots_txt_path}.bak")
 260       shell_info("Backing up existing robots.txt to #{robots_txt_path}.bak")
 261     end
 262
 263     File.write(robots_txt_path, robots_txt)
 264     shell_info("Writing #{robots_txt_path}.")
 265   end
 266 end