X-Git-Url: http://git.squeep.com/?a=blobdiff_plain;f=README.md;h=b07593f67c5192d585ccf58bbdc2753e55d82945;hb=a3e68f02330a3c38f1d3f568ad507e5111b82600;hp=72a6fa835244c79a2274ce0da91dbc36fedd37a2;hpb=c6941676ba9546e8ec451f5f289122a26aa7a070;p=akkoma diff --git a/README.md b/README.md index 72a6fa835..b07593f67 100644 --- a/README.md +++ b/README.md @@ -1,96 +1,54 @@ # Pleroma -## Installation - -### Dependencies - -* Postgresql version 9.5 or newer -* Elixir version 1.4 or newer -* NodeJS LTS -* 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, debian allows multiple versions to coexist but still runs only one version. +## About Pleroma -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` +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. -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` +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). -NodeJS is available as `nodejs` package on debian. `apt install nodejs`. Debian stable has 4.8.x version. If that does not work, use nodesource's repo https://github.com/nodesource/distributions#deb - version 5.x confirmed to work. +Mobile clients that are known to work well: -### Preparation +* Twidere +* Tusky +* Pawoo (Android + iOS) +* Subway Tooter +* Amaroq (iOS) +* Tootdon (Android + iOS) - * 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. +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. -### Database preparation - - * You'll need to allow password-based authorisation for `postgres` superuser - * changing default password for superuser is probably a good idea: - * Open psql shell as postgres user - while being root run `su postgres -c psql` - * There, enter following: `ALTER USER postgres with encrypted password '';` - where is just any string, no need to manually encrypt it, postgres will encrypt it automatically for you. - * Replace password in file `config/dev.exs` with password you supplied in previous step (look for line like `password: "postgres"`) - - * edit `/etc/postgresql/9.6/main/pg_hba.conf` (Assuming you have 9.6 version) and change the line: - ``` - local all postgres peer - ``` - to - ``` - local all postgres md5 - ``` - don't forget to revert it in the later step so you won't have to enter password when accessing psql console. - * Create and update your database with `mix ecto.create && mix ecto.migrate`. If it gives errors, try running again, this is a known issue. - * Undo changes you made in `/etc/postgresql/9.6/main/pg_hba.conf` (replace `md5` with `peer`) - * You most likely don't want having some application accessing database as superuser, so you need to create separate user for that. Right now it must be done manually (issue #27). - * 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; - ``` - - * Again, change password in `config/dev.exs`, and change user to `"pleroma"` (line like `username: "postgres"`) +## Installation -### Some additional configuration +### Dependencies - * You will need to let pleroma instance to know what hostname/url it's running on. +* Postgresql version 9.6 or newer +* Elixir version 1.4 or newer +* Build-essential tools - In file `config/dev.exs`, add these lines at the end of the file: +### Configuration - ```elixir - config :pleroma, Pleroma.Web.Endpoint, - url: [host: "example.tld", scheme: "https", port: 443] - ``` + * Run `mix deps.get` to install elixir dependencies. - replacing `example.tld` with your (sub)domain - - * The common and convenient way for adding HTTPS is by using nginx as 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. + * 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`. - * (not tested with reboots yet!) You'll also want to set up Pleroma to be run as a systemd service. Example .service can be found in `installation/pleroma.service` you can put it in `/etc/systemd/system/`. - Start pleroma by running `service pleroma start` - Logs can be watched by using `journalctl -fu pleroma.service` + * Configure your database settings in `{dev,prod}.secret.exs` and either create the database with psql or run `mix ecto.create`. - * Without systemd you can start Pleroma by starting Phoenix endpoint with `mix phx.server` + * Run `mix ecto.migrate` to run the database migrations. You will have to do this again after certain updates. -In any case, it should be available on 4000 port on localhost and proxied to 443 port by nginx. + * 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. + * [Not tested with system reboot yet!] You'll also want to set up Pleroma to be run as a systemd service. Example .service file can be found in `installation/pleroma.service` you can put it in `/etc/systemd/system/`. -# Phoenix info +## Running -Ready to run in production? Please [check our deployment guides](http://www.phoenixframework.org/docs/deployment). +By default, it listens on port 4000 (TCP), so you can access it on http://localhost:4000/ (if you are on the same machine). In case of an error it will restart automatically. -## Learn more +### As systemd service (with provided .service file) +Running `service pleroma start` +Logs can be watched by using `journalctl -fu pleroma.service` - * Official website: http://www.phoenixframework.org/ - * Guides: http://phoenixframework.org/docs/overview - * Docs: https://hexdocs.pm/phoenix - * Mailing list: http://groups.google.com/group/phoenix-talk - * Source: https://github.com/phoenixframework/phoenix +### Standalone/run by other means +Run `mix phx.server` in repository's root, it will output log into stdout/stderr