Jingga/User-Guide
1
0
Fork 0
mirror of https://github.com/Karaka-Management/User-Guide.git synced 2026-01-10 20:08:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

improve documentation

Browse Source
This commit is contained in:
Dennis Eichhorn 2022-04-08 23:26:59 +02:00
parent 13832b0e52
commit 09a5bf6f97
2 changed files with 41 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
setup/first_steps.md
View File

@ -6,7 +6,7 @@ After your first login you will see that everything is rather empty. A good star
The general application settings can be found in the Admin settings.
Go to:
Go to:
`Modules (on the side navigation) > Admin > Settings`
@ -14,7 +14,7 @@ On this page you may change the general application settings such as login behav
### Modules
Under `Modules` on the side navigation you can see all installed modules. By clicking on them you will get additional module information and module specific settings.
Under `Modules` on the side navigation you can see all installed modules. By clicking on them you will get additional module information and module specific settings.
If you want to install additional settings search for specific keywords on the module page and you will receive suggestions based on these keywords. You can then check out the detailed information of these modules in order to further inspect the features the modules provides.
@ -38,7 +38,7 @@ Groups (and accounts) can have the following permissions:
* `DELETE`: The user can remove certain content
* `PERM`: The user can change permissions
It's also possible to assign permissions directly to individual users but this is **not** recommended as this makes managing permissions much more difficult.
It's also possible to assign permissions directly to individual users but this is **not** recommended as this makes managing permissions much more difficult.
When you assign the above mentioned permissions to a group you will see that you can also define:
@ -59,6 +59,6 @@ These restrictions show that it is possible to do very fine/granular permissions
By default only admin users can create new accounts. However it is possible to allow users to register by themselves in the admin module settings. Self-registered users are always part of the `user` group. Make sure the `user` group permissions are designed while keeping that in mind.
If a admin user creates a new account you must decide if the user/account should also be allowed to login/have a profile or if this account is just an internal account.
If a admin user creates a new account you must decide if the user/account should also be allowed to login/have a profile or if this account is just an internal account.
If the user should be allowed to login/active user you should click on `Create Profile` to also create a profile for the user. Upon doing this the user will receive a registration email in the same way as if he registered by himself. The registration email contains a preliminary password which the user should change.

74
setup/install.md
View File

@ -1,8 +1,8 @@
## Installation
# Installation
The easiest and most common way to install the application is through the web installer. Alternatively you can also install it through a command line interface (cli).
### Server Recommendations
## Server Recommendations
The server recommendations strongly depend on your individual needs, in the following you will find some general recommendations.
@ -15,15 +15,15 @@ The server recommendations strongly depend on your individual needs, in the foll
> The above mentioned recommendations are for the basic application use case without additional tools and software which you maybe want to install or have already running on the server. Furthermore, the amount of concurrent users also impacts which hardware requirements are necessary (above we calculated with 50 concurrent users)
### Web server and Database
## Web server and Database
If you don't have a web server already installed please install the web server of your choice. Web servers which are supported are apache2 and nginx. Databases which are supported are mysql/mariadb, postgres and mssql/sqlsrv.
#### Windows
### Windows
If you are on Windows you may want to download and install the newest version of [Xampp](https://www.apachefriends.org/download.html) / [Bitnami](https://bitnami.com/stack/wamp). During the installation please make sure your install `php` and `mysql`.
#### Linux
### Linux
On linux you may want to install `apache2` and `mysql`. Please note you can also use this application with `nginx` and `postgres`:
@ -37,15 +37,15 @@ sudo a2enmod rewrite
sudo a2enmod headers
```
### Php
## Php
The minimum php version requirement in the following installation guide is version 8.0.
##### Windows
### Windows
On Windows php should already be installed with the web servers mentioned above just like the various extensions.
##### Linux
### Linux
The following extensions are recommended and sometimes even mandatory:
@ -53,37 +53,37 @@ The following extensions are recommended and sometimes even mandatory:
sudo apt-get install php8.0 php8.0-dev php8.0-cli php8.0-common php8.0-mysql php8.0-pgsql php8.0-xdebug php8.0-opcache php8.0-pdo php8.0-sqlite php8.0-mbstring php8.0-curl php8.0-imap php8.0-bcmath php8.0-zip php8.0-dom php8.0-xml php8.0-phar php8.0-gd php-pear
```
### Software
## Software
#### Mandatory
### Mandatory
##### OCR
#### OCR
Some modules in the application may need text recognition of scanned files (e.g. DocumentManagement). If you don't use such a module you don't need to install this.
###### Windows
##### Windows
Download and install [tesseract](https://tesseract-ocr.github.io/tessdoc/Downloads.html).
Download and install [tesseract-ocr](https://tesseract-ocr.github.io/tessdoc/Downloads.html).
Download and install [pdftotext](https://www.xpdfreader.com/pdftotext-man.html).
Download and install [pdftoppm](https://www.xpdfreader.com/pdftoppm-man.html).
###### Linux
##### Linux
```sh
sudo apt-get install tesseract-ocr
```
#### Optional
### Optional
##### Caching
#### Caching
Caching allows the application to store data in memory instead of re-calculating it again and again. This can speed up the general behavior of the application. Supported caching are redis and memcached (**not** memcache)
###### Windows
##### Windows
On windows you may want to download and install [redis](https://redis.io/download).
###### Linux
##### Linux
For caching you may install redis or memcached:
@ -92,31 +92,31 @@ sudo apt install redis-server
sudo phpenmod redis
```
### Application Installation
## Application Installation
#### Files
### Files
Before you can install the application you need to put the application files into the web server directory. This directory depends on the web server which you used and the web server configuration.
##### Windows
#### Windows
By default the windows directory should be `C:/xampp/htdocs`. Remove all files in this directory and put all the files of the Karaka application into this directory.
##### Linux
#### Linux
By default the linux directory should be `/var/www/htm`. Remove all files in this directory and put all the files of the Karaka application into this directory.
#### Web Installer
### Web Installer
If you installed the application on your local computer you can open a browser window and navigate to [http://127.0.0.1/Install](http://127.0.0.1/Install). If you installed it on a remote server navigate to the URL of that server.
Click yourself through the installation and fill out the forms during the installation process.
##### Pre-installation check
#### Pre-installation check
On the page called pre-installation check the installation script will check and inform you if the necessary php extensions and file permissions are available. Only requirements marked as optional can be missing. If any other requirements fail please don't continue with the installation and fix these requirements first. Once you fixed the requirements reload the installation script!
###### File permissions
##### File permissions
File permissions should only be an issue on linux. You can change the file permissions of directories as follows:
@ -124,7 +124,7 @@ File permissions should only be an issue on linux. You can change the file permi
sudo chmod -R 755 /var/www/htm/Modules
```
###### Php extensions
##### Php extensions
If the extension is already installed you can just add it to your `php.ini` file of extension loading files in `conf.d/`. e.g.:
@ -146,27 +146,27 @@ sudo phpenmod mbstring
On windows you may follow the php [installation guide](https://www.php.net/manual/en/install.pecl.windows.php) or the installation guide of your chosen web server which maybe already includes php.
##### Database
#### Database
On this page you must enter the database information which the application can use to store data.
###### Address
##### Address
The address for the database server usually is `127.0.0.1`
###### Type
##### Type
The database type depends on which database you used. If you followed this installation you probably used `mysql`
###### Port
##### Port
The port depends on the database you installed. Different database vendors use different ports. If you followed this installation you probably used mysql, in this case the port is `3306`. If you used another database, please check the documentation of that database to find the default port.
###### Database
##### Database
The recommended database name is `oms`. Please note that this database must be manually created by you. If you've not already done so during the database installation process, please create that database now. In order to create this database please check the documentation of your database vendor. On windows you might be able to log into `phpmyadmin` and create this database.
###### Users
##### Users
For security purposes we recommend that you create 5 different users in your database application who only have access to `oms` database and each one of the users may only have the following permissions. The application installation script cannot create these users, please make sure you already created them:
@ -178,22 +178,22 @@ For security purposes we recommend that you create 5 different users in your dat
It is possible to always input the same user and same password for all users in the installation script but this is not recommended. If you just want to get started you may input the user and password which you defined during the database installation. Nevertheless, please change this in the future.
##### Configuration
#### Configuration
On the last page you can define the name of your organization/company.
###### Admin Login, Password, Email
##### Admin Login, Password, Email
Here you must define the admin login name, the admin password and email.
###### Top Level domain
##### Top Level domain
The top level domain is the domain name where you installed the application. If you only installed it locally, it is 127.0.0.1. If you installed it on your web server, then you input the domain name e.g. `karaka.app`
###### Web Subdirectory
##### Web Subdirectory
The web subdirectory by default is `/`. If you installed the application in a subdirectory instead of the main directory of your web server you input the name of the subdirectory here e.g. `/subdir/`.
##### Install
#### Install
After clicking install you will either receive a message that something went wrong e.g. some configurations are wrong (please fix them) or the installation will redirect you to the login if everything went smoothly. Please make sure to delete the `Install` directory so that no-one else can use it.