.. _host server settings: Host Server Settings ==================== This chapter lists and describes the available configuration options for the TeamDrive Host Server. You can review and modify most of these via the TeamDrive Host Server Administration Console by clicking **Settings**. Some settings are marked as read-only ("R/O"), they can not be changed. APIAccessList ------------- A white list of IP addresses (separated by commas or spaces) of machines that are permitted to access the Host Server API. For example, the IP address of the host running the TeamDrive Registration Server Administration Console should be added here. APIChecksumRequired ------------------- If set to ``True``, then each call to the API must include a checksum hash, constructed using the API Hash defined in ``APISalt``. APILogging ---------- Set to ``True`` if API logging should be enabled. Every API access will be logged in the database table ``hostapilog.TD2APIRequests``. APIReturnSpaceNames ------------------- Set to ``True`` if Space names should be returned through the API. This requires the setting ``StoreSpaceNames`` to be set to ``True`` as well, otherwise this option has no effect. APISalt ------- This is a unique character sequence that must be identical to the API Salt of the associated Registration Server. ClientPollFrequency ------------------- The interval in which Clients poll their Spaces for updates, in seconds. 0 or empty means the Clients will use their default. EnforceTrafficLimit ------------------- When set to ``False``, the traffic quota for all Depots will be considered unlimited. ForceHTTPSUsage --------------- Set to ``True`` if the Host Server Admin Console (this program) must be accessed using HTTPS. Language -------- This is the default language used by the Host Server Admin Console. ModuleLogFile ------------- The path and name of the Apache module (``mod_pspace``) log file. This file must be owned and writable by the system user the Apache http Server runs under (e.g. ``apache``). ModuleLogLevel -------------- This is the maximum level of logging of messages logged by the Apache module (``mod_pspace``). A higher number results in more verbose logging. Possible values are: 1 = Protocol, 2 = Error, 3 = Warning, 4 = Trace, 5 = Debug. ProviderCode ------------ This is the 4-digit code of provider (distributor/tenant) under which this this Host Server is registered. RegistrationDeviceID -------------------- This is the ID returned by the Registration Server upon registration. It is the ID of the user under which the Host Server is registered. This setting cannot be changed. RegServerName ------------- The name of the Registration Server associated with this host. This value cannot be altered after registration. RegServerURL ------------ This is the URL used to access the Registration Server. This value may not be altered after registration. S3AccessKey ----------- The access (public) key, used to access the specified bucket on an S3-compatible object store. S3ArchiveLogs ------------- Set this value to ``True`` if the S3 logs used for calculating traffic are to be archived instead of deleted. S3AuthTimeout ------------- The number of seconds an S3 authenticated query string is valid S3Brand ------- This setting specifies the type of S3 storage. Possible options are: *Amazon* or *OpenStack*. S3DataBucketName ---------------- The name of the Bucket on the S3-compatible object store that will contain the Space data S3EnableRedirect ---------------- When S3 redirect is enabled, the Host Server will redirect the Client to download objects directly from the S3-compatible object store, when appropriate. The alternative is that all downloads are performed via the Host Server (the Host Server acts like a Proxy that fetches data from the object store and forwards it to the Client). S3LogBucketName --------------- The bucket that contains the S3 access log files. These log files are used to analyse and calculate traffic. S3Options --------- S3 options control the way the S3-compatible object store is accessed. For example, the number of parallel threads during upload, whether to use multipart uploads, etc. S3ProcessedPath --------------- If ``S3ArchiveLogs`` is set to ``True``, then the logs stored in ``S3ToProcessPath`` are moved to this path, after they have been used to calculate traffic. S3SecretKey ----------- The S3 secret (private) key used to acces the specified bucket on the S3-compatible object store. S3Server -------- This is the domain name of the S3-compatible object store, e.g. ``s3.amazonaws.com``. S3SyncActive ------------ Set to ``True`` when data stored by the Host Server (Space data) should be transferred to an S3 compatible cloud storage. Transfer to S3 is possible from both Volume storage and TSHS. S3ToProcessPath --------------- The path in which the S3 access logs are stored. The access logs are used to calculate traffic caused by direct downloads from S3 storage. ServerVersion ------------- The current server version. This value cannot be changed. ServiceDisplayName ------------------ This name is displayed in the top left of the Host Server Administration Console. Initially, is is set to the domain name of the Host Server. The name is used for display purposes only, and may be set to any value. ServiceHostURL -------------- This is the Host URL used by the clients to create and access Space data. It can not be changed. ServiceUniqueName ----------------- This is a unique name of the Hosting Service, consisting of the Host Server's domain name and the associated Registration Server. This value can not be changed. SessionTimeout -------------- This is the idle time in seconds after which you are required to login to the Host Server Admin Console again. SnapshotThreshold ----------------- The log threshold, in bytes, after which the Client will create a new snapshot of a Space, 0 or empty means the Client will use its default. SpaceStatisticEnabled --------------------- Set to ``True`` if Space Statistics should be exported. SpaceStatisticExportPath ------------------------ This is the path for the files containing the exported Space Statistics, default is: ``../docs/p1a/statistic/``. StatisticPollFactor ------------------- Multiple the ``ClientPollFrequency`` by this amount to determine the how often the client retrieves the statistics, 0 or empty means the client will use its default value of 5 StoreSpaceNames --------------- Set to ``True`` if the Host Server should store the names of Spaces defined by the user. TSHSEnabled ----------- Set to ``True`` to enabled TSHS (TeamDrive Scalable Hosting Storage). If changed, a restart of the Apache http Server required. TSHSExecutable -------------- This is a reference to the ``tshs`` executable. This path must be set correctly if TSHS is enabled. TSHSImportVolumes ----------------- This setting is set automatically when TSHS is enabled. It is set to ``True`` if Space data is stored on the Host Server Volumes when TSHS is enabled. It must be set manually to ``False`` when all data has been transfered from the Host Volumes to TSHS. TSHSMyCnfFile ------------- This is a reference to the ``my.cnf`` file that is used by TSHS. The ``my.cnf`` file must contain a group called ``[tshs]`` which specifies the connection to the TSHS Admin MySQL database. UseHTTPsForPublishFiles ----------------------- Set to ``True`` if published files must be uploaded and downloaded using HTTPS. This ensures that the file content can not be intercepted in transit from the TeamDrive Client to the Host Server, and from the Host Server to the web client downloading the file.