{"id":24508500,"url":"https://github.com/aplbrain/bossphorus","last_synced_at":"2025-03-15T09:21:06.394Z","repository":{"id":55567460,"uuid":"251356655","full_name":"aplbrain/bossphorus","owner":"aplbrain","description":"A BossDB-like volumetric datastore in Rust","archived":false,"fork":false,"pushed_at":"2023-06-14T16:25:44.000Z","size":265,"stargazers_count":1,"open_issues_count":10,"forks_count":1,"subscribers_count":17,"default_branch":"master","last_synced_at":"2025-01-22T00:16:20.842Z","etag":null,"topics":["3d","bossdb","rust","volumetric-data"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aplbrain.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-03-30T16:02:07.000Z","updated_at":"2023-04-12T13:04:33.000Z","dependencies_parsed_at":"2022-08-15T03:20:31.624Z","dependency_job_id":null,"html_url":"https://github.com/aplbrain/bossphorus","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aplbrain%2Fbossphorus","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aplbrain%2Fbossphorus/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aplbrain%2Fbossphorus/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aplbrain%2Fbossphorus/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aplbrain","download_url":"https://codeload.github.com/aplbrain/bossphorus/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243707943,"owners_count":20334733,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["3d","bossdb","rust","volumetric-data"],"created_at":"2025-01-22T00:16:41.460Z","updated_at":"2025-03-15T09:21:06.363Z","avatar_url":"https://github.com/aplbrain.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=center\u003e\u003cimg align=center src='https://user-images.githubusercontent.com/693511/77836507-0fc11300-712d-11ea-83a4-0c14b674378e.png' width=650 /\u003e\u003c/p\u003e\n\u003ch6 align=center\u003eBossphorus implementation in Rust\u003c/h6\u003e\n\n\u003cp align=center\u003e\n\u003cimg alt=\"GitHub\" src=\"https://img.shields.io/github/license/aplbrain/bossphorus?style=for-the-badge\"\u003e\n\u003ca href=\"https://github.com/aplbrain/bossphorus/actions\"\u003e\u003cimg alt=\"GitHub Workflow Status\" src=\"https://img.shields.io/github/workflow/status/aplbrain/bossphorus/Rust?style=for-the-badge\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\nThis is a partial reimplementation of the BossDB REST API in [Rust](https://www.rust-lang.org/).\n\n\n## Why?\n\nbossphorus simplifies data-access patterns for data that do not fit into RAM. When you write a 100-gigabyte file, bossphorus automatically slices your dataset up to fit in bite-sized pieces.\n\nWhen you request small pieces of your data for analysis, bossphorus intelligently serves only the parts you need, leaving the rest on disk.\n\n\n## Feature Parity\n\nSee [Feature Parity](docs/Features.md) for more information.\n\n\n## Disk Usage\n\nBossphorus caches cuboids in the `uploads` folder that's created in the current\nworking directory.  Currently, it will cache up to 1000 cuboids in this folder.\nThe least recently used cuboids are removed when the cuboid limit is reached.\n\n\n## Configuration\n\nEnvironment variables have precedence over the `Rocket.toml` config file.\n\n\n### Environment Variables\n\n`BOSSHOST`: Sets the Boss DB host  \n`BOSSTOKEN`: Token used for Boss auth\n\n\n### Rocket.toml File\n\n`bosshost`: Sets the Boss DB host  \n`bosstoken`: Token used for Boss auth\n\n\n### Defaults\n\nIn absence of an environment variable and value in the `Rocket.toml` file:\n\n```\nbosshost = \"api.bossdb.io\"\nbosstoken = \"public\"\n```\n\n\n## Development\n\nBlosc must be installed manually via a package manager to build.  SQLite is\nrequired, but it included with MacOS by default.\n\nFor MacOS:\n\n```shell\nbrew install c-blosc\n```\n\nFor Debian based Linux distros:\n\n```shell\nsudo apt-get install libblosc-dev sqlite3\n```\n\nFor RPM based Linux distros:\n\n```shell\nsudo yum install blosc sqlite\n```\n\n\nDue to use of the Rocket web server crate, the nightly Rust toolchain must be used. You can set this as your project default with:\n\n```shell\nrustup override set nightly\n```\n\n\n## Releases\n\nYou can build an optimized release with:\n\n```shell\ncargo build --release\n```\n\nThe binary will be at `target/release/bossphorus`.\n\n\n## License\n[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Faplbrain%2Fbossphorus.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Faplbrain%2Fbossphorus?ref=badge_large)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faplbrain%2Fbossphorus","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faplbrain%2Fbossphorus","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faplbrain%2Fbossphorus/lists"}