filen-rs

(β˜… 89)

Rust Crates for Filen

  • .dockerignore
  • .editorconfig
  • .gitignore
  • .gitmodules
  • .sqlfluff
  • Cargo.lock
  • Cargo.toml
  • CLAUDE.md
  • LICENSE
  • README.md
  • rust-toolchain.toml
  • rustfmt.toml
  • taplo.toml

# Installation Guide

1. Get the code
git clone https://github.com/FilenCloudDienste/filen-rs

Downloads the entire project code from GitHub to your computer.

cd filen-rs

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 build -f filen-cli/Dockerfile -t filen-rs .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 filen-rs

Runs the built image as an actual container.

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

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.
⚠️ 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 filen-sdk-rs/web

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 build

Compiles the Rust project.

cargo test

Type this command into your terminal and run it.

cargo build --features heif-decoder

Compiles the Rust project.

cargo test -p filen-sdk-rs

Type this command into your terminal and run it.

cargo test -p filen-mobile-native-cache

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