aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLain Iwakura <lain@soykaf.club>2017-11-23 16:41:09 +0100
committerLain Iwakura <lain@soykaf.club>2017-11-23 16:41:09 +0100
commit386c1307696b2945ef2289d25e7f61cbf690ba5c (patch)
tree0005efb1435ed13ee5b9b8c3c1f2d09b09c02914 /README.md
parentecf109a0fe65c0221a2d9077156fb4af322f847a (diff)
downloadpleroma-386c1307696b2945ef2289d25e7f61cbf690ba5c.tar.gz
More readme updates.
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/README.md b/README.md
index 899e2ce48..5fd08e2f2 100644
--- a/README.md
+++ b/README.md
@@ -29,7 +29,13 @@ 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/generated_config.exs`. Check that and copy it to either `config/dev.secret.exs` or `config/prod.secret.exs`. You can check if your instance is configured correctly by running it with `mix phx.serve` and checking the instance info endpoint at `/api/v1/instance`. If it shows your uri, name and email correctly, you are configured correctly. If it shows something like `localhost:4000`, your configuration is probably wrong, unless you are running a local development setup.
+ * 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 ecto.migrate` to run the database migrations. You will have to do this again after certain updates.
+
+ * You can check if your instance is configured correctly by running it with `mix phx.serve` and checking the instance info endpoint at `/api/v1/instance`. If it shows your uri, name and email correctly, you are configured correctly. If it shows something like `localhost:4000`, your configuration is probably wrong, unless you are running a local development setup.
* 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.