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:

• First steps
• Manual installation
• Installation with docker
• Development environment setup
• Post-installation
• Configuration reference
  • Application configuration
  • Permissions list
  • Docker container extra parameters
  • PostgreSQL support
• Docker, releases and versioning
• Using postman to manage the application
• Authorization
  • Creating a token
  • Looking up a token
  • Revoking a token
• Files storage
  • Security
  • Uploading
  • Downloading
  • Aliasing filenames (migrating existing files to File Repository)
  • Hotlink protection - personalizing URLs for your visitors
  • Listing and searching
• Backup
  • Getting started
  • Managing collections
  • Authorization
  • Backups: Upload, deletion and versioning
  • Data replication
  • Managing collections from shell
• MinimumUI
  • Quick start in steps
  • Endpoints
• Bahub API client
  • Configuration reference
  • Basic usage
  • Monitoring errors with Sentry
  • Slack/Mattermost notifications
  • Setup
  • Using docker container
  • Without docker
• Shell access
  • Introduction
  • Docker container concept
• 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 Postman 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