X-Git-Url: http://git.squeep.com/?a=blobdiff_plain;f=lib%2Fmix%2Ftasks%2Fpleroma%2Finstance.ex;h=44e49cb69d00b89e4a890304a5e00424763387a2;hb=3b48876cf02b35af953bf463987e42675a9e6180;hp=05653c238479dc47eb2bdf6b7bb14b77714324e7;hpb=57c71f846880083d8a78247f433713963c284ab9;p=akkoma diff --git a/lib/mix/tasks/pleroma/instance.ex b/lib/mix/tasks/pleroma/instance.ex index 05653c238..44e49cb69 100644 --- a/lib/mix/tasks/pleroma/instance.ex +++ b/lib/mix/tasks/pleroma/instance.ex @@ -1,6 +1,10 @@ +# Pleroma: A lightweight social networking server +# Copyright © 2017-2018 Pleroma Authors +# SPDX-License-Identifier: AGPL-3.0-only + defmodule Mix.Tasks.Pleroma.Instance do use Mix.Task - alias Pleroma.{Repo, User} + alias Mix.Tasks.Pleroma.Common @shortdoc "Manages Pleroma instance" @moduledoc """ @@ -8,7 +12,7 @@ defmodule Mix.Tasks.Pleroma.Instance do ## Generate a new instance config. - mix pleroma.instance new [OPTION...] + mix pleroma.instance gen [OPTION...] If any options are left unspecified, you will be prompted interactively @@ -20,13 +24,16 @@ defmodule Mix.Tasks.Pleroma.Instance do - `--domain DOMAIN` - the domain of your instance - `--instance-name INSTANCE_NAME` - the name of your instance - `--admin-email ADMIN_EMAIL` - the email address of the instance admin + - `--notify-email NOTIFY_EMAIL` - email address for notifications - `--dbhost HOSTNAME` - the hostname of the PostgreSQL database to use - `--dbname DBNAME` - the name of the database to use - `--dbuser DBUSER` - the user (aka role) to use for the database connection - `--dbpass DBPASS` - the password to use for the database connection + - `--indexable Y/N` - Allow/disallow indexing site by search engines + - `--db-configurable Y/N` - Allow/disallow configuring instance from admin part """ - def run(["new" | rest]) do + def run(["gen" | rest]) do {options, [], []} = OptionParser.parse( rest, @@ -37,10 +44,13 @@ defmodule Mix.Tasks.Pleroma.Instance do domain: :string, instance_name: :string, admin_email: :string, + notify_email: :string, dbhost: :string, dbname: :string, dbuser: :string, - dbpass: :string + dbpass: :string, + indexable: :string, + db_configurable: :string ], aliases: [ o: :output, @@ -57,25 +67,58 @@ defmodule Mix.Tasks.Pleroma.Instance do will_overwrite = Enum.filter(paths, &File.exists?/1) proceed? = Enum.empty?(will_overwrite) or Keyword.get(options, :force, false) - unless not proceed? do - domain = - get_option( + if proceed? do + [domain, port | _] = + String.split( + Common.get_option( + options, + :domain, + "What domain will your instance use? (e.g pleroma.soykaf.com)" + ), + ":" + ) ++ [443] + + name = + Common.get_option( options, - :domain, - "What domain will your instance use? (e.g pleroma.soykaf.com)" + :instance_name, + "What is the name of your instance? (e.g. Pleroma/Soykaf)" ) - name = - get_option(options, :name, "What is the name of your instance? (e.g. Pleroma/Soykaf)") + email = Common.get_option(options, :admin_email, "What is your admin email address?") + + notify_email = + Common.get_option( + options, + :notify_email, + "What email address do you want to use for sending email notifications?", + email + ) + + indexable = + Common.get_option( + options, + :indexable, + "Do you want search engines to index your site? (y/n)", + "y" + ) === "y" - email = get_option(options, :admin_email, "What is your admin email address?") + db_configurable? = + Common.get_option( + options, + :db_configurable, + "Do you want to be able to configure instance from admin part? (y/n)", + "y" + ) === "y" - dbhost = get_option(options, :dbhost, "What is the hostname of your database?", "localhost") + dbhost = + Common.get_option(options, :dbhost, "What is the hostname of your database?", "localhost") - dbname = get_option(options, :dbname, "What is the name of your database?", "pleroma_dev") + dbname = + Common.get_option(options, :dbname, "What is the name of your database?", "pleroma_dev") dbuser = - get_option( + Common.get_option( options, :dbuser, "What is the user used to connect to your database?", @@ -83,7 +126,7 @@ defmodule Mix.Tasks.Pleroma.Instance do ) dbpass = - get_option( + Common.get_option( options, :dbpass, "What is the password used to connect to your database?", @@ -92,19 +135,27 @@ defmodule Mix.Tasks.Pleroma.Instance do ) secret = :crypto.strong_rand_bytes(64) |> Base.encode64() |> binary_part(0, 64) + signing_salt = :crypto.strong_rand_bytes(8) |> Base.encode64() |> binary_part(0, 8) + {web_push_public_key, web_push_private_key} = :crypto.generate_key(:ecdh, :prime256v1) result_config = EEx.eval_file( "sample_config.eex" |> Path.expand(__DIR__), domain: domain, + port: port, email: email, + notify_email: notify_email, name: name, dbhost: dbhost, dbname: dbname, dbuser: dbuser, dbpass: dbpass, version: Pleroma.Mixfile.project() |> Keyword.get(:version), - secret: secret + secret: secret, + signing_salt: signing_salt, + web_push_public_key: Base.url_encode64(web_push_public_key, padding: false), + web_push_private_key: Base.url_encode64(web_push_private_key, padding: false), + db_configurable?: db_configurable? ) result_psql = @@ -115,29 +166,31 @@ defmodule Mix.Tasks.Pleroma.Instance do dbpass: dbpass ) - Mix.shell().info( + Common.shell_info( "Writing config to #{config_path}. You should rename it to config/prod.secret.exs or config/dev.secret.exs." ) File.write(config_path, result_config) - Mix.shell().info("Writing #{psql_path}.") + Common.shell_info("Writing #{psql_path}.") File.write(psql_path, result_psql) - Mix.shell().info( + write_robots_txt(indexable) + + Common.shell_info( "\n" <> """ To get started: 1. Verify the contents of the generated files. - 2. Run `sudo -u postgres psql -f #{escape_sh_path(psql_path)}`. + 2. Run `sudo -u postgres psql -f #{Common.escape_sh_path(psql_path)}`. """ <> if config_path in ["config/dev.secret.exs", "config/prod.secret.exs"] do "" else - "3. Run `mv #{escape_sh_path(config_path)} 'config/prod.secret.exs'`." + "3. Run `mv #{Common.escape_sh_path(config_path)} 'config/prod.secret.exs'`." end ) else - Mix.shell().error( + Common.shell_error( "The task would have overwritten the following files:\n" <> (Enum.map(paths, &"- #{&1}\n") |> Enum.join("")) <> "Rerun with `--force` to overwrite them." @@ -145,22 +198,27 @@ defmodule Mix.Tasks.Pleroma.Instance do end end + defp write_robots_txt(indexable) do + robots_txt = + EEx.eval_file( + Path.expand("robots_txt.eex", __DIR__), + indexable: indexable + ) - defp escape_sh_path(path) do - ~S(') <> String.replace(path, ~S('), ~S(\')) <> ~S(') - end + static_dir = Pleroma.Config.get([:instance, :static_dir], "instance/static/") - defp get_option(options, opt, prompt, def \\ nil, defname \\ nil) do - Keyword.get(options, opt) || - case Mix.shell().prompt("#{prompt} [#{defname || def}]") do - "\n" -> - case def do - nil -> get_option(options, opt, prompt, def) - def -> def - end + unless File.exists?(static_dir) do + File.mkdir_p!(static_dir) + end + + robots_txt_path = Path.join(static_dir, "robots.txt") + + if File.exists?(robots_txt_path) do + File.cp!(robots_txt_path, "#{robots_txt_path}.bak") + Common.shell_info("Backing up existing robots.txt to #{robots_txt_path}.bak") + end - opt -> - opt |> String.trim() - end + File.write(robots_txt_path, robots_txt) + Common.shell_info("Writing #{robots_txt_path}.") end end