Catalog PyPI
PACKAGE EXPLORERView in registry

aaxenforo2

PyPI

AA XenForo 2 Service Auth

Versions collected1
Direct dependencies8From release 1.0.7
Last observed20 Oct, 17:07 UTC

README

Version 1.0.7 documentation

AA-XenForo2

XenForo v2.x Service Module for Alliance Auth

Contents

Overview

Features

  • Integration with XenForo v2.x Forum Software as a user manager

Installation

Important: Please make sure you meet all preconditions before you proceed:

  • AA XenForo2 is a plugin for Alliance Auth. If you don't have Alliance Auth running already, please install it first before proceeding. (see the official AA installation guide for details)

Step 1 - Install the package

Make sure you are in the virtual environment (venv) of your Alliance Auth installation Then install the latest release directly from PyPi.

pip install aaxenforo2

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 "aaxenforo2", to INSTALLED_APPS

Step 3 - Finalize the installation

Run migrations

python manage.py migrate

Restart your supervisor services for Auth

Step 4 - Set up permissions

Now it's time to set up access permissions for your new forum service. You can do so in your admin backend in the AA XenForo2 section. Read the Permissions section for more information about the available permissions.

Permissions

IDDescriptionNotes
access_xenforo2Can access the XenForo2 Service PageYour line members should have this permission.

Settings

KeyDescriptionTypeDefaultExample
AAXENFORO2_ENDPOINTThe full web address to the xenforo2 install. Must include protocol (https://) and trailing slash /stringNonehttps://forums.mysite.com/
AAXENFORO2_APIKEYXenForo2 Api Key, Must be a superuser keystringNonedefault_api_key_value
AAXENFORO2_API_USER_IDXenForo User ID of an admin to act with via the APIintNone1
AAXENFORO2_DEFAULT_GROUPXenForo Group ID to add users to by defaultintNone5
AAXENFORO2_EXTRA_GROUPXenForo Group ID to add users to in addition to their main groupstringNone"6"

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Versions 1

Collected releases
VersionPublishedDirect dependenciesOpen version
1.0.719 Nov 20218

Package advisories

0
No matching advisories collected

This describes our collected data; it is not a security assessment.

Repository

PENDING
mglinski/aaxenforo2

Shared repository data · GitHub

License detected in repository
Not collected

Metadata history

Meaningful changes
Current collected state Current

Observed since 20 Oct, 17:07 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package:d86edd9c9caa0a5917483f4a7a2bb6c2a9447f7c01f2eded9cc60b1c0b7189b2