Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "spiceio"
version = "0.2.0"
version = "0.3.0"
edition = "2024"
description = "S3-compatible API proxy to SMB file shares"
license = "Apache-2.0"
Expand Down
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ S3 client ---> spiceio (HTTP :8333) ---> SMB server (TCP :445)
- **Full S3 compatibility** for common operations: Get/Put/Copy/Delete/Head Object, ListObjects (v1 & v2), ListBuckets, multipart uploads, range + conditional requests
- **SMB2 compounding** -- batches Create+Read+Close or Create+Write+Close into single round trips for small file performance
- **Streaming I/O** -- GetObject and PutObject stream directly between HTTP and SMB without buffering entire files
- **Simple config** -- everything via environment variables, single binary
- **Non-blocking logging** -- timestamped stdout/stderr with optional file tee via `SPICEIO_LOG_FILE`; dedicated writer thread, never stalls the proxy
- **Simple config** -- everything via environment variables, single binary, `--version` flag
- **Zero external crypto** -- NTLMv2 auth and AES-CMAC signing via macOS CommonCrypto FFI

### Use cases
Expand Down Expand Up @@ -82,6 +83,7 @@ All configuration is via environment variables:
| `SPICEIO_SMB_DOMAIN` | no | *(empty)* | SMB domain |
| `SPICEIO_BUCKET` | no | `SPICEIO_SMB_SHARE` | Virtual S3 bucket name |
| `SPICEIO_REGION` | no | `us-east-1` | AWS region to advertise |
| `SPICEIO_LOG_FILE` | no | *(none)* | Append logs to file (non-blocking) |

## Supported S3 operations

Expand Down
Loading