diff options
Diffstat (limited to 'docs/config')
| -rw-r--r-- | docs/config/General-tips-for-customizing-Pleroma-FE.md | 17 | ||||
| -rw-r--r-- | docs/config/custom_emoji.md | 68 | ||||
| -rw-r--r-- | docs/config/hardening.md | 103 | ||||
| -rw-r--r-- | docs/config/howto_mediaproxy.md | 34 | ||||
| -rw-r--r-- | docs/config/howto_mongooseim.md | 10 | ||||
| -rw-r--r-- | docs/config/howto_proxy.md | 12 | ||||
| -rw-r--r-- | docs/config/howto_set_richmedia_cache_ttl_based_on_image.md | 33 | ||||
| -rw-r--r-- | docs/config/howto_user_recomendation.md | 31 | ||||
| -rw-r--r-- | docs/config/i2p.md | 196 | ||||
| -rw-r--r-- | docs/config/mrf.md | 122 | ||||
| -rw-r--r-- | docs/config/onion_federation.md | 159 | ||||
| -rw-r--r-- | docs/config/small_customizations.md | 12 | ||||
| -rw-r--r-- | docs/config/static_dir.md | 69 |
13 files changed, 0 insertions, 866 deletions
diff --git a/docs/config/General-tips-for-customizing-Pleroma-FE.md b/docs/config/General-tips-for-customizing-Pleroma-FE.md deleted file mode 100644 index 15c4882dd..000000000 --- a/docs/config/General-tips-for-customizing-Pleroma-FE.md +++ /dev/null @@ -1,17 +0,0 @@ -# General tips for customizing Pleroma FE -There are some configuration scripts for Pleroma BE and FE: - -1. `config/prod.secret.exs` -1. `config/config.exs` -1. `priv/static/static/config.json` - -The `prod.secret.exs` affects first. `config.exs` is for fallback or default. `config.json` is for GNU-social-BE-Pleroma-FE instances. - -Usually all you have to do is: - -1. Copy the section in the `config/config.exs` which you want to activate. -1. Paste into `config/prod.secret.exs`. -1. Edit `config/prod.secret.exs`. -1. Restart the Pleroma daemon. - -`prod.secret.exs` is for the `MIX_ENV=prod` environment. `dev.secret.exs` is for the `MIX_ENV=dev` environment respectively. diff --git a/docs/config/custom_emoji.md b/docs/config/custom_emoji.md deleted file mode 100644 index f72c0edbc..000000000 --- a/docs/config/custom_emoji.md +++ /dev/null @@ -1,68 +0,0 @@ -# Custom Emoji - -Before you add your own custom emoji, check if they are available in an existing pack. -See `Mix.Tasks.Pleroma.Emoji` for information about emoji packs. - -To add custom emoji: -* Create the `STATIC-DIR/emoji/` directory if it doesn't exist - (`STATIC-DIR` is configurable, `instance/static/` by default) -* Create a directory with whatever name you want (custom is a good name to show the purpose of it). - This will create a local emoji pack. -* Put your `.png` emoji files in that directory. In case of conflicts, you can create an `emoji.txt` - file in that directory and specify a custom shortcode using the following format: - `shortcode, file-path, tag1, tag2, etc`. One emoji per line. Note that if you do so, - you'll have to list all other emojis in the pack too. -* Either restart pleroma or connect to the iex session pleroma's running and - run `Pleroma.Emoji.reload/0` in it. - -Example: - -image files (in `instance/static/emoji/custom`): `happy.png` and `sad.png` - -content of `emoji.txt`: -``` -happy, /emoji/custom/happy.png, Tag1,Tag2 -sad, /emoji/custom/sad.png, Tag1 -foo, /emoji/custom/foo.png -``` - -The files should be PNG (APNG is okay with `.png` for `image/png` Content-type) and under 50kb for compatibility with mastodon. - -Default file extentions and locations for emojis are set in `config.exs`. To use different locations or file-extentions, add the `shortcode_globs` to your secrets file (`prod.secret.exs` or `dev.secret.exs`) and edit it. Note that not all fediverse-software will show emojis with other file extentions: -```elixir -config :pleroma, :emoji, shortcode_globs: ["/emoji/custom/**/*.png", "/emoji/custom/**/*.gif"] -``` - -## Emoji tags (groups) - -Default tags are set in `config.exs`. To set your own tags, copy the structure to your secrets file (`prod.secret.exs` or `dev.secret.exs`) and edit it. -```elixir -config :pleroma, :emoji, - shortcode_globs: ["/emoji/custom/**/*.png"], - groups: [ - Finmoji: "/finmoji/128px/*-128.png", - Custom: ["/emoji/*.png", "/emoji/custom/*.png"] - ] -``` - -Order of the `groups` matters, so to override default tags just put your group on top of the list. E.g: -```elixir -config :pleroma, :emoji, - shortcode_globs: ["/emoji/custom/**/*.png"], - groups: [ - "Finmoji special": "/finmoji/128px/a_trusted_friend-128.png", # special file - "Cirno": "/emoji/custom/cirno*.png", # png files in /emoji/custom/ which start with `cirno` - "Special group": "/emoji/custom/special_folder/*.png", # png files in /emoji/custom/special_folder/ - "Another group": "/emoji/custom/special_folder/*/.png", # png files in /emoji/custom/special_folder/ subfolders - Finmoji: "/finmoji/128px/*-128.png", - Custom: ["/emoji/*.png", "/emoji/custom/*.png"] - ] -``` - -Priority of tags assigns in emoji.txt and custom.txt: - -`tag in file > special group setting in config.exs > default setting in config.exs` - -Priority for globs: - -`special group setting in config.exs > default setting in config.exs` diff --git a/docs/config/hardening.md b/docs/config/hardening.md deleted file mode 100644 index b54c28850..000000000 --- a/docs/config/hardening.md +++ /dev/null @@ -1,103 +0,0 @@ -# Hardening your instance -Here are some suggestions which improve the security of parts of your Pleroma instance. - -## Configuration file - -These changes should go into `prod.secret.exs` or `dev.secret.exs`, depending on your `MIX_ENV` value. - -### `http` - -> Recommended value: `[ip: {127, 0, 0, 1}]` - -This sets the Pleroma application server to only listen to the localhost interface. This way, you can only reach your server over the Internet by going through the reverse proxy. By default, Pleroma listens on all interfaces. - -### `secure_cookie_flag` - -> Recommended value: `true` - -This sets the `secure` flag on Pleroma’s session cookie. This makes sure, that the cookie is only accepted over encrypted HTTPs connections. This implicitly renames the cookie from `pleroma_key` to `__Host-pleroma-key` which enforces some restrictions. (see [cookie prefixes](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#Cookie_prefixes)) - -### `:http_security` - -> Recommended value: `true` - -This will send additional HTTP security headers to the clients, including: - -* `X-XSS-Protection: "1; mode=block"` -* `X-Permitted-Cross-Domain-Policies: "none"` -* `X-Frame-Options: "DENY"` -* `X-Content-Type-Options: "nosniff"` -* `X-Download-Options: "noopen"` - -A content security policy (CSP) will also be set: - -```csp -content-security-policy: - default-src 'none'; - base-uri 'self'; - frame-ancestors 'none'; - img-src 'self' data: https:; - media-src 'self' https:; - style-src 'self' 'unsafe-inline'; - font-src 'self'; - script-src 'self'; - connect-src 'self' wss://example.tld; - manifest-src 'self'; - upgrade-insecure-requests; -``` - -#### `sts` - -> Recommended value: `true` - -An additional “Strict transport security” header will be sent with the configured `sts_max_age` parameter. This tells the browser, that the domain should only be accessed over a secure HTTPs connection. - -#### `ct_max_age` - -An additional “Expect-CT” header will be sent with the configured `ct_max_age` parameter. This enforces the use of TLS certificates that are published in the certificate transparency log. (see [Expect-CT](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Expect-CT)) - -#### `referrer_policy` - -> Recommended value: `same-origin` - -If you click on a link, your browser’s request to the other site will include from where it is coming from. The “Referrer policy” header tells the browser how and if it should send this information. (see [Referrer policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy)) - -## systemd - -A systemd unit example is provided at `installation/pleroma.service`. - -### PrivateTmp - -> Recommended value: `true` - -Use private `/tmp` and `/var/tmp` folders inside a new file system namespace, which are discarded after the process stops. - -### ProtectHome - -> Recommended value: `true` - -The `/home`, `/root`, and `/run/user` folders can not be accessed by this service anymore. If your Pleroma user has its home folder in one of the restricted places, or use one of these folders as its working directory, you have to set this to `false`. - -### ProtectSystem - -> Recommended value: `full` - -Mount `/usr`, `/boot`, and `/etc` as read-only for processes invoked by this service. - -### PrivateDevices - -> Recommended value: `true` - -Sets up a new `/dev` mount for the process and only adds API pseudo devices like `/dev/null`, `/dev/zero` or `/dev/random` but not physical devices. This may not work on devices like the Raspberry Pi, where you need to set this to `false`. - -### NoNewPrivileges - -> Recommended value: `true` - -Ensures that the service process and all its children can never gain new privileges through `execve()`. - -### CapabilityBoundingSet - -> Recommended value: `~CAP_SYS_ADMIN` - -Drops the sysadmin capability from the daemon. diff --git a/docs/config/howto_mediaproxy.md b/docs/config/howto_mediaproxy.md deleted file mode 100644 index 16c40c5db..000000000 --- a/docs/config/howto_mediaproxy.md +++ /dev/null @@ -1,34 +0,0 @@ -# How to activate mediaproxy -## Explanation - -Without the `mediaproxy` function, Pleroma doesn't store any remote content like pictures, video etc. locally. So every time you open Pleroma, the content is loaded from the source server, from where the post is coming. This can result in slowly loading content or/and increased bandwidth usage on the source server. -With the `mediaproxy` function you can use nginx to cache this content, so users can access it faster, because it's loaded from your server. - -## Activate it - -* Edit your nginx config and add the following location: -``` -location /proxy { - proxy_cache pleroma_media_cache; - proxy_cache_lock on; - proxy_pass http://localhost:4000; -} -``` -Also add the following on top of the configuration, outside of the `server` block: -``` -proxy_cache_path /tmp/pleroma-media-cache levels=1:2 keys_zone=pleroma_media_cache:10m max_size=10g inactive=720m use_temp_path=off; -``` -If you came here from one of the installation guides, take a look at the example configuration `/installation/pleroma.nginx`, where this part is already included. - -* Append the following to your `prod.secret.exs` or `dev.secret.exs` (depends on which mode your instance is running): -``` -config :pleroma, :media_proxy, - enabled: true, - proxy_opts: [ - redirect_on_failure: true - ] - #base_url: "https://cache.pleroma.social" -``` -If you want to use a subdomain to serve the files, uncomment `base_url`, change the url and add a comma after `true` in the previous line. - -* Restart nginx and Pleroma diff --git a/docs/config/howto_mongooseim.md b/docs/config/howto_mongooseim.md deleted file mode 100644 index a33e590a1..000000000 --- a/docs/config/howto_mongooseim.md +++ /dev/null @@ -1,10 +0,0 @@ -# Configuring MongooseIM (XMPP Server) to use Pleroma for authentication - -If you want to give your Pleroma users an XMPP (chat) account, you can configure [MongooseIM](https://github.com/esl/MongooseIM) to use your Pleroma server for user authentication, automatically giving every local user an XMPP account. - -In general, you just have to follow the configuration described at [https://mongooseim.readthedocs.io/en/latest/authentication-backends/HTTP-authentication-module/](https://mongooseim.readthedocs.io/en/latest/authentication-backends/HTTP-authentication-module/) and do these changes to your mongooseim.cfg. - -1. Set the auth_method to `{auth_method, http}`. -2. Add the http auth pool like this: `{http, global, auth, [{workers, 50}], [{server, "https://yourpleromainstance.com"}]}` - -Restart your MongooseIM server, your users should now be able to connect with their Pleroma credentials. diff --git a/docs/config/howto_proxy.md b/docs/config/howto_proxy.md deleted file mode 100644 index 10a635266..000000000 --- a/docs/config/howto_proxy.md +++ /dev/null @@ -1,12 +0,0 @@ -# How to configure upstream proxy for federation -If you want to proxify all http requests (e.g. for TOR) that pleroma makes to an upstream proxy server, edit you config file (`dev.secret.exs` or `prod.secret.exs`) and add the following: - -``` -config :pleroma, :http, - proxy_url: "127.0.0.1:8123" -``` - -The other way to do it, for example, with Tor you would most likely add something like this: -``` -config :pleroma, :http, proxy_url: {:socks5, :localhost, 9050} -``` diff --git a/docs/config/howto_set_richmedia_cache_ttl_based_on_image.md b/docs/config/howto_set_richmedia_cache_ttl_based_on_image.md deleted file mode 100644 index bfee5a9e6..000000000 --- a/docs/config/howto_set_richmedia_cache_ttl_based_on_image.md +++ /dev/null @@ -1,33 +0,0 @@ -# How to set rich media cache ttl based on image ttl -## Explanation - -Richmedia are cached without the ttl but the rich media may have image which can expire, like aws signed url. -In such cases the old image url (expired) is returned from the media cache. - -So to avoid such situation we can define a module that will set ttl based on image. -The module must adopt behaviour `Pleroma.Web.RichMedia.Parser.TTL` - -### Example - -```exs -defmodule MyModule do - @behaviour Pleroma.Web.RichMedia.Parser.TTL - - @impl Pleroma.Web.RichMedia.Parser.TTL - def ttl(data, url) do - image_url = Map.get(data, :image) - # do some parsing in the url and get the ttl of the image - # return ttl is unix time - parse_ttl_from_url(image_url) - end -end -``` - -And update the config - -```exs -config :pleroma, :rich_media, - ttl_setters: [Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl, MyModule] -``` - -> For reference there is a parser for AWS signed URL `Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl`, it's enabled by default. diff --git a/docs/config/howto_user_recomendation.md b/docs/config/howto_user_recomendation.md deleted file mode 100644 index c4d749d0c..000000000 --- a/docs/config/howto_user_recomendation.md +++ /dev/null @@ -1,31 +0,0 @@ -# How to activate user recommendation (Who to follow panel) - - -To show the *who to follow* panel, edit `config/prod.secret.exs` in the Pleroma backend. Following code activates the *who to follow* panel: - -```elixir -config :pleroma, :suggestions, - enabled: true, - third_party_engine: - "http://vinayaka.distsn.org/cgi-bin/vinayaka-user-match-suggestions-api.cgi?{{host}}+{{user}}", - timeout: 300_000, - limit: 40, - web: "https://vinayaka.distsn.org" - -``` - -`config/config.exs` already includes this code, but `enabled:` is `false`. - -`/api/v1/suggestions` is also provided when *who to follow* panel is enabled. - -For advanced customization, following code shows the newcomers of the fediverse at the *who to follow* panel: - -```elixir -config :pleroma, :suggestions, - enabled: true, - third_party_engine: - "http://vinayaka.distsn.org/cgi-bin/vinayaka-user-new-suggestions-api.cgi?{{host}}+{{user}}", - timeout: 60_000, - limit: 40, - web: "https://vinayaka.distsn.org/user-new.html" -``` diff --git a/docs/config/i2p.md b/docs/config/i2p.md deleted file mode 100644 index 62ced8b7a..000000000 --- a/docs/config/i2p.md +++ /dev/null @@ -1,196 +0,0 @@ -# I2P Federation and Accessability - -This guide is going to focus on the Pleroma federation aspect. The actual installation is neatly explained in the official documentation, and more likely to remain up-to-date. -It might be added to this guide if there will be a need for that. - -We're going to use I2PD for its lightweightness over the official client. -Follow the documentation according to your distro: https://i2pd.readthedocs.io/en/latest/user-guide/install/#installing - -How to run it: https://i2pd.readthedocs.io/en/latest/user-guide/run/ - -## I2P Federation - -There are 2 ways to go about this. -One using the config, and one using external software (fedproxy). The external software works better so far. - -### Using the Config - -**Warning:** So far, everytime I followed this way of federating using I2P, the rest of my federation stopped working. I'm leaving this here in case it will help with making it work. - -Assuming you're running in prod, cd to your Pleroma folder and append the following to `config/prod.secret.exs`: -``` -config :pleroma, :http, proxy_url: {:socks5, :localhost, 4447} -``` -And then run the following: -``` -su pleroma -MIX_ENV=prod mix deps.get -MIX_ENV=prod mix ecto.migrate -exit -``` -You can restart I2PD here and finish if you don't wish to make your instance viewable or accessible over I2P. -``` -systemctl stop i2pd.service --no-block -systemctl start i2pd.service -``` -*Notice:* The stop command initiates a graceful shutdown process, i2pd stops after finishing to route transit tunnels (maximum 10 minutes). - -You can change the socks proxy port in `/etc/i2pd/i2pd.conf`. - -### Using Fedproxy - -Fedproxy passes through clearnet requests direct to where they are going. It doesn't force anything over Tor. - -To use [fedproxy](https://github.com/majestrate/fedproxy) you'll need to install Golang. -``` -apt install golang -``` -Use a different user than pleroma or root. Run the following to add the Gopath to your ~/.bashrc. -``` -echo "export GOPATH=/home/ren/.go" >> ~/.bashrc -``` -Restart that bash session (you can exit and log back in). -Run the following to get fedproxy. -``` -go get -u github.com/majestrate/fedproxy$ -cp $(GOPATH)/bin/fedproxy /usr/local/bin/fedproxy -``` -And then the following to start it for I2P only. -``` -fedproxy 127.0.0.1:2000 127.0.0.1:4447 -``` -If you want to also use it for Tor, add `127.0.0.1:9050` to that command. -You'll also need to modify your Pleroma config. - -Assuming you're running in prod, cd to your Pleroma folder and append the following to `config/prod.secret.exs`: -``` -config :pleroma, :http, proxy_url: {:socks5, :localhost, 2000} -``` -And then run the following: -``` -su pleroma -MIX_ENV=prod mix deps.get -MIX_ENV=prod mix ecto.migrate -exit -``` -You can restart I2PD here and finish if you don't wish to make your instance viewable or accessible over I2P. - -``` -systemctl stop i2pd.service --no-block -systemctl start i2pd.service -``` -*Notice:* The stop command initiates a graceful shutdown process, i2pd stops after finishing to route transit tunnels (maximum 10 minutes). - -You can change the socks proxy port in `/etc/i2pd/i2pd.conf`. - -## I2P Instance Access - -Make your instance accessible using I2P. - -Add the following to your I2PD config `/etc/i2pd/tunnels.conf`: -``` -[pleroma] -type = http -host = 127.0.0.1 -port = 14447 -keys = pleroma.dat -``` -Restart I2PD: -``` -systemctl stop i2pd.service --no-block -systemctl start i2pd.service -``` -*Notice:* The stop command initiates a graceful shutdown process, i2pd stops after finishing to route transit tunnels (maximum 10 minutes). - -Now you'll have to find your address. -To do that you can download and use I2PD tools.[^1] -Or you'll need to access your web-console on localhost:7070. -If you don't have a GUI, you'll have to SSH tunnel into it like this: -`ssh -L 7070:127.0.0.1:7070 user@ip -p port`. -Now you can access it at localhost:7070. -Go to I2P tunnels page. Look for Server tunnels and you will see an address that ends with `.b32.i2p` next to "pleroma". -This is your site's address. - -### I2P-only Instance - -If creating an I2P-only instance, open `config/prod.secret.exs` and under "config :pleroma, Pleroma.Web.Endpoint," edit "https" and "port: 443" to the following: -``` - url: [host: "i2paddress", scheme: "http", port: 80], -``` -In addition to that, replace the existing nginx config's contents with the example below. - -### Existing Instance (Clearnet Instance) - -If not an I2P-only instance, add the nginx config below to your existing config at `/etc/nginx/sites-enabled/pleroma.nginx`. - -And for both cases, disable CSP in Pleroma's config (STS is disabled by default) so you can define those yourself seperately from the clearnet (if your instance is also on the clearnet). -Copy the following into the `config/prod.secret.exs` in your Pleroma folder (/home/pleroma/pleroma/): -``` -config :pleroma, :http_security, - enabled: false -``` - -Use this as the Nginx config: -``` -proxy_cache_path /tmp/pleroma-media-cache levels=1:2 keys_zone=pleroma_media_cache:10m max_size=10g inactive=720m use_temp_path=off; -# The above already exists in a clearnet instance's config. -# If not, add it. - -server { - listen 127.0.0.1:14447; - server_name youri2paddress; - - # Comment to enable logs - access_log /dev/null; - error_log /dev/null; - - gzip_vary on; - gzip_proxied any; - gzip_comp_level 6; - gzip_buffers 16 8k; - gzip_http_version 1.1; - gzip_types text/plain text/css application/json application/javascript text/xml application/xml application/xml+rss text/javascript application/activity+json application/atom+xml; - - client_max_body_size 16m; - - location / { - - add_header X-XSS-Protection "1; mode=block"; - add_header X-Permitted-Cross-Domain-Policies none; - add_header X-Frame-Options DENY; - add_header X-Content-Type-Options nosniff; - add_header Referrer-Policy same-origin; - add_header X-Download-Options noopen; - - proxy_http_version 1.1; - proxy_set_header Upgrade $http_upgrade; - proxy_set_header Connection "upgrade"; - proxy_set_header Host $http_host; - - proxy_pass http://localhost:4000; - - client_max_body_size 16m; - } - - location /proxy { - proxy_cache pleroma_media_cache; - proxy_cache_lock on; - proxy_ignore_client_abort on; - proxy_pass http://localhost:4000; - } -} -``` -reload Nginx: -``` -systemctl stop i2pd.service --no-block -systemctl start i2pd.service -``` -*Notice:* The stop command initiates a graceful shutdown process, i2pd stops after finishing to route transit tunnels (maximum 10 minutes). - -You should now be able to both access your instance using I2P and federate with other I2P instances! - -[^1]: [I2PD tools](https://github.com/purplei2p/i2pd-tools) to print information about a router info file or an I2P private key, generate an I2P private key, and generate vanity addresses. - -### Possible Issues - -Will be added when encountered. diff --git a/docs/config/mrf.md b/docs/config/mrf.md deleted file mode 100644 index 45be18fc5..000000000 --- a/docs/config/mrf.md +++ /dev/null @@ -1,122 +0,0 @@ -# Message Rewrite Facility -The Message Rewrite Facility (MRF) is a subsystem that is implemented as a series of hooks that allows the administrator to rewrite or discard messages. - -Possible uses include: - -* marking incoming messages with media from a given account or instance as sensitive -* rejecting messages from a specific instance -* rejecting reports (flags) from a specific instance -* removing/unlisting messages from the public timelines -* removing media from messages -* sending only public messages to a specific instance - -The MRF provides user-configurable policies. The default policy is `NoOpPolicy`, which disables the MRF functionality. Pleroma also includes an easy to use policy called `SimplePolicy` which maps messages matching certain pre-defined criterion to actions built into the policy module. -It is possible to use multiple, active MRF policies at the same time. - -## Quarantine Instances - -You have the ability to prevent from private / followers-only messages from federating with specific instances. Which means they will only get the public or unlisted messages from your instance. - -If, for example, you're using `MIX_ENV=prod` aka using production mode, you would open your configuration file located in `config/prod.secret.exs` and edit or add the option under your `:instance` config object. Then you would specify the instance within quotes. -``` -config :pleroma, :instance, - [...] - quarantined_instances: ["instance.example", "other.example"] -``` - -## Using `SimplePolicy` - -`SimplePolicy` is capable of handling most common admin tasks. - -To use `SimplePolicy`, you must enable it. Do so by adding the following to your `:instance` config object, so that it looks like this: - -``` -config :pleroma, :instance, - [...] - rewrite_policy: Pleroma.Web.ActivityPub.MRF.SimplePolicy -``` - -Once `SimplePolicy` is enabled, you can configure various groups in the `:mrf_simple` config object. These groups are: - -* `media_removal`: Servers in this group will have media stripped from incoming messages. -* `media_nsfw`: Servers in this group will have the #nsfw tag and sensitive setting injected into incoming messages which contain media. -* `reject`: Servers in this group will have their messages rejected. -* `federated_timeline_removal`: Servers in this group will have their messages unlisted from the public timelines by flipping the `to` and `cc` fields. -* `report_removal`: Servers in this group will have their reports (flags) rejected. - -Servers should be configured as lists. - -### Example - -This example will enable `SimplePolicy`, block media from `illegalporn.biz`, mark media as NSFW from `porn.biz` and `porn.business`, reject messages from `spam.com`, remove messages from `spam.university` from the federated timeline and block reports (flags) from `whiny.whiner`: - -``` -config :pleroma, :instance, - rewrite_policy: [Pleroma.Web.ActivityPub.MRF.SimplePolicy] - -config :pleroma, :mrf_simple, - media_removal: ["illegalporn.biz"], - media_nsfw: ["porn.biz", "porn.business"], - reject: ["spam.com"], - federated_timeline_removal: ["spam.university"], - report_removal: ["whiny.whiner"] - -``` - -### Use with Care - -The effects of MRF policies can be very drastic. It is important to use this functionality carefully. Always try to talk to an admin before writing an MRF policy concerning their instance. - -## Writing your own MRF Policy - -As discussed above, the MRF system is a modular system that supports pluggable policies. This means that an admin may write a custom MRF policy in Elixir or any other language that runs on the Erlang VM, by specifying the module name in the `rewrite_policy` config setting. - -For example, here is a sample policy module which rewrites all messages to "new message content": - -```elixir -# This is a sample MRF policy which rewrites all Notes to have "new message -# content." -defmodule Site.RewritePolicy do - @behavior Pleroma.Web.ActivityPub.MRF - - # Catch messages which contain Note objects with actual data to filter. - # Capture the object as `object`, the message content as `content` and the - # message itself as `message`. - @impl true - def filter(%{"type" => Create", "object" => {"type" => "Note", "content" => content} = object} = message) - when is_binary(content) do - # Subject / CW is stored as summary instead of `name` like other AS2 objects - # because of Mastodon doing it that way. - summary = object["summary"] - - # Message edits go here. - content = "new message content" - - # Assemble the mutated object. - object = - object - |> Map.put("content", content) - |> Map.put("summary", summary) - - # Assemble the mutated message. - message = Map.put(message, "object", object) - {:ok, message} - end - - # Let all other messages through without modifying them. - @impl true - def filter(message), do: {:ok, message} -end -``` - -If you save this file as `lib/site/mrf/rewrite_policy.ex`, it will be included when you next rebuild Pleroma. You can enable it in the configuration like so: - -``` -config :pleroma, :instance, - rewrite_policy: [ - Pleroma.Web.ActivityPub.MRF.SimplePolicy, - Site.RewritePolicy - ] -``` - -Please note that the Pleroma developers consider custom MRF policy modules to fall under the purview of the AGPL. As such, you are obligated to release the sources to your custom MRF policy modules upon request. diff --git a/docs/config/onion_federation.md b/docs/config/onion_federation.md deleted file mode 100644 index 99f104995..000000000 --- a/docs/config/onion_federation.md +++ /dev/null @@ -1,159 +0,0 @@ -# Easy Onion Federation (Tor) -Tor can free people from the necessity of a domain, in addition to helping protect their privacy. As Pleroma's goal is to empower the people and let as many as possible host an instance with as little resources as possible, the ability to host an instance with a small, cheap computer like a RaspberryPi along with Tor, would be a great way to achieve that. -In addition, federating with such instances will also help furthering that goal. - -This is a guide to show you how it can be easily done. - -This guide assumes you already got Pleroma working, and that it's running on the default port 4000. -Currently only has an Nginx example. - -To install Tor on Debian / Ubuntu: -``` -apt -yq install tor -``` -If using an old server version (older than Debian Stretch or Ubuntu 18.04), install from backports or PPA. -I recommend using a newer server version instead. - -To have the newest, V3 onion addresses (which I recommend) in Debian, install Tor from backports. -If you do not have backports, uncomment the stretch-backports links at the end of `/etc/apt/sources.list`. -Then install: -``` -apt update -apt -t stretch-backports -yq install tor -``` -**WARNING:** Onion instances not using a Tor version supporting V3 addresses will not be able to federate with you. - -Create the hidden service for your Pleroma instance in `/etc/tor/torrc`: -``` -HiddenServiceDir /var/lib/tor/pleroma_hidden_service/ -HiddenServicePort 80 127.0.0.1:8099 -HiddenServiceVersion 3 # Remove if Tor version is below 0.3 ( tor --version ) -``` -Restart Tor to generate an adress: -``` -systemctl restart tor@default.service -``` -Get the address: -``` -cat /var/lib/tor/pleroma_hidden_service/hostname -``` - -# Federation - -Next, edit your Pleroma config. -If running in prod, cd to your Pleroma directory, edit `config/prod.secret.exs` -and append this line: -``` -config :pleroma, :http, proxy_url: {:socks5, :localhost, 9050} -``` -In your Pleroma directory, assuming you're running prod, -run the following: -``` -su pleroma -MIX_ENV=prod mix deps.get -MIX_ENV=prod mix ecto.migrate -exit -``` -restart Pleroma (if using systemd): -``` -systemctl restart pleroma -``` - -# Tor Instance Access - -Make your instance accessible using Tor. - -## Tor-only Instance -If creating a Tor-only instance, open `config/prod.secret.exs` and under "config :pleroma, Pleroma.Web.Endpoint," edit "https" and "port: 443" to the following: -``` - url: [host: "onionaddress", scheme: "http", port: 80], -``` -In addition to that, replace the existing nginx config's contents with the example below. - -## Existing Instance (Clearnet Instance) -If not a Tor-only instance, -add the nginx config below to your existing config at `/etc/nginx/sites-enabled/pleroma.nginx`. - ---- -For both cases, disable CSP in Pleroma's config (STS is disabled by default) so you can define those yourself seperately from the clearnet (if your instance is also on the clearnet). -Copy the following into the `config/prod.secret.exs` in your Pleroma folder (/home/pleroma/pleroma/): -``` -config :pleroma, :http_security, - enabled: false -``` - -Use this as the Nginx config: -``` -proxy_cache_path /tmp/pleroma-media-cache levels=1:2 keys_zone=pleroma_media_cache:10m max_size=10g inactive=720m use_temp_path=off; -# The above already exists in a clearnet instance's config. -# If not, add it. - -server { - listen 127.0.0.1:8099; - server_name youronionaddress; - - # Comment to enable logs - access_log /dev/null; - error_log /dev/null; - - gzip_vary on; - gzip_proxied any; - gzip_comp_level 6; - gzip_buffers 16 8k; - gzip_http_version 1.1; - gzip_types text/plain text/css application/json application/javascript text/xml application/xml application/xml+rss text/javascript application/activity+json application/atom+xml; - - client_max_body_size 16m; - - location / { - - add_header X-XSS-Protection "1; mode=block"; - add_header X-Permitted-Cross-Domain-Policies none; - add_header X-Frame-Options DENY; - add_header X-Content-Type-Options nosniff; - add_header Referrer-Policy same-origin; - add_header X-Download-Options noopen; - - proxy_http_version 1.1; - proxy_set_header Upgrade $http_upgrade; - proxy_set_header Connection "upgrade"; - proxy_set_header Host $http_host; - - proxy_pass http://localhost:4000; - - client_max_body_size 16m; - } - - location /proxy { - proxy_cache pleroma_media_cache; - proxy_cache_lock on; - proxy_ignore_client_abort on; - proxy_pass http://localhost:4000; - } -} -``` -reload Nginx: -``` -systemctl reload nginx -``` - -You should now be able to both access your instance using Tor and federate with other Tor instances! - ---- - -### Possible Issues - -* In Debian, make sure your hidden service folder `/var/lib/tor/pleroma_hidden_service/` and its contents, has debian-tor as both owner and group by using -``` -ls -la /var/lib/tor/ -``` -If it's not, run: -``` -chown -R debian-tor:debian-tor /var/lib/tor/pleroma_hidden_service/ -``` -* Make sure *only* the owner has *only* read and write permissions. -If not, run: -``` -chmod -R 600 /var/lib/tor/pleroma_hidden_service/ -``` -* If you have trouble logging in to the Mastodon Frontend when using Tor, use the Tor Browser Bundle. diff --git a/docs/config/small_customizations.md b/docs/config/small_customizations.md deleted file mode 100644 index f91657a4c..000000000 --- a/docs/config/small_customizations.md +++ /dev/null @@ -1,12 +0,0 @@ -# Small customizations - -See also static_dir.md for visual settings. - -## Theme - -All users of your instance will be able to change the theme they use by going to the settings (the cog in the top-right hand corner). However, if you wish to change the default theme, you can do so by editing `theme` in `config/dev.secret.exs` accordingly. - -## Message Visibility - -To enable message visibility options when posting like in the Mastodon frontend, set -`scope_options_enabled` to `true` in `config/dev.secret.exs`. diff --git a/docs/config/static_dir.md b/docs/config/static_dir.md deleted file mode 100644 index 5fb38c3de..000000000 --- a/docs/config/static_dir.md +++ /dev/null @@ -1,69 +0,0 @@ -# Static Directory - -Static frontend files are shipped in `priv/static/` and tracked by version control in this repository. If you want to overwrite or update these without the possibility of merge conflicts, you can write your custom versions to `instance/static/`. - -``` -config :pleroma, :instance, - static_dir: "instance/static/", -``` - -For example, edit `instance/static/instance/panel.html` . - -Alternatively, you can overwrite this value in your configuration to use a different static instance directory. - -This document is written assuming `instance/static/`. - -Or, if you want to manage your custom file in git repository, basically remove the `instance/` entry from `.gitignore`. - -## robots.txt - -By default, the `robots.txt` that ships in `priv/static/` is permissive. It allows well-behaved search engines to index all of your instance's URIs. - -If you want to generate a restrictive `robots.txt`, you can run the following mix task. The generated `robots.txt` will be written in your instance static directory. - -``` -mix pleroma.robots_txt disallow_all -``` - -## Thumbnail - -Put on `instance/static/instance/thumbnail.jpeg` with your selfie or other neat picture. It will appear in [Pleroma Instances](http://distsn.org/pleroma-instances.html). - -## Instance-specific panel - - - -Create and Edit your file on `instance/static/instance/panel.html`. - -## Background - -You can change the background of your Pleroma instance by uploading it to `instance/static/`, and then changing `background` in `config/prod.secret.exs` accordingly. - -If you put `instance/static/images/background.jpg` - -``` -config :pleroma, :frontend_configurations, - pleroma_fe: %{ - background: "/images/background.jpg" - } -``` - -## Logo - - - -If you want to give a brand to your instance, You can change the logo of your instance by uploading it to `instance/static/`. - -Alternatively, you can specify the path with config. -If you put `instance/static/static/mylogo-file.png` - -``` -config :pleroma, :frontend_configurations, - pleroma_fe: %{ - logo: "/static/mylogo-file.png" - } -``` - -## Terms of Service - -Terms of Service will be shown to all users on the registration page. It's the best place where to write down the rules for your instance. You can modify the rules by changing `instance/static/static/terms-of-service.html`. |