https://github.com/kennethlove/django-middle-management
A small Django utility for safely executing remote management commands
https://github.com/kennethlove/django-middle-management
django management remote-execution
Last synced: about 1 month ago
JSON representation
A small Django utility for safely executing remote management commands
- Host: GitHub
- URL: https://github.com/kennethlove/django-middle-management
- Owner: kennethlove
- License: apache-2.0
- Created: 2024-12-14T01:32:28.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-03-20T16:48:50.000Z (3 months ago)
- Last Synced: 2025-05-01T19:04:29.727Z (about 1 month ago)
- Topics: django, management, remote-execution
- Language: Python
- Homepage:
- Size: 48.8 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Django Middle Management
It's usually a bad idea to connect to production servers to run one-off or repetitive
maintenance commands. There may not be any auditing, commands and payloads can easily
have mistakes, and a rogue developer could get away with almost anything. With
`django-middle-management`, though, you don't have to allow shell access to your
production servers while still being able to run commands on them.
This is a small library that makes it possible to securely and remotely execute Django
management commands via `POST` requests. Commands must be merged into your code base
before they're eligible to be used. They must also be listed in `settings.py` or they
cannot be triggered. Finally, requests must be authenticated by your system before any
command can be given.
**Warning:** This project runs management commands remotely but _synchronously_.
Long-running commands will potentially block your server from responding to other requests.
Using a task queue like Celery is recommend for anything that may take more than a few
milliseconds.
## Installation
```bash
pip install django-middle-management
```
Add the package to your `INSTALLED_APPS`:
```python
INSTALLED_APPS = [
...,
"middle_management",
...
]
```
Add the URLs to your project's `urls.py`:
```python
from middle_management.urls import manage_urls
urlpatterns = [
...
] + manage_urls
```
You'll need to write a new management command or select an
existing one to expose. Finally, add that command name to
an allowlist of commands in `settings.py`:
```python
MANAGE_ALLOW_LIST = ["noop"]
```
## Usage
To execute a management command, make a `POST` request to the
`/__manage__/` endpoint with a payload similar to
the following:
```json
{
"data": {
"arg1": "value1",
"arg2": "value2"
}
}
```
Your `POST` must also contain a valid `HTTP_AUTHORIZATION` header
with the value `Bearer `. The final request will look
something like:
```shell
curl -XPOST \
-H 'Authorization: Bearer not-a-real-token' \
-H "Content-type: application/json" \
-d '{"data": { "arg1": "value1", "arg2": "value2" }}' \
'https://example.com/__manage__/noop'
```