{"id":23002622,"url":"https://github.com/veeso-dev/ozone","last_synced_at":"2025-04-02T14:21:14.230Z","repository":{"id":176490707,"uuid":"658387757","full_name":"veeso-dev/ozone","owner":"veeso-dev","description":"Web service to scan files with ClamAV","archived":false,"fork":false,"pushed_at":"2023-06-26T08:38:51.000Z","size":59,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-03-08T23:17:12.965Z","etag":null,"topics":["clamav","rust","rust-lang","webservice"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/veeso-dev.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2023-06-25T15:42:10.000Z","updated_at":"2023-08-24T03:35:56.000Z","dependencies_parsed_at":"2024-01-12T10:25:51.835Z","dependency_job_id":"b284f42b-9861-49ab-8c1c-c7c4762896e3","html_url":"https://github.com/veeso-dev/ozone","commit_stats":{"total_commits":16,"total_committers":2,"mean_commits":8.0,"dds":0.1875,"last_synced_commit":"3bb23044e450be1a93b5bac0c9abf2bc7edd0fc5"},"previous_names":["veeso-dev/ozone"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/veeso-dev%2Fozone","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/veeso-dev%2Fozone/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/veeso-dev%2Fozone/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/veeso-dev%2Fozone/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/veeso-dev","download_url":"https://codeload.github.com/veeso-dev/ozone/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246828477,"owners_count":20840474,"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":["clamav","rust","rust-lang","webservice"],"created_at":"2024-12-15T07:11:46.295Z","updated_at":"2025-04-02T14:21:14.209Z","avatar_url":"https://github.com/veeso-dev.png","language":"Rust","funding_links":["https://ko-fi.com/veeso","https://www.paypal.me/chrisintin"],"categories":[],"sub_categories":[],"readme":"# Ozone\n\n\u003cp align=\"center\"\u003e~ A webservice which scans files with ClamAV ~\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"#get-started-\"\u003eGet started\u003c/a\u003e\n  ·\n  \u003ca href=\"https://crates.io/crates/ozone-ws\" target=\"_blank\"\u003eCrates.io\u003c/a\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003eDeveloped by \u003ca href=\"https://veeso.dev/\" target=\"_blank\"\u003e@veeso\u003c/a\u003e\u003c/p\u003e\n\u003cp align=\"center\"\u003eCurrent version: 0.1.0 (26/06/2023)\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://opensource.org/license/mit/\"\n    \u003e\u003cimg\n      src=\"https://img.shields.io/badge/License-MIT-teal.svg\"\n      alt=\"License-MIT\"\n  /\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/veeso-dev/ozone/stargazers\"\n    \u003e\u003cimg\n      src=\"https://img.shields.io/github/stars/veeso-dev/ozone.svg\"\n      alt=\"Repo stars\"\n  /\u003e\u003c/a\u003e\n  \u003ca href=\"https://crates.io/crates/ozone-ws\"\n    \u003e\u003cimg\n      src=\"https://img.shields.io/crates/d/ozone-ws.svg\"\n      alt=\"Downloads counter\"\n  /\u003e\u003c/a\u003e\n  \u003ca href=\"https://crates.io/crates/ozone-ws\"\n    \u003e\u003cimg\n      src=\"https://img.shields.io/crates/v/ozone-ws.svg\"\n      alt=\"Latest version\"\n  /\u003e\u003c/a\u003e\n  \u003ca href=\"https://ko-fi.com/veeso\"\u003e\n    \u003cimg\n      src=\"https://img.shields.io/badge/donate-ko--fi-red\"\n      alt=\"Ko-fi\"\n  /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/veeso-dev/ozone/actions\"\n    \u003e\u003cimg\n      src=\"https://github.com/veeso-dev/ozone/workflows/build-test/badge.svg\"\n      alt=\"Linux CI\"\n  /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n---\n\n- [Ozone](#ozone)\n  - [About Ozone](#about-ozone)\n  - [Get started](#get-started)\n    - [Run with docker](#run-with-docker)\n  - [Ozone API](#ozone-api)\n    - [Check](#check)\n    - [Scan](#scan)\n  - [Support the developer](#support-the-developer)\n  - [Contributing and issues](#contributing-and-issues)\n  - [Changelog](#changelog)\n  - [License](#license)\n\n---\n\n## About Ozone\n\nOzone is a Rust web service which comes integrated with ClamAV. The service provides an API endpoint to scan files with ClamAV.\n\n---\n\n## Get started\n\n### Run with docker\n\nThe entire ozone web service comes with a docker compose file to easily run the service on your machine.\nJust run:\n\n```sh\ndocker-compose build\ndocker-compose up -d\n```\n\nAt this point ozone will be served on the specified port in the docker-compose file. (Default: `3010`)\n\n## Ozone API\n\n### Check\n\nCheck web service status:\n\n```txt\nGET /check\n```\n\nResponse:\n\n```json\n{\n  \"status\": \"ok\"\n}\n```\n\n### Scan\n\nScan different files:\n\n```txt\nPOST /scan\ncurl --request POST \\\n  --url http://localhost:3010/scan \\\n  --header 'Content-Type: multipart/form-data' \\\n  --form file=@/tmp/file1.txt \\\n  --form malware=@/tmp/eicarcom2.zip\n```\n\nResponse:\n\n```json\n{\n  \"files\": [\n    {\n      \"name\": \"file\",\n      \"filename\": \"file1.txt\",\n      \"safe\": true,\n      \"size\": 222\n    },\n    {\n      \"name\": \"malware\",\n      \"filename\": \"eicarcom2.zip\",\n      \"safe\": false,\n      \"size\": 308,\n      \"threat\": \"Win.Test.EICAR_HDB-1\"\n    }\n  ]\n}\n```\n\nWhere:\n\n- `name`: is the form field name\n- `filename`: is the filename\n- `safe`: whether the file is safe\n- `size`: the file size\n- `threat`: the threat name found (optional; only if safe is `false`)\n\n---\n\n## Support the developer\n\nIf you like Ozone and you're grateful for the work I've done, please consider a little donation 🥳\n\nYou can make a donation with one of these platforms:\n\n[![ko-fi](https://img.shields.io/badge/Ko--fi-F16061?style=for-the-badge\u0026logo=ko-fi\u0026logoColor=white)](https://ko-fi.com/veeso)\n[![PayPal](https://img.shields.io/badge/PayPal-00457C?style=for-the-badge\u0026logo=paypal\u0026logoColor=white)](https://www.paypal.me/chrisintin)\n\n---\n\n## Contributing and issues\n\nContributions, bug reports, new features and questions are welcome! 😉\nIf you have any question or concern, or you want to suggest a new feature, or you want just want to improve pavao, feel free to open an issue or a PR.\n\nPlease follow [our contributing guidelines](CONTRIBUTING.md)\n\n---\n\n## Changelog\n\nView Ozone's changelog [HERE](CHANGELOG.md)\n\n---\n\n## License\n\nOzone is licensed under the MIT license.\n\nYou can read the entire license [HERE](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fveeso-dev%2Fozone","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fveeso-dev%2Fozone","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fveeso-dev%2Fozone/lists"}