- Sissejuhatus
- Paigaldusfailide laadimine
- Konfiguratsioon
- Cybsis käivitamine
- Tarkvara litsentsi paigaldamine
- Litsentsi paigaldamine ühenduseta seadmetes
- Root kasutaja
- Veebiserveri kasutamine
- Andmete varundamine
- Tarkvara uuendamine
- Probleemide lahendamine
- Korduma kippuvad küsimused
Sissejuhatus
Järgnev dokument kirjeldab, kuidas seadistada ja paigaldada CYBSIS (Cybersecurity Standard Implementation Software) tarkvara. See juhend on mõeldud abistama kasutajaid tarkvara paigaldamisel ja konfiguratsioonis, et tagada sujuv ja probleemivaba kasutuskogemus.
Paigaldusfailide laadimine
Lae paigaldusfail alla ning paki lahti seadmes soovitud asukohta. Paigaldus pakk sisaldab järgmisi faile ja katalooge:
| /static | teenuse skriptid |
| /views | kasutajaliidese failid |
| /translations | lokaliseerimise failid |
| /keys | self-generated võti ja sertifikaat |
| .env | näidis konfiguratsioonifail |
| cybsis.exe (win) või cybsis (unix) | rakendusfail |
Veendu, et kõik vajalikud failid on olemas ja kontrolli, et paigaldusfailide terviklikkus on tagatud.
Konfiguratsioon
Cybsis konfiguratsioon on ära kirjeldatud .env (dotenv) failis, mis asub käivitusprogrammiga samas kataloogis. Konfiguratsioonifailis määratakse vajalikud seaded, mis on vajalikud tarkvara korrektseks toimimiseks.
Konfiguratsiooni fail võib sisaldada järgmisi muutujaid:
Nõutud väärtused on alla joonitud.
| TLS_KEY | TLS/SSL võtmefaili asukoht * jäta kirjeldamata pordi suunamise korral |
| TLS_CERT | TLS/SSL sertifikaadi asukoht * jäta kirjeldamata pordi suunamise korral |
| SESSION_KEY | sessiooni tunnus |
| DATABASE_TYPE | Andmebaas * Võimalikud väärtused: PSQL, MySQL (PSQL on eelistatud) |
| DATABASE_LOCATION | Andmebaasi asukoht * Salvestatakse litsents (account.pem) ja SQLite kasutades andmebaas |
| DATABASE_HOST | Andmebaasi host * Kasutatakse PSQL ja MySQL andmebaasi puhul |
| DATABASE_PORT | Andmebaasi port * Kasutatakse PSQL ja MySQL andmebaasi puhul |
| DATABASE_USER | Andmebaasi kasutaja * Kasutatakse PSQL ja MySQL andmebaasi puhul |
| DATABASE_PWD | Andmebaasi kasutaja parool * Kasutatakse PSQL ja MySQL andmebaasi puhul |
| DATABASE_NAME | Andmebaasi nimi * Kasutatakse PSQL ja MySQL andmebaasi puhul |
| ALLOW_ANALYTICS | Anonüümse kasutusanalüütika moodul * vaikimisi lubatud |
| LOGS_LOCATION | Logi failide asukoht |
| AD_SERVER_URL | Active Directory serveri URL |
| AD_SERVER_PORT | Active Directory serveri port |
| AD_SERVER_BASEDN | Active Directory serveri base DN |
| AD_SERVER_GROUPS | Active Directory serveri grupid |
| AD_SERVER_CA_CERT | Active Directory serveri CA sertifikaadi asukoht |
| AD_SYNC | Active Directory serveri sünkroniseerimine * Võimalikud väärtused: On, Off (Eksperimentaalne) |
| SMTP_HOST | Meiliserveri aadress * SMTP serveri puudumisel jäta see ja alljärgnevad väljad tühjaks. |
| SMTP_PORT | Meiliserveri port |
| SMTP_USER | Meiliserveri kasutaja |
| SMTP_PWD | Meiliserveri kasutaja parool * Jäta kirjeldamata, kui autentimist ei kasutata |
Näidis konfiguratsioon (Unix):
TLS_KEY=/opt/eits/key.pem
TLS_CERT=/opt/eits/cert.pem
SESSION_KEY=eits-session
DATABASE_TYPE=PSQL # Näide: PSQL, MySQL, SQLite
DATABASE_LOCATION=/opt/eits/ # SQLite andmebaasi ja (account.pem) litsentsi jaoks
DATABASE_HOST=dbserver.local # Täida PSQL/MySQL kasutamisel
DATABASE_PORT=5432 # Täida PSQL/MySQL kasutamisel, näiteks PostgreSQL puhul
DATABASE_USER=eits_user # Täida PSQL/MySQL kasutamisel
DATABASE_PWD=secret123 # Täida PSQL/MySQL kasutamisel
DATABASE_NAME=eits_db # Täida PSQL/MySQL kasutamisel
ALLOW_ANALYTICS=true/false
LOGS_LOCATION=/opt/eits/logs/
SMTP_HOST=smtp.meiliserver.ee # Meiliserveri aadress
SMTP_PORT=587 # Meiliserveri port
SMTP_USER=kasutaja@meiliserver.ee # Meili saatmise kasutaja
SMTP_PWD="smtp app pwd " # Selle kasutaja parool
PUBLIC_URL=https://localhost:9091 # Vajalik linkide tegemiseks
Näidis konfiguratsioon (Windows):
TLS_KEY=C:\eits\key.pem
TLS_CERT=C:\eits\cert.pem
SESSION_KEY=eits-session
DATABASE_TYPE=PSQL # Näide: PSQL, MySQL, SQLite
DATABASE_LOCATION=C:\eits\ # SQLite andmebaasi ja (account.pem) litsentsi jaoks
DATABASE_HOST=dbserver.local # Täida PSQL/MySQL kasutamisel
DATABASE_PORT=5432 # Täida PSQL/MySQL kasutamisel, näiteks PostgreSQL puhul
DATABASE_USER=eits_user # Täida PSQL/MySQL kasutamisel
DATABASE_PWD=secret123 # Täida PSQL/MySQL kasutamisel
DATABASE_NAME=eits_db # Täida PSQL/MySQL kasutamisel
ALLOW_ANALYTICS=true/false
SMTP_HOST=smtp.meiliserver.ee # Meiliserveri aadress
SMTP_PORT=587 # Meiliserveri port
SMTP_USER=kasutaja@meiliserver.ee # Meili saatmise kasutaja
SMTP_PWD="smtp app pwd " # Selle kasutaja parool
PUBLIC_URL=https://localhost:9091 # Vajalik linkide tegemiseks
Punktiga (.) algavad failid on enamikes süsteemides peidetud failid, seega faili avamiseks kasuta käsurida või seadista süsteem kuvama ka peidetud faile.
Tungivalt soovitatav on paigaldada Cybsis viisil, mis välistab sellele ligipääsu välisvõrkudest. Välisvõrkudest juurdepääsu saamiseks peaksid kasutajad kasutama näiteks VPN-ühendust.
Juhul, kui planeerite kasutada veebiserveri tarkvara (nt. Apache) teenuse ees, jätke TLS_KEY ja TLS_CERT konfiguratsiooni parameetrid kirjeldamata.
Cybsis käivitamine
Enne käivitamist veendu, et rakendusfailil oleks antud käivitusõigus. Windows platvormil kasuta selleks "File Properties", Mac ja Linux operatsioonisüsteemis käivita käsurealt käsk:
chmod +x cybsis
Teenuse käivitamiseks mine käsureal Cybsis rakendusfaili asukohta ning käivita rakendusfail.
Windows:
cybsis.exe
Mac/Linux:
./cybsis
Vaikimisi töötab teenus pordis 9090. Juhul, kui vaikimisi kasutatud port ei ole sinu süsteemis lubatud kasutada või on see kasutusel mõne teise teenuse poolt, saad seda muuta rakendusfailile käivitamisel võtme port väärtuse lisamisega.
Windows:
cybsis.exe -port=8888
Mac/Linux:
./cybsis -port=8888
Server käivitus kui terminalis ilmub teavitus: “https server started on [::]:9090”.
Rakendusele saab ligi avades brauseris aadressi https://localhost:9090
Tarkvara litsentsi paigaldamine
Tarkvara litsents paigaldatakse seadmesse automaatselt. Esmasel käivitusel kuvatakse vorm litsentsi koodi aktiveerimiseks. Sisesta vormi välja oma litsentsi kood ning kinnita vorm.
Valiidse koodi korral paigaldab tarkvara litsentsi faili konfiguratsiooni parameetriga DATABASE_LOCATION kirjeldatud kataloogi.
Litsentsi koodi väljastab RaulWalter.
NB! Litsentsi fail on seotud kasutatava seadmega ehk tarkvara ringi tõstmisel uuele seadmele tuleb teavitada kliendituge
Litsentsi paigaldamine ühenduseta seadmetes
Juhul, kui tarkvara kasutatakse seadmes, millel puudub internetiühendus, tuleb litsents paigaldada seadmesse käsitsi.
Selleks toimi järgnevalt:
- käivita teenus
- kopeeri litsentsi aktiveerimise aknas kuvatav seadme tunnus (fingerprint)
- edasta see kood aadressile eits@raulwalter.com
- Sulle tagastatakse litsentsifail (Account.pem)
- kopeeri see konfiguratsioonis kirjeldatud DATABASE_LOCATION kataloogi
- taaskkäivita teenus
Root kasutaja
Esimesel sisse logimisel luuakse süsteemi esmane administraatori õigustega kasutaja. See kasutaja saab süsteemi täieliku haldusõiguse ning teda saab kasutada teiste kasutajate haldamiseks ja süsteemi konfiguratsiooniks.
Administraatori konto loomisel sisesta vajalikud andmed ja määrake tugev parool, et tagada süsteemi turvalisus.
Veebiserveri kasutamine
Juhul, kui kasutate mõnda veebiserveri tarkvara (Apache, Nginx, vms) Cybsis teenuse ees, konfigureerige pordi suunamine veebiserveris. See võimaldab teenusel töötada turvaliselt ja kasutajatele juurdepääsetavalt.
Näide (Apache):
<VirtualHost *:443>
ServerName cybsis.minudomeen.ee
# setup the proxy
<Proxy *>
Order allow,deny
Allow from all
</Proxy>
ProxyPass / http://localhost:9090/
ProxyPassReverse / http://localhost:9090/
</VirtualHost>
Samuti tuleks võimalusel Cybsis konfiguratsioonist eemalda SSL võtme ja sertifikaadi kirjed ning kasutada veebiserveri konfiguratsiooni nende paigaldamiseks.
Andmete varundamine
Varundamist (tagavarakoopia) tuleb vajadusel luua konfiguratsiooni parameetriga DATABASE_LOCATION ära kirjeldatud kataloogist. Regulaarne varundamine tagab andmete säilimise ja võimaluse taastada süsteemi ootamatute probleemide korral.
Varundamiseks võib kasutada järgmisi käske (Unix):
tar -czvf cybsis_backup.tar.gz /opt/eits/
Windows süsteemis võib kasutada failihaldurit või spetsiaalset varundustarkvara.
Tarkvara uuendamine
Tarkvara versiooni uuendamiseks peata teenuse töö ning kopeeri paigaldusfailide pakis olevate failidega eksisteerivad failid üle (v.a. konfiguratsiooni fail) ning käivita teenus uuesti. Uuenduste paigaldamine tagab turvaparanduste ja uute funktsioonide jõudmise süsteemi.
Uuendamiseks (Unix):
service cybsis stop
cp -r /path/to/new/files/* /opt/eits/
service cybsis start
Windows süsteemis võib kasutada failihaldurit või käsureatööriistu failide kopeerimiseks ja teenuse taaskäivitamiseks.
Probleemide lahendamine
Kui tekib probleeme Cybsis paigaldamise või kasutamisega, võib proovida järgmist:
- Kontrolli, kas kõik nõutud konfiguratsioonifailid ja -seaded on õigesti määratud.
- Veendu, et süsteemil on vajalikud õigused failide ja teenuste käivitamiseks.
- Kontrolli logifaile (asuvad LOGS_LOCATION määratud kataloogis) võimalike veateadete jaoks.
- Taaskäivita teenus ja kontrolli, kas probleem püsib.
- Vajadusel võta ühendust klienditoega ja edasta logifailid probleemi diagnoosimiseks.
Korduma kippuvad küsimused
K: Kuidas muuta Cybsis vaikimisi porti?
V: Muuda konfiguratsioonifailis port määratud väärtus või käivita rakendus kasutades port võtme väärtust (näiteks: ./cybsis -port=8888).
K: Kuidas saan kontrollida, kas Cybsis teenus töötab?
V: Ava veebibrauseris aadress http(s)://localhost:9090 ja veendu, et leht laeb korrektselt.
K: Mida teha, kui litsentsi paigaldamine ebaõnnestub?
V: Kontrolli, et litsentsifail asub õiges kataloogis (DATABASE_LOCATION määratud kataloog). Kui probleem püsib, võta ühendust klienditoega.