Instalacja - wersja on-premise
Instalacja OmniMES
Kompletna procedura wdrożenia systemu OmniMES - od pobrania Dockera, przez aktywację licencji, konfigurację Redash i serwera AI Ollama, po zmianę haseł, aktualizację i odinstalowanie.
1. Wymagania wstępne
Przed instalacją upewnij się, że na komputerze docelowym wolne są następujące porty:
Port | Usługa |
|---|---|
80 | Interfejs WWW (frontend) |
8091 | Backend API |
5000 | Redash (raporty) |
1883 | Broker MQTT (TCP) |
1884 | Broker MQTT (WebSocket) |
8083 | EMQX - panel administracyjny brokera |
Wymagany jest również Docker: https://docs.docker.com/get-docker/
Zalecanym środowiskiem dla serwera produkcyjnego jest Linux (Debian / Ubuntu Server LTS) z Docker Engine. Docker Desktop dla Windows nadaje się do testów i prezentacji — dlaczego nie zalecamy Windows Server, wyjaśnia rozdział Wymagania sprzętowe oraz sekcja 10.4.
2. Instalacja krok po kroku
Pobierz i zainstaluj Docker odpowiedni dla swojego systemu.
Z paczki instalacyjnej uruchom skrypt zgodnie z systemem operacyjnym:
Windows:
install_all_windows.batLinux:
install_all_linux.sh
Skrypty te instalują pełną wersję OmniMES wraz z komponentami: API, Stream, WWW, Redash oraz Ollama.
Linux - nadanie uprawnień (przed pierwszym uruchomieniem):
chmod +x install_linux.sh uninstall.sh updated_api.sh updated_www.sh ./install_all_linux.shWindows - komunikat „System Windows ochronił ten komputer" Kliknij Więcej informacji → Uruchom mimo to.
3. Pierwsze logowanie
3.1. Otwarcie aplikacji w przeglądarce
Po zakończeniu pracy skryptu otwórz przeglądarkę i wpisz w pasku adresu jeden z adresów:
localhost127.0.0.1lokalny adres IP komputera, na którym zainstalowano oprogramowanie
Pojawi się ekran logowania OmniMES.
3.2. Wypełnienie ekranu logowania
Na formularzu logowania znajdują się trzy pola - uzupełnij je w następujący sposób:
Pole | Co wpisać | Uwagi |
|---|---|---|
API URL | adres backendu OmniMES, np. | To nie jest adres przeglądarki - to adres usługi API, która zawsze działa na porcie 8091. Jeśli OmniMES uruchomiony jest na innym komputerze, zamień |
Nazwa użytkownika |
| Domyślne konto utworzone po instalacji - superuser z dostępem do wszystkich funkcji, niezależnie od uprawnień grup. |
Hasło |
| Domyślne hasło fabryczne. |
ℹ️ Częsty błąd: w polu API URL wpisuje się adres usługi backendu (port
8091), nie adres, z którego otwierasz przeglądarkę (port80). Te adresy zwykle różnią się portem i mogą wskazywać różne hosty (np. frontend lokalnie, API na serwerze).
⚠️ Bezpieczeństwo: Hasło fabryczne należy zmienić natychmiast po pierwszym zalogowaniu.
4. Aktywacja licencji
Po zalogowaniu system automatycznie przeniesie Cię do ekranu aktywacji. Wprowadź klucz licencji dostarczony wraz z paczką - produkt jest gotowy do użytku.
5. Konfiguracja Redash (raporty)
Redash to wbudowany silnik raportowy OmniMES, dostępny lokalnie pod adresem:
http://localhost:5000/ℹ️ Po instalacji baza Redash jest odtwarzana automatycznie - wraz z gotowym źródłem danych, zapytaniami i pulpitami. Nie trzeba ręcznie dodawać źródła danych JSON ani konfigurować połączenia. Wystarczą poniższe trzy kroki.
5.1. Zaloguj się do Redash
Otwórz http://localhost:5000/ i zaloguj się danymi domyślnymi:
Pole | Wartość domyślna |
|---|---|
| |
Hasło |
|
5.2. Zmień domyślny login i hasło
Ze względów bezpieczeństwa natychmiast zmień domyślny email i hasło na własne: w Redash kliknij Settings (lewy dolny róg) → Account i ustaw nowe dane logowania.
5.3. Wygeneruj token i wklej go do OmniMES
W Redash przejdź do Settings → Account.
W sekcji API Key kliknij Regenerate, aby wygenerować nowy token, i skopiuj go.
W OmniMES przejdź do Ustawienia systemowe → Konfiguracja ogólna, zakładka Redash, i uzupełnij:
Adres Redash:
localhost:5000Token Redash: wklejony, świeżo wygenerowany token
Od tej chwili OmniMES jest połączony z Redash - możesz korzystać z gotowych raportów i pulpitów.
6. Konfiguracja Ollama (asystent AI)
Serwer Ollama dostarcza lokalne modele językowe dla wbudowanego asystenta AI w OmniMES. Jest automatycznie instalowany wraz z pełną wersją systemu (skrypty install_all_*).
6.1. Wymagania sprzętowe
Domyślna instalacja wykorzystuje CPU, więc wydajność zależy od mocy procesora:
CPU (minimum): procesor stacjonarny 24-rdzeniowy lub silniejszy.
GPU (zalecane): karta NVIDIA serii 3070 lub wyższa (jedna lub więcej, zależnie od wybranego modelu AI).
💡 Rekomendacja: Dla większych wdrożeń uruchom Ollama na osobnym serwerze (Docker lub natywnie).
6.2. Instalacja na osobnym serwerze
Obraz Docker: https://hub.docker.com/r/ollama/ollama
Linux: https://github.com/ollama/ollama/blob/main/docs/linux.md
Windows: https://github.com/ollama/ollama/blob/main/docs/windows.md
docker-compose.yaml
version: '3.8'
services:
ollama:
image: ollama/ollama
environment:
- OLLAMA_ORIGINS="*"
- OLLAMA_HOST="0.0.0.0:11434"
container_name: ollama
ports:
- "11434:11434"
volumes:
- ollama:/root/.ollama
restart: unless-stopped
volumes:
ollama:Dla dostępu z zewnątrz: host = 0.0.0.0, port = 11434, CORS = "*" (lub zawężony do potrzeb).
6.3. Pobranie modelu AI
Lista wspieranych modeli: https://ollama.com/library
Pobranie wybranego modelu:
ollama pull llama36.4. Powiązanie z OmniMES
W Ustawieniach OmniMES:
Wybierz typ AI: wewnętrzna.
Wprowadź adres serwera Ollama (np.
http://192.168.3.100:11434).W polu Wersja modelu AI powinna pojawić się lista pobranych modeli.
Jeśli połączenie się nie powiedzie, w polu pojawi się komunikat błędu - sprawdź adres serwera i otwarte porty.
7. Zmiana haseł systemowych
Hasło do bazy PostgreSQL lub brokera MQTT zmienia się dołączonym skryptem **set_pass.py**. Skrypt operuje na uruchomionych kontenerach (docker compose exec database psql), dlatego stack OmniMES musi być włączony, a sam skrypt wymaga jedynie zainstalowanego Pythona i działającego Dockera - bez dodatkowych bibliotek (nie trzeba podawać hosta, portu ani starego hasła). Uruchamiaj go w katalogu, w którym znajduje się docker-compose.yaml stacku OmniMES.
7.1. Zmiana hasła brokera MQTT (użytkownik emqx)
# Windows
py set_pass.py --newpassbroker NOWE_HASLO_BROKERA
# Linux / macOS
python3 set_pass.py --newpassbroker NOWE_HASLO_BROKERASkrypt aktualizuje hasło użytkownika MQTT emqx w bazie, plik .env streama i restartuje usługę stream.
7.2. Zmiana hasła bazy PostgreSQL (użytkownik omni)
# Windows
py set_pass.py --newpassdb NOWE_HASLO_BAZY
# Linux / macOS
python3 set_pass.py --newpassdb NOWE_HASLO_BAZYSkrypt zmienia hasło użytkownika omni, aktualizuje omnimes/.env, konfigurację autoryzacji EMQX (emqx_auth_pgsql.conf), config.json API oraz .env streama, a następnie restartuje usługi broker, api i stream - nie trzeba nic robić ręcznie.
8. Aktualizacja systemu
Każdy główny komponent można aktualizować niezależnie za pomocą dedykowanych skryptów:
Komponent | Windows | Linux |
|---|---|---|
API |
|
|
Stream (MQTT / Sparkplug B) |
|
|
Frontend WWW |
|
|
Każdy ze skryptów wykonuje sekwencję: pull → rebuild → restart kontenera.
Aktualizacja do wersji 4.8.0 - kontrola uprawnień. Od wersji 4.8.0 serwer sprawdza uprawnienia grup z zakładki Administracja → Uprawnienia dostępu (zmienna OMNIMES_RBAC_MODE, sekcja 12.1). Zaktualizowana instalacja zachowuje tryb z pliku omnimes/.env, a bez tego wpisu działa w trybie audit - niczego nie blokuje, tylko zapisuje operacje, które zostałyby zablokowane. Aby włączyć blokowanie:
Przejrzyj raport poleceniem
docker compose exec api python manage.pyc rbac --odmowy(w kataloguomnimes) i uzupełnij grupom brakujące ekrany w Uprawnieniach dostępu.Dopisz w
omnimes/.envwierszOMNIMES_RBAC_MODE=enforce. Jeśli w plikudocker-compose.yaml, w sekcjienvironmentusługiapi, nie ma wierszaOMNIMES_RBAC_MODE: ${OMNIMES_RBAC_MODE:-}, dopisz go.Uruchom
docker compose up -d --no-deps api(w kataloguomnimes). Flaga--no-depssprawia, że ponownie uruchamiany jest tylko kontener API, bez bazy danych.
Powrót do poprzedniego działania: OMNIMES_RBAC_MODE=audit (albo off) i ponownie docker compose up -d --no-deps api. Szczegóły: plik BEZPIECZENSTWO_API.md w paczce instalacyjnej.
💡 Linux: pamiętaj o uprawnieniach -
chmod +x updated_*.shprzed pierwszym uruchomieniem.
8.1. Pełna odbudowa środowiska
W razie problemów (uszkodzony kontener, niespójność konfiguracji) można wymusić odbudowę:
OmniMES:
recreated_omnimes.bat(Windows)Redash:
recreated_redash.bat(Windows)
⚠️ Odbudowa nie usuwa wolumenu
postgres_dataz danymi bazy, ale przed uruchomieniem rekomendowany jest backup.
9. Odinstalowanie
9.1. Procedura
W folderze instalacyjnym uruchom skrypt:
Windows:
uninstall.batLinux / macOS:
uninstall.sh
W systemie Linux pamiętaj wcześniej o nadaniu uprawnień:
chmod +x uninstall.sh
./uninstall.sh9.2. Ostrzeżenie - utrata danych
⚠️ Odinstalowanie usuwa wszystkie kontenery, włącznie z kontenerem bazy
**database**(PostgreSQL + TimescaleDB), w którym przechowywane są dane z urządzeń produkcyjnych.Przed odinstalowaniem wykonaj backup bazy danych - przez Adminer (
http://localhost:8079) lub poleceniemdocker compose exec database pg_dump -U omni -Fc -d data > data.dump(analogicznie dla bazyomni). Odtworzenie:pg_restore.
10. Udostępnianie OmniMES poza komputerem
10.1. Co zrobić, gdy port 80 jest zajęty?
Domyślnie interfejs WWW OmniMES działa na porcie 80. Jeśli port jest zajęty:
Opcja A: zwolnij port 80 w systemie operacyjnym (zatrzymaj usługę, która z niego korzysta).
Opcja B: zmień mapowanie portu w
docker-compose.yaml- w sekcjiwwwzmień lewą liczbę z80:80na np.8080:80. Po tym OmniMES będzie dostępny podhttp://<adres>:8080.
10.2. Udostępnienie poza siecią lokalną
Konfigurację należy wykonać na routerze, kierując ruch na adres IP komputera, na którym zainstalowano system. Wymagane przekierowania portów (port forwarding):
Port(y) | Usługa |
|---|---|
80, 443 | Serwer WWW |
1883, 1884 | MQTT - urządzenia zewnętrzne wysyłające dane do brokera |
8083 | WebSocket Secure (WSS) - strumień danych do podglądu w monitoringu |
10.3. Podłączenie urządzenia zewnętrznego (HMI / bramka)
W urządzeniu (panel HMI, bramka komunikacyjna itp.) wskaż:
Adres serwera OmniMES, np.
192.168.3.100Port MQTT:
1883(standardowy)Dane logowania do brokera EMQX:
Login:
emqxHasło:
Fb7jCkux(fabryczne - zmień po wdrożeniu, patrz sekcja 7)
10.4. Windows jako serwer (niezalecane) - automatyczny start Dockera
Zalecamy uruchamianie OmniMES na serwerze z Linuksem i Docker Engine (patrz rozdział Wymagania sprzętowe). Na Windows Server Docker Desktop nie jest wspierany przez producenta, a kontenery linuksowe działają w dodatkowej maszynie wirtualnej. Instalacja na Windows Server wymaga indywidualnych ustaleń z zespołem OmniMES.
Jeśli system musi działać na Windows, włącz w Docker Desktop opcję „Start Docker Desktop when you log in". Pamiętaj, że Docker Desktop działa w sesji zalogowanego użytkownika — po restarcie (np. po aktualizacjach Windows) OmniMES wystartuje dopiero, gdy ktoś się zaloguje.
11. Pliki instalacyjne - referencja
11.1. Pełna instalacja
Plik | Opis |
|---|---|
| Pełny system OmniMES na Linux (API + Stream + WWW + Redash + Ollama) |
| Pełny system OmniMES na Windows (API + Stream + WWW + Redash + Ollama) |
| Pełna instalacja bez Ollama - Windows (szybsza, bez modeli LLM) |
| Pełna instalacja bez Ollama - Linux |
11.2. Instalacja modułowa
Plik | Opis |
|---|---|
| Tylko podstawa OmniMES (API + Stream + WWW) - Windows |
| Tylko podstawa OmniMES - Linux / macOS |
| Tylko serwer Ollama - Windows |
| Tylko serwer Ollama - Linux |
11.3. Aktualizacje pojedynczych komponentów
Plik | Opis |
|---|---|
| Aktualizacja kontenera API (pull → rebuild → restart) |
| Aktualizacja modułu Stream (MQTT / Sparkplug B) |
| Aktualizacja frontendu WWW |
11.4. Odbudowa środowiska
Plik | Opis |
|---|---|
| Rebuild OmniMES - usuwa kontenery i tworzy je od nowa (Windows) |
| Rebuild środowiska Redash |
11.5. Odinstalowanie
Plik | Opis |
|---|---|
| Pełne usunięcie OmniMES (wraz z danymi!) |
| Usuwa tylko bazową instalację OmniMES (bez Redash, bez Ollama) |
| Usuwa wyłącznie Ollama |
11.6. Narzędzia
Plik | Opis |
|---|---|
| Skrypt Python - zmienia hasło bazy PostgreSQL ( |
12. Pliki konfiguracyjne .env
W paczce instalacyjnej są dwa pliki **.env**, które konfigurują system. Ustaw je przed pierwszym uruchomieniem skryptu instalacyjnego.
12.1. omnimes/.env - stack OmniMES
Zmienna | Znaczenie |
|---|---|
| superużytkownik bazy (domyślnie |
| hasło superużytkownika bazy (zmień na produkcji) |
| host bazy widziany z kontenerów - |
| port bazy - |
| publiczny adres API widziany z przeglądarki, np. |
| port frontendu WWW (domyślnie |
| kontrola uprawnień w API: |
12.2. redash/.env - stack Redash
Zmienna | Znaczenie |
|---|---|
| sekrety sesji/szyfrowania - zmień na produkcji |
| połączenie do Redis ( |
| połączenie do bazy |
| (opcjonalne) publiczny adres Redasha - z niego budowane są linki do publicznych pulpitów |
| (opcjonalne) konfiguracja serwera poczty SMTP - patrz uwaga niżej |
✉️ Poczta SMTP w Redash - ustaw PRZED instalacją (jeśli potrzebna). Pola
REDASH_MAIL_SERVER/REDASH_MAIL_PORT/REDASH_MAIL_USE_TLS/REDASH_MAIL_USE_SSL/REDASH_MAIL_USERNAME/REDASH_MAIL_PASSWORD/REDASH_MAIL_DEFAULT_SENDERsą potrzebne tylko do powiadomień e-mail o alertach, zaproszeń użytkowników i resetu hasła. Redash działa bez nich.
Jeśli chcesz e-maile → uzupełnij te pola własnym serwerem SMTP przed instalacją.
Jeśli nie używasz poczty → te linie muszą pozostać zakomentowane. Nigdy nie zostawiaj pustej linii typu
REDASH_MAIL_PORT=- Redash wykonujeint('')i kontener wpada w pętlę restartów.Po edycji
.envodtwórz kontener (docker compose up -d), a nie tylkorestart- Docker Compose wczytuje.envprzy tworzeniu kontenera, nie przy restarcie.
13. Przeniesienie danych na inny serwer (dumpy bazy)
System można przenieść z danymi na inny serwer. Na starym serwerze zrób dumpy z kontenera database, skopiuj je do omnimes/database/base/ przed buildem, a skrypt instalacyjny odtworzy całość na nowym serwerze.
docker compose exec database pg_dump -U omni -Fc -d omni > omni.dump # konfiguracja
docker compose exec database pg_dump -U omni -Fc -d omni_queue > omni_queue.dump # kolejka Django Q
docker compose exec database pg_dump -U omni -Fc -d mqtt > mqtt.dump # auth EMQX
docker compose exec database pg_dump -U omni -Fc -d redash > redash.dump # dashboardy/queries/users
docker compose exec database pg_dump -U omni -Fc -d data > data.dump # telemetria (hypertable Timescale)Skopiuj wybrane pliki do instalka3/omnimes/database/base/ i uruchom instalację.
Plik (opcjonalny) | Co odtwarza |
|---|---|
| konfiguracja - w praktyce jedyny potrzebny (admin + menu do logowania) |
| kolejka / auth brokera / Redash (transplant) |
| telemetria - musi być formatem |
ℹ️ Bez dumpów = świeża instalacja: schemat tworzy
migrate, a bazędatazasilastream. Szczegóły i akceptowane formaty (.dump/.sql/.sql.gz) opisuje plikdatabase/base/README.md.
Sekcja B - Wpisy w FAQ (3 krótkie skróty)
Gdzie wkleić: sekcja
FAQw Outline. Każdy wpis poniżej to osobna podstrona - krótka treść + link do kotwicy na stronieInstalacja.Uwaga o linkach: Outline tworzy kotwice automatycznie z nagłówków, w formie
#numer-tytul-z-myslnikami. Po opublikowaniu strony Instalacja sprawdź dokładny URL kotwicy (klikając „kopiuj link" przy nagłówku w Outline) i podstaw go pod[link …]poniżej.
B.1 - „Jak zmienić hasło do bazy PostgreSQL lub brokera MQTT?"
# Jak zmienić hasło do bazy PostgreSQL lub brokera MQTT?
Zmiana haseł systemowych odbywa się dołączonym skryptem
**`set_pass.py`** (wymaga tylko Pythona i działającego Dockera; stack OmniMES musi być uruchomiony).
➡ Pełna instrukcja, wraz z konkretnymi poleceniami CLI dla brokera i
bazy PostgreSQL, znajduje się w sekcji
**[Zmiana haseł systemowych](/doc/instalacja#7-zmiana-hasel-systemowych)**.B.2 - „Port 80 jest zajęty - co zrobić?"
# Port 80 jest zajęty - jak uruchomić OmniMES?
OmniMES domyślnie nasłuchuje na porcie 80. Jeśli port jest zajęty przez
inną usługę, masz dwie możliwości:
- zwolnij port 80 w systemie,
- albo zmień lewą stronę mapowania portu w `docker-compose.yaml` w sekcji
`www` z `80:80` na np. `8080:80`.
➡ Szczegóły wraz z opisem przekierowań na routerze i podłączania urządzeń
HMI znajdziesz w sekcji
**[Udostępnianie OmniMES poza komputerem](/doc/instalacja#10-udostepnianie-omnimes-poza-komputerem)**.B.3 - „Jak odinstalować OmniMES?"
# Jak odinstalować OmniMES?
W folderze instalacyjnym uruchom skrypt:
- **Windows:** `uninstall.bat`
- **Linux / macOS:** `uninstall.sh` (najpierw `chmod +x uninstall.sh`)
> ⚠️ Procedura usuwa **wszystkie kontenery, w tym bazę `database`** (PostgreSQL)
> z danymi produkcyjnymi. Przed odinstalowaniem zrób backup przez Adminer lub `pg_dump`.
➡ Pełna procedura wraz z opisem przywracania danych znajduje się w sekcji
**[Odinstalowanie](/doc/instalacja#9-odinstalowanie)**.