O projekcie
OpenKSeF jest w fazie beta. Aktywnie rozwijamy projekt -- nowe funkcjonalności pojawiają się regularnie, ale mogą wystąpić zmiany w API, strukturze danych i konfiguracji między wersjami. Zalecamy śledzenie release notes na GitHub.
Czym jest OpenKSeF?
OpenKSeF to otwartoźródłowy system do synchronizacji i przeglądania faktur z polskiego Krajowego Systemu e-Faktur (KSeF). Projekt został stworzony, aby każdy mógł postawić własną instancję i mieć pełną kontrolę nad swoimi danymi fakturowymi.
Stworzony z pomocą AI
OpenKSeF powstał z wykorzystaniem narzędzi AI -- w szczególności Cursor i modeli Claude (Anthropic). AI wspierało programowanie, generowanie testów, pisanie dokumentacji i projektowanie architektury.
Wierzymy w transparentność: AI to narzędzie, które przyspiesza rozwój oprogramowania. Kod jest otwarty i każdy może go zweryfikować.
Open Source
Projekt jest udostępniony na licencji MIT -- jednej z najbardziej liberalnych licencji open source. Możesz:
- Używać OpenKSeF do celów komercyjnych i prywatnych
- Modyfikować kod źródłowy
- Rozpowszechniać zmodyfikowane wersje
- Bez opłat licencyjnych
Pełny tekst licencji: Licencja MIT
Self-hosting i odpowiedzialność za dane
OpenKSeF jest zaprojektowany do self-hostingu -- uruchamiasz go na własnej infrastrukturze (serwerze, VPS, chmurze, komputerze domowym).
Co to oznacza:
- Twoje dane zostają u Ciebie -- faktury, tokeny KSeF, dane użytkowników są przechowywane w Twojej bazie PostgreSQL
- Ty kontrolujesz dostęp -- Keycloak działa na Twojej instancji
- Ty odpowiadasz za bezpieczeństwo -- konfigurację HTTPS, backupy, aktualizacje, firewall
OpenKSeF to narzędzie. Hostujesz u siebie = Ty odpowiadasz za swoje dane. To Ty decydujesz, jak skonfigurujesz i zabezpieczysz swoją instancję. Autorzy projektu nie mają dostępu do Twoich danych i nie ponoszą odpowiedzialności za ich bezpieczeństwo.
Zalecenia bezpieczeństwa
Jeśli uruchamiasz OpenKSeF z dostępem z internetu:
- Zawsze używaj HTTPS (np. przez Traefik, Caddy, nginx + certbot)
- Regularnie aktualizuj kontenery Docker
- Rób backupy bazy PostgreSQL
- Zmień domyślne hasła Keycloak (admin/admin)
- Ogranicz dostęp do portów 8081, 8082, 5432 (tylko gateway 8080 powinien być publiczny)
- Monitoruj logi pod kątem nieautoryzowanych prób dostępu
Technologie
| Komponent | Technologia |
|---|---|
| Backend API | .NET 8, ASP.NET Core |
| Worker | .NET 8, Background Service |
| Portal webowy | React 19, TypeScript, Vite |
| Aplikacja mobilna | .NET MAUI (Android, iOS) |
| Baza danych | PostgreSQL |
| Uwierzytelnianie | Keycloak (OIDC) |
| Konteneryzacja | Docker, Docker Compose |
| Reverse proxy | nginx |
| Klient KSeF | CIRFMF ksef-client-csharp |
Kontakt
- GitHub: github.com/open-ksef
- Backend + Portal: github.com/open-ksef/open-ksef
- Aplikacja mobilna: github.com/open-ksef/open-ksef-mobile
- Dokumentacja: github.com/open-ksef/open-ksef-doc
- Issues: github.com/open-ksef/open-ksef/issues