mirror of https://github.com/YunoHost-Apps/friendica_ynh.git synced 2024-09-03 18:36:14 +02:00

Friendica package for YunoHost

Find a file

Spencer Dub c0c4b871f5 Update LICENSE It is 2020.		2020-09-24 10:10:40 -07:00
conf	Update addons.src	2020-09-24 10:06:25 -07:00
scripts	Removed logrotate	2020-04-24 01:05:23 +05:30
check_process	Forgot to updated addon sources and updated readme, manifest	2020-04-20 10:53:16 +05:30
LICENSE	Update LICENSE	2020-09-24 10:10:40 -07:00
manifest.json	Forgot to updated addon sources and updated readme, manifest	2020-04-20 10:53:16 +05:30
pull_request_template.md	Forgot to updated addon sources and updated readme, manifest	2020-04-20 10:53:16 +05:30
README.md	Update README.md	2020-09-24 09:58:58 -07:00

README.md

This package allow you to install Friendica quickly and simply on a YunoHost server.
If you don't have YunoHost, please see here to learn how to install and enjoy it.

Friendica integration for YunoHost

Version:2020.09

Current snapshot in sources:

https://github.com/friendica/friendica: 2020.03
https://github.com/friendica/friendica-addons: 2020.03

Important Notes

Before installing, read the Friendica installation instructions for important information about

SSL certificate validation requirement (now with support for Let's Encrypt!). See Installation section below.
Dedicated domain (must install under web root like https://hub.example.com/ not https://example.com/hub/ )

Note: You can use accounts from YunoHost's LDAP. Single sign-on (SSO) is not yet functional.

To-do

Fail2Ban support

Installation

Register a new domain and add it to YunoHost

Friendica requires a dedicated domain, so obtain one and add it using the YunoHost admin panel. Domains -> Add domain. As Friendica uses the full domain and is installed on the root, you can create a subdomain such as friendica.domain.tld. Don't forget to update your DNS if you manage them manually.

Friendica requires browser-approved SSL certificates. If you have certificates not issued by Let's Encrypt, install them manually as usual.

Install the Friendica application

Use the YunoHost admin panel to install Friendica by entering the GitHub repo address in the custom app URL:

	https://github.com/YunoHost-Apps/friendica_ynh

Make sure to select your domain from the previous section as the application domain.

After the installation, login with the username provided at the time of the installation with your SSO password. You can then create your profile and access the admin panel from the button in the center of the top nav bar, just adjacent to the search bar. (The admin panel doesn't have text, so don't get confused with it.) Public users can register and use the instance as normal users. SSO users can login with their username and password as normal users too.

Developers info

Only if you want to use a testing branch for coding, instead of merging directly into master. Please do your pull request to the testing branch.

To try the testing branch, please proceed like that.

sudo yunohost app install https://github.com/YunoHost-Apps/friendica_ynh/tree/testing --debug
or
sudo yunohost app upgrade REPLACEBYYOURAPP -u https://github.com/YunoHost-Apps/friendica_ynh/tree/testing --debug