X-Git-Url: https://git.squeep.com/?a=blobdiff_plain;f=README.md;h=3d909e776a120ad43a4c59913e58216a133938a7;hb=2fab3c44f5a8fd5c2729d10330dae377ab60abdc;hp=5f6e91d0694a74a6b54d41fcf61932b1d953d6cb;hpb=47a72c04f92477aff4954d208a102bddcb69f8ba;p=akkoma diff --git a/README.md b/README.md index 5f6e91d06..3d909e776 100644 --- a/README.md +++ b/README.md @@ -1,85 +1,41 @@ # Pleroma -## Installation - -### Dependencies - -* 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 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` - -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` - -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. - -### 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. +## About Pleroma -### Database setup +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. - * 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: +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). - ```sql - ALTER USER postgres with encrypted password ''; - ``` +Mobile clients that are known to work well: - where is 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 the 9.6 version) and change the line: +* Twidere +* Tusky +* Pawoo (Android + iOS) +* Subway Tooter +* Amaroq (iOS) +* Tootdon (Android + iOS) +* Tootle (iOS) - ``` - local all postgres peer - ``` +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. - to - - ``` - local all postgres md5 - ``` +## Installation - 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 a superuser, so you should create separate user for Pleroma. 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: +### Dependencies - ```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; - ``` +* Postgresql version 9.6 or newer +* Elixir version 1.5 or newer +* Build-essential tools - * Again, change password in `config/dev.exs`, and change user to `"pleroma"` (line like `username: "postgres"`) +### Configuration -### Some additional configuration + * Run `mix deps.get` to install elixir dependencies. - * You will need to let pleroma instance to know what hostname/url it's running on. + * 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. - In file `config/dev.exs`, add these lines at the end of the file: + * Run `mix ecto.migrate` to run the database migrations. You will have to do this again after certain updates. - ```elixir - config :pleroma, Pleroma.Web.Endpoint, - url: [host: "example.tld", scheme: "https", port: 443] - ``` + * 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. - replacing `example.tld` with your (sub)domain - * 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. @@ -87,7 +43,7 @@ NodeJS is available as `nodejs` package on Debian. `apt install nodejs`. Debian ## Running -By default, it listens on port 4000 (TCP), so you can access it on http://localhost:4000/ (if you it on same machine). In case of an error it will restart automatically. +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. ### As systemd service (with provided .service file) Running `service pleroma start` @@ -96,14 +52,23 @@ Logs can be watched by using `journalctl -fu pleroma.service` ### Standalone/run by other means Run `mix phx.server` in repository's root, it will output log into stdout/stderr -# Phoenix info +### Using an upstream proxy for federation + +Add the following to your `dev.secret.exs` or `prod.secret.exs` if you want to proxify all http requests that pleroma makes to an upstream proxy server: + + config :pleroma, :http, + proxy_url: "127.0.0.1:8123" + +This is useful for running pleroma inside Tor or i2p. + +## Admin Tasks + +### Password reset + +Run `mix generate_password_reset username` to generate a password reset link that you can then send to the user. -Ready to run in production? Please [check our deployment guides](http://www.phoenixframework.org/docs/deployment). +### Moderators -## Learn more +You can make users moderators. They will then be able to delete any post. - * 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 +Run `mix set_moderator username [true|false]` to make user a moderator or not.