AS1024/Kanboard-Prod
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add documentations

Browse Source
This commit is contained in:
Frédéric Guillot
2014-03-02 21:53:48 -05:00
parent 1e9232643e
commit c8714c01a4
6 changed files with 113 additions and 128 deletions
Download Patch File Download Diff File Expand all files Collapse all files

147
README.markdown
View File

@@ -3,6 +3,8 @@ Kanboard
Kanboard is a simple visual task board web application. 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) - Inspired by the [Kanban methodology](http://en.wikipedia.org/wiki/Kanban)
- Get a visual and clear overview of your project - Get a visual and clear overview of your project
- Multiple boards with the ability to drag and drop tasks - Multiple boards with the ability to drag and drop tasks
@@ -10,19 +12,6 @@ Kanboard is a simple visual task board web application.
- Open source and self-hosted - Open source and self-hosted
- Super simple installation - Super simple installation
Usage examples
--------------
You can customize your boards according to your business activities:
- Software management: Backlog, Ready, Work in Progress, To be tested, Validated
- Bug tracking: Received, Confirmed, Work in progress, Tested, Fixed
- Sales: Prospect, Meeting, Proposal, Sale
- Lean business management: Ideas, Developement, Measure, Analysis, Done
- Recruiting: Candidates Pool, Phone Screens, Job Interviews, Hires
- E-Commerce Shop: Orders, Packaged, Shipped
- Construction Planning: Materials ordered, Materials received, Work in progress, Work done, Invoice sent, Paid
Features Features
-------- --------
@@ -36,27 +25,20 @@ Features
- **Super easy setup**, copy and paste files and you are done! - **Super easy setup**, copy and paste files and you are done!
- Translations in English, French and Polish - Translations in English, French and Polish
Todo Roadmap
---- -------
- Touch devices support (tablets) Kanboard is under active development, have a look to the roadmap: <http://kanboard.net/#roadmap>
- Task search
- Task limit for each column
- File attachments
- Comments
- API
- Basic reporting
- Tasks export in CSV
Todo and known bugs Known bugs
------------------- ----------
- See Issues: <https://github.com/fguillot/kanboard/issues> See Issues: <https://github.com/fguillot/kanboard/issues>
License License
------- -------
- GNU Affero General Public License version 3: <http://www.gnu.org/licenses/agpl-3.0.txt> GNU Affero General Public License version 3: <http://www.gnu.org/licenses/agpl-3.0.txt>
Authors Authors
------- -------
@@ -72,110 +54,19 @@ Contributors:
There is also many people who have reported bugs or proposed awesome ideas. There is also many people who have reported bugs or proposed awesome ideas.
Requirements Documentation
------------ -------------
- Apache or Nginx - [Installation instructions](docs/installation.markdown)
- PHP >= 5.3.3 - [Installation on Debian](docs/debian-installation.markdown)
- PHP extensions required: mbstring and pdo_sqlite (don't forget to enable extensions) - [Upgrade Kanboard to a new version](docs/update.markdown)
- A web browser with HTML5 drag and drop support - [How to use Kanboard with Vagrant](docs/vagrant.markdown)
- [Webhooks](docs/webhooks.markdown)
Installation The documentation is written in [Markdown](http://en.wikipedia.org/wiki/Markdown).
------------ If you want to improve the documentation, just send a pull-request.
From the archive:
1. You must have a web server with PHP installed
2. Download the source code and copy the directory `kanboard` where you want
3. Check if the directory `data` is writeable (Kanboard stores everything inside a Sqlite database)
4. With your browser go to <http://yourpersonalserver/kanboard>
5. The default login and password is **admin/admin**
6. Start to use the software
7. Don't forget to change your password!
From the repository:
1. `git clone https://github.com/fguillot/kanboard.git`
2. Go to the third step just above
Update
------
From the archive:
1. Close your session (logout)
2. Rename your actual Kanboard directory (to keep a backup)
3. Uncompress the new archive and copy your database file `db.sqlite` in the directory `data`
4. Make the directory `data` writeable by the web server user
5. Login and check if everything is ok
6. Remove the old Kanboard directory
From the repository:
1. Close your session (logout)
2. `git pull`
3. Login and check if everything is ok
Security
--------
- Don't forget to change the default user/password
- Don't allow everybody to access to the directory `data` from the URL. There is already a `.htaccess` for Apache but nothing for Nginx.
FAQ FAQ
--- ---
### Which web browsers are supported? Go to the official website: <http://kanboard.net/faq>
Desktop version of Mozilla Firefox, Safari and Google Chrome.
### Why the minimum requirement is PHP 5.3.3 or 5.3.7?
Kanboard use the function `password_hash()` to crypt passwords but it's available only for PHP >= 5.5.
However, there is a backport for [older versions of PHP](https://github.com/ircmaxell/password_compat#requirements).
This library needs to have at least PHP 5.3.7 to work correctly (however on Debian Wheezy, PHP 5.3.3 should be fine).
### How to test Kanboard with Vagrant?
- Install Vagrant (http://www.vagrantup.com or apt-get install vagrant)
- Install VirtualBox (https://www.virtualbox.org/ or apt-get install virtualbox)
- Inside the root directory, run: vagrant up
- Go to http://localhost:8080/index.php
- Login with admin / admin
### How to test Kanboard with the PHP built-in web server?
If you don't want to install a web server like Apache on localhost. You can test with the embedded web server of PHP:
```bash
unzip kanboard-VERSION.zip
cd kanboard
php -S localhost:8000
open http://localhost:8000/
```
### How to install Kanboard on Debian?
```bash
apt-get update
apt-get install -y php5 php5-sqlite
echo 'extension=sqlite.so' >> /etc/php5/conf.d/sqlite.ini
cd /var/www/
wget http://kanboard.net/kanboard-VERSION.zip
unzip kanboard-VERSION.zip
chown -R www-data kanboard/data
```
### How to use the webhook to create a task?
Firstly, you have to get the token from the preferences page. After that, just call this url from anywhere:
```bash
# Create a task for the default project inside the first column
curl "http://myserver/?controller=task&action=add&token=superSecretToken&title=mySuperTask"
# Create a task to another project inside a specific column with the color red
curl "http://myserver/?controller=task&action=add&token=superSecretToken&title=task123&project_id=3&column_id=7&color_id=red"
```
Webhooks are useful to perform actions from external applications (shell-script, git hooks...).

17
docs/debian-installation.markdown Normal file
View File

@@ -0,0 +1,17 @@
How to install Kanboard on Debian?
==================================
A quick setup procedure for Debian:
```bash
apt-get update
apt-get install -y php5 php5-sqlite
# If sqlite is not loaded by default, add the extension manually
echo 'extension=sqlite.so' >> /etc/php5/conf.d/sqlite.ini
cd /var/www/
wget http://kanboard.net/kanboard-VERSION.zip
unzip kanboard-VERSION.zip
chown -R www-data:www-data kanboard/data
```

33
docs/installation.markdown Normal file
View File

@@ -0,0 +1,33 @@
Installation
============
Requirements
------------
- Apache or Nginx
- PHP >= 5.3.3
- PHP extensions required: mbstring and pdo_sqlite (don't forget to enable extensions)
- A web browser with HTML5 drag and drop support
From the archive
----------------
1. You must have a web server with PHP installed
2. Download the source code and copy the directory `kanboard` where you want
3. Check if the directory `data` is writeable (Kanboard stores everything inside a Sqlite database)
4. With your browser go to <http://yourpersonalserver/kanboard>
5. The default login and password is **admin/admin**
6. Start to use the software
7. Don't forget to change your password!
From the repository
-------------------
1. `git clone https://github.com/fguillot/kanboard.git`
2. Go to the third step just above
Security
--------
- Don't forget to change the default user/password
- Don't allow everybody to access to the directory `data` from the URL. There is already a `.htaccess` for Apache but nothing for Nginx.

19
docs/update.markdown Normal file
View File

@@ -0,0 +1,19 @@
Update
======
From the archive
----------------
1. Close your session (logout)
2. Rename your actual Kanboard directory (to keep a backup)
3. Uncompress the new archive and copy your database file `db.sqlite` in the directory `data`
4. Make the directory `data` writeable by the web server user
5. Login and check if everything is ok
6. Remove the old Kanboard directory
From the repository
-------------------
1. Close your session (logout)
2. `git pull`
3. Login and check if everything is ok

8
docs/vagrant.markdown Normal file
View File

@@ -0,0 +1,8 @@
How to test Kanboard with Vagrant?
==================================
- Install Vagrant (http://www.vagrantup.com or apt-get install vagrant)
- Install VirtualBox (https://www.virtualbox.org/ or apt-get install virtualbox)
- Inside the root directory, and run the command `vagrant up`
- Go to http://localhost:8080/index.php
- Login with admin / admin

17
docs/webhooks.markdown Normal file
View File

@@ -0,0 +1,17 @@
Webhooks
========
Webhooks are useful to perform actions from external applications (shell-scripts, git hooks...).
How to create a task with a webhook?
------------------------------------
Firstly, you have to get the token from the preferences page. After that, just call this url from anywhere:
```bash
# Create a task for the default project inside the first column
curl "http://myserver/?controller=task&action=add&token=superSecretToken&title=mySuperTask"
# Create a task to another project inside a specific column with the color red
curl "http://myserver/?controller=task&action=add&token=superSecretToken&title=task123&project_id=3&column_id=7&color_id=red"
```