akkoma/README.md

110 lines
5.3 KiB
Markdown
Raw Normal View History

2017-03-17 10:09:58 -06:00
# Pleroma
## Installation
2017-03-17 10:09:58 -06:00
### Dependencies
2017-08-15 15:16:55 -06:00
* Postgresql version 9.6 or newer
* Elixir version 1.4 or newer
* NodeJS LTS
2017-08-15 14:50:23 -06:00
* Build-essential tools
#### Installing dependencies on Debian system
2017-08-15 15:16:55 -06:00
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`
2017-08-15 14:50:23 -06:00
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`
2017-08-15 15:16:55 -06:00
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
2017-08-15 14:50:23 -06:00
* 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.
2017-08-15 15:16:55 -06:00
### Database setup
* You'll need to allow password-based authorisation for `postgres` superuser
2017-08-15 15:16:55 -06:00
* Changing default password for superuser is probably a good idea:
2017-08-15 14:50:23 -06:00
* Open psql shell as postgres user - while being root run `su postgres -c psql`
2017-08-15 15:16:55 -06:00
* There, enter following:
```sql
2017-08-15 15:20:02 -06:00
ALTER USER postgres with encrypted password '<PASSWORD>';
2017-08-15 15:16:55 -06:00
```
2017-08-15 15:20:02 -06:00
where `<PASSWORD>` 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"`)
2017-08-15 15:16:55 -06:00
* Edit `/etc/postgresql/9.6/main/pg_hba.conf` (Assuming you have the 9.6 version) and change the line:
2017-08-15 14:54:15 -06:00
```
local all postgres peer
```
2017-08-15 14:54:15 -06:00
to
2017-08-15 14:54:15 -06:00
```
local all postgres md5
```
2017-08-15 14:54:15 -06:00
2017-08-15 14:50:23 -06:00
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`)
2017-08-15 15:16:55 -06:00
* 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:
```sql
\c pleroma_dev
CREATE user pleroma;
2017-08-15 15:20:02 -06:00
ALTER user pleroma with encrypted password '<your password>';
GRANT ALL ON ALL tables IN SCHEMA public TO pleroma;
GRANT ALL ON ALL sequences IN SCHEMA public TO pleroma;
```
2017-08-15 14:50:23 -06:00
* Again, change password in `config/dev.exs`, and change user to `"pleroma"` (line like `username: "postgres"`)
### Some additional configuration
* You will need to let pleroma instance to know what hostname/url it's running on.
In file `config/dev.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
2017-08-15 15:16:55 -06:00
* 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.
2017-08-15 15:16:55 -06:00
* [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/`.
2017-08-15 15:16:55 -06:00
## Running
2017-03-17 10:09:58 -06:00
2017-08-15 15:21:38 -06:00
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.
2017-08-15 14:50:23 -06:00
2017-08-15 15:16:55 -06:00
### As systemd service (with provided .service file)
Running `service pleroma start`
Logs can be watched by using `journalctl -fu pleroma.service`
2017-08-15 14:50:23 -06:00
2017-08-15 15:16:55 -06:00
### Standalone/run by other means
Run `mix phx.server` in repository's root, it will output log into stdout/stderr
2017-08-15 14:50:23 -06:00
# Phoenix info
2017-03-17 10:09:58 -06:00
Ready to run in production? Please [check our deployment guides](http://www.phoenixframework.org/docs/deployment).
## Learn more
* 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