Booktype settings¶
Warning
Work in progress.
Booktype specific¶
BOOKTYPE_SITE_NAME¶
You can name your Booktype instance. This name will be used in default templates as the name of your site.
Example:
BOOKTYPE_SITE_NAME = 'My Booktype instance'
BOOKTYPE_SITE_DIR¶
This is the directory name of your Booktype project on disk. It always ends with “_site”.
Example:
BOOKTYPE_SITE_DIR = 'test_site'
Note
Createbooktype script will configure this value appropriately. User will need to change this value only when changing or renaming Booktype project layout on disk.
BOOKTYPE_ROOT¶
Full path pointing to location of Booktype project.
Example:
BOOKTYPE_ROOT = '/var/www/mybooktype'
Note
Createbooktype script will configure this value appropriately. User will need to change this value only when changing location of Booktype project.
BOOKTYPE_URL¶
URL pointing to your Booktype project.
Example:
BOOKTYPE_URL = 'http://booktype.mydomain.com'
Note
Other URL settings will be configured using this value as a base URL.
PROFILE_ACTIVE¶
Each Booktype instance has more then one profile. Profiles are used so we can have different settings and environment for our Booktype instance in production mode, development mode or staging mode. Different profiles have different settings file and this value is configured accordingly in setting file.
Example for development profile:
PROFILE_ACTIVE = 'dev'
Note
There is no need for user to change this settings unless new profile is being created.
DATA_ROOT¶
Full path where user uploaded data is. Default value is using BOOKTYPE_ROOT to generate this settings.
Note
Change this only if user data is not at the same location as Booktype project.
DATA_URL¶
Full URL where user uploaded data is. Default value is using BOOKTYPE_URL to generate this settings.
Note
Change this only if user data is not at the same URL as Booktype project.
COVER_IMAGE_UPLOAD_DIR¶
Default: "cover_images/".
Name of the directory where cover images are placed. Base directory is DATA_ROOT.
PROFILE_IMAGE_UPLOAD_DIR¶
Default: "profile_images/"
Name of the directory where profile images are stored. Base directory is DATA_ROOT.
BOOKTYPE_CONVERTER_MODULES¶
List of plugins for book conversions into different formats.
Example:
BOOKTYPE_CONVERTER_MODULES = (
'booktype.convert.converters',
)
Redis¶
Configuration for connecting to Redis database.
REDIS_HOST¶
Default: "localhost".
REDIS_PORT¶
Default: 6379.
REDIS_DB¶
Default: 1.
REDIS_PASSWORD¶
Default: None.
Rest of the settings¶
COMPRESS_ENABLED¶
Used for configuring django_compressor application. “Dev” profile has compression disabled by default.
COMPRESS_OFFLINE¶
Used for configuring django_compressor application. “Dev” profile has compression disabled by default.