OxiCloud

(★ 3,500)

☁️ Ultra-fast, secure & lightweight self-hosted cloud storage — your files, photos, calendars & contacts, all in one place. Built in Rust.

  • .claudeignore
  • .dockerignore
  • .envrc
  • .gitattributes
  • .gitignore
  • .stylelintrc.json
  • AGENTS.md
  • bench.sh
  • build.rs
  • Cargo.lock
  • Cargo.toml
  • CLAUDE.md
  • CODE_OF_CONDUCT.md
  • CODEOWNERS
  • CONTRIBUTING.md
  • devenv.nix
  • docker-compose.wopi.yml
  • docker-compose.yml
  • Dockerfile
  • entrypoint.sh
  • example.env
  • flake.lock
  • flake.nix
  • justfile
  • LICENSE
  • README.md
  • TODO-LIST.md
  • TODO-STORAGE-BACKENDS.prompt.md

# Installation Guide

1. Get the code
git clone https://github.com/AtalayaLabs/OxiCloud

Downloads the entire project code from GitHub to your computer.

cd OxiCloud

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.
docker compose up -d

Builds and starts all defined containers (server, database, etc.) at once, in the background.

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

Pulled directly from this repo's README.

3. 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.
cd frontend

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.

4. Rust

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
cargo run

Builds and then immediately runs the program.

cargo fmt --all --check

Type this command into your terminal and run it.

cargo clippy --all-features --all-targets -- -D warnings

Type this command into your terminal and run it.

cargo test --workspace

Type this command into your terminal and run it.

If cargo build finishes without errors, it worked. The executable is created under target/.

Pulled directly from this repo's README.

// repository documentation