From 0673511d3939c04efd0e3fd350c47b4bfb3e322e Mon Sep 17 00:00:00 2001
From: Henry Jameson <me@hjkos.com>
Date: Sun, 26 Nov 2017 20:57:49 +0300
Subject: [PATCH 1/6] first version of safe DB setup
---
README.md | 6 ++----
lib/mix/tasks/generate_config.ex | 13 +++++++++----
lib/mix/tasks/sample_config.eex | 4 ++--
lib/mix/tasks/sample_psql.eex | 6 ++++++
4 files changed, 19 insertions(+), 10 deletions(-)
create mode 100644 lib/mix/tasks/sample_psql.eex
diff --git a/README.md b/README.md
index b07593f67..01a56d6bf 100644
--- a/README.md
+++ b/README.md
@@ -22,16 +22,14 @@ No release has been made yet, but several servers have been online for months al
### Dependencies
* Postgresql version 9.6 or newer
-* Elixir version 1.4 or newer
+* Elixir version 1.4 or newer (you will also need erlang-dev, erlang-parsetools, erlang-xmerl packages)
* Build-essential tools
### Configuration
* Run `mix deps.get` to install elixir dependencies.
- * Run `mix generate_config`. This will ask you a few questions about your instance and generate a configuration file in `config/generated_config.exs`. Check that and copy it to either `config/dev.secret.exs` or `config/prod.secret.exs`.
-
- * Configure your database settings in `{dev,prod}.secret.exs` and either create the database with psql or run `mix ecto.create`.
+ * Run `mix generate_config`. This will ask you a few questions about your instance and generate a configuration file in `config/dev.secret.exs` and `config/prod.secret.exs`. It will also create a `config/db_setup.psql`, which you need to run as PostgreSQL superuser (i.e. `sudo su - postgre -c "psql -f config/db_setup.psql"`). It will setup a pleroma db user, database and will setup needed extensions that need to be set up once as superuser.
* Run `mix ecto.migrate` to run the database migrations. You will have to do this again after certain updates.
diff --git a/lib/mix/tasks/generate_config.ex b/lib/mix/tasks/generate_config.ex
index b3bc14d5b..f9399b114 100644
--- a/lib/mix/tasks/generate_config.ex
+++ b/lib/mix/tasks/generate_config.ex
@@ -4,14 +4,19 @@ defmodule Mix.Tasks.GenerateConfig do
@shortdoc "Generates a new config"
def run(_) do
IO.puts("Answer a few questions to generate a new config\n")
- IO.puts("--- THIS WILL OVERWRITE YOUR config/generated_config.exs! ---\n")
+ IO.puts("--- THIS WILL OVERWRITE YOUR config/dev.secret.exs AND config/prod.secret.exs! ---\n")
domain = IO.gets("What is your domain name? (e.g. pleroma.soykaf.com): ") |> String.trim
name = IO.gets("What is the name of your instance? (e.g. Pleroma/Soykaf): ") |> String.trim
email = IO.gets("What's your admin email address: ") |> String.trim
secret = :crypto.strong_rand_bytes(64) |> Base.encode64 |> binary_part(0, 64)
+ dbpass = :crypto.strong_rand_bytes(64) |> Base.encode64 |> binary_part(0, 64)
- result = EEx.eval_file("lib/mix/tasks/sample_config.eex", [domain: domain, email: email, name: name, secret: secret])
- IO.puts("\nWriting config to config/generated_config.exs.\n\nCheck it and configure your database, then copy it to either config/dev.secret.exs or config/prod.secret.exs")
- File.write("config/generated_config.exs", result)
+ resultSql = EEx.eval_file("lib/mix/tasks/sample_psql.eex", [dbpass: dbpass])
+ result = EEx.eval_file("lib/mix/tasks/sample_config.eex", [domain: domain, email: email, name: name, secret: secret, dbpass: dbpass])
+ IO.puts("\nWriting config to config/dev.secret.exs and config/prod.secret.exs")
+ IO.puts("\nWriting setup_db.psql, please run it as postgre superuser, i.e. su - postgre -c 'psql -f setup_db.psql'")
+ File.write("config/dev.secret.exs", result)
+ File.write("config/prod.secret.exs", result)
+ File.write("config/setup_db.psql", resultSql)
end
end
diff --git a/lib/mix/tasks/sample_config.eex b/lib/mix/tasks/sample_config.eex
index 62a9804fe..85a7c554e 100644
--- a/lib/mix/tasks/sample_config.eex
+++ b/lib/mix/tasks/sample_config.eex
@@ -13,8 +13,8 @@ config :pleroma, :instance,
# Configure your database
config :pleroma, Pleroma.Repo,
adapter: Ecto.Adapters.Postgres,
- username: "postgres",
- password: "postgres",
+ username: "pleroma",
+ password: "<%= dbpass %>",
database: "pleroma_dev",
hostname: "localhost",
pool_size: 10
diff --git a/lib/mix/tasks/sample_psql.eex b/lib/mix/tasks/sample_psql.eex
new file mode 100644
index 000000000..5353fa216
--- /dev/null
+++ b/lib/mix/tasks/sample_psql.eex
@@ -0,0 +1,6 @@
+CREATE USER pleroma WITH ENCRYPTED PASSWORD '<%= dbpass %>' CREATEDB;
+CREATE DATABASE pleroma_dev;
+ALTER DATABASE pleroma_dev OWNER TO pleroma;
+\c pleroma_dev;
+--Extensions made by ecto.migrate that need superuser access
+CREATE EXTENSION citext;
From 40714031176f28ed1af2ed83f01b1d066badb871 Mon Sep 17 00:00:00 2001
From: Henry Jameson <me@hjkos.com>
Date: Tue, 28 Nov 2017 00:42:03 +0300
Subject: [PATCH 2/6] fixes
---
README.md | 2 +-
lib/mix/tasks/generate_config.ex | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 01a56d6bf..175b90f88 100644
--- a/README.md
+++ b/README.md
@@ -29,7 +29,7 @@ No release has been made yet, but several servers have been online for months al
* Run `mix deps.get` to install elixir dependencies.
- * Run `mix generate_config`. This will ask you a few questions about your instance and generate a configuration file in `config/dev.secret.exs` and `config/prod.secret.exs`. It will also create a `config/db_setup.psql`, which you need to run as PostgreSQL superuser (i.e. `sudo su - postgre -c "psql -f config/db_setup.psql"`). It will setup a pleroma db user, database and will setup needed extensions that need to be set up once as superuser.
+ * Run `mix generate_config`. This will ask you a few questions about your instance and generate a configuration file in `config/dev.secret.exs` and `config/prod.secret.exs`. It will also create a `config/setup_db.psql`, which you need to run as PostgreSQL superuser (i.e. `sudo su postgres -c "psql -f config/setup_db.psql"`). It will setup a pleroma db user, database and will setup needed extensions that need to be set up once as superuser.
* Run `mix ecto.migrate` to run the database migrations. You will have to do this again after certain updates.
diff --git a/lib/mix/tasks/generate_config.ex b/lib/mix/tasks/generate_config.ex
index f9399b114..d06cc1a84 100644
--- a/lib/mix/tasks/generate_config.ex
+++ b/lib/mix/tasks/generate_config.ex
@@ -14,7 +14,7 @@ defmodule Mix.Tasks.GenerateConfig do
resultSql = EEx.eval_file("lib/mix/tasks/sample_psql.eex", [dbpass: dbpass])
result = EEx.eval_file("lib/mix/tasks/sample_config.eex", [domain: domain, email: email, name: name, secret: secret, dbpass: dbpass])
IO.puts("\nWriting config to config/dev.secret.exs and config/prod.secret.exs")
- IO.puts("\nWriting setup_db.psql, please run it as postgre superuser, i.e. su - postgre -c 'psql -f setup_db.psql'")
+ IO.puts("\nWriting setup_db.psql, please run it as postgre superuser, i.e. su - postgres -c 'psql -f config/setup_db.psql'")
File.write("config/dev.secret.exs", result)
File.write("config/prod.secret.exs", result)
File.write("config/setup_db.psql", resultSql)
From a884e08271ec29ed42011c450655861b870f4745 Mon Sep 17 00:00:00 2001
From: Henry Jameson <me@hjkos.com>
Date: Tue, 28 Nov 2017 00:44:14 +0300
Subject: [PATCH 3/6] fix
---
lib/mix/tasks/generate_config.ex | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/lib/mix/tasks/generate_config.ex b/lib/mix/tasks/generate_config.ex
index d06cc1a84..95cf394be 100644
--- a/lib/mix/tasks/generate_config.ex
+++ b/lib/mix/tasks/generate_config.ex
@@ -14,7 +14,7 @@ defmodule Mix.Tasks.GenerateConfig do
resultSql = EEx.eval_file("lib/mix/tasks/sample_psql.eex", [dbpass: dbpass])
result = EEx.eval_file("lib/mix/tasks/sample_config.eex", [domain: domain, email: email, name: name, secret: secret, dbpass: dbpass])
IO.puts("\nWriting config to config/dev.secret.exs and config/prod.secret.exs")
- IO.puts("\nWriting setup_db.psql, please run it as postgre superuser, i.e. su - postgres -c 'psql -f config/setup_db.psql'")
+ IO.puts("\nWriting setup_db.psql, please run it as postgre superuser, i.e.: sudo su postgres -c 'psql -f config/setup_db.psql'")
File.write("config/dev.secret.exs", result)
File.write("config/prod.secret.exs", result)
File.write("config/setup_db.psql", resultSql)
From 071f518028e20d1f22811d6a10f120bebe26c2ce Mon Sep 17 00:00:00 2001
From: Henry Jameson <me@hjkos.com>
Date: Mon, 4 Dec 2017 02:01:45 +0300
Subject: [PATCH 4/6] reverts config gen
---
README.md | 2 +-
lib/mix/tasks/generate_config.ex | 8 ++++----
2 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
index 175b90f88..664b8b475 100644
--- a/README.md
+++ b/README.md
@@ -29,7 +29,7 @@ No release has been made yet, but several servers have been online for months al
* Run `mix deps.get` to install elixir dependencies.
- * Run `mix generate_config`. This will ask you a few questions about your instance and generate a configuration file in `config/dev.secret.exs` and `config/prod.secret.exs`. It will also create a `config/setup_db.psql`, which you need to run as PostgreSQL superuser (i.e. `sudo su postgres -c "psql -f config/setup_db.psql"`). It will setup a pleroma db user, database and will setup needed extensions that need to be set up once as superuser.
+ * Run `mix generate_config`. This will ask you a few questions about your instance and generate a configuration file in `config/generated_config.exs`. Check that and copy it to either `config/dev.secret.exs` or `config/prod.secret.exs`. It will also create a `config/setup_db.psql`, which you need to run as PostgreSQL superuser (i.e. `sudo su postgres -c "psql -f config/setup_db.psql"`). It will setup a pleroma db user, database and will setup needed extensions that need to be set up once as superuser.
* Run `mix ecto.migrate` to run the database migrations. You will have to do this again after certain updates.
diff --git a/lib/mix/tasks/generate_config.ex b/lib/mix/tasks/generate_config.ex
index 95cf394be..f20f93e4d 100644
--- a/lib/mix/tasks/generate_config.ex
+++ b/lib/mix/tasks/generate_config.ex
@@ -4,7 +4,7 @@ defmodule Mix.Tasks.GenerateConfig do
@shortdoc "Generates a new config"
def run(_) do
IO.puts("Answer a few questions to generate a new config\n")
- IO.puts("--- THIS WILL OVERWRITE YOUR config/dev.secret.exs AND config/prod.secret.exs! ---\n")
+ IO.puts("--- THIS WILL OVERWRITE YOUR config/generated_config.exs! ---\n")
domain = IO.gets("What is your domain name? (e.g. pleroma.soykaf.com): ") |> String.trim
name = IO.gets("What is the name of your instance? (e.g. Pleroma/Soykaf): ") |> String.trim
email = IO.gets("What's your admin email address: ") |> String.trim
@@ -13,10 +13,10 @@ defmodule Mix.Tasks.GenerateConfig do
resultSql = EEx.eval_file("lib/mix/tasks/sample_psql.eex", [dbpass: dbpass])
result = EEx.eval_file("lib/mix/tasks/sample_config.eex", [domain: domain, email: email, name: name, secret: secret, dbpass: dbpass])
- IO.puts("\nWriting config to config/dev.secret.exs and config/prod.secret.exs")
+
+ IO.puts("\nWriting config to config/generated_config.exs.\n\nCheck it and configure your database, then copy it to either config/dev.secret.exs or config/prod.secret.exs")
+ File.write("config/generated_config.exs", result)
IO.puts("\nWriting setup_db.psql, please run it as postgre superuser, i.e.: sudo su postgres -c 'psql -f config/setup_db.psql'")
- File.write("config/dev.secret.exs", result)
- File.write("config/prod.secret.exs", result)
File.write("config/setup_db.psql", resultSql)
end
end
From 6b60f5f64ab9d7598ccdb2545b0e5560991ff5f3 Mon Sep 17 00:00:00 2001
From: Henry Jameson <me@hjkos.com>
Date: Mon, 4 Dec 2017 02:06:05 +0300
Subject: [PATCH 5/6] made psql script compatible with migrations or
generate_config reruns
---
lib/mix/tasks/sample_psql.eex | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)
diff --git a/lib/mix/tasks/sample_psql.eex b/lib/mix/tasks/sample_psql.eex
index 5353fa216..9eb7f65b0 100644
--- a/lib/mix/tasks/sample_psql.eex
+++ b/lib/mix/tasks/sample_psql.eex
@@ -1,6 +1,8 @@
-CREATE USER pleroma WITH ENCRYPTED PASSWORD '<%= dbpass %>' CREATEDB;
-CREATE DATABASE pleroma_dev;
+CREATE USER IF NOT EXISTS pleroma WITH ENCRYPTED PASSWORD '<%= dbpass %>' CREATEDB;
+-- in case someone runs this second time accidentally
+ALTER USER pleroma WITH ENCRYPTED PASSWORD '<%= dbpass %>' CREATEDB;
+CREATE DATABASE IF NOT EXISTS pleroma_dev;
ALTER DATABASE pleroma_dev OWNER TO pleroma;
\c pleroma_dev;
--Extensions made by ecto.migrate that need superuser access
-CREATE EXTENSION citext;
+CREATE EXTENSION IF NOT EXISTS citext;
From 964e2dd2f055207ac8fa7f8b3612e50860a0472a Mon Sep 17 00:00:00 2001
From: Henry Jameson <me@hjkos.com>
Date: Mon, 4 Dec 2017 04:06:52 +0300
Subject: [PATCH 6/6] unfuck
---
lib/mix/tasks/sample_psql.eex | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/lib/mix/tasks/sample_psql.eex b/lib/mix/tasks/sample_psql.eex
index 9eb7f65b0..18e322efc 100644
--- a/lib/mix/tasks/sample_psql.eex
+++ b/lib/mix/tasks/sample_psql.eex
@@ -1,7 +1,7 @@
-CREATE USER IF NOT EXISTS pleroma WITH ENCRYPTED PASSWORD '<%= dbpass %>' CREATEDB;
+CREATE USER pleroma WITH ENCRYPTED PASSWORD '<%= dbpass %>' CREATEDB;
-- in case someone runs this second time accidentally
ALTER USER pleroma WITH ENCRYPTED PASSWORD '<%= dbpass %>' CREATEDB;
-CREATE DATABASE IF NOT EXISTS pleroma_dev;
+CREATE DATABASE pleroma_dev;
ALTER DATABASE pleroma_dev OWNER TO pleroma;
\c pleroma_dev;
--Extensions made by ecto.migrate that need superuser access