kev/rimgu
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
3nprob 2021-10-07 22:24:37 +09:00
parent fdb6759587
commit 857e22ed87
1 changed files with 20 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -9,25 +9,35 @@ It's lightweight and easy to configure.
Inspired by and (soon) integratable with: Inspired by and (soon) integratable with:
* [searx](https://github.com/searx/searx) * [searx](https://github.com/searx/searx)
* [teddit](https://codeberg.org/teddit/teddit) * [teddit](https://codeberg.org/teddit/teddit) ([integration](https://codeberg.org/teddit/teddit/pulls/249))
* [Privacy Redirect](https://github.com/SimonBrazell/privacy-redirect) * [Privacy Redirect](https://github.com/SimonBrazell/privacy-redirect) ([integration](https://github.com/SimonBrazell/privacy-redirect/pull/303))
* [nitter](https://github.com/zedeus/nitter) * [nitter](https://github.com/zedeus/nitter)
* [bibliogram](https://sr.ht/~cadence/bibliogram/) * [bibliogram](https://sr.ht/~cadence/bibliogram/)
Features:
- [x] URL-compatible with i.imgur.com - just replace the domain in the URL
- [x] Images and videos (gifv, mp4) returned directly
- [x] Galleries with comments
- [x] Albums
- [x] Supports http(s) forward proxy
This is currently very early stage software. Some things left to implement (contributions welcome!): This is currently very early stage software. Some things left to implement (contributions welcome!):
[ ] User page - [ ] User page
[ ] Tag page - [ ] Tag page
[ ] Localization/internationalization - [ ] Streaming (currently media is downloaded in full in rimgu before it's returned)
[ ] Pretty CSS styling - [ ] Localization/internationalization
[ ] Automatically fetch / rotate / renew client ID - [ ] Pretty CSS styling (responsive?)
[ ] Support for other popular image sites than only imgur - [ ] Automatically fetch / rotate / renew client ID
[ ] Prometheus metrics - [ ] Support for other popular image sites than only imgur
- [ ] Prometheus metrics
Things that are *currently* considered out of scope: Things that are *currently* considered out of scope:
* Uploading/commenting/voting/etc - rimgu is read-only for now. * Uploading/commenting/voting/etc - rimgu is read-only for now.
* Caching, authentication, serving HTTPS, rate limiting etc - Just use a load balancer like haproxy/envoy/nginx/traefik/caddy. * Caching, authentication, serving HTTPS, rate limiting etc - Just use a proxy or load balancer like squid/haproxy/envoy/nginx/traefik/caddy.
* Anything requiring client-side JS or client-side directly interacting with upstream servers * Anything requiring client-side JS or client-side directly interacting with upstream servers
## Building ## Building