Files
pyShelf/docs/man/man3/pyShelf_src_frontend_settings.3
2019-12-01 13:09:41 -05:00

181 lines
4.4 KiB
Groff
Vendored

.TH "pyShelf.src.frontend.settings" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
pyShelf.src.frontend.settings
.SH SYNOPSIS
.br
.PP
.SS "Variables"
.in +1c
.ti -1c
.RI "\fBBASE_DIR\fP = os\&.path\&.dirname(os\&.path\&.dirname(os\&.path\&.abspath(__file__)))"
.br
.ti -1c
.RI "string \fBSECRET_KEY\fP = '@(9b9jslgg41u1u=mr)\-2*\-n2x0vef0zsy39*z@sz18&tvow18'"
.br
.ti -1c
.RI "bool \fBDEBUG\fP = False"
.br
.ti -1c
.RI "list \fBALLOWED_HOSTS\fP = ['*']"
.br
.ti -1c
.RI "list \fBINSTALLED_APPS\fP"
.br
.ti -1c
.RI "list \fBMIDDLEWARE\fP"
.br
.ti -1c
.RI "list \fBINTERNAL_IPS\fP"
.br
.ti -1c
.RI "string \fBROOT_URLCONF\fP = 'frontend\&.urls'"
.br
.ti -1c
.RI "list \fBTEMPLATES\fP"
.br
.ti -1c
.RI "string \fBWSGI_APPLICATION\fP = 'frontend\&.wsgi\&.application'"
.br
.ti -1c
.RI "dictionary \fBDATABASES\fP"
.br
.ti -1c
.RI "list \fBAUTH_PASSWORD_VALIDATORS\fP"
.br
.ti -1c
.RI "string \fBLANGUAGE_CODE\fP = 'en\-us'"
.br
.ti -1c
.RI "string \fBTIME_ZONE\fP = 'UTC'"
.br
.ti -1c
.RI "bool \fBUSE_I18N\fP = True"
.br
.ti -1c
.RI "bool \fBUSE_L10N\fP = True"
.br
.ti -1c
.RI "bool \fBUSE_TZ\fP = True"
.br
.ti -1c
.RI "string \fBSTATIC_URL\fP = '/static/'"
.br
.ti -1c
.RI "\fBSTATIC_ROOT\fP = os\&.path\&.join(BASE_DIR, 'interface/static/')"
.br
.in -1c
.SH "Detailed Description"
.PP
.PP
.nf
Django settings for frontend project.
Generated by 'django-admin startproject' using Django 2.2.7.
For more information on this file, see
https://docs.djangoproject.com/en/2.2/topics/settings/
For the full list of settings and their values, see
https://docs.djangoproject.com/en/2.2/ref/settings/
.fi
.PP
.SH "Variable Documentation"
.PP
.SS "list pyShelf\&.src\&.frontend\&.settings\&.AUTH_PASSWORD_VALIDATORS"
\fBInitial value:\fP
.PP
.nf
1 = [
2 {
3 "NAME": "django\&.contrib\&.auth\&.password_validation\&.UserAttributeSimilarityValidator",
4 },
5 {"NAME": "django\&.contrib\&.auth\&.password_validation\&.MinimumLengthValidator",},
6 {"NAME": "django\&.contrib\&.auth\&.password_validation\&.CommonPasswordValidator",},
7 {"NAME": "django\&.contrib\&.auth\&.password_validation\&.NumericPasswordValidator",},
8 ]
.fi
.SS "dictionary pyShelf\&.src\&.frontend\&.settings\&.DATABASES"
\fBInitial value:\fP
.PP
.nf
1 = {
2 "default": {
3 "ENGINE": "django\&.db\&.backends\&.postgresql",
4 # "ENGINE": "django\&.db\&.backends\&.sqlite3",
5 "NAME": "pyshelf",
6 "PASSWORD": "",
7 # "NAME": os\&.path\&.join(BASE_DIR, "db\&.sqlite3"),
8 }
9 }
.fi
.SS "list pyShelf\&.src\&.frontend\&.settings\&.INSTALLED_APPS"
\fBInitial value:\fP
.PP
.nf
1 = [
2 "django\&.contrib\&.admin",
3 "django\&.contrib\&.auth",
4 "django\&.contrib\&.contenttypes",
5 "django\&.contrib\&.sessions",
6 "django\&.contrib\&.messages",
7 "django\&.contrib\&.staticfiles",
8 "interface",
9 "interface\&.templatetags",
10 "debug_toolbar",
11 ]
.fi
.SS "list pyShelf\&.src\&.frontend\&.settings\&.INTERNAL_IPS"
\fBInitial value:\fP
.PP
.nf
1 = [
2 # \&.\&.\&.
3 "127\&.0\&.0\&.1",
4 # \&.\&.\&.
5 ]
.fi
.SS "list pyShelf\&.src\&.frontend\&.settings\&.MIDDLEWARE"
\fBInitial value:\fP
.PP
.nf
1 = [
2 "django\&.middleware\&.security\&.SecurityMiddleware",
3 "django\&.contrib\&.sessions\&.middleware\&.SessionMiddleware",
4 "django\&.middleware\&.common\&.CommonMiddleware",
5 "django\&.middleware\&.csrf\&.CsrfViewMiddleware",
6 "debug_toolbar\&.middleware\&.DebugToolbarMiddleware",
7 "django\&.contrib\&.auth\&.middleware\&.AuthenticationMiddleware",
8 "django\&.contrib\&.messages\&.middleware\&.MessageMiddleware",
9 "django\&.middleware\&.clickjacking\&.XFrameOptionsMiddleware",
10 ]
.fi
.SS "list pyShelf\&.src\&.frontend\&.settings\&.TEMPLATES"
\fBInitial value:\fP
.PP
.nf
1 = [
2 {
3 "BACKEND": "django\&.template\&.backends\&.django\&.DjangoTemplates",
4 "DIRS": [],
5 "APP_DIRS": True,
6 "OPTIONS": {
7 "context_processors": [
8 "django\&.template\&.context_processors\&.debug",
9 "django\&.template\&.context_processors\&.request",
10 "django\&.contrib\&.auth\&.context_processors\&.auth",
11 "django\&.contrib\&.messages\&.context_processors\&.messages",
12 ],
13 },
14 },
15 ]
.fi
.SH "Author"
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.