diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 1c74593ff34c99e0f271e919f776e74ba48f7273..f9319f4a9a36f23d2f2b12d2f6d1927095236bd4 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -17,7 +17,7 @@ Added * Add django-cachalot as query cache * Add `syncable_fields` property to `ExtensibleModel to discover fields sync backends can write to -* Add `aleksis-admin` script to wrap django-admin with pre-configured mappings +* Add `aleksis-admin` script to wrap django-admin with pre-configured settings * Auto-create persons for users if matching attributes are found * Add `django-allauth` to allow authentication using OAuth, user registration, password changes and password reset @@ -25,7 +25,7 @@ Added * Add `django-uwsgi` to use uWSGI and Celery in development * Add loading page for displaying Celery task progress * Implement generic PDF generation using Chromium -* Support Amaxon S3 storage for /media files +* Support Amazon S3 storage for /media files * Enable Django REST framework for apps to use at own discretion * Add method to inject permissions to ExtensibleModels dynamically * Add helper function which filters queryset by permission and user diff --git a/README.rst b/README.rst index de7d791c4b901e4b35f08bc3c2fa64ca9bbc2307..b322b3e82ac50b4bb9683581c82345d04926ded2 100644 --- a/README.rst +++ b/README.rst @@ -14,22 +14,43 @@ The AlekSIS-Core currently provides the following features: * For users: + * Authentication via OAuth applications + * Configurable dashboard * Custom menu entries (e.g. in footer) * Global preferences + * Global search * Group types * Manage announcements * Manage groups * Manage persons * Notifications via SMS email or dashboard + * PWA with offline caching * Rules and permissions for users, objects and pages * Two factor authentication via Yubikey, OTP or SMS * User preferences + * User registration, password changes and password reset * For admins * Asynchronous tasks with celery * Authentication via LDAP * Automatic backup of database, static and media files + * Generic PDF generation with chromium + * OAuth2 and OpenID Connect provider support + * Serve prometheus metrics + * System health and data checks + +* For developers + + * `aleksis-admin` script to wrap django-admin with pre-configured settings + * Caching with Redis + * Django REST framework for apps to use at own discretion + * Injection of fields, methods, permissions and properties via custom `ExtensibleModel` + * K8s compatible, read-only Docker image + * Object-level permissions and rules with `django-guardian` and `django-rules` + * Query caching with `django-cachalot` + * Search with `django-haystack` and `Whoosh` backend + * uWSGI and Celery via `django-uwsgi` in development Licence -------