Remove the getting started steps from pleroma.instance gen task
[akkoma] / 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 - `--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.)
36 """
37
38 def run(["gen" | rest]) do
39 {options, [], []} =
40 OptionParser.parse(
41 rest,
42 strict: [
43 force: :boolean,
44 output: :string,
45 output_psql: :string,
46 domain: :string,
47 instance_name: :string,
48 admin_email: :string,
49 notify_email: :string,
50 dbhost: :string,
51 dbname: :string,
52 dbuser: :string,
53 dbpass: :string,
54 indexable: :string,
55 db_configurable: :string,
56 uploads_dir: :string,
57 static_dir: :string
58 ],
59 aliases: [
60 o: :output,
61 f: :force
62 ]
63 )
64
65 paths =
66 [config_path, psql_path] = [
67 Keyword.get(options, :output, "config/generated_config.exs"),
68 Keyword.get(options, :output_psql, "config/setup_db.psql")
69 ]
70
71 will_overwrite = Enum.filter(paths, &File.exists?/1)
72 proceed? = Enum.empty?(will_overwrite) or Keyword.get(options, :force, false)
73
74 if proceed? do
75 [domain, port | _] =
76 String.split(
77 get_option(
78 options,
79 :domain,
80 "What domain will your instance use? (e.g pleroma.soykaf.com)"
81 ),
82 ":"
83 ) ++ [443]
84
85 name =
86 get_option(
87 options,
88 :instance_name,
89 "What is the name of your instance? (e.g. Pleroma/Soykaf)"
90 )
91
92 email = get_option(options, :admin_email, "What is your admin email address?")
93
94 notify_email =
95 get_option(
96 options,
97 :notify_email,
98 "What email address do you want to use for sending email notifications?",
99 email
100 )
101
102 indexable =
103 get_option(
104 options,
105 :indexable,
106 "Do you want search engines to index your site? (y/n)",
107 "y"
108 ) === "y"
109
110 db_configurable? =
111 get_option(
112 options,
113 :db_configurable,
114 "Do you want to store the configuration in the database (allows controlling it from admin-fe)? (y/n)",
115 "n"
116 ) === "y"
117
118 dbhost = get_option(options, :dbhost, "What is the hostname of your database?", "localhost")
119
120 dbname = get_option(options, :dbname, "What is the name of your database?", "pleroma")
121
122 dbuser =
123 get_option(
124 options,
125 :dbuser,
126 "What is the user used to connect to your database?",
127 "pleroma"
128 )
129
130 dbpass =
131 get_option(
132 options,
133 :dbpass,
134 "What is the password used to connect to your database?",
135 :crypto.strong_rand_bytes(64) |> Base.encode64() |> binary_part(0, 64),
136 "autogenerated"
137 )
138
139 uploads_dir =
140 get_option(
141 options,
142 :upload_dir,
143 "What directory should media uploads go in (when using the local uploader)?",
144 Pleroma.Config.get([Pleroma.Uploaders.Local, :uploads])
145 )
146
147 static_dir =
148 get_option(
149 options,
150 :static_dir,
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])
153 )
154
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"
159
160 result_config =
161 EEx.eval_file(
162 template_dir <> "/sample_config.eex",
163 domain: domain,
164 port: port,
165 email: email,
166 notify_email: notify_email,
167 name: name,
168 dbhost: dbhost,
169 dbname: dbname,
170 dbuser: dbuser,
171 dbpass: dbpass,
172 secret: secret,
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
179 )
180
181 result_psql =
182 EEx.eval_file(
183 template_dir <> "/sample_psql.eex",
184 dbname: dbname,
185 dbuser: dbuser,
186 dbpass: dbpass
187 )
188
189 shell_info("Writing config to #{config_path}.")
190
191 File.write(config_path, result_config)
192 shell_info("Writing the postgres script to #{psql_path}.")
193 File.write(psql_path, result_psql)
194
195 write_robots_txt(indexable, template_dir)
196
197 shell_info(
198 "\n All files successfully written! Refer to the installation instructions for your platform for next steps"
199 )
200 else
201 shell_error(
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."
205 )
206 end
207 end
208
209 defp write_robots_txt(indexable, template_dir) do
210 robots_txt =
211 EEx.eval_file(
212 template_dir <> "/robots_txt.eex",
213 indexable: indexable
214 )
215
216 static_dir = Pleroma.Config.get([:instance, :static_dir], "instance/static/")
217
218 unless File.exists?(static_dir) do
219 File.mkdir_p!(static_dir)
220 end
221
222 robots_txt_path = Path.join(static_dir, "robots.txt")
223
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")
227 end
228
229 File.write(robots_txt_path, robots_txt)
230 shell_info("Writing #{robots_txt_path}.")
231 end
232 end