| Name | netbox-authorized-keys JSON |
| Version |
2.0.0
JSON |
| download |
| home_page | None |
| Summary | NetBox plugin to store Authorized Keys |
| upload_time | 2025-10-22 11:26:09 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10.0 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# NetBox Authorized Keys Plugin
NetBox Authorized Keys is a plugin for NetBox that allows you to store and manage SSH authorized keys.
## Features
- Store SSH authorized keys
- Assign keys to devices or virtual machines
- Manage keys through the NetBox UI
- API support for managing keys
## Installation
### From PyPI (when available)
```sh
pip install netbox-authorized-keys
```
### From Source
1. Clone the repository:
```sh
git clone https://github.com/CESNET/netbox_authorized_keys.git
```
2. Navigate to the project directory:
```sh
cd netbox_authorized_keys
```
3. Install the plugin:
```sh
pip install .
```
4. Add the plugin to your NetBox configuration:
```python
PLUGINS = ["netbox_authorized_keys"]
PLUGINS_CONFIG = {
"netbox_authorized_keys": {
# Add any plugin-specific configuration here
}
}
```
5. Run the migrations:
```sh
python manage.py migrate
```
### Importing Keys through the GUI
- Visit `<NETBOX_URL>plugins/authorized-keys/authorized-keys/import/`
- Paste the authorized keys into the text area as YAML
- Example:
```yaml
- public_key: "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDQq ... user@host"
username: "admin"
full_name: "System Administrator"
description: "Admin SSH key"
devices: R121,R119,DEVICE_NAME3
virtual_machines: krupa.vm.cesnet.cz, VM_NAME2
comments: "Primary admin access key"
- public_key: "ssh-ed25519 AAAAC3aaNzaC1lZDI1NTE5AAAAIJEj2f9jQS3zGOVKUtEtQXFvFJ6YyB4hjQvQEXEsEZGk developer@laptop"
username: "developer"
full_name: "Jane Developer"
description: "Developer access key"
comments: "Development environment access"
tags: "tag_slug1,tag_slug2"
```
- Notes:
- Tags slug need to be encased in quotes and separated by commas
- Devices and virtual machines need to be specified by their name, enclosed in quotes, and separated by commas
Raw data
{
"_id": null,
"home_page": null,
"name": "netbox-authorized-keys",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10.0",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Jan Krupa <jan.krupa@cesnet.cz>",
"download_url": "https://files.pythonhosted.org/packages/76/70/23a262b274033f7a01fcb55fbf124f7d26a891f16a9e3c2c9185b0191228/netbox_authorized_keys-2.0.0.tar.gz",
"platform": null,
"description": "# NetBox Authorized Keys Plugin\n\nNetBox Authorized Keys is a plugin for NetBox that allows you to store and manage SSH authorized keys.\n\n## Features\n\n- Store SSH authorized keys\n- Assign keys to devices or virtual machines\n- Manage keys through the NetBox UI\n- API support for managing keys\n\n## Installation\n\n### From PyPI (when available)\n```sh\npip install netbox-authorized-keys\n```\n\n### From Source\n\n1. Clone the repository:\n ```sh\n git clone https://github.com/CESNET/netbox_authorized_keys.git\n ```\n\n2. Navigate to the project directory:\n ```sh\n cd netbox_authorized_keys\n ```\n\n3. Install the plugin:\n ```sh\n pip install .\n ```\n\n4. Add the plugin to your NetBox configuration:\n ```python\n PLUGINS = [\"netbox_authorized_keys\"]\n PLUGINS_CONFIG = {\n \"netbox_authorized_keys\": {\n # Add any plugin-specific configuration here\n }\n }\n ```\n\n5. Run the migrations:\n ```sh\n python manage.py migrate\n ```\n\n### Importing Keys through the GUI\n- Visit `<NETBOX_URL>plugins/authorized-keys/authorized-keys/import/`\n- Paste the authorized keys into the text area as YAML\n- Example:\n```yaml\n- public_key: \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDQq ... user@host\"\n username: \"admin\"\n full_name: \"System Administrator\"\n description: \"Admin SSH key\"\n devices: R121,R119,DEVICE_NAME3\n virtual_machines: krupa.vm.cesnet.cz, VM_NAME2\n comments: \"Primary admin access key\"\n\n\n- public_key: \"ssh-ed25519 AAAAC3aaNzaC1lZDI1NTE5AAAAIJEj2f9jQS3zGOVKUtEtQXFvFJ6YyB4hjQvQEXEsEZGk developer@laptop\"\n username: \"developer\"\n full_name: \"Jane Developer\"\n description: \"Developer access key\"\n comments: \"Development environment access\"\n tags: \"tag_slug1,tag_slug2\"\n```\n- Notes:\n - Tags slug need to be encased in quotes and separated by commas\n - Devices and virtual machines need to be specified by their name, enclosed in quotes, and separated by commas\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "NetBox plugin to store Authorized Keys",
"version": "2.0.0",
"project_urls": {
"Bug Tracker": "https://github.com/CESNET/netbox_authorized_keys/issues",
"Homepage": "https://github.com/CESNET/netbox_authorized_keys",
"Repository": "https://github.com/CESNET/netbox_authorized_keys"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "767023a262b274033f7a01fcb55fbf124f7d26a891f16a9e3c2c9185b0191228",
"md5": "0f6e8a058defe1f7ffb0f71ad33d816f",
"sha256": "da7ebfa9ce147c6c758192bb828bb0ecab7c6578ff8d9d7dd4209e7224f121f6"
},
"downloads": -1,
"filename": "netbox_authorized_keys-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "0f6e8a058defe1f7ffb0f71ad33d816f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10.0",
"size": 20059,
"upload_time": "2025-10-22T11:26:09",
"upload_time_iso_8601": "2025-10-22T11:26:09.836697Z",
"url": "https://files.pythonhosted.org/packages/76/70/23a262b274033f7a01fcb55fbf124f7d26a891f16a9e3c2c9185b0191228/netbox_authorized_keys-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-22 11:26:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CESNET",
"github_project": "netbox_authorized_keys",
"github_not_found": true,
"lcname": "netbox-authorized-keys"
}
