1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/osada_ynh.git synced 2024-09-03 19:46:30 +02:00

Add README

This commit is contained in:
ericgaspar 2021-11-03 22:51:21 +01:00
parent 67e67702bb
commit fcbc9c3f33
No known key found for this signature in database
GPG key ID: 574F281483054D44
4 changed files with 27 additions and 2 deletions

2
doc/DESCRIPTION.md Normal file
View file

@ -0,0 +1,2 @@
## Overview
[Osada](http://zotlabs.com/osada/) uses **Zot6 protocol** which is next version of **zot5 protocol**. Osada has native support for the **ActivityPub protocol** (W3C standard) as well as the more advanced features. It can inter-operate with other social networking applications and projects in either of these spaces, including **Mastodon, Pleroma, Pixelfed, PeerTube, Funkwhale, Zap, Friendica, Hubzilla,** and many more.

18
doc/DISCLAIMER.md Normal file
View file

@ -0,0 +1,18 @@
## This app claims following features:
- [X] LDAP integration
- [X] Multi-instance
- [X] Adeed php.log in the root folder for debugging PHP, with logrotate applied on it (can be accesssed by **admin->logs** and entering the **php.log**).
- [X] Fail2Ban
- [X] Option to choose between **Mysql** and **PostgreSQL** for the Osada
## Ldap Admin user rights, logs and failed database updates
- **For admin rights**: When installation is complete, you will need to visit your new hub's page and login with the **admin account username** which was entered at the time of installation process. You should then be able to create your first channel and have the **admin rights** for the hub.
- **For normal YunoHost users**: Normal LDAP users can login through LDAP authentication and create there channels.
- **Failing to get admin rights**: If the admin cannot access the admin settings at `https://osada.example.com/admin` then you have to **manually add 4096** to the **account_roles** under **accounts** for that user in the **database through phpMyAdmin**.
- **For logs**: Go to **admin->logs** and enter the file name **php.log**.
- **Failed Database after Upgrade:** Some times databse upgrade fails after version upgrade. You can go to hub eg. `https://osada.example.com/admin/dbsync/` and check the numbers of failled update. These updates will have to be ran manually by **phpMyAdmin**.

Binary file not shown.

After

Width:  |  Height:  |  Size: 114 KiB

View file

@ -6,9 +6,14 @@
"en": "Decentralized publication platform and social network",
"fr": "Plateforme de publication décentralisée et un réseau social"
},
"url": "http://zotlabs.com/osada/",
"license": "MIT",
"version": "21.05.21~ynh1",
"url": "http://zotlabs.com/osada/",
"upstream": {
"license": "MIT",
"website": "http://zotlabs.com/osada/",
"code": "https://codeberg.org/zot/osada"
},
"license": "MIT",
"maintainer": {
"name": "Anmol Sharma",
"email": ""