PHPackages                             avalexgmbh/kirby-avalex - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. avalexgmbh/kirby-avalex

ActiveKirby-plugin[API Development](/categories/api)

avalexgmbh/kirby-avalex
=======================

avalex client for Kirby CMS. Requires avalex API version 3 or higher.

1.1.1(3mo ago)120↓100%proprietaryPHPPHP >=8.1

Since Sep 24Pushed 3mo agoCompare

[ Source](https://github.com/avalexgmbh/kirby-avalex)[ Packagist](https://packagist.org/packages/avalexgmbh/kirby-avalex)[ RSS](/packages/avalexgmbh-kirby-avalex/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (4)Dependencies (1)Versions (5)Used By (0)

Kirby-Plugin for avalex
=======================

[](#kirby-plugin-for-avalex)

This plugin offers functions to integrate the avalex legal text service into any new or existing Kirby project.

> To make use of the service a paid subscription from [avalex.de](https://avalex.de) is required!

The plugin calls the avalex API and downloads one of the legal texts that are created and maintained by avalex (depending on your type of subscription, you may not have access to all legal texts avalex generally provides). Once a text is downloaded it will be cached using Kirby’s integrated caching functions. This is a requirement by avalex in order to avoid heavy traffic on the API and must carefully be respected – otherwise, avalex might ban your project for a certain amount of time from further API calls.

All texts will be created and downloaded in plain HTML format and can be styled to match your project’s design by using CSS.

Compatibility
-------------

[](#compatibility)

- Kirby 3
- Kirby 4
- Kirby 5

Installation
------------

[](#installation)

Subscribe to an avalex subscription plan under [avalex.de](https://avalex.de) and after providing all required information you will be finally directed to their “Installation” page where you can select the Kirby plugin to download as ZIP-file. Unpack and copy it to `/site/plugins/kirby-avalex`.

Alternatively, you may want to install the plugin using composer:

```
composer require avalexgmbh/kirby-avalex

```

Setup
-----

[](#setup)

Extend your project’s config file with your avalex API key as shown on avalex’ “Installation” page:

```
# /site/config/config.php