{
  "schema_version": 1,
  "generated_at": "2026-10-23T00:00:00.000Z",
  "canonical_url": "https://openlogs.fyi/tools/rustfs",
  "slug": "rustfs",
  "name": "RustFS",
  "tagline": "S3-compatible object storage server written in Rust.",
  "replaces": {
    "summary": "Paid object storage services, such as Amazon S3.",
    "products": [
      {
        "slug": "amazon-s3",
        "name": "Amazon S3",
        "vendor": "Amazon",
        "url": "https://openlogs.fyi/alternatives/amazon-s3"
      }
    ]
  },
  "stack": [
    {
      "kind": "language",
      "name": "Rust"
    }
  ],
  "deployment_methods": [
    "docker_compose"
  ],
  "requirements": {
    "min_ram_mb": null,
    "min_cpu_cores": null,
    "source_url": null
  },
  "license": {
    "spdx": "Apache-2.0",
    "class": "osi",
    "source_url": "https://github.com/rustfs/rustfs/blob/1e36e18265d8d9f2183d75ac15d6049d87783ff7/LICENSE"
  },
  "business_model": {
    "value": "unknown",
    "notes": "The README at the pinned commit does not state a business model, so it stays unknown.",
    "source_url": "https://github.com/rustfs/rustfs/blob/1e36e18265d8d9f2183d75ac15d6049d87783ff7/README.md",
    "checked_at": "2026-10-22"
  },
  "difficulty": {
    "value": "medium",
    "reason": "2 services, 5 volume mounts, no env values to set, no elevated host access. Heuristic score 3 of 11: medium. A source checkout is needed, so the rating is at least medium."
  },
  "repository": {
    "owner": "rustfs",
    "name": "rustfs",
    "url": "https://github.com/rustfs/rustfs"
  },
  "compose_check": {
    "status": "config_ok",
    "validated_at": "2026-10-22",
    "summary": "config_ok on 2026-10-22"
  },
  "recipe": {
    "version": 1,
    "source_path": "docker-compose-simple.yml",
    "source_repo": "rustfs/rustfs",
    "source_commit_sha": "1e36e18265d8d9f2183d75ac15d6049d87783ff7",
    "source_kind": "app_repo",
    "source_url": "https://github.com/rustfs/rustfs/blob/1e36e18265d8d9f2183d75ac15d6049d87783ff7/docker-compose-simple.yml"
  },
  "install_steps": [
    {
      "order": 1,
      "kind": "prerequisite",
      "language": "text",
      "label": "Docker with the Compose plugin and git",
      "body": "A host with Docker, the Docker Compose plugin and git. This entry needs a checkout of the project repository.",
      "source_url": "https://github.com/rustfs/rustfs/blob/1e36e18265d8d9f2183d75ac15d6049d87783ff7/README.md",
      "validation_status": "unvalidated"
    },
    {
      "order": 2,
      "kind": "shell",
      "language": "bash",
      "label": "Get the source at commit 1e36e18",
      "body": "git init rustfs\ncd rustfs\ngit remote add origin https://github.com/rustfs/rustfs.git\ngit fetch --depth 1 origin 1e36e18265d8d9f2183d75ac15d6049d87783ff7\ngit checkout FETCH_HEAD",
      "source_url": "https://github.com/rustfs/rustfs/blob/1e36e18265d8d9f2183d75ac15d6049d87783ff7/README.md",
      "validation_status": "unvalidated"
    },
    {
      "order": 3,
      "kind": "compose",
      "language": "yaml",
      "label": "The compose file in the checkout: docker-compose-simple.yml (shown here for reading)",
      "body": "# Copyright 2024 RustFS Team\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n#     http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nservices:\n  # RustFS main service\n  rustfs:\n    image: rustfs/rustfs:latest\n    container_name: rustfs-server\n    depends_on:\n      volume-permission-helper:\n        condition: service_completed_successfully\n    security_opt:\n      - \"no-new-privileges:true\"\n    ports:\n      - \"9000:9000\" # S3 API port\n      - \"9001:9001\" # Console port\n    environment:\n      - RUSTFS_VOLUMES=/data/rustfs{0...3}\n      - RUSTFS_ADDRESS=0.0.0.0:9000\n      - RUSTFS_CONSOLE_ADDRESS=0.0.0.0:9001\n      - RUSTFS_CONSOLE_ENABLE=true\n      - RUSTFS_CONSOLE_CORS_ALLOWED_ORIGINS=*\n      - RUSTFS_ACCESS_KEY=rustfsadmin # CHANGEME\n      - RUSTFS_SECRET_KEY=rustfsadmin # CHANGEME\n      - RUSTFS_OBS_LOGGER_LEVEL=info\n      - RUSTFS_OBS_LOG_DIRECTORY=/app/logs\n      # Optional TLS:\n      # - mount your cert directory to /opt/tls\n      # - set RUSTFS_TLS_PATH=/opt/tls\n      # - when TLS is enabled, health checks automatically switch to HTTPS\n      # Keep strict disk topology checks enabled by default.\n      # For local testing only, set `RUSTFS_UNSAFE_BYPASS_DISK_CHECK=true` explicitly.\n      - RUSTFS_UNSAFE_BYPASS_DISK_CHECK=${RUSTFS_UNSAFE_BYPASS_DISK_CHECK:-false}\n    volumes:\n      - rustfs_data_0:/data/rustfs0\n      - rustfs_data_1:/data/rustfs1\n      - rustfs_data_2:/data/rustfs2\n      - rustfs_data_3:/data/rustfs3\n      - logs:/app/logs\n    networks:\n      - rustfs-network\n    restart: unless-stopped\n    healthcheck:\n      # Default behavior:\n      # - HTTP when RUSTFS_TLS_PATH is unset\n      # - HTTPS when RUSTFS_TLS_PATH is set\n      # - loopback TLS uses `-k` unless strict host+CA values are provided\n      #\n      # Strict TLS example:\n      # - set RUSTFS_HEALTHCHECK_HOST to a SAN-covered hostname\n      # - optionally set RUSTFS_HEALTHCHECK_CA (defaults to /opt/tls/ca.crt when present)\n      test:\n        [\n          \"CMD\",\n          \"sh\", \"-ec\",\n          \"host=\\\"$${RUSTFS_HEALTHCHECK_HOST:-127.0.0.1}\\\"; scheme=\\\"http\\\"; set -- -fsS; \\\n          if [ -n \\\"$${RUSTFS_TLS_PATH:-}\\\" ]; then \\\n            scheme=\\\"https\\\"; \\\n            ca_path=\\\"$${RUSTFS_HEALTHCHECK_CA:-}\\\"; \\\n            if [ -z \\\"$${ca_path}\\\" ] && [ -f /opt/tls/ca.crt ]; then ca_path=/opt/tls/ca.crt; fi; \\\n            case \\\"$${host}\\\" in 127.0.0.1|localhost) strict_host=false ;; *) strict_host=true ;; esac; \\\n            if [ \\\"$${strict_host}\\\" = true ] && [ -n \\\"$${ca_path}\\\" ]; then \\\n              set -- \\\"$${@}\\\" --cacert \\\"$${ca_path}\\\" --resolve \\\"$${host}:9000:127.0.0.1\\\" --resolve \\\"$${host}:9001:127.0.0.1\\\"; \\\n            else \\\n              set -- \\\"$${@}\\\" -k; \\\n            fi; \\\n          fi; \\\n          curl \\\"$${@}\\\" \\\"$${scheme}://$${host}:9000/health\\\" && \\\n          curl \\\"$${@}\\\" \\\"$${scheme}://$${host}:9001/rustfs/console/health\\\"\"\n        ]\n      interval: 30s\n      timeout: 10s\n      retries: 3\n      start_period: 40s\n\n  # RustFS volume permissions fixer service\n  volume-permission-helper:\n    image: alpine\n    volumes:\n      - rustfs_data_0:/data/rustfs0\n      - rustfs_data_1:/data/rustfs1\n      - rustfs_data_2:/data/rustfs2\n      - rustfs_data_3:/data/rustfs3\n      - logs:/app/logs\n    command: >\n      sh -c \"\n        chown -R 10001:10001 /data/rustfs0 /data/rustfs1 /data/rustfs2 /data/rustfs3 /app/logs &&\n        echo 'Volume Permissions fixed' &&\n        exit 0\n      \"\n    # Permission baseline:\n    # - default RustFS runtime user is 10001:10001\n    # - alternatively, run rustfs service with host-matched `user: \\\"<uid>:<gid>\\\"`\n    restart: \"no\"\n\nnetworks:\n  rustfs-network:\n\nvolumes:\n  rustfs_data_0:\n  rustfs_data_1:\n  rustfs_data_2:\n  rustfs_data_3:\n  logs:\n",
      "source_url": "https://github.com/rustfs/rustfs/blob/1e36e18265d8d9f2183d75ac15d6049d87783ff7/docker-compose-simple.yml",
      "validation_status": "config_ok"
    },
    {
      "order": 4,
      "kind": "note",
      "language": "text",
      "label": "What the compose file check ran with",
      "body": "The compose file check ran in a checkout of rustfs/rustfs at 1e36e18265d8d9f2183d75ac15d6049d87783ff7 (a sparse checkout: only the top-level files). The README tells the reader to use the docker-compose-simple.yml file in the root directory of the repository.",
      "source_url": "https://github.com/rustfs/rustfs/blob/1e36e18265d8d9f2183d75ac15d6049d87783ff7/README.md",
      "validation_status": "unvalidated"
    },
    {
      "order": 5,
      "kind": "shell",
      "language": "bash",
      "label": "Start it",
      "body": "docker compose -f docker-compose-simple.yml up -d",
      "source_url": "https://github.com/rustfs/rustfs/blob/1e36e18265d8d9f2183d75ac15d6049d87783ff7/README.md",
      "validation_status": "unvalidated"
    },
    {
      "order": 6,
      "kind": "verify",
      "language": "text",
      "label": "Open the app",
      "body": "Open http://localhost:9001. The compose file publishes host port 9001 for the rustfs service. The compose file marks port 9001 as the console port and port 9000 as the S3 API port.",
      "source_url": "https://github.com/rustfs/rustfs/blob/1e36e18265d8d9f2183d75ac15d6049d87783ff7/docker-compose-simple.yml",
      "validation_status": "unvalidated"
    }
  ],
  "notes": [
    {
      "kind": "gotcha",
      "title": "Some images use the latest tag or no tag",
      "body": "Images without a pinned version: rustfs: rustfs/rustfs:latest, volume-permission-helper: alpine (no tag). A later pull can get a different version.",
      "source_url": "https://github.com/rustfs/rustfs/blob/1e36e18265d8d9f2183d75ac15d6049d87783ff7/docker-compose-simple.yml",
      "checked_at": "2026-10-22"
    },
    {
      "kind": "gotcha",
      "title": "The compose file has placeholder values",
      "body": "Lines with a CHANGEME comment set: RUSTFS_ACCESS_KEY, RUSTFS_SECRET_KEY.",
      "source_url": "https://github.com/rustfs/rustfs/blob/1e36e18265d8d9f2183d75ac15d6049d87783ff7/docker-compose-simple.yml",
      "checked_at": "2026-10-22"
    },
    {
      "kind": "gotcha",
      "title": "The compose file publishes host ports",
      "body": "Host ports: 9000 (rustfs), 9001 (rustfs). A port without a host address listens on all host network interfaces.",
      "source_url": "https://github.com/rustfs/rustfs/blob/1e36e18265d8d9f2183d75ac15d6049d87783ff7/docker-compose-simple.yml",
      "checked_at": "2026-10-22"
    }
  ],
  "signals": {
    "captured_at": "2026-10-22",
    "stars": 35251,
    "forks": 1609,
    "open_issues": 45,
    "last_push": "2026-10-22",
    "days_since_push": 0,
    "latest_release": "1.0.3",
    "latest_release_date": "2026-10-17",
    "days_since_release": 5
  },
  "links": {
    "html": "https://openlogs.fyi/tools/rustfs",
    "markdown": "https://openlogs.fyi/tools/rustfs.md",
    "json": "https://openlogs.fyi/tools/rustfs.json"
  },
  "updated_at": "2026-10-22"
}