cortx

(β˜… 625)

CORTX Community Object Storage is 100% open source object storage uniquely optimized for mass capacity storage devices.

File Explorer

Download Latest Version (.zip)

Showing a partial file list β€” download the zip above to see everything.

  • .alexignore
  • .alexrc
  • .gitattributes
  • .gitignore
  • .gitmodules
  • .imgbotconfig
  • .whitesource
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • CONTRIBUTORS.md
  • cortx-experiments
  • cortx-ha
  • cortx-halo
  • cortx-hare
  • cortx-k8s
  • cortx-manager
  • cortx-motr
  • cortx-motr-apps
  • cortx-multisite
  • cortx-prvsnr
  • cortx-re
  • cortx-rgw
  • cortx-rgw-integration
  • cortx-utils
  • CORTXTestimonials.md
  • FAQs.md
  • Feature_Roadmap.md
  • FeatureRoadmap.md
  • GLOSSARY.md
  • LICENSE
  • QUICK_START.md
  • README.md
  • SECURITY.md
  • SUPPORT.md

# Installation Guide

1. Get the code
git clone https://github.com/Seagate/cortx

Downloads the entire project code from GitHub to your computer.

cd cortx

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
docker compose -f doc/community-build/docker/cortx-all/docker-compose.yml up -d --build

Runs the command against the services defined in the compose file.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. .NET

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • .NET SDK The SDK required for the dotnet command.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd doc/integrations/drp/DRP-dotnet-test

This project's files live in a subfolder, so move into it first.

dotnet restore

Downloads the packages the project depends on.

dotnet run

Builds the project and runs it immediately.

βœ… After dotnet run, check the message or address shown in the terminal.

4. Gradle (Java/Kotlin)

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • JDK (Java) Required to build and run Java/Kotlin projects.
  • Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd doc/integrations/cortx-drive

This project's files live in a subfolder, so move into it first.

./gradlew build

Builds the project using Gradle.

βœ… A BUILD SUCCESSFUL message means it worked. The output is created under build/.

5. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd doc/integrations/drp/DRP-nodejs/cucm-sql-async

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

6. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
pip install -r doc/integrations/cortx-milvusio/audio_search/requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

jupyter notebook

Launches Jupyter in your browser so you can open and run the notebook (.ipynb) files.

βœ… If it runs without errors and prints output in the terminal, it worked.

7. PHP (Composer)

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • PHP A PHP runtime is required.
  • Composer The package manager used to install PHP libraries.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd doc/integrations/laravel

This project's files live in a subfolder, so move into it first.

composer install

Installs the PHP libraries listed in composer.json.

βœ… Run it with a built-in server like php -S localhost:8000, then open http://localhost:8000 in your browser.

Today's picks

RuView β˜… 90,357

Ο€ RuView turns commodity WiFi signals into real-time spatial intelligence, vital sign moni

Rust
SecLists β˜… 72,883

SecLists is the security tester's companion. It's a collection of multiple types of lists

PHP
tabby β˜… 73,948

A terminal for a more modern age

TypeScript
youtube-dl β˜… 140,972

Command-line program to download videos from YouTube.com and other video sites

Python
rtk β˜… 76,287

CLI proxy that reduces LLM token consumption by 60-90% on common dev commands. Single Rust

Rust
excalidraw β˜… 129,791

Virtual whiteboard for sketching hand-drawn like diagrams

TypeScript
// repository documentation