mirror of
https://github.com/YunoHost-Apps/kanboard_ynh.git
synced 2024-09-03 19:36:17 +02:00
125 lines
4.1 KiB
Markdown
125 lines
4.1 KiB
Markdown
|
Kanboard
|
||
|
|
========
|
||
|
|
|
||
|
|
Kanboard is a simple visual task board web application.
|
||
|
|
|
||
|
|
Official website: <http://kanboard.net>
|
||
|
|
|
||
|
|
- Inspired by the [Kanban methodology](http://en.wikipedia.org/wiki/Kanban)
|
||
|
|
- Get a visual and clear overview of your project
|
||
|
|
- Multiple boards with the ability to drag and drop tasks
|
||
|
|
- Minimalist software, focus only on essential features (Less is more)
|
||
|
|
- Open source and self-hosted
|
||
|
|
- Super simple installation
|
||
|
|
|
||
|
|
[](https://travis-ci.org/fguillot/kanboard)
|
||
|
|
|
||
|
|
[](https://scrutinizer-ci.com/g/fguillot/kanboard/)
|
||
|
|
|
||
|
|
Features
|
||
|
|
--------
|
||
|
|
|
||
|
|
- Multiple boards/projects
|
||
|
|
- Boards customization, rename or add columns
|
||
|
|
- Tasks with different colors, categories, sub-tasks, attachments, Markdown support for the description
|
||
|
|
- Automatic actions
|
||
|
|
- Users management with a basic privileges separation (administrator or regular user)
|
||
|
|
- External authentication: Google and GitHub accounts as well as LDAP/ActiveDirectory
|
||
|
|
- Webhooks to create tasks from an external software
|
||
|
|
- Host anywhere (shared hosting, VPS, Raspberry Pi or localhost)
|
||
|
|
- No external dependencies
|
||
|
|
- **Super easy setup**, copy and paste files and you are done!
|
||
|
|
- Translations in English, French, Brazilian Portuguese, Spanish, German, Polish, Swedish and Chinese
|
||
|
|
|
||
|
|
Roadmap
|
||
|
|
-------
|
||
|
|
|
||
|
|
Kanboard is under active development, have a look to the roadmap: <http://kanboard.net/#roadmap>
|
||
|
|
|
||
|
|
Known bugs
|
||
|
|
----------
|
||
|
|
|
||
|
|
See Issues: <https://github.com/fguillot/kanboard/issues>
|
||
|
|
|
||
|
|
License
|
||
|
|
-------
|
||
|
|
|
||
|
|
GNU Affero General Public License version 3: <http://www.gnu.org/licenses/agpl-3.0.txt>
|
||
|
|
|
||
|
|
Authors
|
||
|
|
-------
|
||
|
|
|
||
|
|
Original author: [Frédéric Guillot](http://fredericguillot.com/)
|
||
|
|
|
||
|
|
Contributors:
|
||
|
|
|
||
|
|
- Alex Butum: https://github.com/dZkF9RWJT6wN8ux
|
||
|
|
- Claudio Lobo
|
||
|
|
- Gavlepeter: https://github.com/gavlepeter
|
||
|
|
- Jesusaplsoft: https://github.com/jesusaplsoft
|
||
|
|
- Kiswa: https://github.com/kiswa
|
||
|
|
- Levlaz: https://github.com/levlaz
|
||
|
|
- Mathgl67: https://github.com/mathgl67
|
||
|
|
- Matthieu Keller: https://github.com/maggick
|
||
|
|
- Maxime: https://github.com/EpocDotFr
|
||
|
|
- Moraxy: https://github.com/moraxy
|
||
|
|
- Nala Ginrut: https://github.com/NalaGinrut
|
||
|
|
- Nekohayo: https://github.com/nekohayo
|
||
|
|
- Olivier Maridat: https://github.com/oliviermaridat
|
||
|
|
- Poikilotherm: https://github.com/poikilotherm
|
||
|
|
- Raphaël Doursenaud: https://github.com/rdoursenaud
|
||
|
|
- Rzeka: https://github.com/rzeka
|
||
|
|
- Sebastien pacilly: https://github.com/spacilly
|
||
|
|
- Toomyem: https://github.com/Toomyem
|
||
|
|
- Troloo: https://github.com/troloo
|
||
|
|
- Typz: https://github.com/Typz
|
||
|
|
|
||
|
|
There is also many people who have reported bugs or proposed awesome ideas.
|
||
|
|
|
||
|
|
Documentation
|
||
|
|
-------------
|
||
|
|
|
||
|
|
### Using Kanboard
|
||
|
|
|
||
|
|
- [Usage examples](docs/usage-examples.markdown)
|
||
|
|
- [Manage users](docs/manage-users.markdown)
|
||
|
|
- [Syntax guide](docs/syntax-guide.markdown)
|
||
|
|
- [Automatic actions](docs/automatic-actions.markdown)
|
||
|
|
|
||
|
|
### Technical details
|
||
|
|
|
||
|
|
#### Installation
|
||
|
|
|
||
|
|
- [Installation instructions](docs/installation.markdown)
|
||
|
|
- [Installation on Ubuntu](docs/ubuntu-installation.markdown)
|
||
|
|
- [Installation on Debian](docs/debian-installation.markdown)
|
||
|
|
- [Installation on Centos](docs/centos-installation.markdown)
|
||
|
|
- [Upgrade Kanboard to a new version](docs/update.markdown)
|
||
|
|
- [Secure connections (HTTPS)](docs/secure-connections.markdown)
|
||
|
|
|
||
|
|
#### Database
|
||
|
|
|
||
|
|
- [Sqlite database management](docs/sqlite-database.markdown)
|
||
|
|
- [How to use Mysql](docs/mysql-configuration.markdown)
|
||
|
|
- [How to use Postgresql](docs/postgresql-configuration.markdown)
|
||
|
|
|
||
|
|
#### Authentication
|
||
|
|
|
||
|
|
- [LDAP authentication](docs/ldap-authentication.markdown)
|
||
|
|
- [Google authentication](docs/google-authentication.markdown)
|
||
|
|
- [GitHub authentication](docs/github-authentication.markdown)
|
||
|
|
|
||
|
|
#### Developers
|
||
|
|
|
||
|
|
- [Json-RPC API](docs/api-json-rpc.markdown)
|
||
|
|
- [How to use Kanboard with Vagrant](docs/vagrant.markdown)
|
||
|
|
- [Webhooks](docs/webhooks.markdown)
|
||
|
|
|
||
|
|
The documentation is written in [Markdown](http://en.wikipedia.org/wiki/Markdown).
|
||
|
|
If you want to improve the documentation, just send a pull-request.
|
||
|
|
|
||
|
|
FAQ
|
||
|
|
---
|
||
|
|
|
||
|
|
Go to the official website: <http://kanboard.net/faq>
|