1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/tiki_ynh.git synced 2024-09-04 01:15:54 +02:00
tiki_ynh/README.md

61 lines
2.9 KiB
Markdown
Raw Normal View History

2022-05-22 20:54:12 +02:00
<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->
2022-05-22 20:54:18 +02:00
# Tiki for YunoHost
2022-05-22 20:54:12 +02:00
2022-05-24 11:07:06 +02:00
[![Integration level](https://dash.yunohost.org/integration/tiki.svg)](https://dash.yunohost.org/appci/app/tiki) ![Working status](https://ci-apps.yunohost.org/ci/badges/tiki.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/tiki.maintain.svg)
2022-05-22 20:54:18 +02:00
[![Install Tiki with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=tiki)
2022-05-22 20:54:12 +02:00
*[Lire ce readme en français.](./README_fr.md)*
2022-05-22 20:54:18 +02:00
> *This package allows you to install Tiki quickly and simply on a YunoHost server.
2022-05-22 20:54:12 +02:00
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview
2022-12-15 08:57:11 +01:00
Tiki Wiki CMS Groupware is the Free / Libre / Open Source Web Application with the most built-in features. Use cases: Web Publishing / Collaboration / Project Management / Office Suite / Knowledge base / Shopping Cart / Social Networking / CRM / Membership / E-learning. Tiki Trackers is the built-in database web apps builder and low-code / no-code application framework.
2022-05-22 20:54:12 +02:00
2022-05-24 11:40:44 +02:00
**Shipped version:** 24.0~ynh2
2022-05-22 20:54:12 +02:00
2022-05-22 20:54:18 +02:00
**Demo:** https://tiki.org/Try-Tiki
2022-05-22 20:54:12 +02:00
2022-05-22 20:54:18 +02:00
## Screenshots
2022-05-22 20:54:12 +02:00
2022-05-24 11:07:06 +02:00
![Screenshot of Tiki](./doc/screenshots/Screenshot.png)
2022-05-22 20:54:12 +02:00
## Disclaimers / important information
2022-05-22 22:51:09 +02:00
### Postinstall
2022-05-22 21:13:17 +02:00
Database credentials are sent by mail for the post installation. `http://example.org/tiki-install.php`
2022-05-22 22:51:09 +02:00
### Storing your uploaded files
To ease the install process and first access, Tiki saves your uploaded files (office documents, images, pdf, etc. attached to wiki pages, forum posts, tracker items, file galleries, ...) by default in its database. This works perfectly in most cases but it is not the recommended setup if you need to save many thousands of files or more.
In that case, consider switching from "Store to database" to "Store to directory", which you will find in the Configuration Wizard. Please use this preset path directory: `/home/yunohost.app/tiki`. You will be able to migrate your currently uploaded files from one to the other.
2022-05-22 20:54:12 +02:00
## Documentation and resources
2022-05-24 11:07:06 +02:00
* Official app website: <https://tiki.org/>
* Official admin documentation: <https://doc.tiki.org>
* Upstream app code repository: <https://gitlab.com/tikiwiki/tiki/>
* YunoHost documentation for this app: <https://yunohost.org/app_tiki>
* Report a bug: <https://github.com/YunoHost-Apps/tiki_ynh/issues>
2022-05-22 20:54:12 +02:00
## Developer info
2022-05-22 20:54:18 +02:00
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/tiki_ynh/tree/testing).
2022-05-22 20:54:12 +02:00
To try the testing branch, please proceed like that.
2022-05-24 11:07:06 +02:00
``` bash
2022-05-22 20:54:18 +02:00
sudo yunohost app install https://github.com/YunoHost-Apps/tiki_ynh/tree/testing --debug
2022-05-22 20:54:12 +02:00
or
2022-05-22 20:54:18 +02:00
sudo yunohost app upgrade tiki -u https://github.com/YunoHost-Apps/tiki_ynh/tree/testing --debug
2022-05-22 20:54:12 +02:00
```
2022-05-24 11:07:06 +02:00
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>