-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
archivebox.config.paths
Nick Sweeting edited this page Nov 13, 2024
·
2 revisions
:allowtitles:
:class: autosummary longtable
:align: left
* - {py:obj}`_get_collection_id <archivebox.config.paths._get_collection_id>`
- ```{autodoc2-docstring} archivebox.config.paths._get_collection_id
:summary:
```
* - {py:obj}`get_collection_id <archivebox.config.paths.get_collection_id>`
- ```{autodoc2-docstring} archivebox.config.paths.get_collection_id
:summary:
```
* - {py:obj}`get_machine_id <archivebox.config.paths.get_machine_id>`
- ```{autodoc2-docstring} archivebox.config.paths.get_machine_id
:summary:
```
* - {py:obj}`get_machine_type <archivebox.config.paths.get_machine_type>`
- ```{autodoc2-docstring} archivebox.config.paths.get_machine_type
:summary:
```
* - {py:obj}`dir_is_writable <archivebox.config.paths.dir_is_writable>`
- ```{autodoc2-docstring} archivebox.config.paths.dir_is_writable
:summary:
```
* - {py:obj}`assert_dir_can_contain_unix_sockets <archivebox.config.paths.assert_dir_can_contain_unix_sockets>`
- ```{autodoc2-docstring} archivebox.config.paths.assert_dir_can_contain_unix_sockets
:summary:
```
* - {py:obj}`create_and_chown_dir <archivebox.config.paths.create_and_chown_dir>`
- ```{autodoc2-docstring} archivebox.config.paths.create_and_chown_dir
:summary:
```
* - {py:obj}`get_or_create_working_tmp_dir <archivebox.config.paths.get_or_create_working_tmp_dir>`
- ```{autodoc2-docstring} archivebox.config.paths.get_or_create_working_tmp_dir
:summary:
```
* - {py:obj}`get_or_create_working_lib_dir <archivebox.config.paths.get_or_create_working_lib_dir>`
- ```{autodoc2-docstring} archivebox.config.paths.get_or_create_working_lib_dir
:summary:
```
* - {py:obj}`get_data_locations <archivebox.config.paths.get_data_locations>`
- ```{autodoc2-docstring} archivebox.config.paths.get_data_locations
:summary:
```
* - {py:obj}`get_code_locations <archivebox.config.paths.get_code_locations>`
- ```{autodoc2-docstring} archivebox.config.paths.get_code_locations
:summary:
```
:class: autosummary longtable
:align: left
* - {py:obj}`PACKAGE_DIR <archivebox.config.paths.PACKAGE_DIR>`
- ```{autodoc2-docstring} archivebox.config.paths.PACKAGE_DIR
:summary:
```
* - {py:obj}`DATA_DIR <archivebox.config.paths.DATA_DIR>`
- ```{autodoc2-docstring} archivebox.config.paths.DATA_DIR
:summary:
```
* - {py:obj}`ARCHIVE_DIR <archivebox.config.paths.ARCHIVE_DIR>`
- ```{autodoc2-docstring} archivebox.config.paths.ARCHIVE_DIR
:summary:
```
* - {py:obj}`IN_DOCKER <archivebox.config.paths.IN_DOCKER>`
- ```{autodoc2-docstring} archivebox.config.paths.IN_DOCKER
:summary:
```
* - {py:obj}`DATABASE_FILE <archivebox.config.paths.DATABASE_FILE>`
- ```{autodoc2-docstring} archivebox.config.paths.DATABASE_FILE
:summary:
```
:canonical: archivebox.config.paths.PACKAGE_DIR
:type: pathlib.Path
:value: >
None
```{autodoc2-docstring} archivebox.config.paths.PACKAGE_DIR
```
:canonical: archivebox.config.paths.DATA_DIR
:type: pathlib.Path
:value: >
'resolve(...)'
```{autodoc2-docstring} archivebox.config.paths.DATA_DIR
```
:canonical: archivebox.config.paths.ARCHIVE_DIR
:type: pathlib.Path
:value: >
None
```{autodoc2-docstring} archivebox.config.paths.ARCHIVE_DIR
```
:canonical: archivebox.config.paths.IN_DOCKER
:value: >
None
```{autodoc2-docstring} archivebox.config.paths.IN_DOCKER
```
:canonical: archivebox.config.paths.DATABASE_FILE
:value: >
None
```{autodoc2-docstring} archivebox.config.paths.DATABASE_FILE
```
:canonical: archivebox.config.paths._get_collection_id
```{autodoc2-docstring} archivebox.config.paths._get_collection_id
```
:canonical: archivebox.config.paths.get_collection_id
```{autodoc2-docstring} archivebox.config.paths.get_collection_id
```
:canonical: archivebox.config.paths.get_machine_id
```{autodoc2-docstring} archivebox.config.paths.get_machine_id
```
:canonical: archivebox.config.paths.get_machine_type
```{autodoc2-docstring} archivebox.config.paths.get_machine_type
```
:canonical: archivebox.config.paths.dir_is_writable
```{autodoc2-docstring} archivebox.config.paths.dir_is_writable
```
:canonical: archivebox.config.paths.assert_dir_can_contain_unix_sockets
```{autodoc2-docstring} archivebox.config.paths.assert_dir_can_contain_unix_sockets
```
:canonical: archivebox.config.paths.create_and_chown_dir
```{autodoc2-docstring} archivebox.config.paths.create_and_chown_dir
```
:canonical: archivebox.config.paths.get_or_create_working_tmp_dir
```{autodoc2-docstring} archivebox.config.paths.get_or_create_working_tmp_dir
```
:canonical: archivebox.config.paths.get_or_create_working_lib_dir
```{autodoc2-docstring} archivebox.config.paths.get_or_create_working_lib_dir
```
:canonical: archivebox.config.paths.get_data_locations
```{autodoc2-docstring} archivebox.config.paths.get_data_locations
```
:canonical: archivebox.config.paths.get_code_locations
```{autodoc2-docstring} archivebox.config.paths.get_code_locations
```
- π’ Quickstart
- π₯οΈ Install
- π³ Docker
- β‘οΈ Supported Sources
- β¬ οΈ Supported Outputs
- οΉ©Command Line
- π Web UI
- π§© Browser Extension
- πΎ REST API / Webhooks
- π Python API / REPL / SQL API
- βοΈ Configuration
- π¦ Dependencies
- πΏ Disk Layout
- π Security Overview
- π Developer Documentation
- Upgrading
- Setting up Storage (NFS/SMB/S3/etc)
- Setting up Authentication (SSO/LDAP/etc)
- Setting up Search (rg/sonic/etc)
- Scheduled Archiving
- Publishing Your Archive
- Chromium Install
- Cookies & Sessions Setup
- Merging Collections
- Troubleshooting
- βοΈ Web Archiving Community
- Background & Motivation
- Comparison to Other Tools
- Architecture Diagram
- Changelog & Roadmap