wekan_ynh/README.md

# Wekan for YunoHost

[![Integration level](https://dash.yunohost.org/integration/wekan.svg)](https://dash.yunohost.org/appci/app/wekan) ![](https://ci-apps.yunohost.org/ci/badges/wekan.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/wekan.maintain.svg)  
[![Install Wekan with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=wekan)

> *This package allows you to install Wekan 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
Wekan is an open-source kanban board (task manager and organizer)

**Shipped version:** 5.00

## Screenshots

![](screenshot.jpg)

## Status

- This app **only works on x86, 64bits architecture**! In particular, it won't work on 32 bit machines or ARM. See the discussion [here](https://github.com/YunoHost-Apps/wekan_ynh/issues/1#issuecomment-401612500).

- There is currently **no SSO integration** though it might be integrated at some point in the app, now that it's supported in Meteor/Wekan. In the meantime, users can create accounts (in fact, they can create infinite number of accounts) manually, and need to login manually specifically in Wekan.

## Infos

**Package by:** ljf & Aleks
**Categories:** Productivity, Task

## Configuration

As LDAP authentification is enabled by default, Wekan admins correspond to the permission `Wekan Admin`. The user you choose during installation is member of this group.
To add an admin account, you can:

- [with the webadmin] go to Users > Groups and permissions > Add the user to the permission `Wekan Admin`
- [or with the command line] `yunohost user permission update wekan.admin -a the_user_to_add`

All others YunhoHost user can access with LDAP authentication.

If you have disable ldap authentication, first registered user will be admin, and next ones normal users. If you want other admins too, you can change their permission to admin at Wekan Admin Panel.

**Private/Public mode:** In private mode, only authorized YunoHost members can access to the Wekan. 

## Documentation

 * Official documentation: https://github.com/wekan/wekan/wiki
 * YunoHost documentation: https://yunohost.org/#/app_wekan

## YunoHost specific features

#### Multi-user support

LDAP is supported but HTTP auth is still not supported

#### Supported architectures

* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/wekan%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/wekan/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/wekan%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/wekan/)

## Links

 * Report a bug: https://github.com/YunoHost-Apps/wekan_ynh/issues
 * App website: https://wekan.github.io/
 * Upstream app repository: https://github.com/wekan/wekan
 * YunoHost website: https://yunohost.org/

---

## Developer info

Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/wekan_ynh/tree/testing).

To try the testing branch, please proceed like that.
```
sudo yunohost app install https://github.com/YunoHost-Apps/wekan_ynh/tree/testing --debug
or
sudo yunohost app upgrade wekan -u https://github.com/YunoHost-Apps/wekan_ynh/tree/testing --debug
```
Update README.md Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com> 2020-08-07 19:48:33 +02:00			`# Wekan for YunoHost`
Initial commit 2017-02-10 17:06:59 +01:00
Apply last example_ynh 2020-06-15 04:15:42 +02:00			`[![Integration level](https://dash.yunohost.org/integration/wekan.svg)](https://dash.yunohost.org/appci/app/wekan) ![](https://ci-apps.yunohost.org/ci/badges/wekan.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/wekan.maintain.svg)`
Apply last example_ynh 2021-02-25 23:53:02 +01:00			`[![Install Wekan with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=wekan)`
Apply example_ynh on README.md 2019-02-05 23:00:28 +01:00
Apply last example_ynh 2020-06-15 04:15:42 +02:00			`> *This package allows you to install Wekan 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.*`
Apply example_ynh on README.md 2019-02-05 23:00:28 +01:00
			`## Overview`
			`Wekan is an open-source kanban board (task manager and organizer)`
Update README.md 2019-01-29 02:28:17 +01:00
Upgrade to 5.00 2021-02-26 00:16:24 +01:00			`Shipped version: 5.00`
update version number to 2.09 2019-02-05 21:16:13 +01:00
Apply example_ynh on README.md 2019-02-05 23:00:28 +01:00			`## Screenshots`
Update README.md 2019-01-29 02:28:17 +01:00
			`![](screenshot.jpg)`
Initial commit 2017-02-10 17:06:59 +01:00
Update README 2017-02-26 17:53:28 +01:00			`## Status`

Update README.md - Add badges 2020-09-11 22:40:15 +02:00			`- This app only works on x86, 64bits architecture! In particular, it won't work on 32 bit machines or ARM. See the discussion [here](https://github.com/YunoHost-Apps/wekan_ynh/issues/1#issuecomment-401612500).`
Update README 2017-02-26 17:53:28 +01:00
Update according LDAP implementation 2019-03-07 03:08:27 +01:00			`- There is currently no SSO integration though it might be integrated at some point in the app, now that it's supported in Meteor/Wekan. In the meantime, users can create accounts (in fact, they can create infinite number of accounts) manually, and need to login manually specifically in Wekan.`
Update README 2017-02-26 17:53:28 +01:00
[enh] Upgrade all the package, backup script 2017-10-02 02:07:41 +02:00			`## Infos`

Update README.md 2019-01-29 02:28:17 +01:00			`Package by: ljf & Aleks`
[enh] Upgrade all the package, backup script 2017-10-02 02:07:41 +02:00			`Categories: Productivity, Task`

Apply example_ynh on README.md 2019-02-05 23:00:28 +01:00			`## Configuration`

Apply last example_ynh 2020-06-15 04:15:42 +02:00			As LDAP authentification is enabled by default, Wekan admins correspond to the permission `Wekan Admin`. The user you choose during installation is member of this group.
Add admin creation during install 2020-04-01 17:49:20 +02:00			`To add an admin account, you can:`
fix ldap 2020-04-01 16:01:52 +02:00
Update README.md Co-Authored-By: Alexandre Aubin <alex.aubin@mailoo.org> 2020-04-01 16:57:38 +02:00			- [with the webadmin] go to Users > Groups and permissions > Add the user to the permission `Wekan Admin`
			- [or with the command line] `yunohost user permission update wekan.admin -a the_user_to_add`
Add admin information when using ldap authentication 2019-07-11 00:42:12 +02:00
Adding informations 2020-04-05 01:52:08 +02:00			`All others YunhoHost user can access with LDAP authentication.`

Add admin information when using ldap authentication 2019-07-11 00:42:12 +02:00			`If you have disable ldap authentication, first registered user will be admin, and next ones normal users. If you want other admins too, you can change their permission to admin at Wekan Admin Panel.`
Apply example_ynh on README.md 2019-02-05 23:00:28 +01:00
Apply last example_ynh 2020-06-15 04:15:42 +02:00			`Private/Public mode: In private mode, only authorized YunoHost members can access to the Wekan.`
Apply example_ynh 2019-07-10 00:03:59 +02:00
Apply example_ynh on README.md 2019-02-05 23:00:28 +01:00			`## Documentation`

			`* Official documentation: https://github.com/wekan/wekan/wiki`
Update README.md - Add badges 2020-09-11 22:40:15 +02:00			`* YunoHost documentation: https://yunohost.org/#/app_wekan`
Apply example_ynh on README.md 2019-02-05 23:00:28 +01:00
			`## YunoHost specific features`

Apply last example_ynh 2020-06-15 04:15:42 +02:00			`#### Multi-user support`
Update according LDAP implementation 2019-03-07 03:08:27 +01:00
Spelling 2019-03-27 11:13:37 +01:00			`LDAP is supported but HTTP auth is still not supported`
Add admin information when using ldap authentication 2019-07-11 00:42:12 +02:00
Apply example_ynh on README.md 2019-02-05 23:00:28 +01:00			`#### Supported architectures`

Apply last example_ynh 2020-06-15 04:15:42 +02:00			`* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/wekan%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/wekan/)`
Upgrade X64 to 2. 98 + introducing ARM64 2.94 2019-07-09 22:34:52 +02:00			`* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/wekan%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/wekan/)`
Apply example_ynh on README.md 2019-02-05 23:00:28 +01:00
			`## Links`

			`* Report a bug: https://github.com/YunoHost-Apps/wekan_ynh/issues`
adding links 2019-02-06 00:29:35 +01:00			`* App website: https://wekan.github.io/`
Apply example_ynh 2019-07-10 00:03:59 +02:00			`* Upstream app repository: https://github.com/wekan/wekan`
Apply example_ynh on README.md 2019-02-05 23:00:28 +01:00			`* YunoHost website: https://yunohost.org/`

			`---`

Apply last example_ynh 2021-02-25 23:53:02 +01:00			`## Developer info`
Apply example_ynh on README.md 2019-02-05 23:00:28 +01:00
Apply last example_ynh 2020-06-15 04:15:42 +02:00			`Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/wekan_ynh/tree/testing).`
Apply example_ynh on README.md 2019-02-05 23:00:28 +01:00
			`To try the testing branch, please proceed like that.`
			```
			`sudo yunohost app install https://github.com/YunoHost-Apps/wekan_ynh/tree/testing --debug`
			`or`
			`sudo yunohost app upgrade wekan -u https://github.com/YunoHost-Apps/wekan_ynh/tree/testing --debug`
			```