Download the PHP package codewithathis/paperless-ngx without Composer

On this page you can find all versions of the php package codewithathis/paperless-ngx. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of codewithathis/paperless-ngx

Informations about the package paperless-ngx

Paperless-ngx Laravel Package

A comprehensive Laravel package for integrating with Paperless-ngx document management system. This package provides authentication, document management, search capabilities, and bulk operations through a clean Laravel interface.

Features

Requirements

The supported integration surface is PaperlessService, the Paperless facade, configuration keys, and Artisan commands. Classes under Codewithathis\PaperlessNgx\Http and Codewithathis\PaperlessNgx\Api are internal implementation details and may change without a major release.

Installation

Via Composer

Manual Installation

  1. Add to your composer.json:

  2. Run composer install:

  3. Publish Configuration:

  4. Environment Variables

Add the following variables to your .env file:

Configuration

The package can be configured through the config/paperless.php file. Key configuration options:

Authentication

auth.method controls how requests are signed when using the service container defaults:

Runtime setToken() / setBasicAuth() on PaperlessService override the above for that instance.

Document Upload Settings

Usage

Basic Usage

Using Dependency Injection

Using the Facade

Authentication

Token Authentication (Recommended)

Basic Authentication

Document Operations

Upload Document

Get Documents with Filters

Update Document

Download Document

Delete Document

Search Operations

Search Documents

Get Search Autocomplete

Bulk Operations

Bulk Edit Documents

Bulk Download Documents

Metadata Management

Tags

Correspondents

Document Types

Document Notes

Document History

Share Links

Statistics

System Information

Artisan Commands

The package includes several Artisan commands for testing and management:

Test Connection

Test with File Upload

Test Search

Error Handling

The service includes comprehensive error handling with custom exception classes:

Custom Exceptions

Basic Error Handling

Using the Exception Handler

For detailed exception handling examples, see EXCEPTION_HANDLING_EXAMPLES.md.

Logging

The service logs all API interactions when logging is enabled:

Caching

The service supports caching for improved performance:

Security

Security settings for SSL verification and timeouts:

Testing

Test the connection to your Paperless-ngx instance:

Examples

Complete Document Management Workflow

Using with Laravel Jobs

Troubleshooting

Common Issues

  1. Authentication Failed

    • Verify your API token or credentials
    • Check if the Paperless-ngx instance is accessible
    • Ensure the authentication method is correctly configured

  2. Upload Fails

    • Check file size limits
    • Verify supported file types
    • Ensure proper permissions on the Paperless-ngx instance

  3. Connection Timeout

    • Increase timeout settings in configuration
    • Check network connectivity
    • Verify Paperless-ngx instance is running
  4. SSL Certificate Issues
    • Set PAPERLESS_VERIFY_SSL=false for self-signed certificates
    • Update SSL certificates on your Paperless-ngx instance

Debug Mode

Enable debug logging to troubleshoot issues:

Package Structure

Requirements

Contributing

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

Testing

Changelog

Please see CHANGELOG for more information on what has changed recently.

License

This package is open-sourced software licensed under the MIT license.

Support

If you encounter any issues or have questions, please:

  1. Check the troubleshooting section
  2. Search existing issues
  3. Create a new issue with detailed information

Credits

All versions of paperless-ngx with dependencies

PHP Build Version
Package Version
Requires php Version ^8.0
laravel/framework Version ^9.0|^10.0|^11.0|^12.0
guzzlehttp/guzzle Version ^7.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package codewithathis/paperless-ngx contains the following files

Loading the files please wait ...