Installation
Custom Fields is now open source and can be installed directly via Composer for all users. The installation process is the same whether you’re using the AGPL-3.0 or Commercial license.
Requirements
- PHP: 8.2 or higher
- Laravel: 10.0 or higher (via Filament)
- Filament: 3.0 or higher
Installation Steps
1. Install via Composer
2. Publish Migrations
3. Run Migrations
That’s it! Custom Fields is now installed and ready to use.
License Activation (Commercial Users Only)
If you’re using Custom Fields in a closed-source commercial project, you need to purchase and activate a commercial license.
License Activation
After purchasing, you’ll receive a license key. Add it to your .env
file:
Or configure it in config/custom-fields.php
:
The package will work without a license key, but commercial use without a valid license violates the terms of use. Please ensure you have the appropriate license for your use case.
Publishing Assets (Optional)
Configuration File
Language Files
Views (for customization)
Verify Installation
After installation, verify everything is working:
You should see Custom Fields listed in the environment section.
License Compliance
Do I need a license key for open source projects?
Do I need a license key for open source projects?
No. If your project is open source under AGPL-3.0, you can use Custom Fields without a license key.
How do I know if I need a commercial license?
How do I know if I need a commercial license?
If your project is closed-source, proprietary, or you cannot comply with AGPL-3.0 requirements (making your code open source), you need a commercial license.
What happens if I don't add a license key?
What happens if I don't add a license key?
The package will function normally. However, using it commercially without a valid license is a violation of the license agreement. We trust our users to obtain the appropriate license.
Troubleshooting
Class not found errors
Class not found errors
Run composer dump-autoload
to regenerate the autoloader.
Migration errors
Migration errors
Ensure your database is properly configured and accessible.
License key not recognized
License key not recognized
Check that your .env
file is properly loaded and the key is correctly formatted.
Next Steps
Ready to start using Custom Fields? Check out our Quickstart Guide to add your first custom fields in minutes!