Add documentations

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

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
```

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"
```