class SafeDb::Indices
Indices
are key/value pairs that serve within the safe database index files for denoting, pinpointing, writing and retrieving data values as well as for naming of files folders and other artifacts.
Constants
- BACKUP_CRYPTS_FOLDER_NAME
The name of the backup master crypts folder.
- BACKUP_CRYPTS_FOLDER_PATH
The path of the backup master crypts folder.
- BOOK_BRANCH_LOGIN_TIME
The time this book was first logged into during this branch
- BOOK_LAST_ACCESSED_TIME
The time this book was last accessed during this branch
- BOOTUP_IDENTIFIER
The bootup id is set on machine boot and lasts until the reboot or shutdown.
- BRANCH_CRYPTS_FOLDER_NAME
The name of the branch crypts folder.
- BRANCH_CRYPTS_FOLDER_PATH
The path to the branch crypts folder.
- BRANCH_DATA
This is the global section header of the branch book index file
- BRANCH_INDICES_FOLDER_NAME
The name of the branch indices folder.
- BRANCH_INDICES_FOLDER_PATH
The path to the branch indices folder.
- BRANCH_INITIAL_LOGIN_TIME
The time of the first book login within this shell
- BRANCH_LAST_ACCESSED_TIME
The most recent time that any book of this branch was accessed
- COMMANDER
The command used to invoke the safe database
- COMMIT_IDENTIFIER
The commit identifiers of the master and branch are compared to ascertain eligibility for commits
- CONFIGURE_BACKEND_KEY_NAME
The parameter key name to configure the backend coordinates
- CONTENT_BLOCK_DELIMITER
The delimeter used to separate headers from ciphertext in a crypt file
- CONTENT_BLOCK_END_STRING
The end of the content block laid out in a crypt file
- CONTENT_BLOCK_START_STRING
The start of the content block laid out in a crypt file
- CONTENT_IDENTIFIER
Content
identifiers act to name chapter and/or index database files.- CONTENT_ID_LENGTH
The desired length of a content identifier
- CONTENT_RANDOM_IV
The AES symmetric encryption initialization vector
- CRYPT_CIPHER_TEXT
The key ciphertext that sits against the trio of either master, branch or chapter
- CURRENT_BRANCH_BOOK_ID
The ID of the book being currently used by this branch
- ELLIPTIC_CURVE_KEY_TYPE
Elliptic Curve SSL
Key
Type- FILE_CHMOD_PERMISSIONS_KEY
The permission setting (chmod) key name
- GITHUB_ACCESS_TOKEN
This access token allows us to talk to the
Github
API- GIT_CLONE_BASE_PATH
The keyname whose value denotes a local folder path to clone to
- GIT_REPOSITORY_HOST_KEYNAME
Github
Host Keyname- GIT_REPOSITORY_NAME_KEYNAME
Github
repository keyname- GIT_REPOSITORY_USER_KEYNAME
Github
Username Keyname- INGESTED_FILE_BASE_NAME_KEY
Handle to the simple name of the ingested file in the submap verse
- INGESTED_FILE_CONTENT64_KEY
Handle to the file base64 content within the submap verse
- INGESTED_FILE_LINE_NAME_KEY
Handle to the key name of the ingested file in the submap verse
- MACHINE_CONFIG_FILEPATH
The path to the remote storage configuration INI file
- MACHINE_REMOVABLE_DRIVE_PATH
The name of the machine removable drive path location directive
- MASTER_CRYPTS_FOLDER_NAME
The name of the master crypts folder.
- MASTER_CRYPTS_FOLDER_PATH
The path to the master crypts folder.
- MASTER_CRYPTS_GIT_PATH
The path to the master crypts .git directory.
- MASTER_INDICES_FILEPATH
The path to the master indices file
- MASTER_INDICES_FILE_NAME
The master indices file name
- NOTHING_TO_OBLITERATE
##################################### ### Strings printed to the user interface ### ##################################### ###
- OPENED_CHAPTER_NAME
The opened chapter id/name in the current book
- OPENED_VERSE_NAME
The opened verse id/name in the current book
- PRIVATE_KEY_DEFAULT_KEY_NAME
- PRIVATE_KEY_PREFIX
The keypair name prefix for private keys.
- PUBLIC_KEY_DEFAULT_KEY_NAME
- PUBLIC_KEY_PREFIX
The keypair name prefix for public keys.
- REMOTE_DATABASE_GIT_PULL_URL
The name of the remote database git pull url key
- REMOTE_DATABASE_GIT_PUSH_URL
The name of the remote database git push url key
- REMOTE_LAST_PUSH_BY
Keyname for the user and hostname that evoked the last push
- REMOTE_LAST_PUSH_ID
Keyname for the ID of the last push (Usually
Git
Commit
Reference)- REMOTE_LAST_PUSH_ON
Keyname for when the last backend push occured
- REMOTE_MIRROR_PAGE_NAME
The name of the property that points to the book/chapter/verse (page)
- REMOTE_MIRROR_PRIVATE_KEY_POSTFIX
The ending of the private key filename for remote mirror push access
- REMOTE_MIRROR_SECTION_NAME
The name of the keys section that holds remote mirror properties
- REMOTE_MIRROR_SSH_HOST_KEYNAME
The key name that holds the remote mirror ssh config host value
- REMOTE_PRIVATE_KEY_KEYNAME
The key name that holds the remote mirror private key filename
- SAFE_APP_NAME
The name of the safe application and the safe gem as known by the operating system.
- SAFE_BOOK_CHAPTER_KEYS
The handle to the chapter keys inside the book index.
- SAFE_BOOK_CURRENT_VERSION
The application version that oversaw this book's initialization.
- SAFE_BOOK_ID_LENGTH
The desired length of a safe book ergonomic identifier.
- SAFE_BOOK_INITIALIZE_TIME
The birthday (initialization time) of this safe book.
- SAFE_BOOK_INIT_VERSION
The application version that oversaw this book's initialization.
- SAFE_BOOK_NAME
The name of this safe book.
- SAFE_DATABASE_FOLDER
The file-system location of the safe database tree
- SAFE_GEM_WEBSITE
The fully qualified domain name of the safedb home website
- SAFE_GITHUB_URL
The safe database github clonable url for the ruby software
- SAFE_PRE_VERSION_STRING
The application version that oversaw this book's initialization.
- SAFE_URL_NAME
The short url name of the safe personal database.
- SECRET_MASK_STRING
Character (randomly) repeated to mask credentials Asterices, hyphens, plus and equal signs are common alternatives.
- SSH_CONFIG_FILE_PATH
The path to the SSH config file
- SSH_DIRECTORY_PATH
The path to the SSH directory
- TOKEN_VARIABLE_NAME
The name of the safe tty token environment variable
- TOKEN_VARIABLE_SIZE
The expected length of the tty token environment variable