You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
3nprob 7584ad2552 Add support info 2 weeks ago
samples Make comments optional 2 weeks ago
src handle user cover 2 weeks ago
static/css header style fix 2 weeks ago
templates Add support info 2 weeks ago
.dockerignore Add Dockerfile 2 weeks ago
.eslintrc Add tag page 2 weeks ago
.gitignore First commit: /a/, /gallery/, images, gifv 2 weeks ago
Dockerfile Copy assets as part of npm postbuild 2 weeks ago
FUNDING.yml Add support info 2 weeks ago
LICENSE Add README, LICENSE 2 weeks ago
README.md Add support info 2 weeks ago
package-lock.json Add eslint 2 weeks ago
package.json Copy assets as part of npm postbuild 2 weeks ago
tsconfig.json enable ts sourcemaps 2 weeks ago

README.md

rimgu: image host alternative frontend

rimgu is an alternative frontend / proxy for imgur

It's read-only and works without browser JavaScript. Images and albums can be viewed without wasting resources and anyonymity from downloading and running tracking scripts. No sign-up nags.

It's lightweight and easy to configure.

Inspired by and (soon) integratable with:

Features:

  • URL-compatible with i.imgur.com - just replace the domain in the URL
  • Images and videos (gifv, mp4) returned directly
  • Galleries with comments
  • Albums
  • User page
  • Tag page
  • Supports http(s) forward proxy

This is currently very early stage software. Some things left to implement (contributions welcome!):

  • Streaming (currently media is downloaded in full in rimgu before it's returned)
  • Localization/internationalization
  • Pretty CSS styling (responsive?)
  • Automatically fetch / rotate / renew client ID
  • Support for other popular image sites than only imgur
  • Filtering and exploration on user/tags pages
  • Responsive scaling of videos on user/tags pages
  • Prometheus metrics
  • Logo
  • SOCKS5 proxy support

Things that are currently considered out of scope:

  • Uploading/commenting/voting/etc - rimgu is read-only for now.
  • 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

Building

Locally

Dependencies:

  • node.js >= v16 (earlier most likely works fine)
$ npm install && npm run build

Docker

$ docker build -t rimgu:latest .

Running

Locally

$ node dist/index.js

Docker

$ docker run -p 8080:8080 -e -it RIMGU_ADDRESS=0.0.0.0 -e RIMGU_PORT=8080 rimgu:latest

If you decide to run a public instance, consider opening an issue to have it listed here :)

Configuration

Rimgu is configured via environment variables. See available variables in src/config.ts.

API and client ID

Media and galleries can be scraped without authorization through the public web interface. Some imgur functionality (comments, full albums) requires a provisioned client ID to authenticate requests.

You can get a client ID by opening https://imgur.com in a web browser and looking for requests to https://api.imgur.com/...?client_id=1234567deadbeef under "Network" in the developer console.

To run without API/key: RIMGU_USE_API=false

To run with API/key: RIMGU_USE_API=true RIMGU_IMGUR_CLIENT_ID=1234567deadbeef

This key may be used to track you and could be banned when overused. Keep this in mind before exposing a public instance with a client key associated with your personal imgur account. Consider any ToS you may have signed before associating a personal imgur account with a public instance.

Contributing

PRs are welcome! Before submitting a PR, please make sure linting passes successfully:

$ npm run lint

This software is released under the AGPL 3.0 license. In short, this means that if you make any modifications to the code and then publish the result (e.g. by hosting the result on a webserver), you must publicly distribute your changes and declare that they also use AGPL 3.0.

You are also requested to not remove attribution and donation information from forks and publications.

Support

Donations are welcome and will contribute to development, maintenance and a future public hosted instance.

  • XMR: 8C58RTj15HbWRhjqhdk9mmg5ro1GoTXH3Z5cR7nPATM3QvudQ25yoXA7rqPGsuuxK6YWV2zrvhcXjPhip2nEtUhmDh9goqT
  • BTC: bc1qwzdqywdezr5afyrtqenj7yz3fpz2qzpx7lca8j
  • ETH: 0x3FE87870e80a56c02D98a4E3CE946318b917d719
  • BCH: qzxxuatxvfz5wjdyckrlc9hclvfvmfrc6qr9nzzaue