Browse Apps

aa-gdpr

Alliance Auth GDPR App


AA-GDPR

Version License Python Django pre-commit pre-commit.ci status Code Style: black Automated Checks codecov Contributor Covenant Discord Alliance Auth Compatibility

ko-fi

A Collection of overrides and resources to help Alliance Auth installs meet GDPR legislation.

<hr /> <hr />

Disclaimer

[!IMPORTANT]

This App cannot guarantee your legal requirements but aims to reduce the technical burden on web/system administrators.

Not all 3rd party apps for Alliance Auth are using bundle templates to include their CSS and JS files. This app will not be able to override those files and you will have to contact the developers of those apps to make them compatible with AA-GDPR. (See Compatibility section for more information)

Compatibility

Alliance Auth >= v5.6.0

Compatible Alliance Auth version 5.6.0 and above.

Replacements

The following themes and libraries loaded from CDNs by Alliance Auth core will now be loaded from local static files:

Themes
  • Bootstrap
  • Bootstrap Dark
  • Darkly
  • Flatly
  • Materia
Libraries
  • Bootstrap JS Bundle
  • Chart JS
  • Clipboard JS
  • DataTables Bootstrap 5 CSS
  • DataTables Bootstrap 5 JS
  • FontAwesome
  • jQuery Datetimepicker CSS
  • jQuery Datetimepicker JS
  • jQuery JS
  • jQuery Visibility JS
  • Moment JS

Installation

Bare Metal

Step 1: Install the App

Install the app with your venv active

pip install aa-gdpr==1.0.0

Step 2: Update Your AA Settings

Add the following line after your INSTALLED_APPS list in your projects local.py, like so:

INSTALLED_APPS += [
    # … A bunch of apps …
]

# Ensure this is the last line that starts with `INSTALLED_APPS` in your local.py file
INSTALLED_APPS = ["aagdpr"] + INSTALLED_APPS

Step 3: Finalizing the Installation

Now that's done, run static collection:

python manage.py collectstatic

And restart your supervisor.

Docker

Step 1: Add the App

Add the following line to your conf/requirements.txt file

aa-gdpr==1.0.0

Step 2: Update Your AA Settings

Add the following line after your INSTALLED_APPS list in your projects conf/local.py, like so:

INSTALLED_APPS += [
    # … A bunch of apps …
]

# Ensure this is the last line that starts with `INSTALLED_APPS` in your local.py file
INSTALLED_APPS = ["aagdpr"] + INSTALLED_APPS

Step 3: Build Auth and Restart Your Containers

Now that's done, rebuild your docker image and restart your containers.

docker compose build --no-cache
docker compose --env-file=.env up -d

Step 4: Finalizing the Installation

Now that your containers are up and running, run static collection:

docker compose exec allianceauth_gunicorn bash

auth collectstatic

Updating

Bare Metal

To update your existing installation of AA-GDPR, first enable your virtual environment (venv) of your Alliance Auth installation.

pip install aa-gdpr==1.0.0

python manage.py collectstatic

Finally, restart your supervisor services for AA.

Docker

To update your existing installation of AA-GDPR, first update your conf/requirements.txt file to the latest version of AA-GDPR.

aa-gdpr==1.0.0

Now rebuild your containers:

docker compose build --no-cache
docker compose --env-file=.env up -d

After that, run the following commands to collect the static files:

docker compose exec allianceauth_gunicorn bash
auth collectstatic

Migrating From Previous Versions (v0.7.x and below)

This is a complete rewrite of the app and will require you to remove the old implementation from your local.py file and replace it with the new one.

Since there are a lot of options with the old implementation, I cannot provide a complete list of what to remove. However, you can check the old README for what to remove. It is safe to assume that you can remove anything that is mentioned there in the install section to be added to your local.py file.

Once done and you've cleaned up your local.py file, you can add the new implementation as described in the "Step 2: Configure" section above.

Contributing

Do you want to contribute to this project? That's cool!

Please make sure to read the Contribution Guidelines. (I promise, it's not much, just some basics)

Credits

Thanks to Ariel Rin (@soratidus999) for creating and maintaining this app for a long time for the Alliance Auth community. Your contributions are greatly appreciated!

No reviews yet...

Python Requirements

  • allianceauth<6,>=5.6
  • coverage; extra == "tests-allianceauth-latest"

Required Python packages to be installed and other Python requirement.

App Dependencies


Required apps:

    -


Used by apps:

    -

Dependencies to other apps registered in this app directory.

Classifiers

  • Environment :: Web Environment
  • Framework :: Django
  • Framework :: Django :: 5.2
  • Intended Audience :: Developers
  • License :: OSI Approved :: GNU General Public License v3 (GPLv3)
  • Operating System :: OS Independent
  • Programming Language :: Python
  • Programming Language :: Python :: 3 :: Only
  • Programming Language :: Python :: 3.11
  • Programming Language :: Python :: 3.12
  • Programming Language :: Python :: 3.13
  • Programming Language :: Python :: 3.14
  • Topic :: Internet :: WWW/HTTP
  • Topic :: Internet :: WWW/HTTP :: Dynamic Content

Version

1.0.0

License

GPLv3

PyPI

  https://pypi.org/project/aa-gdpr/

Last updated

1 week, 5 days ago

First published

6 years, 2 months ago

Category

Plugin Apps

Rating

-

Authors

Rounon Dax

Maintainers

-

Please login to see more options.