YunoHost-Apps/friendica_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/friendica_ynh.git synced 2024-09-03 18:36:14 +02:00
Code Issues Activity Actions

Update README.md

Browse source 
Copy-editing
This commit is contained in:
Spencer Dub 2020-09-24 09:57:51 -07:00 committed by GitHub
parent 7c4c2d32e8
commit e1b08b432f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -9,7 +9,7 @@ If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to
[Friendica](http://friendi.ca/) integration for YunoHost<br> [Friendica](http://friendi.ca/) integration for YunoHost<br>
**Version:2020.03**<br><br> **Version:2020.09*<br><br>
Current snapshot in *sources*: Current snapshot in *sources*:
@ -18,14 +18,11 @@ Current snapshot in *sources*:
## Important Notes ## Important Notes
Before installing, read the [Friendica installation instructions](https://github.com/friendica/friendica/blob/master/INSTALL.txt) for important information about Before installing, read the [Friendica installation instructions](https://github.com/friendica/friendica/blob/develop/doc/Install.md) for important information about
- SSL certificate validation requirement (now with support for [Let's Encrypt!](https://letsencrypt.org)). See Installation section below. - SSL certificate validation requirement (now with support for [Let's Encrypt!](https://letsencrypt.org)). See Installation section below.
- Dedicated domain (must install under web root like **https://hub.example.com/** not **https://example.com/hub/** ) - Dedicated domain (must install under web root like **https://hub.example.com/** not **https://example.com/hub/** )
#### Multi-users support **Note:** You can use accounts from YunoHost's LDAP. Single sign-on (SSO) is not yet functional.
LDAP auth supported. There are not yet active SSO.
<br><br>
# To-do # To-do
- [ ] Fail2Ban support - [ ] Fail2Ban support
@ -36,15 +33,19 @@ LDAP auth supported. There are not yet active SSO.
### Register a new domain and add it to YunoHost ### 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 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](https://letsencrypt.org/), install them manually as usual.
### Install the Friendica application ### Install the Friendica application
Use the YunoHost admin panel to install Friendica by entering the GitHub repo address in the custom app URL 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 https://github.com/YunoHost-Apps/friendica_ynh
Make sure to select your domain from the previous section as the application domain. 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 installaion 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 adjecent to the search bar.<b>(The admin panel don't have text,so don't get confuse with it) </b> 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 there username and password as normal users too. 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 Developers info
---------------- ----------------