mirror of
https://github.com/YunoHost-Apps/cowyo_ynh.git
synced 2024-09-03 18:16:15 +02:00
53 lines
2.2 KiB
Markdown
53 lines
2.2 KiB
Markdown
<!--
|
|
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.
|
|
-->
|
|
|
|
# Cowyo for YunoHost
|
|
|
|
[](https://dash.yunohost.org/appci/app/cowyo)  
|
|
[](https://install-app.yunohost.org/?app=cowyo)
|
|
|
|
*[Lire ce readme en français.](./README_fr.md)*
|
|
|
|
> *This package allows you to install Cowyo quickly and simply on a YunoHost server.
|
|
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
|
|
|
## Overview
|
|
|
|
Cowyo is a self-contained wiki server that makes jotting notes easy and fast. The most important feature here is simplicity. Other features include versioning, page locking, self-destructing messages, encryption, and listifying. See https://github.com/schollz/cowyo#usage
|
|
|
|
|
|
**Shipped version:** 2.12.0~ynh5
|
|
|
|
**Demo:** https://cowyo.com
|
|
## Disclaimers / important information
|
|
|
|
## Limitations
|
|
|
|
* By design, *cowyo* requires its own domain.
|
|
|
|
## Configuration
|
|
|
|
No configuration required except specifying the domain to access it, and its public/private status.
|
|
|
|
## Documentation and resources
|
|
|
|
* Official admin documentation: <https://github.com/schollz/cowyo/blob/master/README.md>
|
|
* Upstream app code repository: <https://github.com/schollz/cowyo>
|
|
* YunoHost documentation for this app: <https://yunohost.org/app_cowyo>
|
|
* Report a bug: <https://github.com/YunoHost-Apps/cowyo_ynh/issues>
|
|
|
|
## Developer info
|
|
|
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/cowyo_ynh/tree/testing).
|
|
|
|
To try the testing branch, please proceed like that.
|
|
|
|
``` bash
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/cowyo_ynh/tree/testing --debug
|
|
or
|
|
sudo yunohost app upgrade cowyo -u https://github.com/YunoHost-Apps/cowyo_ynh/tree/testing --debug
|
|
```
|
|
|
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|