Repository navigation
archivebox.machine.detect
Nick Sweeting edited this page Sep 1, 2026
·
2 revisions
:allowtitles:
:class: autosummary longtable
:align: left
* - {py:obj}`get_vm_info <archivebox.machine.detect.get_vm_info>`
- ```{autodoc2-docstring} archivebox.machine.detect.get_vm_info
:summary:
```
* - {py:obj}`get_public_ip <archivebox.machine.detect.get_public_ip>`
- ```{autodoc2-docstring} archivebox.machine.detect.get_public_ip
:summary:
```
* - {py:obj}`get_local_ip <archivebox.machine.detect.get_local_ip>`
- ```{autodoc2-docstring} archivebox.machine.detect.get_local_ip
:summary:
```
* - {py:obj}`unknown_if_blank <archivebox.machine.detect.unknown_if_blank>`
- ```{autodoc2-docstring} archivebox.machine.detect.unknown_if_blank
:summary:
```
* - {py:obj}`get_isp_info <archivebox.machine.detect.get_isp_info>`
- ```{autodoc2-docstring} archivebox.machine.detect.get_isp_info
:summary:
```
* - {py:obj}`get_host_network <archivebox.machine.detect.get_host_network>`
- ```{autodoc2-docstring} archivebox.machine.detect.get_host_network
:summary:
```
* - {py:obj}`get_os_info <archivebox.machine.detect.get_os_info>`
- ```{autodoc2-docstring} archivebox.machine.detect.get_os_info
:summary:
```
* - {py:obj}`get_host_stats <archivebox.machine.detect.get_host_stats>`
- ```{autodoc2-docstring} archivebox.machine.detect.get_host_stats
:summary:
```
* - {py:obj}`get_host_guid <archivebox.machine.detect.get_host_guid>`
- ```{autodoc2-docstring} archivebox.machine.detect.get_host_guid
:summary:
```
:class: autosummary longtable
:align: left
* - {py:obj}`PACKAGE_DIR <archivebox.machine.detect.PACKAGE_DIR>`
- ```{autodoc2-docstring} archivebox.machine.detect.PACKAGE_DIR
:summary:
```
* - {py:obj}`DATA_DIR <archivebox.machine.detect.DATA_DIR>`
- ```{autodoc2-docstring} archivebox.machine.detect.DATA_DIR
:summary:
```
* - {py:obj}`ip_addrs <archivebox.machine.detect.ip_addrs>`
- ```{autodoc2-docstring} archivebox.machine.detect.ip_addrs
:summary:
```
* - {py:obj}`mac_addrs <archivebox.machine.detect.mac_addrs>`
- ```{autodoc2-docstring} archivebox.machine.detect.mac_addrs
:summary:
```
:canonical: archivebox.machine.detect.PACKAGE_DIR
:value: >
None
```{autodoc2-docstring} archivebox.machine.detect.PACKAGE_DIR
```
:canonical: archivebox.machine.detect.DATA_DIR
:value: >
'resolve(...)'
```{autodoc2-docstring} archivebox.machine.detect.DATA_DIR
```
:canonical: archivebox.machine.detect.get_vm_info
```{autodoc2-docstring} archivebox.machine.detect.get_vm_info
```
:canonical: archivebox.machine.detect.get_public_ip
```{autodoc2-docstring} archivebox.machine.detect.get_public_ip
```
:canonical: archivebox.machine.detect.get_local_ip
```{autodoc2-docstring} archivebox.machine.detect.get_local_ip
```
:canonical: archivebox.machine.detect.ip_addrs
:value: >
None
```{autodoc2-docstring} archivebox.machine.detect.ip_addrs
```
:canonical: archivebox.machine.detect.mac_addrs
:value: >
None
```{autodoc2-docstring} archivebox.machine.detect.mac_addrs
```
:canonical: archivebox.machine.detect.unknown_if_blank
```{autodoc2-docstring} archivebox.machine.detect.unknown_if_blank
```
:canonical: archivebox.machine.detect.get_isp_info
```{autodoc2-docstring} archivebox.machine.detect.get_isp_info
```
:canonical: archivebox.machine.detect.get_host_network
```{autodoc2-docstring} archivebox.machine.detect.get_host_network
```
:canonical: archivebox.machine.detect.get_os_info
```{autodoc2-docstring} archivebox.machine.detect.get_os_info
```
:canonical: archivebox.machine.detect.get_host_stats
```{autodoc2-docstring} archivebox.machine.detect.get_host_stats
```
:canonical: archivebox.machine.detect.get_host_guid
```{autodoc2-docstring} archivebox.machine.detect.get_host_guid
```
- ๐ข Quickstart
- ๐ฅ๏ธ Install
- ๐ณ Docker
- โก๏ธ Supported Sources
- โฌ ๏ธ Supported Outputs
- ๏นฉCommand Line
- ๐ Web UI
- ๐งฉ Browser Extension
- ๐พ REST API / Webhooks
- ๐ธ UI Screenshots
- ๐ Python API / REPL / SQL API
- โ๏ธ Configuration
- ๐ฆ Dependencies
- ๐ฟ Disk Layout
- ๐ Security Overview
- ๐ Developer Documentation
- ๐ฟ Setting up Storage
(NFS/SMB/S3/Google Drive/etc) - ๐ Setting up Authentication
(Web Admin SSO/LDAP/etc) - ๐ Setting up Search
(rg/sonic/FTS5/etc) - ๐ Publishing Your Archive
- ๐ Chromium Install
- ๐ช Cookies & Sessions Setup
- ๐ Scheduled Archiving
- ๐๏ธ Change Detection
- ๐ OSINT Preservation
- ๐งฎ Archiving URLs from Google Sheets
- ๐ฌ Archiving URLs via Chat Bot (Slack/WhatsApp/etc)
- โญ๏ธ Web Archiving Community
- Background & Motivation
- Comparison to Other Tools
- Architecture Diagram
- Changelog & Roadmap


