Skip to content

Commit

Permalink
fix-format (#199)
Browse files Browse the repository at this point in the history
  • Loading branch information
mariuszkrzaczkowski authored Nov 12, 2024
1 parent e40e302 commit e955395
Show file tree
Hide file tree
Showing 24 changed files with 75 additions and 1 deletion.
6 changes: 6 additions & 0 deletions docs/1-introduction/1-requirements/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,9 @@ Pliki konfiguracyjne np. `/etc/my.cnf`, `/etc/mysql/my.cnf`, `/etc/mysql/conf.d/
- `ENGINE = InnoDB` powinno być dostępne i domyślnie włączone. (wyłącz --skip-innodb)

:::warning

Ze względów bezpieczeństwa zalecamy aby każda baza danych posiadała dedykowanego użytkownika, nie zalecamy używania użytkownika bazodanowego `root` do komunikacji z bazą danych.

:::

import DB_MYSQL_REQUIREMENTS from '/static/files/db_mysql_requirements.mdx';
Expand Down Expand Up @@ -159,6 +161,7 @@ catch_workers_output = yes
import FPM from '/static/files/fpm.mdx';

:::important

Przykładowa konfiguracja FPM:

<details>
Expand Down Expand Up @@ -224,6 +227,7 @@ Konfiguracja powinna umożliwiać serwerowi WWW na pełne uprawnienia do plików
### Problemy z SELinux

:::warning

Gdy na serwerze jest zainstalowany SELinux w trybie enforcing często występują problemy z uprawnieniami. Należy zwrócić uwagę na parametry konfiguracyjne:

- httpd_unified
Expand Down Expand Up @@ -266,7 +270,9 @@ Część serwerów umożliwia zmianę konfiguracji za pomocą pliku `.htaccess`,
#### Apache module

:::warning

Poniższa konfiguracja działa tylko jak ustawiono w konfiguracji Apache np. `httpd.conf` "AllowOverride Options" lub "AllowOverride All"

:::

```apacheconf
Expand Down
2 changes: 2 additions & 0 deletions docs/1-introduction/2-download.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ Tutaj znajdziesz linki do pobrania najnowszej stabilnej wersji systemu.
## Wymagania systemu YetiForce

:::important

Przed pobraniem zapoznaj się z wymaganiami dla serwera i oceń czy jest gotowy do rozpoczęcia procesu instalacji.

:::

Pełna lista wymagań: [Wymagania systemu YetiForce](/introduction/requirements).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,11 @@ Następnie przejdź do sekcji administracyjnej i wybierz `Integracja → Kolekto
Poniżej znajduje się lista wszystkich aktualnie dostępnych kolektorów rekordów. Darmowe kolekcjonerskie dostępne w systemie są domyślnie oznaczone tagiem, pozostałe mogą być zakupione w Marketplace. Regularnie dodajemy do systemu YetiForce nowe kolektory rekordów.

:::warning

Należy pamiętać, że dostęp do danych z niektórych kolektorów może wymagać odpowiednich danych uwierzytelniających.

**Prosimy o zapoznanie się z dokumentacją danego kolektora, aby uzyskać więcej informacji na temat wymagań dotyczących dostępu.**

:::

- GUS [PL] - Pobiera dane o polskich firmach z bazy danych **REGON 1(BIR1)** dostarczonej przez GUS
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ preview: calendar-view-1.jpg
## Dodatkowe źródła danych

:::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
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@ tags:
Przekierowanie domeny (lub subdomeny) na inny adres www (domenę/subdomenę) jest bardzo praktyczne biznesowo. Najczęściej stosuje się to wówczas, gdy chcemy, aby docelowa aplikacja była dla użytkowników końcowych widoczna pod innym adresem. Szczególnie warto stosować przekierowanie, gdy korzystamy z rozwiązań, które nie są na naszym serwerze i są pod innym adresem niż na przykład nasza domena, która jest znana naszym użytkownikom. Poniżej znajdziesz instrukcje krok po kroku.

:::warning

Dla klientów YetiForce usługa przekierowywania jest dostępna tylko dla produktu YetiForce Cloud.

:::

## Opis problemu
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,9 @@ Usunięcie pamięci podręcznej przeglądarki, czyli tak zwane czyszczenie cache
Inna opcja, która jest możliwa do wykonania, to wyczyszczenie danych przeglądania. Opis tego procesu można znaleźć w następującym artykule: [Wyczyść pamięć podręczną & ciasteczka](https://support.google.com/accounts/answer/32050).

:::warning

Wybierz wszystkie elementy, które chcesz usunąć i zakres czasowy

:::

![how-to-clear-browser-cache-3.jpg](how-to-clear-browser-cache-3.jpg)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,7 @@ Następujące pola mogą być dodane:
- Aplikacja Web service

:::info

💻 Demo: https://demo.yetiforce.com/index.php?module=LayoutEditor&parent=Settings&view=Index

:::
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ kolumnami. Dzięki temu w łatwy sposób możemy śledzić postęp prac, identyf
innymi modułami YetiForce, co wspiera zarządzanie zadaniami w kontekście działań sprzedażowych, projektowych, serwisowych i innych.

:::warning

Dodatek YetiForce Kanban Board jest dostępny do subskrypcji w naszym Marketplace. - [**Więcej informacji**](https://yetiforce.com/pl/tablica-kanban.html)

:::

![Widok ekranu konfiguracji](kanban-1.png)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ preview: bria-softphone-1.png
---

:::tip

Funkcjonalność dostępna od wersji YetiForce 7.0

:::

Integracja z centralą telefoniczną za pośrednictwem aplikacji Bria Softphone.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,15 @@ preview: genesys-wde-whirly.jpg
---

:::tip

Funkcjonalność dostępna od wersji YetiForce 7.0

:::

:::warning Do integracji wykorzystuje dedykowane rozszerzenie od firmy Whirly, które obsługuje funkcjonujące procesy w systemie Genesys.
:::warning

Do integracji wykorzystuje dedykowane rozszerzenie od firmy Whirly, które obsługuje funkcjonujące procesy w systemie Genesys.

:::

Integracja z centralą telefoniczną za pośrednictwem aplikacji Genesys Workspace Desktop Edition.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ System YetiForce umożliwia integrację z innymi aplikacjami, co pozwala na pły
:::warning

**Uwaga!** Aby móc zintegrować YetiForce z Dav, potrzebujesz płatnego dodatku **Outlook Integration Panel & DAV**, dostępnego w Marketplace YetiForce.

:::

Poniżej znajduje się instrukcja, która krok po korku pokaże jak skonfigurować integrację DAV w systemie YetiForce.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@ Dzięki takiemu rozwiązaniu nie jest konieczne wykonywanie kopii całego system
Implementacja umożliwia korzystanie ze wszystkich funkcjonalności YetiForce w Outlook.

:::important

Artykuł omawia najważniejsze kwestie związane z dodatkiem Outlook do systemu YetiForce. Przeczytaj go w całości i zwróć szczególną uwagę na wytyczne aby dodatek działał prawidłowo.

:::

## Prezentacja wideo
Expand Down Expand Up @@ -63,9 +65,11 @@ Dodatek Outlook do systemu YetiForce działa z następującymi typami aplikacji
- Outlook.com

:::warning

Klient poczty musi być połączony z serwerem Exchange lub Microsoft 365 (dawniej Office 365) przy użyciu połączenia bezpośredniego. Podczas konfigurowania klienta użytkownik musi wybrać typ konta Exchange, Office lub Outlook.com. Dodatki nie zostaną załadowane jeśli klient poczty jest skonfigurowany do łączenia się przez POP3 lub IMAP.

Więcej informacji na stronie: [Wymagania dotyczące dodatku Outlook](https://learn.microsoft.com/en-us/office/dev/add-ins/outlook/add-in-requirements)

:::

### Silnik przeglądarki
Expand Down
2 changes: 2 additions & 0 deletions docs/3-administrator-guides/16-automation/2-cron/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,9 @@ CRON można włączyć w kilku prostych krokach:
- Dodaj wpis do crontab, lub plik do CRON, np. w takim formacie (`__YETIFORCE_PATH__`jest pełną ścieżką bezwzględną do folderu systemu YetiForce, np. /var/www/example),

:::warning

Ważne jest, aby skrypt był uruchamiany z takimi samymi uprawnieniami jak właściciel plików systemowych.

:::

```bash
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,9 @@ Należy wypełnić wszystkie obowiązkowe pola (oznaczone czerwoną gwiazdką) p
Po wysłaniu formularza rejestracyjnego czekamy na weryfikację systemu.

:::warning

Klucze rejestracyjne generowane są automatycznie i wysyłane na adres email podany podczas rejestracji. W przypadku podania nieprawidłowych informacji, rejestracja zostanie odrzucona.

:::

![registration-2.jpg](registration-2.jpg)
Expand All @@ -83,7 +85,9 @@ W menu z lewej strony wybierz `Firma`, a następnie `Dane firmy`. Popraw dane w
![registration-5.jpg](registration-5.jpg)

:::warning

Każdorazowa zmiana danych w formularzu, automatycznie zmieni status rejestracji na "**oczekuje na akceptację**" i będzie wymagana ponowna weryfikacja wprowadzonych danych.

:::

Dane wprowadzone w formularzu rejestracyjnym, zostaną przesłane do nas w celu weryfikacji. Weryfikacja nastąpi w ciągu 2 dni roboczych.
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@ tags:
---

:::tip

This functionality is available for YetiForce version `6.2.0` and later

:::

The article describes how to add a new entry with an attachment in the Documents module via Rest API.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ tags:
---

:::tip

Funkcjonalność dostępna od wersji YetiForce `3.5`

:::

The QueryGenerator mechanism can be used to list any data from entity type modules.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,9 @@ A few important principles about the `Autoloader`:
There is also a `Loader` within the system and it is responsible for the upload of files. By knowing its working principles, it is possible to overwrite system files without changing engine files. Some of the capabilities of a Loader are described below:

:::tip

The mechanism described below works from version YetiForce `2.1`

:::

The Loader allows to overwrite any system file. A folder named 'custom' needs to be added to the main system directory and a complete file path provided, e.g. `custom/modules/Accounts/Accounts.php`. The system will load the file Accounts.php instead of the original file. Currently, this solution works only for modules, but in the future the system will allow to change system files globally. A list of directories possible to overwrite:
Expand Down
2 changes: 2 additions & 0 deletions docs/4-developer-guides/4-cli/Eraser.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ preview: Eraser-0.jpg
---

:::tip

Ta funkcja jest dostępna dla YetiForce w wersji `6.4.146` i później

:::

![Eraser CLI](Eraser-0.jpg)
Expand Down
4 changes: 4 additions & 0 deletions docs/4-developer-guides/4-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ preview: Cli.jpg
---

:::tip

Funkcjonalność dostępna od wersji YetiForce `6.2.0` i później

:::

Opis interfejsu CLI (Command Line Interface) do obsługi niestandardowych operacji systemu YetiForce.
Expand All @@ -28,7 +30,9 @@ Opis interfejsu CLI (Command Line Interface) do obsługi niestandardowych operac
Konsolę zawsze uruchamiany z głównego katalogu systemu YetiForce, czyli tam gdzie znajduje sie plik cli.php.

:::tip

YetiForce CLI musi być zawsze uruchamiany na użytkowniku systemu operacyjnego, który jest właścicielem plików systemu YetiForce.

:::

Możliwe polecenia w zależności od środowiska:
Expand Down
15 changes: 15 additions & 0 deletions docs/4-developer-guides/5-environments/1-debian-10.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,17 @@ tags:
Instrukcja przedstawia proces instalacji i konfiguracji platformy LEMP dla YetiForce na Debian 10 z serwerem NGINX/PHP-FPM 7.4/MariaDB.

:::warning

W artykule zakładamy, że masz przynajmniej podstawową wiedzę o Linux i wiesz jak korzystać z powłoki shell.

:::

Instalacja jest całkiem prosta i zakłada, że pracujesz na koncie root. Jeśli nie, może być konieczne dodanie `sudo` poleceń, aby uzyskać uprawnienia `root`.

:::tip

Pełna lista wymagań dla systemu YetiForce jest na stronie: [Wymagania systemu YetiForce](/introduction/requirements/)

:::

## 1. Aktualizacja wszystkich zainstalowanych pakietów do najnowszych dostępnych wersji
Expand Down Expand Up @@ -50,6 +54,7 @@ echo "deb https://packages.sury.org/php/ $(lsb_release -sc) main" > /etc/apt/sou
```

:::important Opcjonalnie

Jeśli chcesz mieć najnowszą wersję silnika bazy danych, to możesz dodać dodatkowe repozytorium pakietów od MariaDB.

```bash
Expand Down Expand Up @@ -93,6 +98,7 @@ passwd yfprod
```

:::important Opcjonalnie

Utworzenie środowiska testowego

```bash
Expand Down Expand Up @@ -120,10 +126,13 @@ wget -O /etc/nginx/nginx.conf "https://raw.githubusercontent.com/YetiForceCompan
```

:::warning

Plik [www.conf](https://github.com/YetiForceCompany/YetiForceCRM/blob/stable/tests/setup/nginx/www.conf) z github zawiera przykładowe nazwy domen i należy je zmienić. W przykładzie jest użyta wersja deweloperska, zalecamy aby pobrać pliki dla wersji CRM, która będzie instalowana.

:::

:::important Opcjonalnie

Utworzenie środowiska testowego, wymaga zmiany nazwy domeny

```bash
Expand All @@ -146,11 +155,13 @@ sed -i 's/output_buffering = "On"/output_buffering = "Off"/g' /etc/php/7.4/cli/c
```

:::warning

W przykładzie jest użyta wersja deweloperska, zalecamy aby pobrać pliki dla wersji systemu, która będzie instalowana np. https://github.com/YetiForceCompany/YetiForceCRM/blob/6.4.0/tests/setup/fpm/www.conf

:::

:::important Opcjonalnie

Tworzenie środowiska testowego wymaga skopiowania pliku i zastąpienia `yfprod` `yftest`

```bash
Expand All @@ -168,7 +179,9 @@ wget -O /etc/mysql/mariadb.conf.d/50-server.cnf "https://raw.githubusercontent.c
```

:::warning

W przykładzie jest użyta wersja deweloperska, zalecamy aby pobrać pliki dla wersji systemu, która będzie instalowana np. https://github.com/YetiForceCompany/YetiForceCRM/blob/6.4.0/tests/setup/db/mysql.cnf

:::

**MariaDB nie jest domyślnie bezpieczna**. Możesz to zrobić na dwa sposoby:
Expand Down Expand Up @@ -256,7 +269,9 @@ Pełny opis instalacji systemu YetiForce znajduje się w artykule: [Instalacja s
## 15. Uwagi końcowe

:::warning

Po zakończeniu konfiguracji dostęp do SSH powinien zostać ograniczony tylko do zaufanych adresów IP lub VPN.

Zalecamy również wyłączenie możliwości logowania się na użytkownika root bezpośrednio przez SSH oraz instalację i konfigurację firewall.

:::
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ Jeśli jesteście użytkownikami systemu YetiForce i macie problem, które chcec
#### 2. Dane dostępowe do system YetiForce

:::important

Użytkownik musi mieć uprawnienia administratora.

:::

- login
Expand Down Expand Up @@ -50,11 +52,15 @@ Dostęp do bazy danych musi być możliwy przez klienta zewnętrznego, czyli mus
#### 5. VPN - Opcjonalny

:::warning

Dotyczy tylko jeśli dostęp do Twoich danych wymaga VPN

:::

Prosimy dodatkowo o podanie nazwy programu potrzebnego do połączenia z VPN oraz dane do konfiguracji tego programu (adres, port, login, hasło, oraz inne informacje wymagane przez konkretny program, jak np. certyfikat).

:::tip

Po realizacji przez nas zlecenia dane dostępowe należy zmienić a dostęp z zewnątrz należy wyłączyć zgodnie z dobrymi praktykami bezpieczeństwa.

:::
1 change: 1 addition & 0 deletions docs/5-contributing/2-languages.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ The official translation project of [YetiForce](https://crowdin.com/project/yeti
:::warning

**You need a Crowdin account to be able to add translations.**

:::

:::tip
Expand Down
1 change: 1 addition & 0 deletions docs/5-contributing/3-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ You can help us develop our documentation by adding new articles or fixing any e
You need a [Github user account](https://github.com/join) to edit pages on the YetiForce Documentation Site.

[How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github)

:::

To add a new article you need to create a new file [here](https://github.com/YetiForceCompany/YetiForceDoc/tree/main/docs), and to fix an existing one simply scroll down to the end of the article and click `Edit`.
Expand Down
1 change: 1 addition & 0 deletions docs/5-contributing/4-issues-and-discussions.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ You can test our [development version](https://demo.yetiforce.com) and report al
Remember that system testing and bug reporting is also considered contribution to the development of the system, because if we don't know that there is a bug, we can't fix it.

:::warning

Przed rozpoczęciem zapoznaj się z artykułami:

- [How to report bugs?](/developer-guides/github/how-to-report-bugs)
Expand Down

0 comments on commit e955395

Please sign in to comment.