archivebox.core.settings

Module Contents

Classes

HueyDBRouter

A router to store all the Huey result k:v / Huey Monitor models in the queue.sqlite3 database. We keep the databases separate because the queue database receives many more reads/writes per second and we want to avoid single-write lock contention with the main database. Also all the in-progress task data is ephemeral/not-important-long-term. This makes it easier to for the user to clear non-critical temp data by just deleting queue.sqlite3 and leaving index.sqlite3.

Data

IS_MIGRATING

IS_TESTING

IS_SHELL

IS_GETTING_VERSION_OR_HELP

ALL_PLUGINS

LOADED_PLUGINS

WSGI_APPLICATION

ASGI_APPLICATION

ROOT_URLCONF

LOGIN_URL

LOGOUT_REDIRECT_URL

PASSWORD_RESET_URL

APPEND_SLASH

DEBUG

INSTALLED_APPS

MIDDLEWARE

AUTHENTICATION_BACKENDS

STATIC_URL

TEMPLATES_DIR_NAME

CUSTOM_TEMPLATES_ENABLED

STATICFILES_DIRS

TEMPLATE_DIRS

TEMPLATES

DATABASE_NAME

SQLITE_CONNECTION_OPTIONS

DATABASES

MIGRATION_MODULES

DEFAULT_AUTO_FIELD

HUEY

DJANGO_HUEY

DATABASE_ROUTERS

CACHES

EMAIL_BACKEND

STORAGES

CHANNEL_LAYERS

SECRET_KEY

ALLOWED_HOSTS

CSRF_TRUSTED_ORIGINS

SECURE_BROWSER_XSS_FILTER

SECURE_CONTENT_TYPE_NOSNIFF

SECURE_REFERRER_POLICY

CSRF_COOKIE_SECURE

SESSION_COOKIE_SECURE

SESSION_COOKIE_HTTPONLY

SESSION_COOKIE_DOMAIN

SESSION_COOKIE_AGE

SESSION_EXPIRE_AT_BROWSER_CLOSE

SESSION_SAVE_EVERY_REQUEST

SESSION_ENGINE

AUTH_PASSWORD_VALIDATORS

DATA_UPLOAD_MAX_NUMBER_FIELDS

DATA_UPLOAD_MAX_MEMORY_SIZE

SHELL_PLUS

SHELL_PLUS_PRINT_SQL

IPYTHON_ARGUMENTS

IPYTHON_KERNEL_DISPLAY_NAME

LANGUAGE_CODE

USE_I18N

USE_TZ

DATETIME_FORMAT

SHORT_DATETIME_FORMAT

TIME_ZONE

LOGGING

SIGNAL_WEBHOOKS_CUSTOM_MODEL

SIGNAL_WEBHOOKS

ADMIN_DATA_VIEWS

DEBUG_TOOLBAR

DEBUG_REQUESTS_TRACKER

API

archivebox.core.settings.IS_MIGRATING[source]

None

archivebox.core.settings.IS_TESTING[source]

None

archivebox.core.settings.IS_SHELL[source]

None

archivebox.core.settings.IS_GETTING_VERSION_OR_HELP[source]

None

archivebox.core.settings.ALL_PLUGINS[source]

None

archivebox.core.settings.LOADED_PLUGINS[source]

None

archivebox.core.settings.WSGI_APPLICATION[source]

‘core.wsgi.application’

archivebox.core.settings.ASGI_APPLICATION[source]

‘core.asgi.application’

archivebox.core.settings.ROOT_URLCONF[source]

‘core.urls’

archivebox.core.settings.LOGIN_URL[source]

‘/accounts/login/’

archivebox.core.settings.LOGOUT_REDIRECT_URL[source]

‘get(…)’

archivebox.core.settings.PASSWORD_RESET_URL[source]

‘/accounts/password_reset/’

archivebox.core.settings.APPEND_SLASH[source]

True

archivebox.core.settings.DEBUG[source]

None

archivebox.core.settings.INSTALLED_APPS[source]

None

archivebox.core.settings.MIDDLEWARE[source]

None

archivebox.core.settings.AUTHENTICATION_BACKENDS[source]

None

archivebox.core.settings.STATIC_URL[source]

‘/static/’

archivebox.core.settings.TEMPLATES_DIR_NAME[source]

‘templates’

archivebox.core.settings.CUSTOM_TEMPLATES_ENABLED[source]

None

archivebox.core.settings.STATICFILES_DIRS[source]

None

archivebox.core.settings.TEMPLATE_DIRS[source]

None

archivebox.core.settings.TEMPLATES[source]

None

archivebox.core.settings.DATABASE_NAME[source]

‘get(…)’

archivebox.core.settings.SQLITE_CONNECTION_OPTIONS[source]

None

archivebox.core.settings.DATABASES[source]

None

archivebox.core.settings.MIGRATION_MODULES[source]

None

archivebox.core.settings.DEFAULT_AUTO_FIELD[source]

‘django.db.models.BigAutoField’

archivebox.core.settings.HUEY[source]

None

archivebox.core.settings.DJANGO_HUEY[source]

None

class archivebox.core.settings.HueyDBRouter[source]

A router to store all the Huey result k:v / Huey Monitor models in the queue.sqlite3 database. We keep the databases separate because the queue database receives many more reads/writes per second and we want to avoid single-write lock contention with the main database. Also all the in-progress task data is ephemeral/not-important-long-term. This makes it easier to for the user to clear non-critical temp data by just deleting queue.sqlite3 and leaving index.sqlite3.

route_app_labels[source]

None

db_name[source]

‘queue’

db_for_read(model, **hints)[source]
db_for_write(model, **hints)[source]
allow_relation(obj1, obj2, **hints)[source]
allow_migrate(db, app_label, model_name=None, **hints)[source]
archivebox.core.settings.DATABASE_ROUTERS[source]

[‘core.settings.HueyDBRouter’]

archivebox.core.settings.CACHES[source]

None

archivebox.core.settings.EMAIL_BACKEND[source]

‘django.core.mail.backends.console.EmailBackend’

archivebox.core.settings.STORAGES[source]

None

archivebox.core.settings.CHANNEL_LAYERS[source]

None

archivebox.core.settings.SECRET_KEY[source]

None

archivebox.core.settings.ALLOWED_HOSTS[source]

‘split(…)’

archivebox.core.settings.CSRF_TRUSTED_ORIGINS[source]

‘list(…)’

archivebox.core.settings.SECURE_BROWSER_XSS_FILTER[source]

True

archivebox.core.settings.SECURE_CONTENT_TYPE_NOSNIFF[source]

True

archivebox.core.settings.SECURE_REFERRER_POLICY[source]

‘strict-origin-when-cross-origin’

False

False

True

None

1209600

archivebox.core.settings.SESSION_EXPIRE_AT_BROWSER_CLOSE[source]

False

archivebox.core.settings.SESSION_SAVE_EVERY_REQUEST[source]

False

archivebox.core.settings.SESSION_ENGINE[source]

‘django.contrib.sessions.backends.db’

archivebox.core.settings.AUTH_PASSWORD_VALIDATORS[source]

None

archivebox.core.settings.DATA_UPLOAD_MAX_NUMBER_FIELDS[source]

None

archivebox.core.settings.DATA_UPLOAD_MAX_MEMORY_SIZE[source]

26214400

archivebox.core.settings.SHELL_PLUS[source]

‘ipython’

archivebox.core.settings.SHELL_PLUS_PRINT_SQL[source]

False

archivebox.core.settings.IPYTHON_ARGUMENTS[source]

[’–no-confirm-exit’, ‘–no-banner’]

archivebox.core.settings.IPYTHON_KERNEL_DISPLAY_NAME[source]

‘ArchiveBox Django Shell’

archivebox.core.settings.LANGUAGE_CODE[source]

‘en-us’

archivebox.core.settings.USE_I18N[source]

True

archivebox.core.settings.USE_TZ[source]

True

archivebox.core.settings.DATETIME_FORMAT[source]

‘Y-m-d h:i:s A’

archivebox.core.settings.SHORT_DATETIME_FORMAT[source]

‘Y-m-d h:i:s A’

archivebox.core.settings.TIME_ZONE[source]

None

archivebox.core.settings.LOGGING[source]

None

archivebox.core.settings.SIGNAL_WEBHOOKS_CUSTOM_MODEL[source]

‘api.models.OutboundWebhook’

archivebox.core.settings.SIGNAL_WEBHOOKS[source]

None

archivebox.core.settings.ADMIN_DATA_VIEWS[source]

None

archivebox.core.settings.DEBUG_TOOLBAR[source]

False

archivebox.core.settings.DEBUG_REQUESTS_TRACKER[source]

True