https://github.com/brutus5000/orcap
https://github.com/brutus5000/orcap
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/brutus5000/orcap
- Owner: Brutus5000
- License: mit
- Created: 2021-11-18T13:13:54.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-14T08:04:21.000Z (over 2 years ago)
- Last Synced: 2025-02-09T19:17:18.447Z (4 months ago)
- Language: Kotlin
- Size: 83 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.MD
- License: LICENSE
Awesome Lists containing this project
README
# ORCAP
ORCAP is an acronym for
**O**auth \
**R**estricted \
**C**ontent server \
**A**nd \
**P**roxy cache
It allows serving any files from disk and restricting acces to these files as an OAuth resource server.
Using the `cache` profile it also acts as a proxy cache.
## Why not use Nginx or similar for serving files?
The point of ORCAP is to allow downloads only for people providing a valid OAuth 2 / OIDC token with a predefined scope.
These features are not available in free versions of common web servers. Additional features from other file servers are not required.
Spring Webflux should allow sufficient performance as it also provides zero-copy file transfer.
## And other proxy cache solutions?
Again, the demand for OAuth protected resources does not work together with regular proxy caches.
Each proxy node needs enforce the same OAuth checks as the root node does.
## File path assumptions
* In production: We assume you run this app in a Docker container and mount all files for download in the `/content` directory.
* In development: All files are served from your project folder under `./content`
Other directories can be configured using environment variables.