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",toINSTALLED_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
| ID | Description | Notes |
|---|---|---|
access_xenforo2 |
Can access the XenForo2 Service Page | Your line members should have this permission. |
Settings
| Key | Description | Type | Default | Example |
|---|---|---|---|---|
AAXENFORO2_ENDPOINT |
The full web address to the xenforo2 install. Must include protocol (https://) and trailing slash / |
string | None |
https://forums.mysite.com/ |
AAXENFORO2_APIKEY |
XenForo2 Api Key, Must be a superuser key | string | None |
default_api_key_value |
AAXENFORO2_API_USER_ID |
XenForo User ID of an admin to act with via the API | int | None |
1 |
AAXENFORO2_DEFAULT_GROUP |
XenForo Group ID to add users to by default | int | None |
5 |
AAXENFORO2_EXTRA_GROUP |
XenForo Group ID to add users to in addition to their main group | string | None |
"6" |
Metadata
Release files for aaxenforo2 1.0.7
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| aaxenforo2-1.0.7.tar.gz | 28.6 kB | Without provenance | Details for aaxenforo2-1.0.7.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| aaxenforo2-1.0.7-py3-none-any.whl | Python 3 | none | any | Details for aaxenforo2-1.0.7-py3-none-any.whl |
Total release size: 59.3 kB
Release files / aaxenforo2-1.0.7.tar.gz
| Download URL | aaxenforo2-1.0.7.tar.gz |
|---|---|
| Size | 28.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4690645bb53fd3a64aa58ec24da4f2af4f4b89271bb94deb378da7bd7dfbe000
|
|
BLAKE2b-256 checksum How to use checksums |
eff95ca9ebccd7410a992b6c126f5ab0622a4661a228c2cab53bfd2aa10bc10e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.0 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.12
|
Release files / aaxenforo2-1.0.7-py3-none-any.whl
| Download URL | aaxenforo2-1.0.7-py3-none-any.whl |
|---|---|
| Size | 30.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d1382a281a66bbd546993ebfb9a22969628a31359e7f3c7d825805ca56b630f2
|
|
BLAKE2b-256 checksum How to use checksums |
dddeafbe7eaa3f76e0cfee69b24e185a697d249f429f2a4b86b59d93c25e8eb5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.0 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.12
|
Security for aaxenforo2 1.0.7
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.