https://github.com/ppfeufer/aa-fleetfinder
Control access to your fleets through Alliance Auth.
https://github.com/ppfeufer/aa-fleetfinder
allianceauth django fleetfinder python
Last synced: 10 months ago
JSON representation
Control access to your fleets through Alliance Auth.
- Host: GitHub
- URL: https://github.com/ppfeufer/aa-fleetfinder
- Owner: ppfeufer
- License: gpl-3.0
- Created: 2020-12-23T23:05:00.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-07-08T08:54:22.000Z (11 months ago)
- Last Synced: 2025-07-08T09:51:03.019Z (11 months ago)
- Topics: allianceauth, django, fleetfinder, python
- Language: Python
- Homepage:
- Size: 1.44 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
[](https://pypi.org/project/aa-fleetfinder/)
[](https://github.com/ppfeufer/aa-fleetfinder/blob/master/LICENSE)
[](https://pypi.org/project/aa-fleetfinder/)
[](https://pypi.org/project/aa-fleetfinder/)
[](https://results.pre-commit.ci/latest/github/ppfeufer/aa-fleetfinder/master)
[](http://black.readthedocs.io/en/latest/)
[](https://discord.gg/zmh52wnfvM)
[](https://github.com/ppfeufer/aa-fleetfinder/actions/workflows/automated-checks.yml)
[](https://codecov.io/gh/ppfeufer/aa-fleetfinder)
[](https://weblate.ppfeufer.de/engage/alliance-auth-apps/)
[](https://github.com/ppfeufer/aa-fleetfinder/blob/master/CODE_OF_CONDUCT.md)
[](https://ko-fi.com/N4N8CL1BY)
Control access to your fleets through Alliance Auth.
______________________________________________________________________
- [Installation](#installation)
- [Step 1: Install the Package](#step-1-install-the-package)
- [Step 2: Configure Alliance Auth](#step-2-configure-alliance-auth)
- [Step 3: Add the Scheduled Task](#step-3-add-the-scheduled-task)
- [Step 4: Finalizing the Installation](#step-4-finalizing-the-installation)
- [Step 4: Setup Permissions](#step-4-setup-permissions)
- [Changelog](#changelog)
- [Translation Status](#translation-status)
- [Contributing](#contributing)
______________________________________________________________________
> [!NOTE]
>
> **AA Fleet Finder >= 2.0.0 needs at least Alliance Auth v4.0.0!**
>
> Please make sure to update your Alliance Auth instance _before_ you install this
> module or update to the latest version, otherwise an update to Alliance Auth will
> be pulled in unsupervised.
>
> The last version compatible with Alliance Auth v3 is `1.5.2`.
### Step 1: Install the Package
Make sure you're in the virtual environment (venv) of your Alliance Auth installation Then install the latest release directly from PyPi.
```shell
pip install aa-fleetfinder
```
### Step 2: Configure Alliance Auth
This is fairly simple, just add the following to the `INSTALLED_APPS` of your `local.py`
Configure your AA settings (`local.py`) as follows:
- Add `"fleetfinder",` to `INSTALLED_APPS`
### Step 3: Add the Scheduled Task
To set up the scheduled task, add the following code to your `local.py`:
```python
# AA Fleetfinder - https://github.com/ppfeufer/aa-fleetfinder
if "fleetfinder" in INSTALLED_APPS:
CELERYBEAT_SCHEDULE["fleetfinder_check_fleet_adverts"] = {
"task": "fleetfinder.tasks.check_fleet_adverts",
"schedule": crontab(minute="*/1"),
}
```
### Step 4: Finalizing the Installation
Run static files collection and migrations
```shell
python manage.py collectstatic
python manage.py migrate
```
Now it's time to set up access permissions for your new Fleetfinder module.
| ID | Description | Notes |
| :------------------- | :-------------------------------- | :---------------------------------------------------------------------------------------------------------- |
| `access_fleetfinder` | Can access the Fleetfinder module | Your line members should have this permission, together with everyone you want to have access to he module. |
| `manage_fleets` | Can manage fleets | Everyone with this permission can open and edit fleets |
See [CHANGELOG.md](https://github.com/ppfeufer/aa-fleetfinder/blob/master/CHANGELOG.md)
[](https://weblate.ppfeufer.de/engage/alliance-auth-apps/)
Do you want to help translate this app into your language or improve the existing
translation? - [Join our team of translators][weblate engage]!
You want to contribute to this project? That's cool!
Please make sure to read the [Contribution Guidelines](https://github.com/ppfeufer/aa-fleetfinder/blob/master/CONTRIBUTING.md).\
(I promise, it's not much, just some basics)
[weblate engage]: https://weblate.ppfeufer.de/engage/alliance-auth-apps/ "Weblate Translations"