summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRoger Braun <rbraun@Bobble.local>2017-09-15 14:44:52 +0200
committerRoger Braun <rbraun@Bobble.local>2017-09-15 14:44:52 +0200
commiteb248cf8aa92316269a77d1234234a536627cbf8 (patch)
tree579250507c7df5c0e055b97514abb1ca21180c78
parentc20530e7080e7c37f33a944933a5a84c95f0e387 (diff)
downloadpleroma-eb248cf8aa92316269a77d1234234a536627cbf8.tar.gz
pleroma-eb248cf8aa92316269a77d1234234a536627cbf8.zip
Document options in README
-rw-r--r--README.md13
1 files changed, 11 insertions, 2 deletions
diff --git a/README.md b/README.md
index a3eb06896..36b4c5133 100644
--- a/README.md
+++ b/README.md
@@ -41,14 +41,15 @@ Elixir will also require `make` and probably other related software for building
GRANT ALL ON ALL sequences IN SCHEMA public TO pleroma;
```
- * Change password in `config/dev.exs`, and change user to `"pleroma"` (line like `username: "postgres"`)
+ * Create `config/dev.secret.exs` and copy the database settings from `dev.exs` there.
+ * Change password in `config/dev.secret.exs`, and change user to `"pleroma"` (line like `username: "postgres"`)
* Create and update your database with `mix ecto.create && mix ecto.migrate`. If it gives errors, try running again, this is a known issue.
### Some additional configuration
* You will need to let pleroma instance to know what hostname/url it's running on. _THIS IS THE MOST IMPORTANT STEP. GET THIS WRONG AND YOU'LL HAVE TO RESET YOUR DATABASE_.
- In file `config/dev.exs`, add these lines at the end of the file:
+ Create the file `config/dev.secret.exs`, add these lines at the end of the file:
```elixir
config :pleroma, Pleroma.Web.Endpoint,
@@ -57,6 +58,14 @@ Elixir will also require `make` and probably other related software for building
replacing `example.tld` with your (sub)domain
+ * You should also setup your site name and admin email address. Look at config.exs for more available options.
+
+ ```elixir
+ config :pleroma, :instance,
+ name: "My great instance",
+ email: "someone@example.com"
+ ```
+
* The common and convenient way for adding HTTPS is by using Nginx as a reverse proxy. You can look at example Nginx configuration in `installation/pleroma.nginx`. If you need TLS/SSL certificates for HTTPS, you can look get some for free with letsencrypt: https://letsencrypt.org/
On Debian you can use `certbot` package and command to manage letsencrypt certificates.