1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/wekan_ynh.git synced 2024-09-03 20:36:09 +02:00
wekan_ynh/README.md

78 lines
3.2 KiB
Markdown
Raw Normal View History

2017-02-10 17:06:59 +01:00
# Wekan for Yunohost
2020-09-11 22:40:15 +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)
2019-02-05 23:00:28 +01:00
[![Install Wekan with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=wekan)
2019-07-10 00:03:59 +02:00
> *This package allow you to install Wekan quickly and simply on a YunoHost server.
2019-02-05 23:00:28 +01:00
If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
## Overview
Wekan is an open-source kanban board (task manager and organizer)
2019-01-29 02:28:17 +01:00
2020-05-29 18:54:49 +02:00
**Shipped version:** 4.09
2019-02-05 21:16:13 +01:00
2019-02-05 23:00:28 +01:00
## Screenshots
2019-01-29 02:28:17 +01:00
![](screenshot.jpg)
2017-02-10 17:06:59 +01:00
2017-02-26 17:53:28 +01:00
## Status
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).
2017-02-26 17:53:28 +01:00
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.
2017-02-26 17:53:28 +01:00
## Infos
2019-01-29 02:28:17 +01:00
**Package by:** ljf & Aleks
**Categories:** Productivity, Task
2019-02-05 23:00:28 +01:00
## Configuration
2020-04-01 17:49:20 +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.
To add an admin account, you can:
2020-04-01 16:01:52 +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`
2020-04-05 01:52:08 +02:00
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.
2019-02-05 23:00:28 +01:00
2019-07-10 00:03:59 +02:00
**Private/Public mode:** In private mode, only authorized YunoHost members can access to the wekan.
2019-02-05 23:00:28 +01:00
## Documentation
* Official documentation: https://github.com/wekan/wekan/wiki
2020-09-11 22:40:15 +02:00
* YunoHost documentation: https://yunohost.org/#/app_wekan
2019-02-05 23:00:28 +01:00
## YunoHost specific features
2019-03-07 03:08:27 +01:00
#### Multi-users support
2019-03-27 11:13:37 +01:00
LDAP is supported but HTTP auth is still not supported
2019-02-05 23:00:28 +01:00
#### Supported architectures
2020-09-11 22:40:15 +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/)
* 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/)
2019-02-05 23:00:28 +01:00
## Links
* Report a bug: https://github.com/YunoHost-Apps/wekan_ynh/issues
2019-02-06 00:29:35 +01:00
* App website: https://wekan.github.io/
2019-07-10 00:03:59 +02:00
* Upstream app repository: https://github.com/wekan/wekan
2019-02-05 23:00:28 +01:00
* YunoHost website: https://yunohost.org/
---
2020-09-11 22:40:15 +02:00
## Developers info
2019-02-05 23:00:28 +01:00
Please do 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
```