Phishing Service, phishing feeds paylaşımı yapan kaynaklardan URL'leri çeken, veritabanına kaydeden ve FastAPI aracılığıyla bu URL'leri sunan bir uygulamadır.
Bu talimatlar, projenin yerel makinenizde nasıl çalıştırılacağı veya dağıtılacağı hakkında size rehberlik edecektir. Geliştirme ve test amacıyla bu adımları takip edebilirsiniz.
Projenin çalışması için aşağıdaki yazılımların yüklü olması gerekmektedir:
- Docker
- Docker Compose
- Python 3.11
Ayrıca, .env dosyasında PostgreSQL veritabanı bağlantı bilgilerini ve çekilecek URL listesini ayarladığınızdan emin olun.
- Proje klasörüne gidin:
cd phishing_service- Docker Compose ile projeyi başlatın:
docker-compose up -dBu komut, PostgreSQL veritabanı ve iki farklı container'ı başlatacak; veritabanını oluşturacak, URL'leri çekip veritabanına kaydedecek ve FastAPI sunucusunu başlatacaktır.
- Proje çalıştıktan sonra API'ye aşağıdaki adres üzerinden erişebilirsiniz:
http://localhost:8000/phishing-urls/GET /phishing-urls/: Veritabanındaki phishing URL'lerini listeleyen bir endpointtir. Sayfalama için skip ve limit parametrelerini kullanabilirsiniz.
http://localhost:8000/phishing-urls/?limit=100
http://localhost:8000/phishing-urls/?limit=20&skip=20Proje, .env dosyasında belirtilen çevresel değişkenleri kullanır. Bu değişkenler, veritabanı bağlantı bilgilerini ve çekilecek URL listesini içerir.
POSTGRES_USER: PostgreSQL veritabanı kullanıcı adıPOSTGRES_PASSWORD: PostgreSQL veritabanı şifresiPOSTGRES_HOST: PostgreSQL veritabanı host adresiPOSTGRES_DB: PostgreSQL veritabanı adıURLS: Phishing URL'lerini çekmek için kullanılacak URL listesi. Virgülle ayrılmış bir liste olarak girilmelidir.
Katkıda bulunmak için bu depoyu forklayın, değişikliklerinizi yapın ve bir pull isteği gönderin.