From 81d66b9446781d069eed73c076ce473803aa1015 Mon Sep 17 00:00:00 2001 From: Jack Polgar Date: Sun, 31 Jan 2016 14:08:47 +1100 Subject: [PATCH] Start documentation for Traq 4.0. --- 4.0/installation.md.phtml | 39 ++++++++++++++++++++++++++++++++++++++ 4.0/major-changes.md.phtml | 23 ++++++++++++++++++++++ index.md.phtml | 3 +++ 3 files changed, 65 insertions(+) create mode 100644 4.0/installation.md.phtml create mode 100644 4.0/major-changes.md.phtml diff --git a/4.0/installation.md.phtml b/4.0/installation.md.phtml new file mode 100644 index 0000000..7d1b55d --- /dev/null +++ b/4.0/installation.md.phtml @@ -0,0 +1,39 @@ +--- +title: Install and Upgrade +crumbs: + - "4.0" +--- + +## Installation + +Installing Traq 4.0 is the same as previous versions. + +You will need to setup a database for Traq to use before the installation. + +1. Download Traq 4.0 and extract the archive. +2. Upload the contents of the `upload` directory to your server. +3. Open the URL to [Traq](https://traq.io) in your browser. +4. Follow the installation steps. +5. Rename `htaccess.txt` to `.htaccess` in the root directory of [Traq](https://traq.io). + +### From the repository + +Installing Traq 4.0 from the repository is trickier than previous versions. You will need [Composer][1], [Node][2], +[NPM][3] and [Gulp][4]. + +1. Clone the repository: `git clone https://github.com/nirix/traq` +2. Install dependencies: `composer install` +3. Setup `dev` directory: `cd dev && npm install` +4. Compile assets: `gulp compile` + +This change was made to keep the repository clean and remove 3rd party code. There are plans to setup a repository to contain +the "compiled" Traq 4.0. + +## Upgrade + +_Not yet relevant._ + +[1]: https://getcomposer.org +[2]: https://nodejs.org +[3]: https://www.npmjs.com/ +[4]: http://gulpjs.com/ diff --git a/4.0/major-changes.md.phtml b/4.0/major-changes.md.phtml new file mode 100644 index 0000000..1aee4b4 --- /dev/null +++ b/4.0/major-changes.md.phtml @@ -0,0 +1,23 @@ +--- +title: Major Changes +crumbs: + - "4.0" +--- + +Traq 4.0 is a complete rewrite from Traq 3.x, the major changes are: + +- **PHP 5.5 is required** + + _Traq 4.0 might run on 5.4, but it is not supported._ + +- **New framework: Avalon 2.0** +- **PostgreSQL support** + + Avalon 2.0 uses the [Doctrine DBAL][1] which supports more database systems such as PostgreSQL. + +- **BCrypt passwords required** + + Anyone logging into a Traq 4.0 installation that was upgraded from Traq 3.x will be required to change their password + if they are still using a `sha1` hashed password. + +[1]: http://docs.doctrine-project.org/projects/doctrine-dbal/en/latest/ diff --git a/index.md.phtml b/index.md.phtml index 34798c3..ccad442 100644 --- a/index.md.phtml +++ b/index.md.phtml @@ -2,6 +2,9 @@ title: Documentation --- +* Traq 4.0 + * [Major changes]() + * [Install and Upgrade]() * Traq 3.x * [Install and Upgrade]() * [API]()