Config

Type Alias Config 

Source
pub type Config = ServeConfig;
Expand description

Legacy Config type alias for backward compatibility. New code should use Cli and ServeConfig instead.

Aliased Type§

pub struct Config {
Show 17 fields pub s3_uri: Option<String>, pub host: String, pub port: u16, pub s3_bucket: Option<String>, pub s3_endpoint: Option<String>, pub s3_region: String, pub auth_secret: Option<String>, pub auth_enabled: bool, pub cache_slides: usize, pub cache_blocks: usize, pub cache_tiles: usize, pub block_size: usize, pub jpeg_quality: u8, pub cache_max_age: u32, pub cors_origins: Option<Vec<String>>, pub verbose: bool, pub no_tracing: bool,
}

Fields§

§s3_uri: Option<String>

S3 bucket URI (e.g., s3://my-bucket) or just the bucket name. Alternative to –s3-bucket flag.

§host: String

Host address to bind the server to.

§port: u16

Port to listen on.

§s3_bucket: Option<String>

S3 bucket name containing the slide files. Can also be provided as a positional argument (s3://bucket).

§s3_endpoint: Option<String>

Custom S3 endpoint URL for S3-compatible services (MinIO, etc.).

If not specified, uses the default AWS S3 endpoint.

§s3_region: String

AWS region for S3.

§auth_secret: Option<String>

Secret key for HMAC-SHA256 signed URL authentication.

Required when authentication is enabled.

§auth_enabled: bool

Enable signed URL authentication.

When disabled (default), all tile requests are allowed without authentication. Enable for production deployments.

§cache_slides: usize

Maximum number of slides to keep in cache.

§cache_blocks: usize

Maximum number of blocks to cache per slide (256KB each).

§cache_tiles: usize

Maximum tile cache size in bytes (default: 100MB).

§block_size: usize

Block size in bytes for the block cache.

§jpeg_quality: u8

Default JPEG quality for tile encoding (1-100).

§cache_max_age: u32

HTTP Cache-Control max-age in seconds.

§cors_origins: Option<Vec<String>>

Allowed CORS origins (comma-separated).

If not specified, allows any origin.

§verbose: bool

Enable verbose logging (debug level).

§no_tracing: bool

Disable request tracing.