reun/nanomanager

Modern and minimalist PHP file manager

Maintainers

Details

github.com/ReunMedia/nanomanager

Source

Issues

Installs: 1

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 0

Forks: 0

Open Issues: 0

pkg:composer/reun/nanomanager

0.11.0 2025-10-22 13:16 UTC

Requires

  • php: ^8.2

Requires (Dev)

MIT 1f27e6c60afd836aef937ae3fe27958d873937c1

This package is auto-updated.

Last update: 2025-10-22 13:24:50 UTC

README

Supported PHP Version Packagist Version

Nano File Manager (or Nanomanager for short) is a minimalist PHP file manager that can be used to quickly add simple uploads and file management to any PHP powered website.

❗ Caution

Nanomanager doesn't include any authentication! Therefore it is very important to manually secure access to it.

Features

  • List, upload, rename and delete files in a specific folder
  • Quickly copy links to files
  • Lightweight and performant

Installation

Requirements

With Composer

composer require reun/nanomanager

PHAR (single file install)

If you're not using Composer or simply want Nanomanager in a single self-contained file, you can download the latest PHAR from releases and put it anywhere outside your public folder. Then just require it whenever you want to use it.

require_once "path/to/Nanomanager.phar";

Usage

To use Nanomanager, create a new instance by passing configuration to constructor and call run() which returns a string that can be outputted to browser.

use Reun\Nanomanager\Nanomanager;

// require_once "path/to/Nanomanager.phar"; // If using PHAR installation

$nanomanager = new Nanomanager(
  "public/uploads", // Path to directory where Nanomanager stores files
  "https://example.com/uploads", // Public URL of the directory
  "https://example.com/admin/nanomanager" // URL to access Nanomanager
);

echo $nanomanager->run();

Framework integration

You can manually pass request method and body to run() as optional arguments to integrate Nanomanager with any existing PHP framework.

$app->any("/admin/nanomanager", function($request, $response) {
  $nanomanager = new Nanomanager\Nanomanager(...);

  $response->getBody()->write($nanomanager->run(
      $request->getMethod(),
      (string) $request->getBody(),
  ));

  return $response;
});

💡 Tip

Check out tests/integration directory for additional usage examples.

Configuration

PHP API configuration

PHP API is configured with constructor parameters. Check out Nanomanager.php for full list of options.

new Nanomanager(..., createMissingDirectory: false);

Frontend configuration

Frontend is configured with HTML attributes. Check out Props interface in NanoFileManager.svelte for full list of options.

If you're not embedding frontend yourself, you can customize frontend with frontendAttributes parameter.

new Nanomanager(..., frontendAttributes: 'theme="dark"');

Embedding Nanomanager frontend to existing page

Nanomanager frontend can easily be embedded to any existing HTML page or JS framework as a custom element.

<nano-file-manager
  api-url="https://example.com/admin/nanomanager"
></nano-file-manager>

The custom element is loaded from nanomanager.js file, which can be found in vendor/reun/nanomanager/packages/frontend/dist/nanomanager.js if you installed Nanomanager with Composer. For PHAR installation, you can copy the file from releases.

Using <script> tag in HTML file

To embed Nanomanager into any HTML page, you need to copy nanomanager.js into publicly accessible asset directory and include it as a script tag. It is recommended to rename the file to include version number to avoid caching issues.

<head>
  <script src="/path/to/nanomanager-1.0.0.js"></script>
</head>
<body>
  ...
  <nano-file-manager api-url="..."></nano-file-manager>
  ...
</body>

💡 Tip

Check out tests/integration/framework-test for a complete example.

Using import in JS

You can import Nanomanager in JS to load the custom element. We're using Vue as an example, but it works with any JS framework or even without one.

<script setup>
// Load `nanomanager.js` from Composer package
import "../vendor/reun/nanomanager/packages/frontend/dist/nanomanager.js";

// Using dynamic hostname for easy access in both development and production
const apiUrl = window.location.origin + "/admin/nanomanager";
</script>

<template>
  <nano-file-manager :api-url="apiUrl"></nano-file-manager>
</template>

Frontend customization and theming with CSS

<nano-file-manager> exposes its root element as part attribute with the name body. You can target this element with nano-file-manager::part(body) CSS selector to set theme variables or use custom CSS. See NanoFileManager.svelte for a full list of available theme variables and index.html in framework integration test as an example.

nano-file-manager::part(body) {
  --rounded: 2em;
  --bg: linear-gradient(to top, #cfd9df 0%, #e2ebf0 100%);
  /* You can set different values for dark / light theme */
  --bg-modal: var(--dark, #0d1b2a) var(--light, #e5edf7);
}

Additional tips

Setting URL dynamically

You can utilize $_SERVER to set URL dynamically when configuring Nanomanager. This is useful for development and testing.

ℹ️ Important

It is recommended to set URL manually in production instead of relying on $_SERVER global. This is also illustrated in the example below.

$proto = ($_SERVER['HTTPS'] ?? false) ? 'https' : 'http';
$host = is_string($_SERVER['HTTP_HOST']) ? $_SERVER['HTTP_HOST'] : '';
$urlBase = "{$proto}://{$host}";

// Override dynamic URL in production
if($isProduction) {
  $urlBase = "https://example.com";
}

$nanomanager = new Nanomanager(
    "path/to/uploads",
    "{$urlBase}/uploads",
    "{$urlBase}/admin/nanomanager",
);

Development

See docs/development for development documentation.