Nimbus Documentation

Overview

Nimbus is a self-hosted CDN designed to simplify static asset delivery through a powerful API interface. The following documentation will guide you through installation and setup.

Requirements

System Dependencies

  • Node.js (v14 or higher)
  • npm (comes with Node)
  • VPS/Server with SSH access

Installation

  1. 1

    Clone the repository

    git clone https://github.com/im-playstation451/Nimbus
  2. 2

    Install dependencies

    cd nimbus
npm install
  3. 3

    Start the API

    node api
  4. 4

    Start the application

    node .

Using the API

Example of uploading a file using the upload endpoint:

curl -X POST https://localhost:3001/upload \
  -H "Authorization: Bearer [token]" \
  -F "file=@file.png" \
  -F "folder=folder" \
  -F "filename=file name"

Replace [token] with your authentication token if required.
Fields folder and filename are optional.

Configuration

Key Value Description
ROOT_CDN_FOLDER cdn Root folder for CDN files
SUB_CDN_FOLDERS image, gif, video, profile Allowed subfolders for organization
PORT 3001 API server port

Contributing

  1. Fork the repository on GitHub
  2. Create a new branch for your feature/fix
  3. Submit pull request