X-Git-Url: http://git.squeep.com/?a=blobdiff_plain;f=README.md;h=31d2a27549b409b49dd758e7eac300ff0cf43f86;hb=bcc4e73e51fb59c1cf924cdef8ccf317bc3971e9;hp=620b3ea1d911bfa7065d64d423ceff47a8746551;hpb=9112eda14ffa203eeca1d129d6739840f684569d;p=akkoma diff --git a/README.md b/README.md index 620b3ea1d..31d2a2754 100644 --- a/README.md +++ b/README.md @@ -1,47 +1,49 @@ # Pleroma +## About Pleroma + +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](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: + +* Twidere +* Tusky +* 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 #pleroma on freenode or via matrix at https://matrix.heldscal.la/#/room/#freenode_#pleroma:matrix.org. + ## Installation ### Dependencies -* Postgresql version 9.5 or newer +* Postgresql version 9.6 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 `postgresql-9.5` or older is not installed, for some strange reason debian allows multiple versions to coexist, what effect it has - i don't know. +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. 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` -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. +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` - * Clone the git repository into new user's dir (clone as the user to avoid permissions errors) + * 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 preparation +### Database setup - * 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: (as root) `su postgres -c psql` - * There, enter following: `ALTER USER postgres with encrypted password '';` - * 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 - ``` - * Create and migrate your database with `mix ecto.create && mix ecto.migrate`. If it gives errors, try running again, it should be ok. - * You most likely don't want having some application accessing database as superuser, so we need to create separate user for that. For now it's done manually (issue #27). - * Revert `/etc/postgresql/9.6/main/pg_hba.conf` to previous state (replace `md5` with `peer`) + * 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: + * Create a new PostgreSQL user: + ```sql \c pleroma_dev CREATE user pleroma; @@ -49,35 +51,44 @@ NodeJS is available as `nodejs` package on debian. `apt install nodejs`. Debian 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 too to `"pleroma"` (like 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`. ### Some additional configuration - * You will need to let pleroma instance to know what hostname/url it's running on. + * 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. - 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, - url: [host: "example.tld", scheme: "https", port: 443] + url: [host: "example.tld", scheme: "https", port: 443] ``` 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 HTTPS certificates, you can look into letsencrypt. - * (not tested with reboots!) 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/` and run it by `service pleroma start`; You can watch logs by using `journalctl -u pleroma.service`; + * 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. - * Without systemd you can start Pleroma by starting Phoenix endpoint with `mix phx.server` - it should be available on 4000 port on localhost and proxied to 443 port by nginx. + * [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/`. +## 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