summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/creating-projects.markdown11
-rw-r--r--docs/debian-installation.markdown2
-rw-r--r--docs/faq.markdown7
-rw-r--r--docs/freebsd-installation.markdown152
4 files changed, 147 insertions, 25 deletions
diff --git a/docs/creating-projects.markdown b/docs/creating-projects.markdown
index cf184e1b..c4d80eb0 100644
--- a/docs/creating-projects.markdown
+++ b/docs/creating-projects.markdown
@@ -1,12 +1,15 @@
Creating projects
=================
-Kanboard can handle multiple projects.
+Kanboard can handle multiple projects. There are two kinds of project:
+
+- Project with mutliple users (you work in team)
+- Private project for a single user
Creating projects for multiple users
-------------------------------------
-- Only administrators can create and manage those projects
+- Only administrators can create those projects
- User management is available
From the dashboard, click on the link **New project**.
@@ -16,8 +19,8 @@ Then the form appears:
It's very easy, you just have to find a name for your project!
-Creating a private prooject
----------------------------
+Creating a private project
+--------------------------
- Everybody can create a private project
- There is **NO** user management
diff --git a/docs/debian-installation.markdown b/docs/debian-installation.markdown
index 7cc9b5b7..d76cb613 100644
--- a/docs/debian-installation.markdown
+++ b/docs/debian-installation.markdown
@@ -24,8 +24,6 @@ rm kanboard-latest.zip
Debian 6 (Squeeze)
------------------
-**Kanboard >= 1.0.10 require at least PHP 5.3.7 and Debian 6 provide PHP 5.3.3 by default**
-
Install Apache and PHP:
```bash
diff --git a/docs/faq.markdown b/docs/faq.markdown
index c8cc8406..8959a320 100644
--- a/docs/faq.markdown
+++ b/docs/faq.markdown
@@ -45,14 +45,17 @@ The project [eAccelerator seems dead and not updated since 2012](https://github.
We recommend to switch to the last version of PHP because it's bundled with [OPcache](http://php.net/manual/en/intro.opcache.php).
-Why the minimum requirement is PHP 5.3.7?
+Why the minimum requirement is PHP 5.3.3?
-----------------------------------------
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 require at least PHP 5.3.7 to work correctly.
+This library require at least PHP 5.3.7 to work correctly.
+Apparently, Centos and Debian backports security patches so PHP 5.3.3 should be ok.
+
+Kanboard v1.0.10 and v1.0.11 requires at least PHP 5.3.7 but this change has been reverted to be compatible with PHP 5.3.3 with Kanboard >= v1.0.12
How to test Kanboard with the PHP built-in web server?
------------------------------------------------------
diff --git a/docs/freebsd-installation.markdown b/docs/freebsd-installation.markdown
index 0fd1ac9d..dde799ff 100644
--- a/docs/freebsd-installation.markdown
+++ b/docs/freebsd-installation.markdown
@@ -1,15 +1,15 @@
-Freebsd Installation
-====================
+FreeBSD 10 Installation
+=======================
-Freebsd 10
-----------
+Manual installation
+-------------------
```bash
-pkg update
-pkg upgrade
+$ pkg update
+$ pkg upgrade
# Install PHP with some standard extensions
-pkg install wget unzip mod_php55 \
+$ pkg install wget unzip mod_php55 \
php55-session php55-pdo_sqlite php55-pdo \
php55-openssl php55-opcache php55-mbstring \
php55-json php55-curl php55-mcrypt \
@@ -30,27 +30,145 @@ Zend Engine v2.5.0, Copyright (c) 1998-2014 Zend Technologies
Enable Apache in your `/etc/rc.conf`:
```bash
-echo apache24_enable="YES" >> /etc/rc.conf
+$ echo apache24_enable="YES" >> /etc/rc.conf
```
-Setting up PHP for Apache, just add those lines into `/usr/local/etc/apache24/Includes/php.conf`:
+Set up PHP for Apache:
```bash
-AddType application/x-httpd-php .php
-DirectoryIndex index.php index.html
+$ echo "AddType application/x-httpd-php .php" >> /usr/local/etc/apache24/Includes/php.conf
+$ echo "DirectoryIndex index.php index.html" >> /usr/local/etc/apache24/Includes/php.conf
```
Then start Apache:
-```
-service apache24 start
+```bash
+$ service apache24 start
```
Install Kanboard:
```bash
-wget http://kanboard.net/kanboard-latest.zip
-unzip kanboard-latest.zip
-chown -R www:www kanboard/data
-rm kanboard-latest.zip
+$ cd /usr/local/www
+$ wget http://kanboard.net/kanboard-latest.zip
+$ unzip kanboard-latest.zip
+$ chown -R www:www kanboard/data
+$ rm kanboard-latest.zip
+```
+Go to http://your.server.domain.tld/kanboard and enjoy!
+
+Installing from ports
+---------------------
+
+Generally 3 elements have to be installed:
+
+- Apache
+- mod_php for Apache
+- Kanboard
+
+Fetch and extract ports...
+
+```bash
+$ portsnap fetch
+$ portsnap extract
+```
+
+or update already existing:
+
+```bash
+$ portsnap fetch
+$ portsnap update
+```
+
+More details regarding portsnap can be found in the [FreeBSD Handbook](https://www.freebsd.org/doc/handbook/ports-using.html).
+
+Install Apache:
+
+```bash
+$ cd /usr/ports/www/apache24
+$ make install clean
+```
+Enable Apache in your `/etc/rc.conf`:
+
+```bash
+$ echo apache24_enable="YES" >> /etc/rc.conf
+```
+
+Install mod_php for Apache:
+
+```bash
+$ cd /usr/ports/www/mod_php5
+$ make install clean
+```
+
+Download and extract the latest version of kanboard port:
+
+```bash
+$ wget https://bitbucket.org/if0/freebsd-kanboard/get/tip.zip
+$ unzip tip.zip
+$ cd if0-freebsd-kanboard-*/kanboard
+```
+
+Choose proper type of the database (MySQL, Postgresql, SQLite), build port and install:
+
+```bash
+$ make config
+$ make install clean
+$ cd /usr/local/www/kanboard
+$ chown -R www:www data
+```
+
+Set up PHP for Apache:
+
+```bash
+$ echo "AddType application/x-httpd-php .php" >> /usr/local/etc/apache24/Includes/php.conf
+$ echo "DirectoryIndex index.php index.html" >> /usr/local/etc/apache24/Includes/php.conf
```
+
+Then start Apache:
+
+```bash
+$ service apache24 start
+```
+
+Go to http://your.server.domain.tld/kanboard and enjoy!
+
+Please note!
+------------
+
+FreeBSD port of kanboard is not yet a part of official FreeBSD ports tree.
+It has been commited for aprooval to be included in the repository. Details
+regarding the progress can be found [here](https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=196810).
+
+Port is being hosted on [bitbucket](https://bitbucket.org/if0/freebsd-kanboard/). Please feel free to comment,
+fork and suggest updates!
+
+PS.
+Once kanboard port is part of the FreeBSD ports tree the installation of kanboard will be even easier, something like:
+
+```bash
+$ pkg update
+$ pkg upgrade
+$ pkg install apache24 mod_php5 kanboard
+```
+
+Enable Apache in your `/etc/rc.conf`:
+
+```bash
+$ echo apache24_enable="YES" >> /etc/rc.conf
+```
+
+Set up PHP for Apache:
+
+```bash
+$ echo "AddType application/x-httpd-php .php" >> /usr/local/etc/apache24/Includes/php.conf
+$ echo "DirectoryIndex index.php index.html" >> /usr/local/etc/apache24/Includes/php.conf
+```
+
+Then start Apache:
+
+```bash
+$ service apache24 start
+```
+
+Go to http://your.server.domain.tld/kanboard and enjoy!