From f6372b245a2d65cf1c225adfe7bf822094cb4e1e Mon Sep 17 00:00:00 2001 From: Roger Braun Date: Tue, 31 Oct 2017 14:46:53 +0100 Subject: Small readme update. --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 12efb681b..78be3d2d5 100644 --- a/README.md +++ b/README.md @@ -6,12 +6,13 @@ Pleroma is an OStatus-compatible social networking server written in Elixir, com For clients it supports both the GNU Social API with Qvitter extensions and the Mastodon client API. -Mobile clients that are known to work: +Mobile clients that are known to work well: * Twidere * Tusky * Pawoo (Android) * Subway Tooter +* Amaroq (iOS) No release has been made yet, but several servers have been online for months already. If you want to run your own server, feel free to contact us at @lain@pleroma.soykaf.com or in our dev chat at https://matrix.heldscal.la/#/room/#pleromafe:matrix.heldscal.la. -- cgit v1.2.3 From f3083ab18ef81075b23aa482d31df7fd84f0c551 Mon Sep 17 00:00:00 2001 From: Roger Braun Date: Tue, 31 Oct 2017 18:51:51 +0100 Subject: Update README. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 78be3d2d5..fc3d07e03 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Mobile clients that are known to work well: * Twidere * Tusky -* Pawoo (Android) +* Pawoo (Android + iOS) * Subway Tooter * Amaroq (iOS) -- cgit v1.2.3 From c877583a4fc872410b9d0202e7092b17666ba409 Mon Sep 17 00:00:00 2001 From: Roger Braun Date: Tue, 31 Oct 2017 18:56:04 +0100 Subject: Update README. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index fc3d07e03..339f8cc69 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,7 @@ Elixir will also require `make` and probably other related software for building ### 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_. + * 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_. We _ONLY_ support _HTTPS_ deployments in production. You can use basic http for local dev, but _NEVER USE IT_ on an actual instance. Create the file `config/dev.secret.exs`, add these lines at the end of the file: -- cgit v1.2.3 From d1c126ac98ff1664fa0491145b428212829619a0 Mon Sep 17 00:00:00 2001 From: eal Date: Mon, 6 Nov 2017 22:22:36 +0200 Subject: Update README. --- README.md | 1 + 1 file changed, 1 insertion(+) (limited to 'README.md') diff --git a/README.md b/README.md index 339f8cc69..cb91f0b48 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,7 @@ Mobile clients that are known to work well: * Pawoo (Android + iOS) * Subway Tooter * Amaroq (iOS) +* Tootdon (Android + iOS) No release has been made yet, but several servers have been online for months already. If you want to run your own server, feel free to contact us at @lain@pleroma.soykaf.com or in our dev chat at https://matrix.heldscal.la/#/room/#pleromafe:matrix.heldscal.la. -- cgit v1.2.3 From 312d389f560dfb051c8d006c9a1e0cf22e1473f8 Mon Sep 17 00:00:00 2001 From: eal Date: Tue, 14 Nov 2017 16:15:03 +0200 Subject: Add links to API documentation. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index cb91f0b48..ff98ae1c7 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Pleroma is an OStatus-compatible social networking server written in Elixir, compatible with GNU Social and Mastodon. It is high-performance and can run on small devices like a Raspberry Pi. -For clients it supports both the GNU Social API with Qvitter extensions and the Mastodon client API. +For clients it supports both the [GNU Social API with Qvitter extensions](https://twitter-api.readthedocs.io/en/latest/index.html) and the [Mastodon client API](https://github.com/tootsuite/documentation/blob/master/Using-the-API/API.md). Mobile clients that are known to work well: -- cgit v1.2.3 From bcc4e73e51fb59c1cf924cdef8ccf317bc3971e9 Mon Sep 17 00:00:00 2001 From: lambda Date: Wed, 22 Nov 2017 13:42:27 +0000 Subject: Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index ff98ae1c7..31d2a2754 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ Mobile clients that are known to work well: * Amaroq (iOS) * Tootdon (Android + iOS) -No release has been made yet, but several servers have been online for months already. If you want to run your own server, feel free to contact us at @lain@pleroma.soykaf.com or in our dev chat at https://matrix.heldscal.la/#/room/#pleromafe:matrix.heldscal.la. +No release has been made yet, but several servers have been online for months already. If you want to run your own server, feel free to contact us at @lain@pleroma.soykaf.com or in our dev chat at #pleroma on freenode or via matrix at https://matrix.heldscal.la/#/room/#freenode_#pleroma:matrix.org. ## Installation -- cgit v1.2.3 From 44dc6948823f5e26ede427d3348fef72129f3f4d Mon Sep 17 00:00:00 2001 From: Lain Iwakura Date: Thu, 23 Nov 2017 16:22:20 +0100 Subject: Add configuration generation tool, update readme. --- README.md | 52 ++-------------------------------------------------- 1 file changed, 2 insertions(+), 50 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 31d2a2754..57343c151 100644 --- a/README.md +++ b/README.md @@ -25,57 +25,9 @@ No release has been made yet, but several servers have been online for months al * Elixir version 1.4 or newer * Build-essential tools -#### Installing dependencies on Debian system -PostgreSQL 9.6 should be available on Debian stable (Jessie) from "main" area. Install it using apt: `apt install postgresql-9.6`. Make sure that older versions are not installed since Debian allows multiple versions to coexist but still runs only one version. +### Configuration -You must install elixir 1.4+ from elixir-lang.org, because Debian repos only have 1.3.x version. You will need to add apt repo to sources.list(.d) and import GPG key. Follow instructions here: https://elixir-lang.org/install.html#unix-and-unix-like (See "Ubuntu or Debian 7"). This should be valid until Debian updates elixir in their repositories. Package you want is named `elixir`, so install it using `apt install elixir` - -Elixir will also require `make` and probably other related software for building dependencies - in case you don't have them, get them via `apt install build-essential` - -### Preparation - - * You probably want application to run as separte user - so create a new one: `adduser pleroma`, you can login as it via `su pleroma` - * Clone the git repository into new user's dir (clone as the pleroma user to avoid permissions errors) - * Again, as new user, install dependencies with `mix deps.get` if it asks you to install "hex" - agree to that. - -### Database setup - - * Create a database user and database for pleroma - * Open psql shell as postgres user: (as root) `su postgres -c psql` - * Create a new PostgreSQL user: - - ```sql - \c pleroma_dev - CREATE user pleroma; - ALTER user pleroma with encrypted password ''; - GRANT ALL ON ALL tables IN SCHEMA public TO pleroma; - GRANT ALL ON ALL sequences IN SCHEMA public TO pleroma; - ``` - - * 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`. - -### 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_. We _ONLY_ support _HTTPS_ deployments in production. You can use basic http for local dev, but _NEVER USE IT_ on an actual instance. - - Create the file `config/dev.secret.exs`, add these lines at the end of the file: - - ```elixir - config :pleroma, Pleroma.Web.Endpoint, - url: [host: "example.tld", scheme: "https", port: 443] - ``` - - 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" - ``` + * 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. * 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. -- cgit v1.2.3 From ecf109a0fe65c0221a2d9077156fb4af322f847a Mon Sep 17 00:00:00 2001 From: Lain Iwakura Date: Thu, 23 Nov 2017 16:35:03 +0100 Subject: Add mix deps.get back to readme. --- README.md | 2 ++ 1 file changed, 2 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 57343c151..899e2ce48 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,8 @@ No release has been made yet, but several servers have been online for months al ### 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`. 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/ -- cgit v1.2.3 From 386c1307696b2945ef2289d25e7f61cbf690ba5c Mon Sep 17 00:00:00 2001 From: Lain Iwakura Date: Thu, 23 Nov 2017 16:41:09 +0100 Subject: More readme updates. --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) (limited to 'README.md') 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. -- cgit v1.2.3 From f86fca682a1a4ca71169003b714cc3ad104c411d Mon Sep 17 00:00:00 2001 From: Partial name Date: Sat, 25 Nov 2017 02:42:39 +0000 Subject: fix mix typo in README.md $ mix phx.serve ** (Mix) The task "phx.serve" could not be found. Did you mean "phx.server"? $ mix phx.server [info] Running Pleroma.Web.Endpoint with Cowboy using http://0.0.0.0:4000 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 5fd08e2f2..b07593f67 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ No release has been made yet, but several servers have been online for months al * 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. + * You can check if your instance is configured correctly by running it with `mix phx.server` 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. -- cgit v1.2.3 From 0673511d3939c04efd0e3fd350c47b4bfb3e322e Mon Sep 17 00:00:00 2001 From: Henry Jameson Date: Sun, 26 Nov 2017 20:57:49 +0300 Subject: first version of safe DB setup --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) (limited to 'README.md') 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. -- cgit v1.2.3 From 40714031176f28ed1af2ed83f01b1d066badb871 Mon Sep 17 00:00:00 2001 From: Henry Jameson Date: Tue, 28 Nov 2017 00:42:03 +0300 Subject: fixes --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') 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. -- cgit v1.2.3 From 071f518028e20d1f22811d6a10f120bebe26c2ce Mon Sep 17 00:00:00 2001 From: Henry Jameson Date: Mon, 4 Dec 2017 02:01:45 +0300 Subject: reverts config gen --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') 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. -- cgit v1.2.3