Bu rehberde, Greenbone Community Edition dokümantasyonunu yerel olarak kurmak için adım adım talimatlar bulacaksın. İlk olarak, sanal bir makine (VM) üzerinde Linux kurulumu yapacak ve sonrasında gerekli bağımlılıkları kurarak dokümantasyonu oluşturacağız.
Greenbone Community Edition'ı çalıştırmak için önce bir sanal makine (VM) oluşturmalısın. VM üzerine Linux dağıtımı kuracağız. Aşağıda VirtualBox kullanarak bir VM kurulumunu anlatıyorum.
- VirtualBox'ı indir ve kur: VirtualBox İndir
- Linux ISO dosyasını indir: Örneğin, Ubuntu 22.04 kullanabilirsin. Ubuntu İndir
- VirtualBox'ı aç ve Yeni butonuna tıkla.
- Ad: Ubuntu veya tercih ettiğin Linux dağıtımının adı.
- Tip: Linux.
- Versiyon: Ubuntu (64-bit).
- Bellek (RAM): En az 2048 MB önerilir.
- Sanal Sabit Disk: En az 20 GB önerilir (dinamik tahsisli olabilir).
- VM'i başlat ve indirdiğin Ubuntu ISO dosyasını seç.
- Ekrandaki talimatları takip ederek Linux'u kur.
- Kurulum tamamlandıktan sonra VM'yi yeniden başlat.
Greenbone Community Edition'ı kurmak için aşağıdaki yazılımlar gereklidir:
- Python 3.9 veya üstü
- Poetry bağımlılık yönetim aracı
Ubuntu üzerinde Python ve diğer araçları kurmak için aşağıdaki adımları takip et:
sudo apt update
sudo apt install python3 python3-pip python3-venv -yPoetry'yi kurmak için önce pipx'i kuracağız:
-
pipx'i kur:
sudo apt install pipx
-
Poetry'yi pipx ile kur:
python3 -m pipx install poetry
Şimdi Greenbone projesi için gerekli olan bağımlılıkları kuracağız.
-
Proje dosyalarının bulunduğu dizine git:
cd /path/to/greenbone-community-edition -
Bağımlılıkları kurmak için Poetry kullan:
poetry install
Bu komutu haftada bir çalıştırarak bağımlılıkları güncel tutman önerilir.
Bağımlılıkları kurduktan sonra, Greenbone dokümantasyonunu HTML formatında oluşturabiliriz.
Dokümantasyonu oluşturmak için şu komutu çalıştır:
poetry run make htmlBu işlem tamamlandığında, oluşturulan dokümantasyonu tarayıcıda görüntülemek için:
firefox _build/html/index.htmlDokümantasyon üzerinde çalışıyorsan ve her değişiklikten sonra otomatik olarak yeniden oluşturulmasını istiyorsan şu komutu çalıştır:
poetry run make livehtmlTarayıcıda görüntülemek için:
firefox http://127.0.0.1:8000Eğer herhangi bir sorun yaşarsan veya bağımlılıkları sıfırlamak istersen, sanal ortamı silip yeniden oluşturabilirsin.
Öncelikle sanal ortamın proje klasörü içinde yer almasını sağla:
poetry config virtualenvs.in-project trueSanal ortamı ve bağımlılıkları tamamen silmek için:
rm -rf .venvSonrasında, bağımlılıkları yeniden kurmak için:
poetry install- Poetry Belgelendirme: Poetry Resmi Sitesi
- pipx Kullanımı: pipx Resmi Sitesi