jjsm01/kimai2
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Update installation instructions for non-server (#382)

Browse Source
This commit is contained in:
srdco
2018-11-01 06:28:39 -05:00
committed by Kevin Papst
parent f8adafdabe
commit c648866cb4
2 changed files with 19 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

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

12
var/docs/installation.md
View File

@@ -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: