Download the PHP package ancalagon/netbox-podman without Composer

On this page you can find all versions of the php package ancalagon/netbox-podman. 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 ancalagon/netbox-podman

Informations about the package netbox-podman

NetBox Podman Quadlet

A rootless Podman deployment of NetBox using Quadlet (systemd-native container management). One command spins up a fully working NetBox instance with random credentials -- ideal for local development, integration testing, and CI pipelines.

This project is designed to work as a test fixture for the ancalagon/netbox PHP library, but is equally useful as a standalone NetBox deployment on any Linux system with Podman.

Prerequisites

Quick Start

The first run will pull container images and run Django migrations, which may take a few minutes. Subsequent runs are faster -- especially with --keep-data, which preserves volumes so migrations are skipped entirely.

bootstrap.sh

Option Description
--bind=ADDRESS Required. Reachable IP address to bind published ports to
--json Output connection details as JSON to stdout (progress goes to stderr)
--keep-data Preserve existing volumes (DB, Valkey, media) for faster startup
-h, --help Show usage help

The script will:

  1. Tear down any existing NetBox stack (calls teardown.sh)
  2. Generate random secrets (DB, Valkey, Django secret key, API token pepper, admin password)
  3. Resolve {{PLACEHOLDER}} tokens in template files into a generated/ directory
  4. Install Quadlet units to ~/.config/containers/systemd/
  5. Start the pod and wait for all health checks to pass
  6. Create an admin superuser and print login credentials

teardown.sh

Option Description
--keep-data Keep volumes intact (DB, Valkey, media) for faster re-bootstrap
-h, --help Show usage help

By default, stops all services and removes containers, pods, volumes, the Podman network, installed Quadlet units, and the generated/ directory. With --keep-data, volumes are preserved so the next ./bootstrap.sh skips migrations and starts much faster.

JSON Output

When using --json, the output contains everything a test harness needs:

Usage with Composer (PHP Integration Testing)

This repository can be added as a Composer dev dependency to provide a disposable NetBox instance for PHPUnit tests:

Composer will symlink bootstrap.sh and teardown.sh into vendor/bin/, so they are available on your $PATH when using Composer scripts.

Example: PHPUnit bootstrap file

Create a tests/bootstrap.php that starts NetBox before the test suite runs:

Then point your phpunit.xml at it:

Example: CI script

If you prefer to manage the lifecycle outside of PHP (e.g. in a Makefile or CI job):

For faster iteration during development, use --keep-data so that subsequent runs skip database migrations:

Architecture

All services run inside a single Podman pod on a dedicated bridge network (172.16.0.0/24).

Services

Unit File Image Role
netbox-netbox.container netboxcommunity/netbox:latest-4.0.0 Web app (port 8080 internal, 8000 published)
netbox-worker.container netboxcommunity/netbox:latest-4.0.0 RQ background worker
netbox-postgres.container postgres:17-alpine PostgreSQL database
netbox-valkey.container valkey/valkey:8.1-alpine Task queue (port 6380)
netbox-valkey-cache.container valkey/valkey:8.1-alpine Cache (port 6379)

Startup Dependencies

Volumes

Persistent data uses named Podman volumes: netbox-postgres-data, netbox-media-files, netbox-report-files, netbox-script-files, netbox-valkey-data, netbox-valkey-cache-data.

Configuration

Template Files

Environment files in env/ and netbox-configuration/extra.py use {{PLACEHOLDER}} tokens that bootstrap.sh resolves with random values into the generated/ directory (git-ignored). Templates are never modified.

File Placeholders
env/netbox.env {{DB_PASSWORD}}, {{REDIS_PASSWORD}}, {{REDIS_CACHE_PASSWORD}}, {{SECRET_KEY}}
env/postgres.env {{DB_PASSWORD}}
env/valkey.env {{REDIS_PASSWORD}}
env/valkey-cache.env {{REDIS_CACHE_PASSWORD}}
netbox-configuration/extra.py {{API_TOKEN_PEPPER}}
netbox.pod {{BIND_ADDRESS}}

Application Config

Security Considerations

By default, bootstrap.sh binds to 0.0.0.0, which exposes NetBox on all network interfaces. For local-only access, use:

For any deployment beyond local development, you should place a reverse proxy in front of NetBox to handle TLS termination. For example, with Caddy:

Or with Nginx:

When using a reverse proxy, always bind to 127.0.0.1 so NetBox is not directly reachable from the network.

Roadmap

Helm Chart for OpenShift / Kubernetes

The long-term goal of this project is to produce a Helm chart that deploys NetBox on OpenShift and Kubernetes clusters. The Podman Quadlet setup serves as the reference architecture for:

Planned Helm chart features:

License

MIT

All versions of netbox-podman with dependencies

PHP Build Version
Package Version
No informations.
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 ancalagon/netbox-podman contains the following files

Loading the files please wait ...