matty/ncd-fe
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
71eb595458d84f8b153a42225d3eb8c15bc05eab
ncd-fe/packages/pl-fe/README.md
mkljczk a3cf44d860 pl-fe: Add a note to readme 
Signed-off-by: mkljczk <git@mkljczk.pl>
2025-02-15 13:57:23 +01:00

3.2 KiB
Raw Blame History

pl-fe is a social networking client app. It works with any Mastodon API-compatible software, but it's focused on supporting alternative backends, like Pleroma or GoToSocial.

GitHub Repo stars GitHub License Weblate project translated

Try it out

Want to test pl-fe with any existing MastoAPI-compatible server? Try pl.mkljczk.pl — enter your server's domain name to use pl-fe on any server!

If you want to use pl-fe as the default frontend on your server, download the latest build from pl.mkljczk.pl/pl-fe.zip and install it following the instructions for your backend. For example, on a standard Pleroma installation you can use:

curl -O https://pl.mkljczk.pl/pl-fe.zip
unzip pl-fe.zip -d /opt/pleroma/instance/static/
rm pl-fe.zip

Note: Some Fediverse software (Akkoma, Mitra) use Content Security Policy configuration which disallows the usage of inline styles, which are used by pl-fe for color schemes. Mangane README suggests using server configuration to override the default CSP header:

Here is an example configuration for nginx:

# add style-src for mangane
proxy_hide_header Content-Security-Policy;
add_header Content-Security-Policy "upgrade-insecure-requests;script-src 'self';connect-src 'self' blob: https://example.com wss://example.com;media-src 'self' https:;img-src 'self' data: blob: https:;default-src 'none';base-uri 'self';frame-ancestors 'none';style-src 'self' 'unsafe-inline';font-src 'self';manifest-src 'self';" always;

Please replace https://example.com with your own domain

Contribute

Code contributions are welcome. Weblate is used for project translation.

Translation status

License

pl-fe is a fork of Soapbox, which was forked from Gab Social, which is a fork of Mastodon.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.

Follow my Pleroma account to stay up to date on pl-fe development.