Skip to content

SeaSearch Configuration

For the official ZincSearch configuration, refer to: ZincSearch Official Documentation.

The following configuration options are the ones we’ve extended. All configurations are set via environment variables.

Local Storage

  • SS_DATA_PATH: Local storage path (default ./data). This is a required option and will be used as the SeaSearch system storage path (replaces the original ZINC_DATA_PATH).

Object Storage

  • SS_STORAGE_TYPE: Type of storage medium, default is disk. Possible options are s3, oss.
  • SS_MAX_OBJ_CACHE_SIZE: When using object storage, the maximum local cache size. Default is 10GB. Support human-friendly storage formats, e.g. 500MB, 12GB
  • SS_DATA_PATH: Local storage path (default ./data). This is a required option and will be used for local cache storage when using object storage.

S3

These configurations are only effective when SS_STORAGE_TYPE=s3.

  • SS_S3_ACCESS_ID: The SS_S3_ACCESS_ID is required to authenticate you to S3. You can find the SS_S3_ACCESS_ID in the "security credentials" section on your AWS account page or from your storage provider.
  • SS_S3_USE_V4_SIGNATURE: There are two versions of authentication protocols that can be used with S3 storage: Version 2 (older, may still be supported by some regions) and Version 4 (current, used by most regions). If you don't set this option, SeaSearch will use the v2 protocol. It's suggested to use the v4 protocol.
  • SS_S3_ACCESS_SECRET: The SS_S3_ACCESS_SECRET is required to authenticate you to S3. You can find the key in the "security credentials" section on your AWS account page or from your storage provider.
  • SS_S3_ENDPOINT: (Optional) The endpoint by which you access the storage service. Usually it starts with the region name. It's required to provide the host address if you use storage provider other than AWS, otherwise SeaSearch will use AWS's address (i.e., s3.us-east-1.amazonaws.com).
  • SS_S3_BUCKET: Bucket name for SeaSearch storage. Make sure it follows S3 naming rules (you can refer the notes below the table).
  • SS_S3_USE_HTTPS: Use https to connect to S3. It's recommended to use https.
  • SS_S3_PATH_STYLE_REQUEST: (Optional) This option asks SeaSearch to use URLs like https://192.168.1.123:8080/bucketname/object to access objects. In Amazon S3, the default URL format is in virtual host style, such as https://bucketname.s3.amazonaws.com/object. But this style relies on advanced DNS server setup. So most self-hosted storage systems only implement the path style format. So we recommend to set this option to true for self-hosted storage.
  • SS_S3_AWS_REGION: (Optional) If you use the v4 protocol and AWS S3, set this option to the region you chose when you create the buckets. If it's not set and you're using the v4 protocol, SeaSearch will use us-east-1 as the default. This option will be ignored if you use the v2 protocol.
  • SS_S3_SSE_C_KEY(Optional) A string of 32 characters can be generated by openssl rand -base64 24. It can be any 32-character long random string. It's required to use V4 authentication protocol and https if you enable SSE-C.

Logging

  • SeaSearch_LOG_TO_STDOUT: Whether to output logs to standard output as part of the SeaSearch component (default false).
  • SEATABLE_LOG_TO_STDOUT: Whether to output logs to standard output as part of the Seatable component (default false).
  • SS_LOG_DIR: Log directory (default is a log subdirectory in the current directory).
  • SS_LOG_LEVEL: Log level (default is debug).

Example SeaSearch Configuration

Enabling Local Disk as Storage Backend

  ZINC_FIRST_ADMIN_USER=admin
  ZINC_FIRST_ADMIN_PASSWORD=password
  SS_DATA_PATH=./data

Enabling S3 as Storage Backend

sh ZINC_FIRST_ADMIN_USER=admin ZINC_FIRST_ADMIN_PASSWORD=password SS_DATA_PATH=./data SS_STORAGE_TYPE=s3 SS_S3_ACCESS_ID=<your-s3-key-id> SS_S3_ACCESS_SECRET=<your-s3-secret-key> SS_S3_BUCKET=<your-seasearch-bucket> SS_S3_REGION=us-east-1 SS_S3_USE_HTTPS=true SS_S3_USE_V4_SIGNATURE=true

sh ZINC_FIRST_ADMIN_USER=admin ZINC_FIRST_ADMIN_PASSWORD=password SS_DATA_PATH=./data SS_STORAGE_TYPE=s3 SS_S3_ACCESS_ID=<your-s3-key-id> SS_S3_ACCESS_SECRET=<your-s3-secret-key> SS_S3_BUCKET=<your-seasearch-bucket> SS_S3_ENDPOINT=sos-de-fra-1.exo.io SS_S3_PATH_STYLE_REQUEST=true

sh ZINC_FIRST_ADMIN_USER=admin ZINC_FIRST_ADMIN_PASSWORD=password SS_DATA_PATH=./data SS_STORAGE_TYPE=s3 SS_S3_ACCESS_ID=<your-s3-key-id> SS_S3_ACCESS_SECRET=<your-s3-secret-key> SS_S3_BUCKET=<your-seasearch-bucket> SS_S3_ENDPOINT=fsn1.your-objectstorage.com SS_S3_PATH_STYLE_REQUEST=true SS_S3_USE_HTTPS=true

sh ZINC_FIRST_ADMIN_USER=admin ZINC_FIRST_ADMIN_PASSWORD=password SS_DATA_PATH=./data SS_STORAGE_TYPE=s3 SS_S3_ACCESS_ID=<your-s3-key-id> SS_S3_ACCESS_SECRET=<your-s3-secret-key> SS_S3_BUCKET=<your-seasearch-bucket> SS_S3_ENDPOINT=<access endpoint for storage provider> SS_S3_REGION=<region name for storage provider> SS_S3_USE_HTTPS=true

sh ZINC_FIRST_ADMIN_USER=admin ZINC_FIRST_ADMIN_PASSWORD=password SS_DATA_PATH=./data SS_STORAGE_TYPE=s3 SS_S3_ACCESS_ID=<your-s3-key-id> SS_S3_ACCESS_SECRET=<your-s3-secret-key> SS_S3_BUCKET=<your-seasearch-bucket> SS_S3_ENDPOINT=<your s3 api endpoint host>:<your s3 api endpoint port> SS_S3_USE_HTTPS=true SS_S3_PATH_STYLE_REQUEST=true SS_S3_USE_HTTPS=true