diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Clients.md | 100 | ||||
| -rw-r--r-- | docs/Pleroma-API.md | 8 | ||||
| -rw-r--r-- | docs/config.md | 87 |
3 files changed, 185 insertions, 10 deletions
diff --git a/docs/Clients.md b/docs/Clients.md new file mode 100644 index 000000000..c3d776488 --- /dev/null +++ b/docs/Clients.md @@ -0,0 +1,100 @@ +# Pleroma Clients +Note: Additionnal clients may be working but theses are officially supporting Pleroma. +Feel free to contact us to be added to this list! + +## Desktop +### Roma for Desktop +- Homepage: <http://www.pleroma.com/desktop-app/> +- Source Code: ??? +- Platforms: Windows, Mac, (Linux?) +- Features: Streaming Ready + +### Social +- Source Code: <https://gitlab.gnome.org/BrainBlasted/Social> +- Contact: [@brainblasted@social.libre.fi](https://social.libre.fi/users/brainblasted) +- Platforms: Linux (GNOME) +- Note(2019-01-28): Not at a pre-alpha stage yet + +### Whalebird +- Homepage: <https://whalebird.org/> +- Source Code: <https://github.com/h3poteto/whalebird-desktop> +- Contact: [@h3poteto@pleroma.io](https://pleroma.io/users/h3poteto) +- Platforms: Windows, Mac, Linux +- Features: Streaming Ready + +## Handheld +### Amaroq +- Homepage: <https://itunes.apple.com/us/app/amaroq-for-mastodon/id1214116200> +- Source Code: <https://github.com/ReticentJohn/Amaroq> +- Contact: [@eurasierboy@mastodon.social](https://mastodon.social/users/eurasierboy) +- Platforms: iOS +- Features: No Streaming + +### Nekonium +- Homepage: [F-Droid Repository](https://repo.gdgd.jp.net/), [Google Play](https://play.google.com/store/apps/details?id=com.apps.nekonium), [Amazon](https://www.amazon.co.jp/dp/B076FXPRBC/) +- Source: <https://git.gdgd.jp.net/lin/nekonium/> +- Contact: [@lin@pleroma.gdgd.jp.net](https://pleroma.gdgd.jp.net/users/lin) +- Platforms: Android +- Features: Streaming Ready + +### Mastalab +- Source Code: <https://gitlab.com/tom79/mastalab/> +- Contact: [@tom79@mastodon.social](https://mastodon.social/users/tom79) +- Platforms: Android +- Features: Streaming Ready + +### Roma +- Homepage: <http://www.pleroma.com/> +- Source Code: ??? +- Platforms: iOS, Android +- Features: No Streaming + +### Tootdon +- Homepage: <http://tootdon.club/>, <http://blog.mastodon-tootdon.com/> +- Source Code: ??? +- Contact: [@tootdon@mstdn.jp](https://mstdn.jp/users/tootdon) +- Platforms: Android, iOS +- Features: No Streaming + +### Tusky +- Homepage: <https://tuskyapp.github.io/> +- Source Code: <https://github.com/tuskyapp/Tusky> +- Contact: [@ConnyDuck@mastodon.social](https://mastodon.social/users/ConnyDuck) +- Platforms: Android +- Features: No Streaming + +### Twidere +- Homepage: <https://twidere.mariotaku.org/> +- Source Code: <https://github.com/TwidereProject/Twidere-Android/>, <https://github.com/TwidereProject/Twidere-iOS/> +- Contact: <me@mariotaku.org> +- Platform: Android, iOS +- Features: No Streaming + +## Alternative Web Interfaces +### Brutaldon +- Homepage: <https://jfm.carcosa.net/projects/software/brutaldon/> +- Source Code: <https://github.com/jfmcbrayer/brutaldon> +- Contact: [@gcupc@glitch.social](https://glitch.social/users/gcupc) +- Features: No Streaming + +### Feather +- Source Code: <https://github.com/kaniini/feather> +- Contact: [@kaniini@pleroma.site](https://pleroma.site/kaniini) +- Features: No Streaming + +### Halcyon +- Source Code: <https://notabug.org/halcyon-suite/halcyon> +- Contact: [@halcyon@social.csswg.org](https://social.csswg.org/users/halcyon) +- Features: Streaming Ready + +### Pinafore +- Homepage: <https://pinafore.social/> +- Source Code: <https://github.com/nolanlawson/pinafore> +- Contact: [@pinafore@mastodon.technology](https://mastodon.technology/users/pinafore) +- Note: Pleroma support is a secondary goal +- Features: No Streaming + +### Sengi +- Source Code: <https://github.com/NicolasConstant/sengi> +- Contact: [@sengi_app@mastodon.social](https://mastodon.social/users/sengi_app) +- Note(2019-01-28): The development is currently in a early stage. diff --git a/docs/Pleroma-API.md b/docs/Pleroma-API.md index da58babf9..e1448d3f0 100644 --- a/docs/Pleroma-API.md +++ b/docs/Pleroma-API.md @@ -1,13 +1,9 @@ -# Authentication +# Pleroma API Requests that require it can be authenticated with [an OAuth token](https://tools.ietf.org/html/rfc6749), the `_pleroma_key` cookie, or [HTTP Basic Authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization). -# Request parameters - Request parameters can be passed via [query strings](https://en.wikipedia.org/wiki/Query_string) or as [form data](https://www.w3.org/TR/html401/interact/forms.html). Files must be uploaded as `multipart/form-data`. -# Endpoints - ## `/api/pleroma/emoji` ### Lists the custom emoji on that server. * Method: `GET` @@ -15,6 +11,7 @@ Request parameters can be passed via [query strings](https://en.wikipedia.org/wi * Params: none * Response: JSON * Example response: `{"kalsarikannit_f":"/finmoji/128px/kalsarikannit_f-128.png","perkele":"/finmoji/128px/perkele-128.png","blobdab":"/emoji/blobdab.png","happiness":"/finmoji/128px/happiness-128.png"}` +* Note: Same data as Mastodon API’s `/api/v1/custom_emojis` but in a different format ## `/api/pleroma/follow_import` ### Imports your follows, for example from a Mastodon CSV file. @@ -55,6 +52,7 @@ Request parameters can be passed via [query strings](https://en.wikipedia.org/wi * `confirm` * `captcha_solution`: optional, contains provider-specific captcha solution, * `captcha_token`: optional, contains provider-specific captcha token + * `token`: invite token required when the registerations aren't public. * Response: JSON. Returns a user object on success, otherwise returns `{"error": "error_msg"}` * Example response: ``` diff --git a/docs/config.md b/docs/config.md index 1c3219efe..74badd0da 100644 --- a/docs/config.md +++ b/docs/config.md @@ -17,7 +17,7 @@ Note: `strip_exif` has been replaced by `Pleroma.Upload.Filter.Mogrify`. ## Pleroma.Upload.Filter.Mogrify -* `args`: List of actions for the `mogrify` command like `"strip"` or `["strip", {"impode", "1"}]`. +* `args`: List of actions for the `mogrify` command like `"strip"` or `["strip", "auto-orient", {"impode", "1"}]`. ## Pleroma.Upload.Filter.Dedupe @@ -32,7 +32,7 @@ This filter replaces the filename (not the path) of an upload. For complete obfu ## Pleroma.Mailer * `adapter`: one of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters), or `Swoosh.Adapters.Local` for in-memory mailbox. -* `api_key` / `password` and / or other adapter-specific settings, per the above documentation. +* `api_key` / `password` and / or other adapter-specific settings, per the above documentation. An example for Sendgrid adapter: @@ -72,6 +72,7 @@ config :pleroma, Pleroma.Mailer, * `invites_enabled`: Enable user invitations for admins (depends on `registrations_open: false`). * `account_activation_required`: Require users to confirm their emails before signing in. * `federating`: Enable federation with other instances +* `federation_reachability_timeout_days`: Timeout (in days) of each external federation target being unreachable prior to pausing federating to it. * `allow_relay`: Enable Pleroma’s Relay, which makes it possible to follow a whole instance * `rewrite_policy`: Message Rewrite Policy, either one or a list. Here are the ones available by default: * `Pleroma.Web.ActivityPub.MRF.NoOpPolicy`: Doesn’t modify activities (default) @@ -93,13 +94,57 @@ config :pleroma, Pleroma.Mailer, * `always_show_subject_input`: When set to false, auto-hide the subject field when it's empty. * `extended_nickname_format`: Set to `true` to use extended local nicknames format (allows underscores/dashes). This will break federation with older software for theses nicknames. +* `max_pinned_statuses`: The maximum number of pinned statuses. `0` will disable the feature. +* `autofollowed_nicknames`: Set to nicknames of (local) users that every new user should automatically follow. +* `no_attachment_links`: Set to true to disable automatically adding attachment link text to statuses + +## :logger +* `backends`: `:console` is used to send logs to stdout, `{ExSyslogger, :ex_syslogger}` to log to syslog + +An example to enable ONLY ExSyslogger (f/ex in ``prod.secret.exs``) with info and debug suppressed: +``` +config :logger, + backends: [{ExSyslogger, :ex_syslogger}] + +config :logger, :ex_syslogger, + level: :warn +``` + +Another example, keeping console output and adding the pid to syslog output: +``` +config :logger, + backends: [:console, {ExSyslogger, :ex_syslogger}] + +config :logger, :ex_syslogger, + level: :warn, + option: [:pid, :ndelay] +``` + +See: [logger’s documentation](https://hexdocs.pm/logger/Logger.html) and [ex_syslogger’s documentation](https://hexdocs.pm/ex_syslogger/) + + +## :frontend_configurations + +This can be used to configure a keyword list that keeps the configuration data for any kind of frontend. By default, settings for `pleroma_fe` are configured. + +Frontends can access these settings at `/api/pleroma/frontend_configurations` + +To add your own configuration for PleromaFE, use it like this: + +`config :pleroma, :frontend_configurations, pleroma_fe: %{redirectRootNoLogin: "/main/all", ...}` + +These settings need to be complete, they will override the defaults. See `priv/static/static/config.json` for the available keys. ## :fe +__THIS IS DEPRECATED__ + +If you are using this method, please change it to the `frontend_configurations` method. Please set this option to false in your config like this: `config :pleroma, :fe, false`. + This section is used to configure Pleroma-FE, unless ``:managed_config`` in ``:instance`` is set to false. * `theme`: Which theme to use, they are defined in ``styles.json`` * `logo`: URL of the logo, defaults to Pleroma’s logo -* `logo_mask`: Whenether to mask the logo +* `logo_mask`: Whether to use only the logo's shape as a mask (true) or as a regular image (false) * `logo_margin`: What margin to use around the logo * `background`: URL of the background, unless viewing a user profile with a background that is set * `redirect_root_no_login`: relative URL which indicates where to redirect when a user isn’t logged in. @@ -123,7 +168,13 @@ This section is used to configure Pleroma-FE, unless ``:managed_config`` in ``:i * `allow_direct`: whether to allow direct messages ## :mrf_hellthread -* `threshold`: Number of mentioned users after which the message gets discarded as spam +* `delist_threshold`: Number of mentioned users after which the message gets delisted (the message can still be seen, but it will not show up in public timelines and mentioned users won't get notifications about it). Set to 0 to disable. +* `reject_threshold`: Number of mentioned users after which the messaged gets rejected. Set to 0 to disable. + +## :mrf_keyword +* `reject`: A list of patterns which result in message being rejected, each pattern can be a string or a [regular expression](https://hexdocs.pm/elixir/Regex.html) +* `federated_timeline_removal`: A list of patterns which result in message being removed from federated timelines (a.k.a unlisted), each pattern can be a string or a [regular expression](https://hexdocs.pm/elixir/Regex.html) +* `replace`: A list of tuples containing `{pattern, replacement}`, `pattern` can be a string or a [regular expression](https://hexdocs.pm/elixir/Regex.html) ## :media_proxy * `enabled`: Enables proxying of remote media to the instance’s proxy @@ -201,6 +252,32 @@ curl "http://localhost:4000/api/pleroma/admin/invite_token?admin_token=somerando ## Pleroma.Web.Federator.RetryQueue * `enabled`: If set to `true`, failed federation jobs will be retried -* `max_jobs`: The maximum amount of parallel federation jbos running at the same time. +* `max_jobs`: The maximum amount of parallel federation jobs running at the same time. * `initial_timeout`: The initial timeout in seconds * `max_retries`: The maximum number of times a federation job is retried + +## Pleroma.Web.Metadata +* `providers`: a list of metadata providers to enable. Providers availible: + * Pleroma.Web.Metadata.Providers.OpenGraph + * Pleroma.Web.Metadata.Providers.TwitterCard +* `unfurl_nsfw`: If set to `true` nsfw attachments will be shown in previews + +## :rich_media +* `enabled`: if enabled the instance will parse metadata from attached links to generate link previews + +## :hackney_pools + +Advanced. Tweaks Hackney (http client) connections pools. + +There's three pools used: + +* `:federation` for the federation jobs. + You may want this pool max_connections to be at least equal to the number of federator jobs + retry queue jobs. +* `:media` for rich media, media proxy +* `:upload` for uploaded media (if using a remote uploader and `proxy_remote: true`) + +For each pool, the options are: + +* `max_connections` - how much connections a pool can hold +* `timeout` - retention duration for connections + |