Skip to content

Commit

Permalink
YID-21 (#145)
Browse files Browse the repository at this point in the history
* YID-21

* update images to v7.0

* CR

---------

Co-authored-by: Ruben Lech <r.lech@yetiforce.com>
  • Loading branch information
RubenLech and Ruben Lech authored May 7, 2024
1 parent 22c9c7c commit afc9c49
Show file tree
Hide file tree
Showing 52 changed files with 38 additions and 48 deletions.
42 changes: 19 additions & 23 deletions docs/1-introduction/3-installation-manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ First, prepare the installation files. **[Download YetiForce](download) from our

:::warning

We recommend downloading the "complete" versions, for example `YetiForceCRM-6.4.0-complete.zip`. If you don't download the "complete" version, you will have to install the libraries using `yarn` and `composer` before installing the system.
We recommend downloading the "complete" versions, for example `YetiForceCRM-7.0.0-complete.zip`. If you don't download the "complete" version, you will have to install the libraries using `yarn` and `composer` before installing the system.
The right order is important - first `yarn`, then `composer`.
A sample installation script can be downloaded from [here](https://github.com/YetiForceCompany/YetiForceCRM/blob/developer/tests/setup/dependency.sh).

Expand All @@ -46,14 +46,14 @@ You can also use the bash console

```bash
cd /home/yfprod/html/
wget -O YetiForceCRM.zip https://github.com/YetiForceCompany/YetiForceCRM/releases/download/6.2.0/YetiForceCRM-6.2.0-complete.zip
wget -O YetiForceCRM.zip https://api.yetiforce.eu/download/crm/www/7.0.0-complete
unzip YetiForceCRM.zip
chown -R yfprod:yfprod /home/yfprod/html/
```

## Step 1 - Run the installation wizard

Run the target address of your system in the browser window, the system should show the installation wizard. If it doesn't, there may be some problems, you can try running the address: **SITE_URL**/install/Install.php eg. https://gitdeveloper.yetiforce.com/install/Install.php
Run the target address of your system in the browser window, the system should show the installation wizard. If it doesn't, there may be some problems, you can try running the address: **SITE_URL**/install/Install.php

![step 1](install-1.png)

Expand All @@ -65,52 +65,48 @@ It's necessary to agree to the license terms in order to proceed with the instal

![step 2](install-2.png)

## Step 3 - Choose installation type
## Step 3 - Server configuration review

Decide where you want to install the system - you can choose your own server or buy our hosting or cloud services. If you'd like to use our services, after clicking the "Buy" button, you will be able to make the payment.

![step 3](install-3.png)

## Step 4 - Server configuration review

In the fourth step, you can find your current web server configuration compared to the requirements of YetiForce (what needs to be changed and to what values to set). It is necessary to remember that this configuration may change according to different requirements applied to the application and a deployment company should take it into consideration. For example, if you generate large reports that have a longer generating time than the maximum time set in the `max_execution_time` parameter, then it is necessary to set the parameters in such a way that the time of executing a script is always longer than the time for generating a report. Otherwise, reports may not be generated successfully.
In the third step, you can find your current web server configuration compared to the requirements of YetiForce (what needs to be changed and to what values to set). It is necessary to remember that this configuration may change according to different requirements applied to the application and a deployment company should take it into consideration. For example, if you generate large reports that have a longer generating time than the maximum time set in the `max_execution_time` parameter, then it is necessary to set the parameters in such a way that the time of executing a script is always longer than the time for generating a report. Otherwise, reports may not be generated successfully.

Make sure your administrator is familiar with [web server requirements](/introduction/requirements/). If all required parameters are not met, and you attempt to proceed with the installation, the application will display a warning message.

Once you are aware of the risks associated with incorrect web server configuration you can click "OK", and move to the next step.

![step 4](install-4.png)
![step 3](install-3.png)

## Step 5 - Access data configuration
## Step 4 - Access data configuration

In this step, you need to enter access data to a database as well as set output parameters for the system. A database will be created on the basis of this data (when this option has been activated). The structure of the database will be copied together with basic records and an administrator account will be created, so after completing the installation it will be possible to log on this account.

If incorrect access data is entered into the database, an error message will be displayed.

In this case, it is necessary to go back and enter the correct access data. If everything is set correctly, the screen from Step 7 will appear.
In this case, it is necessary to go back and enter the correct access data. If everything is set correctly, the screen from Step 5 will appear.

![step 4](install-4.png)

## Step 5 - Data summary

![step 5](install-5.png)

## Step 6 - Data summary
## Step 6 - Specify business profile

![step 6](install-6.png)

## Step 7 - Enter registration information
## Step 7 - Verify email address

Enter the data of the company that will use the system, the data will then be used to register the system.
![step 7](install-7.png)

According to the license, each system must be registered after the trial period of 14 days.
## Step 8 - Enter registration information

![step 7](install-7.png)
Enter the data of the company that will use the system, the data will then be used to register the system.

## Step 8 - Database import and system configuration
According to the license, each system must be registered after the trial period of 14 days.

![step 8](install-8.png)

When the installation is performed correctly, you will be automatically redirected to the system.

![step 9](install-9.png)

## The installation process has failed

What to do when the system shows the message `Invalid session ID` at the beginning of the installation.
Expand Down Expand Up @@ -151,4 +147,4 @@ Pay attention to delete cookies for HTTP and HTTPS!!!

You can easily remove all browser cache, but how to do it for one domain only so as not to lose all data?

In the development tools, it is possible to view and delete the cache. Each browser may have removal options elsewhere. More details can be found in the article [How to clear browser cache?](/administrator-guides/faq/how-to-clear-browser-cache/)
In the development tools, it is possible to view and delete the cache. Each browser may have removal options elsewhere. More details can be found in the article [How to clear browser cache?](/administrator-guides/faq/how-to-clear-browser-cache/)
Binary file modified docs/1-introduction/install-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/1-introduction/install-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/1-introduction/install-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/1-introduction/install-4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/1-introduction/install-5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/1-introduction/install-6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/1-introduction/install-7.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/1-introduction/install-8.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ preview: calendar-view-1.jpg

## Additional data sources

:::tip The functionality is available for YetiForce version `6.4.233` and later
:::tip The functionality is available for YetiForce version `7.0` and later
:::

Additional data sources allow you to show information from all record modules that have a date or time and date field. The configuration block is available in the filter panel on the right.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -44,14 +44,14 @@ Lub z konsoli bash

```bash
cd /home/yfprod/html/
wget -O YetiForceCRM.zip https://github.com/YetiForceCompany/YetiForceCRM/releases/download/6.2.0/YetiForceCRM-6.2.0-complete.zip
wget -O YetiForceCRM.zip https://api.yetiforce.eu/download/crm/www/7.0.0-complete
unzip YetiForceCRM.zip
chown -R yfprod:yfprod /home/yfprod/html/
```

## Krok 1 - Uruchomienie kreatora instalacji

Uruchom w oknie przeglądarki adres docelowy twojego systemu - powinien pokazać się kreator instalacji. Jeśli nie pokazał się kreator, to może znaczyć, że wystąpiły jakieś problemy, możesz spróbować uruchomić adres: **SITE_URL**/install/Install.php np. https://gitdeveloper.yetiforce.com/install/Install.php
Uruchom w oknie przeglądarki adres docelowy twojego systemu - powinien pokazać się kreator instalacji. Jeśli nie pokazał się kreator, to może znaczyć, że wystąpiły jakieś problemy, możesz spróbować uruchomić adres: **SITE_URL**/install/Install.php

![step 1](install-1.png)

Expand All @@ -63,51 +63,45 @@ W drugim kroku kreator wymaga zaakceptowania licencji. Licencja YetiForce jest b

![step 2](install-2.png)

## Krok 3 - Wybierz rodzaj instalacji
## Krok 3 - Weryfikacja konfiguracji serwera

Zdecyduj, gdzie chcesz zainstalować system - możesz wybrać własny serwer albo dokonać zakupu naszego hostingu lub chmury. Jeśli chcesz korzystać z naszych usług, po kliknięciu przycisku "Kup", będziesz mógł dokonać płatności.

![step 3](install-3.png)

## Krok 4 - Weryfikacja konfiguracji serwera

W czwartym kroku możesz znaleźć aktualną konfigurację serwera w porównaniu z wymaganiami YetiForce (wraz z informacją co należy zmienić i jakie wartości należy ustawić). Należy pamiętać, że w zależności od wymagań, jakie się stawia aplikacji CRM, konfiguracja ta może ulec zmianom. Firma wdrożeniowa powinna uwzględnić zmiany we własnym zakresie. Na przykład jeśli generujesz duże raporty, które mają dłuższy czas generowania niż maksymalny czas określony w parametrze `max_execution_time`, konieczne jest ustawienie parametrów w taki sposób, aby czas wykonania skryptu był zawsze dłuższy niż czas potrzebny na sporządzenie raportu. W przeciwnym wypadku taki raport może się nie wygenerować.
W trzecim kroku możesz znaleźć aktualną konfigurację serwera w porównaniu z wymaganiami YetiForce (wraz z informacją co należy zmienić i jakie wartości należy ustawić). Należy pamiętać, że w zależności od wymagań, jakie się stawia aplikacji CRM, konfiguracja ta może ulec zmianom. Firma wdrożeniowa powinna uwzględnić zmiany we własnym zakresie. Na przykład jeśli generujesz duże raporty, które mają dłuższy czas generowania niż maksymalny czas określony w parametrze `max_execution_time`, konieczne jest ustawienie parametrów w taki sposób, aby czas wykonania skryptu był zawsze dłuższy niż czas potrzebny na sporządzenie raportu. W przeciwnym wypadku taki raport może się nie wygenerować.

Dla pewności, poproś swojego administratora, aby zapoznał się z tymi [wymaganiami dla serwerów WWW](/introduction/requirements/). Jeśli mimo niespełnienia wszystkich wymaganych parametrów zdecydujesz się kontynuować instalację, aplikacja wyświetli komunikat ostrzegawczy.

Po zapoznaniu się z ryzykiem związanym z nieprawidłową konfiguracją serwera możesz kliknąć "OK" i przejść do następnego kroku.

![step 4](install-4.png)
![step 3](install-3.png)

## Krok 5 - Konfiguracja danych dostępowych
## Krok 4 - Konfiguracja danych dostępowych

W tym kroku musisz wprowadzić dane dostępowe do bazy danych oraz ustawić parametry wyjściowe dla systemu. Na podstawie tych danych zostanie utworzona baza danych (gdy ta opcja została aktywowana). Na podstawie tych danych system utworzy bazę danych (o ile opcja ta została aktywowana), wgra strukturę bazy danych razem z podstawowymi danymi oraz utworzy podstawowe konto administratora, do którego będziesz mógł się zalogować po instalacji.

Jeżeli wprowadzisz nieprawidłowe dane dostępowe do bazy danych pokaże się błąd.

W takim wypadku musisz cofnąć się do ekranu poprzedniego i prawidłowo wprowadzić dane dostępowe. Jeżeli wszystko zostanie uzupełnione prawidłowo, zobaczysz ekran podobny do tego, który jest w kroku następnym.

![step 5](install-5.png)
![step 4](install-4.png)

## Krok 6 - Podsumowanie danych
## Krok 5 - Podsumowanie danych

![step 6](install-6.png)
![step 5](install-5.png)

## Krok 7 - Wprowadzenie danych rejestracyjnych
## Step 6 -Określ profil działalności

Wprowadź dane firmy, która będzie korzystała z systemu. Te dane zostaną potem wykorzystane do rejestracji systemu.
![step 6](install-6.png)

Zgodnie z zapisami licencji każdy system musi być zarejestrowany po okresie próbnym 14 dni.
## Step 7 - Zweryfikuj adres e-mail

![step 7](install-7.png)

## Krok 8 - Import bazy danych oraz konfigurowanie systemu
## Krok 8 - Wprowadzenie danych rejestracyjnych

![step 8](install-8.png)
Wprowadź dane firmy, która będzie korzystała z systemu. Te dane zostaną potem wykorzystane do rejestracji systemu.

Jeżeli instalacja zostanie wykonana prawidłowo, zostaniesz automatycznie przeniesiony do systemu CRM.
Zgodnie z zapisami licencji każdy system musi być zarejestrowany po okresie próbnym 14 dni.

![step 9](install-9.png)
![step 8](install-8.png)

## Proces instalacji nie powiódł się

Expand Down Expand Up @@ -149,4 +143,4 @@ Zwróć uwagę na usunięcie ciasteczek dla HTTP i HTTPS!!!

Możesz łatwo usunąć pamięć podręczną przeglądarki, ale jak to zrobić tylko dla jednej domeny, aby nie stracić wszystkich danych?

W narzędziach deweloperskich jest możliwość podejrzenia i usunięcia danych podręcznych. Opcje usuwania danych podręcznych znajdują się w różnych modułach konfiguracji przeglądarki, w zależności od rodzaju używanej przeglądarki. Więcej informacji można znaleźć w artykule [Jak wyczyścić pamięć podręczną przeglądarki?](/administrator-guides/faq/how-to-clear-browser-cache/)
W narzędziach deweloperskich jest możliwość podejrzenia i usunięcia danych podręcznych. Opcje usuwania danych podręcznych znajdują się w różnych modułach konfiguracji przeglądarki, w zależności od rodzaju używanej przeglądarki. Więcej informacji można znaleźć w artykule [Jak wyczyścić pamięć podręczną przeglądarki?](/administrator-guides/faq/how-to-clear-browser-cache/)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ preview: calendar-view-1.jpg

## Dodatkowe źródła danych

:::tip Ta funkcja jest dostępna dla YetiForce w wersji `6.4.233` i później
:::tip Ta funkcja jest dostępna dla YetiForce w wersji `7.0` i później
:::

Dodatkowe źródła danych umożliwiają wyświetlanie informacji ze wszystkich modułów z rekordami, które mają pole daty lub czasu i daty. Blok konfiguracyjny jest dostępny w panelu filtrów po prawej stronie.
Expand Down

0 comments on commit afc9c49

Please sign in to comment.