File Repository’s documentation

File Repository is a modern API application dedicated for storing files. It is able to use various storage backends including AWS S3, Dropbox, Google Drive and just filesystem. Lightweight, requires just PHP7 and at least SQLite3 or MySQL (other databases can be also supported in future due to using ORM).

Main functionality:

• Strict access control, you can generate a token that will have access to specific actions on specific items
• Store files where you need; on AWS S3, Minio.io, FTP, local storage and others…
• Deduplication for non-grouped files. There will be no duplicated files stored on your disk
• Backups management, you can define a collection of file versions that can rotate on adding a new version
• API + lightweight frontend
• Ready to integrate upload forms for your applications. Only generate token and redirect a user to an url

Contents:

• Server
  • First steps
  • Manual installation
  • Installation with docker
  • Development environment setup
  • Post-installation
  • Configuration reference
    • Application configuration
    • Permissions list
    • Docker container extra parameters
    • Redis/Memcached cache support
    • PostgreSQL support
  • Detailed server API documentation
  • Server functionality
    • Authorization
      • Creating a token
      • Searching tokens
      • Looking up a token
      • Revoking a token
      • Managing authentication using console commands
        • Generating an unlimited administrative token
        • Generating a normal token
        • Deleting expired tokens
      • Token load hierarchy
        • Loading priority
        • Use cases: Static assets serving
      • Secure Copy and token secrets
    • Files storage
      • Security
        • Access
        • Uploading restrictions
      • Uploading
        • From external resource by URL
        • In RAW BODY
        • In a POST form field
      • Downloading
        • Regular downloading
        • Downloading using alias defined in ids_mapping.yaml
        • Downloading using hotlink protection
      • Aliasing filenames (migrating existing files to File Repository)
        • Scenario
        • Practice, defining aliases
      • Hotlink protection - personalizing URLs for your visitors
        • Preparing your website and File Repository configuration
        • Practical example of generating access token on your website
      • Listing and searching
    • Backup
      • Getting started
        • Versioning
        • Collection limits
        • Permissions
      • Managing collections
        • Collection creation
        • Collection editing
        • Deleting
        • Fetching collection information
      • Authorization
        • Assigning a token to the collection
        • Revoking access to the collection for given token
      • Backups: Upload, deletion and versioning
        • Uploading a new version to the collection
        • Deleting a version
        • Getting the list of uploaded versions
        • Downloading uploaded versions
      • Data replication
        • Choosing scalable storage backends for File Repository
        • Selecting a scalable database
        • Using a scalable cache
      • Managing collections from shell
        • Creating collections
    • MinimumUI
      • Quick start in steps
      • Endpoints
        • Image Upload
        • File upload
        • Video watching
    • SecureCopy
      • SecureCopy API endpoints
        • What is encrypted or hashed?
      • Specification of data format returned by event list endpoint
      • Specification of encryption of file content
  • Specification of encryption
    • Key
    • Example of decryption using OpenSSL shell utility
  • Shell access
    • Introduction
    • Docker container concept
      • Managing collections from shell
        • Creating collections
      • Managing authentication using console commands
        • Generating an unlimited administrative token
        • Generating a normal token
        • Deleting expired tokens
      • Technical shell commands
        • Wait for database
        • Wait for other File Repository instance to be up
        • Health check
        • Dump database connection information
• Docker, releases and versioning
• API/Project rules
  • Releasing
  • Naming convention and formatting
  • Documentation
• Official clients
  • Bahub API client
    • Configuration reference
      • Environment variables
      • Application configuration
    • Basic usage
      • Sending a backup
      • Listing stored backups
      • Restoring a backup
      • Recovery from disaster
      • Making a snapshot of multiple services at once
    • Monitoring errors with Sentry
    • Slack/Mattermost notifications
    • Setup
    • Using docker container
    • Without docker
  • KropotCLI
    • Mechanism and security
    • How it works from KropotCLI perspective?
    • Getting started
• General guide for Administrators, DevOps and Developers

From authors

Project was started as a part of RiotKit initiative, for the needs of grassroot organizations such as:

• Fighting for better working conditions syndicalist (International Workers Association for example)
• Tenants rights organizations
• Various grassroot organizations that are helping people to organize themselves without authority

Technical description:

Project was created in Domain Driven like design in PHP 7, with Symfony 4 framework. There are API tests written in Codeception and unit tests written in PhpUnit. Feel free to submit pull requests, report issues, or join our team. The project is licensed with a MIT license.

RiotKit Collective