CrudAdmin is commercial software licensed by Gogoľ Development s.r.o. It is not open source, and you need a valid license key to use it. The license covers the core packages:
  • crudadmin/crudadmin
  • crudadmin/framework
  • crudadmin/resources
The full license text is in the LICENSE.md file of each package.

What a license allows

With a valid license key, you can:
  • Install and use CrudAdmin in the projects covered by your license key.
  • Modify CrudAdmin to the extent your projects need.
  • Deliver CrudAdmin to your client as an integral part of the project you built for them. Your client is bound by the same license.

What is not allowed

Without a valid license key, or without written permission of Gogoľ Development s.r.o., you cannot:
  • Use CrudAdmin in any project.
  • Copy, distribute, publish, sell or sublicense CrudAdmin, or a modified version of it.
  • Fork or mirror the source code or the built assets into a public or shared repository or package archive.
  • Distribute a derivative work on its own, or build a product that competes with CrudAdmin.
  • Remove or circumvent the license key verification, or the copyright notices.
  • Transfer your license key to another person, company or project.
Every copy of CrudAdmin stays subject to the license, including modified copies.

License key

Set your license key in the CrudAdmin configuration.
config/admin.php
To obtain a license key, contact sales@gogoldev.com.

Installing the licensed packages

CrudAdmin 6 is downloaded from the private composer repository packages.crudadmin.com, not from Packagist. Add the repository to composer.json of your project:
composer.json
Composer authenticates every download with a username and a composer token, which you receive together with the license. The username does not have to be an e-mail address. A license grants access to selected major versions of CrudAdmin. Composer lists only the versions your license includes.

CrudAdmin 5

CrudAdmin 5 stays under the MIT license and is free. It is installed from the same repository, with a free license for CrudAdmin 5. To get it, contact sales@gogoldev.com.
Existing CrudAdmin 5 projects need the repository in composer.json and the credentials as well. Run composer update "crudadmin/*" once, so composer.lock downloads the packages from packages.crudadmin.com.
Never put the credentials into composer.json or any other versioned file. The composer token grants access to the packages of your license.

Storing the credentials

Composer reads the credentials from auth.json or from the COMPOSER_AUTH environment variable. All options use the same content:
auth.json
When both the global and the project auth.json exist, composer merges them and the project file wins.

Global auth.json

Find the composer home directory:
Create auth.json in that directory. When the file already exists, for example with a GitHub token, add packages.crudadmin.com into its http-basic section instead of overwriting it. Then restrict the file to your user:

Project auth.json

Create auth.json next to composer.json. The Laravel .gitignore already contains /auth.json, check that git ignores the file:
When the command prints nothing, add /auth.json to .gitignore before you commit.

COMPOSER_AUTH

On servers and in CI, pass the same JSON through the environment of the deployment user or the CI job:
In GitHub Actions or GitLab CI, store the JSON as a secret variable and expose it as COMPOSER_AUTH in the job.

Earlier versions

CrudAdmin 5 and earlier releases were distributed under the MIT license, and they stay under it. The commercial license applies to every release distributed with the new LICENSE.md file.

Helper packages

The helper packages stay open source under the MIT license:
  • crudadmin/autoajax
  • crudadmin/helpers
  • crudadmin/socialite