X-Git-Url: http://git.squeep.com/?a=blobdiff_plain;ds=sidebyside;f=README.md;h=7fc1fd381ffbabaad5bed749b310bb579c10bb79;hb=4ab07cf0d53c24c8770bd3a47892b23344b103f6;hp=cb91f0b48ff14e5c841879e7e6b4f1e1204c5742;hpb=ed1eb5deea35ff2c3487ef550fad3a543a80cb32;p=akkoma
diff --git a/README.md b/README.md
index cb91f0b48..7fc1fd381 100644
--- a/README.md
+++ b/README.md
@@ -1,94 +1,43 @@
-# Pleroma
+
-## About Pleroma
+## About
-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.
+Pleroma is a microblogging server software that can federate (= exchange messages with) other servers that support ActivityPub. What that means is that you can host a server for yourself or your friends and stay in control of your online identity, but still exchange messages with people on larger servers. Pleroma will federate with all servers that implement ActivityPub, like Friendica, GNU Social, Hubzilla, Mastodon, Misskey, Peertube, and Pixelfed.
-For clients it supports both the GNU Social API with Qvitter extensions and the Mastodon client API.
+Pleroma is written in Elixir and uses PostgresSQL for data storage. It's efficient enough to be ran on low-power devices like Raspberry Pi (though we wouldn't recommend storing the database on the internal SD card ;) but can scale well when ran on more powerful hardware (albeit only single-node for now).
-Mobile clients that are known to work well:
+For clients it supports the [Mastodon client API](https://docs.joinmastodon.org/api/guidelines/) with Pleroma extensions (see the API section on ).
-* 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 https://matrix.heldscal.la/#/room/#pleromafe:matrix.heldscal.la.
+- [Client Applications for Pleroma](https://docs-develop.pleroma.social/backend/clients/)
## Installation
-### Dependencies
-
-* Postgresql version 9.6 or newer
-* 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.
-
-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"
- ```
+### OTP releases (Recommended)
+If you are running Linux (glibc or musl) on x86/arm, the recommended way to install Pleroma is by using OTP releases. OTP releases are as close as you can get to binary releases with Erlang/Elixir. The release is self-contained, and provides everything needed to boot it. The installation instructions are available [here](https://docs-develop.pleroma.social/backend/installation/otp_en/).
- * 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.
+### From Source
+If your platform is not supported, or you just want to be able to edit the source code easily, you may install Pleroma from source.
- * [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/`.
+- [Debian-based](https://docs-develop.pleroma.social/backend/installation/debian_based_en/)
+- [Debian-based (jp)](https://docs-develop.pleroma.social/backend/installation/debian_based_jp/)
+- [Alpine Linux](https://docs-develop.pleroma.social/backend/installation/alpine_linux_en/)
+- [Arch Linux](https://docs-develop.pleroma.social/backend/installation/arch_linux_en/)
+- [Gentoo Linux](https://docs-develop.pleroma.social/backend/installation/gentoo_en/)
+- [NetBSD](https://docs-develop.pleroma.social/backend/installation/netbsd_en/)
+- [OpenBSD](https://docs-develop.pleroma.social/backend/installation/openbsd_en/)
+- [OpenBSD (fi)](https://docs-develop.pleroma.social/backend/installation/openbsd_fi/)
+- [CentOS 7](https://docs-develop.pleroma.social/backend/installation/centos7_en/)
-## Running
+### OS/Distro packages
+Currently Pleroma is not packaged by any OS/Distros, but if you want to package it for one, we can guide you through the process on our [community channels](#community-channels). If you want to change default options in your Pleroma package, please **discuss it with us first**.
-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.
+### Docker
+While we donât provide docker files, other people have written very good ones. Take a look at or .
-### As systemd service (with provided .service file)
-Running `service pleroma start`
-Logs can be watched by using `journalctl -fu pleroma.service`
+## Documentation
+- Latest Released revision:
+- Latest Git revision:
-### Standalone/run by other means
-Run `mix phx.server` in repository's root, it will output log into stdout/stderr
+## Community Channels
+* IRC: **#pleroma** and **#pleroma-dev** on freenode, webchat is available at
+* Matrix: and