diff options
Diffstat (limited to 'doc/en_US/installation.markdown')
| -rw-r--r-- | doc/en_US/installation.markdown | 17 |
1 files changed, 7 insertions, 10 deletions
diff --git a/doc/en_US/installation.markdown b/doc/en_US/installation.markdown index d8969c1c..543ca4d0 100644 --- a/doc/en_US/installation.markdown +++ b/doc/en_US/installation.markdown @@ -1,7 +1,7 @@ Installation ============ -Firstly, check the [requirements](requirements.markdown) before to go further. +First, check the [requirements](requirements.markdown) before going further. From the archive (stable version) --------------------------------- @@ -11,26 +11,23 @@ From the archive (stable version) 3. Check if the directory `data` is writeable by the web server user 4. With your browser go to <http://yourpersonalserver/kanboard> 5. The default login and password is **admin/admin** -6. Start to use the software +6. Start using the software 7. Don't forget to change your password! The `data` folder is used to store: - Sqlite database: `db.sqlite` -- Debug file: `debug.log` (if debug mode enabled) +- Debug file: `debug.log` (if debug mode is enabled) - Uploaded files: `files/*` - Image thumbnails: `files/thumbnails/*` -People who are using a remote database (Mysql/Postgresql) and a remote object storage (Aws S3 or similar) don't necessarily need to have a persistent local data folder or to change the permission. +People who are using a remote database (Mysql/Postgresql) and a remote object storage (Aws S3 or similar) don't necessarily need to have a persistent local data folder or to change the permissions for the folder. From the git repository (development version) --------------------------------------------- -You must install [composer](https://getcomposer.org/) to use this method. - 1. `git clone https://github.com/kanboard/kanboard.git` -2. `composer install --no-dev` -3. Go to the third step just above +2. Go to the third step just above Note: This method will install the **current development version**, use at your own risk. @@ -67,10 +64,10 @@ Optional Installation --------------------- - Some features of Kanboard require that you run [a daily background job](cronjob.markdown) (Reports and analytics) -- [Install the background worker](worker.markdown) to improve the performances +- [Install the background worker](worker.markdown) to improve performance 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 and a `web.config` file for IIS but nothing for other web servers. +- Don't allow everybody to access to the directory `data` from the URL. A `.htaccess` file for Apache and a `web.config` file for IIS is included but other web servers will have to be configured manually. |