Freight for Alliance Auth

This is a plugin app for Alliance Auth (AA) that adds a central freight service.

Contents

• Overview
• Key Features
• Screenshots
• Installation
• Updating
• Settings
• Operation Mode
• Permissions
• Pricing
• Contract Check
• Change Log

Overview

This app helps running a central freight service for an alliance or corporation. It allows different modes of operation that support the most common approaches a central freight service is setup. (e.g. for alliance members only or run by a corporation outside the alliance)

Key Features

Alliance Freight offers the following main features:

• Reward calculator allowing members to easily calculate the correct reward for their a courier contract
• Page showing the list of currently outstanding courier contracts incl. an indicator if the contract is compliant with the pricing for the respective route ("contract check")
• Multiple routes can be defined, each with its own pricing.
• It's possible to have the same pricing for both directions, or to have different pricings for each direction of the same route.
• Automatic notifications to alliance pilots on Discord informing them about new courier contracts
• Automatic notifications to contract issuers on Discord informing them about the developing status of their contract or potentially issues
• Contract issuer can always check the current status of his courier contracts
• Statistics page showing key performance metrics for routes, pilots, customers

Screenshots

Reward Calculator

Contract List

Discord Notification

Installation

1. Install app

Install into your Alliance Auth virtual environment from PyPI:

pip install aa-freight

2 Update Eve Online app

Update the Eve Online app used for authentication in your AA installation to include the following scopes:

esi-universe.read_structures.v1
esi-contracts.read_corporation_contracts.v1

3. Configure AA settings

Configure your AA settings (local.py) as follows:

• Add 'freight' to INSTALLED_APPS

• Add these lines add to bottom of your settings file:

  # settings for freight
  CELERYBEAT_SCHEDULE['freight_run_contracts_sync'] = {
      'task': 'freight.tasks.run_contracts_sync',
      'schedule': crontab(minute='*/10'),
  }
  

If you want to setup notifications for Discord you can now also add the required settings. Check out section Settings for details.

3a Celery setup

This app uses celery for critical functions like refreshing data from ESI. We strongly recommend to enable the following additional settings for celery workers to enable proper logging and to protect against potential memory leaks:

• To enable logging of celery tasks up to info level: -l info

• To automatically restart workers that grow above 256 MB: --max-memory-per-child 262144

Here is how an example config would look for workers in your supervisor conf:

command=/home/allianceserver/venv/auth/bin/celery -A myauth worker -l info --max-memory-per-child 262144

On Ubuntu you can run systemctl status supervisor to see where your supervisor config file is located.

Note that you need to restart the supervisor service itself to activate those changes.

e.g. on Ubuntu:

systemctl restart supervisor

4. Finalize installation into AA

Run migrations & copy static files

python manage.py migrate
python manage.py collectstatic

Restart your supervisor services for AA

5. Setup permissions

Now you can access Alliance Auth and setup permissions for your users. See section Permissions below for details.

6. Setup contract handler

Finally you need to set the contract handler with the character that will be used for fetching the corporation or alliance contracts and related structures. Just click on "Set Contract Handler" and add the requested token. Note that only users with the appropriate permission will be able to see and use this function. However, the respective character does not need any special corporation roles. Any corp member will work.

Once a contract handler is set the app will start fetching contracts. Wait a minute and then reload the contract list page to see the result.

7. Define pricing

Finally go ahead and define the first pricing of a courier route. See section Pricing for details.

That's it. The Alliance Freight app is fully installed and ready to be used.

Updating

To update your existing installation of Alliance Freight first enable your virtual environment.

Then run the following commands from your AA project directory (the one that contains manage.py).

pip install -U aa-freight

python manage.py migrate

python manage.py collectstatic

Finally restart your AA supervisor services.

Settings

Here is a list of available settings for this app. They can be configured by adding them to your AA settings file (local.py). If they are not set the defaults are used.

Operation Mode

The operation mode defines which contracts are processed by the Alliance Freight. For example you can define that only contracts assigned to your alliance are processed. Any courier contract that is not in scope of the configured operation mode will be ignored by the freight app and e.g. not show up in the contract list or generate notifications.

The following operation modes are available:

Permissions

This is an overview of all permissions used by this app:

Pricing

A pricing defines a route and the parameters for calculating the price for that route along with some additional information for the users. You can define multiple pricings if you want, but at least one pricing has to be defined for this app to work.

Pricing routes are bidirectional by default. For bidirectional pricings courier contracts in both directions are matched against the same pricing. Alternatively pricings can also be defined individually for each direction.

Pricings are defined in the admin section of AA, so you need staff permissions to access it.

Most parameters of a pricing are optional, but you need to define at least one of the four pricing components to create a valid pricing. It's also possible to define a route that does not require a reward by setting "Price base" to 0 and not setting any other pricing components.

All pricing parameters can be found on the admin panel under Pricing, with the exception of the "price per volume modifier", which is a global pricing parameter and therefore property of the ContractHandler.

How to add new locations:If you are creating a pricing for a new route you may need to first add the locations (stations and/or structures).The easiest way is to create a courier contract between those locations in game and then run contract sync. Those locations will then be added automatically.Alternatively you can use the "Add Location" feature on the main page of the app. This will require you to provide the respective station or structure eve ID.

Contract Check

The app will automatically check if a newly issued contract complies with the pricing parameters for the respective route.

Compliant contracts will have a green checkmark (✓) in the "Contract Check" column on the contract list. Related notifications on Discord will be colored in green.

Non-compliant contracts will have a red warning sign in the "Contract Check" column on the contract list. And related notifications on Discord will be colored in red. In addition the first customer notification will inform the customer about the issues and ask him to correct the issues.

The following parameters will be checked (if they have been defined):

• reward in contract >= calculated reward
• volume min <= volume in contract <= volume max
• collateral min <= collateral in contract <= collateral max

Deviations on "Days to expire" and "Days to complete" are currently not part of the contract check and only used to show the recommended contract parameters in the calculator.