From c648866cb4a5fc0b394b61af7fe0eb44cc0b5d31 Mon Sep 17 00:00:00 2001 From: srdco Date: Thu, 1 Nov 2018 06:28:39 -0500 Subject: [PATCH] Update installation instructions for non-server (#382) --- README.md | 8 +++++++- var/docs/installation.md | 12 ++++++++++++ 2 files changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index dce1f372..feb496f0 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,9 @@ Our roadmap is open for changes and input from the community, please [sent us](i ## Installation -There are [further infos about installation](var/docs/installation.md) if you have to use FTP or want to develop with Kimai. +> **NOTE** +> +> There are [further infos about installation](var/docs/installation.md) if you have to use FTP, want to develop with Kimai, or are setting Kimai up on a personal computer (vs a server). If you want to install Kimai 2 in your production environment, then SSH into your server and change to your webserver root. You need to install Git and [Composer](https://getcomposer.org/doc/00-intro.md) if you haven't already. @@ -118,6 +120,10 @@ Installation complete: enjoy time-tracking :-) ## Updating Kimai +> **NOTE** +> +> Don't forget tweaks that may be necessary to these instructions if you are using FTP, developing, or updating on a personal computer instead of a server. See [further infos about installation](var/docs/installation.md). + **STOP** 1. It's important that you don't execute the Installation steps before or after your upgrade diff --git a/var/docs/installation.md b/var/docs/installation.md index 2bb3eea4..33bc58fb 100644 --- a/var/docs/installation.md +++ b/var/docs/installation.md @@ -5,6 +5,18 @@ installation instruction in our [README](https://github.com/kevinpapst/kimai2/#i You need GIT and [Composer](https://getcomposer.org/doc/00-intro.md) on the machine where you want to install Kimai. +## Installing on a personal computer (instead of a server) +### 1. No need to use www-data user +The installation instructions are intended primarily for server applications. +If you are installing Kimai 2 on a desktop or laptop computer - even for use in a local network, but where the computer primarily serves as a single user computer - you will avoid permission errors by subsituting ```www-data``` in the relevant commands with your username. +In particular, ```sudo -u www-data``` is a command which grants the ```www-data``` user temporary administrator/super-user privileges). However, depending on the configuration of your particular computer, you may be able to avoid sudo altogether (your user may already have adequate permissions). +You can try first leaving ```sudo -u www-data``` altogether in the relevant commands. If you have permission errors, you can substitute it for ```sudo -u username``` in the relevant commands (where username is the username that runs the server - if you don't know, it is likely your own username that you login with). + +### 2. Chown & Chmod commands +Further, chown & chmod commands should be for the username that runs the server instead of ```www-data``` (again, if you don't know, it is likely your own username). + +Also note that, depending on where you are installing Kimai 2 and how your computer is configured, you may also receive "operation not permitted" errors when setting file permissions (chown and chmod commands). In that case, prefix them with ```sudo ```. + ## Hosting & 1-click installations These platforms adopted Kimai 2 to be compatible with their one-click installation systems: